jmemsys.h
上传用户:tongfa
上传日期:2007-01-06
资源大小:1071k
文件大小:8k
源码类别:

图片显示

开发平台:

WINDOWS

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