home *** CD-ROM | disk | FTP | other *** search
/ Windows Graphics Programming / Feng_Yuan_Win32_GDI_DirectX.iso / Samples / include / jlib / jmemsys.h < prev    next >
Encoding:
C/C++ Source or Header  |  2000-05-16  |  7.0 KB  |  152 lines
  1. //-------------------------------------------------------------------------//
  2. //          Windows Graphics Programming: Win32 GDI and DirectDraw         //
  3. //                        ISBN  0-13-086985-6                              //
  4. //                                                                         //
  5. //  Modified by: Yuan, Feng                             www.fengyuan.com   //
  6. //  Changes    : C++, exception, in-memory source, BGR byte order          //
  7. //  Version    : 1.00.000, May 31, 2000                                    //
  8. //-------------------------------------------------------------------------//
  9.  
  10. /*
  11.  * jmemsys.h
  12.  *
  13.  * Copyright (C) 1992-1997, Thomas G. Lane.
  14.  * This file is part of the Independent JPEG Group's software.
  15.  * For conditions of distribution and use, see the accompanying README file.
  16.  *
  17.  * This include file defines the interface between the system-independent
  18.  * and system-dependent portions of the JPEG memory manager.  No other
  19.  * modules need include it.  (The system-independent portion is jmemmgr.c;
  20.  * there are several different versions of the system-dependent portion.)
  21.  *
  22.  * This file works as-is for the system-dependent memory managers supplied
  23.  * in the IJG distribution.  You may need to modify it if you write a
  24.  * custom memory manager.  If system-dependent changes are needed in
  25.  * this file, the best method is to #ifdef them based on a configuration
  26.  * symbol supplied in jconfig.h, as we have done with USE_MSDOS_MEMMGR
  27.  * and USE_MAC_MEMMGR.
  28.  */
  29.  
  30. /*
  31.  * These two functions are used to allocate and release small chunks of
  32.  * memory.  (Typically the total amount requested through jpeg_get_small is
  33.  * no more than 20K or so; this will be requested in chunks of a few K each.)
  34.  * Behavior should be the same as for the standard library functions malloc
  35.  * and free; in particular, jpeg_get_small must return NULL on failure.
  36.  * On most systems, these ARE malloc and free.  jpeg_free_small is passed the
  37.  * size of the object being freed, just in case it's needed.
  38.  * On an 80x86 machine using small-data memory model, these manage near heap.
  39.  */
  40.  
  41.  
  42. /*
  43.  * These two functions are used to allocate and release large chunks of
  44.  * memory (up to the total free space designated by jpeg_mem_available).
  45.  * The interface is the same as above, except that on an 80x86 machine,
  46.  * far pointers are used.  On most other machines these are identical to
  47.  * the jpeg_get/free_small routines; but we keep them separate anyway,
  48.  * in case a different allocation strategy is desirable for large chunks.
  49.  */
  50.  
  51. /*
  52.  * The macro MAX_ALLOC_CHUNK designates the maximum number of bytes that may
  53.  * be requested in a single call to jpeg_get_large (and jpeg_get_small for that
  54.  * matter, but that case should never come into play).  This macro is needed
  55.  * to model the 64Kb-segment-size limit of far addressing on 80x86 machines.
  56.  * On those machines, we expect that jconfig.h will provide a proper value.
  57.  * On machines with 32-bit flat address spaces, any large constant may be used.
  58.  *
  59.  * NB: jmemmgr.c expects that MAX_ALLOC_CHUNK will be representable as type
  60.  * size_t and will be a multiple of sizeof(align_type).
  61.  */
  62.  
  63. #ifndef MAX_ALLOC_CHUNK        /* may be overridden in jconfig.h */
  64. #define MAX_ALLOC_CHUNK  1000000000L
  65. #endif
  66.  
  67. /*
  68.  * This routine computes the total space still available for allocation by
  69.  * jpeg_get_large.  If more space than this is needed, backing store will be
  70.  * used.  NOTE: any memory already allocated must not be counted.
  71.  *
  72.  * There is a minimum space requirement, corresponding to the minimum
  73.  * feasible buffer sizes; jmemmgr.c will request that much space even if
  74.  * jpeg_mem_available returns zero.  The maximum space needed, enough to hold
  75.  * all working storage in memory, is also passed in case it is useful.
  76.  * Finally, the total space already allocated is passed.  If no better
  77.  * method is available, cinfo->mem->max_memory_to_use - already_allocated
  78.  * is often a suitable calculation.
  79.  *
  80.  * It is OK for jpeg_mem_available to underestimate the space available
  81.  * (that'll just lead to more backing-store access than is really necessary).
  82.  * However, an overestimate will lead to failure.  Hence it's wise to subtract
  83.  * a slop factor from the true available space.  5% should be enough.
  84.  *
  85.  * On machines with lots of virtual memory, any large constant may be returned.
  86.  * Conversely, zero may be returned to always use the minimum amount of memory.
  87.  */
  88.  
  89. long jpeg_mem_available (j_common_ptr cinfo,
  90.                      long min_bytes_needed,
  91.                      long max_bytes_needed,
  92.                      long already_allocated);
  93.  
  94. /*
  95.  * This structure holds whatever state is needed to access a single
  96.  * backing-store object.  The read/write/close method pointers are called
  97.  * by jmemmgr.c to manipulate the backing-store object; all other fields
  98.  * are private to the system-dependent backing store routines.
  99.  */
  100.  
  101. #define TEMP_NAME_LENGTH   64    /* max length of a temporary file's name */
  102.  
  103. typedef struct backing_store_struct * backing_store_ptr;
  104.  
  105. typedef struct backing_store_struct {
  106.   /* Methods for reading/writing/closing this backing-store object */
  107.   JMETHOD(void, read_backing_store, (j_common_ptr cinfo,
  108.                      backing_store_ptr info,
  109.                      void * buffer_address,
  110.                      long file_offset, long byte_count));
  111.   JMETHOD(void, write_backing_store, (j_common_ptr cinfo,
  112.                       backing_store_ptr info,
  113.                       void * buffer_address,
  114.                       long file_offset, long byte_count));
  115.   JMETHOD(void, close_backing_store, (j_common_ptr cinfo,
  116.                       backing_store_ptr info));
  117.  
  118.   /* Private fields for system-dependent backing-store management */
  119.   /* For a typical implementation with temp files, we need: */
  120.   FILE * temp_file;        /* stdio reference to temp file */
  121.   char temp_name[TEMP_NAME_LENGTH]; /* name of temp file */
  122. } backing_store_info;
  123.  
  124.  
  125. /*
  126.  * Initial opening of a backing-store object.  This must fill in the
  127.  * read/write/close pointers in the object.  The read/write routines
  128.  * may take an error exit if the specified maximum file size is exceeded.
  129.  * (If jpeg_mem_available always returns a large value, this routine can
  130.  * just take an error exit.)
  131.  */
  132.  
  133. void jpeg_open_backing_store (j_common_ptr cinfo,
  134.                       backing_store_ptr info,
  135.                       long total_bytes_needed);
  136.  
  137.  
  138. /*
  139.  * These routines take care of any system-dependent initialization and
  140.  * cleanup required.  jpeg_mem_init will be called before anything is
  141.  * allocated (and, therefore, nothing in cinfo is of use except the error
  142.  * manager pointer).  It should return a suitable default value for
  143.  * max_memory_to_use; this may subsequently be overridden by the surrounding
  144.  * application.  (Note that max_memory_to_use is only important if
  145.  * jpeg_mem_available chooses to consult it ... no one else will.)
  146.  * jpeg_mem_term may assume that all requested memory has been freed and that
  147.  * all opened backing-store objects have been closed.
  148.  */
  149.  
  150. long jpeg_mem_init (j_common_ptr cinfo);
  151. void jpeg_mem_term (j_common_ptr cinfo);
  152.