granicus.if.org Git - imagemagick/blob - magick/cache-private.h

   1 /*
   2   Copyright 1999-2011 ImageMagick Studio LLC, a non-profit organization
   3   dedicated to making software imaging solutions freely available.
   4
   5   You may not use this file except in compliance with the License.
   6   obtain a copy of the License at
   7
   8     http://www.imagemagick.org/script/license.php
   9
  10   Unless required by applicable law or agreed to in writing, software
  11   distributed under the License is distributed on an "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13   See the License for the specific language governing permissions and
  14   limitations under the License.
  15
  16   MagickCore cache private methods.
  17 */
  18 #ifndef _MAGICKCORE_CACHE_PRIVATE_H
  19 #define _MAGICKCORE_CACHE_PRIVATE_H
  20
  21 #if defined(__cplusplus) || defined(c_plusplus)
  22 extern "C" {
  23 #endif
  24
  25 #include <time.h>
  26 #include "magick/random_.h"
  27 #include "magick/thread-private.h"
  28 #include "magick/semaphore.h"
  29
  30 typedef enum
  31 {
  32   UndefinedCache,
  33   MemoryCache,
  34   MapCache,
  35   DiskCache,
  36   PingCache
  37 } CacheType;
  38
  39 typedef void
  40   *Cache;
  41
  42 typedef const IndexPacket
  43   *(*GetVirtualIndexesFromHandler)(const Image *);
  44
  45 typedef IndexPacket
  46   *(*GetAuthenticIndexesFromHandler)(const Image *);
  47
  48 typedef MagickBooleanType
  49   (*GetOneAuthenticPixelFromHandler)(Image *,const ssize_t,const ssize_t,
  50     PixelPacket *,ExceptionInfo *),
  51   (*GetOneVirtualPixelFromHandler)(const Image *,const VirtualPixelMethod,
  52     const ssize_t,const ssize_t,PixelPacket *,ExceptionInfo *),
  53   (*SyncAuthenticPixelsHandler)(Image *,ExceptionInfo *);
  54
  55 typedef const PixelPacket
  56   *(*GetVirtualPixelHandler)(const Image *,const VirtualPixelMethod,
  57     const ssize_t,const ssize_t,const size_t,const size_t,ExceptionInfo *),
  58   *(*GetVirtualPixelsHandler)(const Image *);
  59
  60 typedef PixelPacket
  61   *(*GetAuthenticPixelsHandler)(Image *,const ssize_t,const ssize_t,
  62     const size_t,const size_t,ExceptionInfo *);
  63
  64 typedef PixelPacket
  65   *(*GetAuthenticPixelsFromHandler)(const Image *);
  66
  67 typedef PixelPacket
  68   *(*QueueAuthenticPixelsHandler)(Image *,const ssize_t,const ssize_t,
  69     const size_t,const size_t,ExceptionInfo *);
  70
  71 typedef void
  72   (*DestroyPixelHandler)(Image *);
  73
  74 typedef struct _CacheMethods
  75 {
  76   GetVirtualPixelHandler
  77     get_virtual_pixel_handler;
  78
  79   GetVirtualPixelsHandler
  80     get_virtual_pixels_handler;
  81
  82   GetVirtualIndexesFromHandler
  83     get_virtual_indexes_from_handler;
  84
  85   GetOneVirtualPixelFromHandler
  86     get_one_virtual_pixel_from_handler;
  87
  88   GetAuthenticPixelsHandler
  89     get_authentic_pixels_handler;
  90
  91   GetAuthenticIndexesFromHandler
  92     get_authentic_indexes_from_handler;
  93
  94   GetOneAuthenticPixelFromHandler
  95     get_one_authentic_pixel_from_handler;
  96
  97   GetAuthenticPixelsFromHandler
  98     get_authentic_pixels_from_handler;
  99
 100   QueueAuthenticPixelsHandler
 101     queue_authentic_pixels_handler;
 102
 103   SyncAuthenticPixelsHandler
 104     sync_authentic_pixels_handler;
 105
 106   DestroyPixelHandler
 107     destroy_pixel_handler;
 108 } CacheMethods;
 109
 110 typedef struct _NexusInfo
 111    NexusInfo;
 112
 113 typedef struct _CacheInfo
 114 {
 115   ClassType
 116     storage_class;
 117
 118   ColorspaceType
 119     colorspace;
 120
 121   size_t
 122     channels;
 123
 124   CacheType
 125     type;
 126
 127   MapMode
 128     mode;
 129
 130   MagickBooleanType
 131     mapped;
 132
 133   size_t
 134     columns,
 135     rows;
 136
 137   MagickOffsetType
 138     offset;
 139
 140   MagickSizeType
 141     length;
 142
 143   VirtualPixelMethod
 144     virtual_pixel_method;
 145
 146   MagickPixelPacket
 147     virtual_pixel_color;
 148
 149   size_t
 150     number_threads;
 151
 152   NexusInfo
 153     **nexus_info;
 154
 155   PixelPacket
 156     *pixels;
 157
 158   IndexPacket
 159     *indexes;
 160
 161   MagickBooleanType
 162     active_index_channel;
 163
 164   int
 165     file;
 166
 167   char
 168     filename[MaxTextExtent],
 169     cache_filename[MaxTextExtent];
 170
 171   CacheMethods
 172     methods;
 173
 174   RandomInfo
 175     *random_info;
 176
 177   MagickBooleanType
 178     debug;
 179
 180   MagickThreadType
 181     id;
 182
 183   ssize_t
 184     reference_count;
 185
 186   SemaphoreInfo
 187     *semaphore,
 188     *disk_semaphore;
 189
 190   time_t
 191     timestamp;
 192
 193   size_t
 194     signature;
 195 } CacheInfo;
 196
 197 extern MagickExport Cache
 198   AcquirePixelCache(const size_t),
 199   ClonePixelCache(const Cache),
 200   DestroyPixelCache(Cache),
 201   ReferencePixelCache(Cache);
 202
 203 extern MagickExport CacheType
 204   GetPixelCacheType(const Image *);
 205
 206 extern MagickExport ClassType
 207   GetPixelCacheStorageClass(const Cache);
 208
 209 extern MagickExport ColorspaceType
 210   GetPixelCacheColorspace(const Cache);
 211
 212 extern MagickExport const IndexPacket
 213   *GetVirtualIndexesFromNexus(const Cache,NexusInfo *);
 214
 215 extern MagickExport const PixelPacket
 216   *GetVirtualPixelsFromNexus(const Image *,const VirtualPixelMethod,
 217     const ssize_t,const ssize_t,const size_t,const size_t,NexusInfo *,
 218     ExceptionInfo *),
 219   *GetVirtualPixelsNexus(const Cache,NexusInfo *);
 220
 221 extern MagickExport IndexPacket
 222   *GetPixelCacheNexusIndexes(const Cache,NexusInfo *);
 223
 224 extern MagickExport MagickBooleanType
 225   SyncAuthenticPixelCacheNexus(Image *,NexusInfo *,ExceptionInfo *);
 226
 227 extern MagickExport MagickSizeType
 228   GetPixelCacheNexusExtent(const Cache,NexusInfo *);
 229
 230 extern MagickExport NexusInfo
 231   **AcquirePixelCacheNexus(const size_t),
 232   **DestroyPixelCacheNexus(NexusInfo **,const size_t);
 233
 234 extern MagickExport PixelPacket
 235   *GetAuthenticPixelCacheNexus(Image *,const ssize_t,const ssize_t,
 236     const size_t,const size_t,NexusInfo *,ExceptionInfo *),
 237   *GetPixelCacheNexusPixels(const Cache,NexusInfo *),
 238   *QueueAuthenticNexus(Image *,const ssize_t,const ssize_t,const size_t,
 239     const size_t,NexusInfo *,ExceptionInfo *);
 240
 241 extern MagickExport size_t
 242   GetPixelCacheChannels(const Cache);
 243
 244 extern MagickExport void
 245   ClonePixelCacheMethods(Cache,const Cache),
 246   GetPixelCacheTileSize(const Image *,size_t *,size_t *),
 247   GetPixelCacheMethods(CacheMethods *),
 248   SetPixelCacheMethods(Cache,CacheMethods *);
 249
 250 #if defined(__cplusplus) || defined(c_plusplus)
 251 }
 252 #endif
 253
 254 #endif