blob: 1a810945ec71d5f4b07b2b597b8161aaddc70341 [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +00001/*
2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3% %
4% %
5% %
6% CCCC AAA CCCC H H EEEEE %
7% C A A C H H E %
8% C AAAAA C HHHHH EEE %
9% C A A C H H E %
10% CCCC A A CCCC H H EEEEE %
11% %
12% V V IIIII EEEEE W W %
13% V V I E W W %
14% V V I EEE W W W %
15% V V I E WW WW %
16% V IIIII EEEEE W W %
17% %
18% %
19% MagickCore Cache View Methods %
20% %
21% Software Design %
22% John Cristy %
23% February 2000 %
24% %
25% %
cristy1454be72011-12-19 01:52:48 +000026% Copyright 1999-2012 ImageMagick Studio LLC, a non-profit organization %
cristy3ed852e2009-09-05 21:47:34 +000027% dedicated to making software imaging solutions freely available. %
28% %
29% You may not use this file except in compliance with the License. You may %
30% obtain a copy of the License at %
31% %
32% http://www.imagemagick.org/script/license.php %
33% %
34% Unless required by applicable law or agreed to in writing, software %
35% distributed under the License is distributed on an "AS IS" BASIS, %
36% WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
37% See the License for the specific language governing permissions and %
38% limitations under the License. %
39% %
40%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
41%
42%
43%
44*/
45
46/*
47 Include declarations.
48*/
cristy4c08aed2011-07-01 19:47:50 +000049#include "MagickCore/studio.h"
50#include "MagickCore/cache.h"
51#include "MagickCore/cache-private.h"
52#include "MagickCore/cache-view.h"
53#include "MagickCore/memory_.h"
54#include "MagickCore/exception.h"
55#include "MagickCore/exception-private.h"
56#include "MagickCore/pixel-accessor.h"
57#include "MagickCore/string_.h"
58#include "MagickCore/thread-private.h"
cristy3ed852e2009-09-05 21:47:34 +000059
60/*
61 Typedef declarations.
62*/
63struct _CacheView
64{
65 Image
66 *image;
67
68 VirtualPixelMethod
69 virtual_pixel_method;
70
cristybb503372010-05-27 20:51:26 +000071 size_t
cristy3ed852e2009-09-05 21:47:34 +000072 number_threads;
73
74 NexusInfo
75 **nexus_info;
76
77 MagickBooleanType
78 debug;
79
cristybb503372010-05-27 20:51:26 +000080 size_t
cristy3ed852e2009-09-05 21:47:34 +000081 signature;
82};
83
84/*
85%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
86% %
87% %
88% %
89% A c q u i r e C a c h e V i e w %
90% %
91% %
92% %
93%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
94%
95% AcquireCacheView() acquires a view into the pixel cache, using the
96% VirtualPixelMethod that is defined within the given image itself.
97%
98% The format of the AcquireCacheView method is:
99%
100% CacheView *AcquireCacheView(const Image *image)
101%
102% A description of each parameter follows:
103%
104% o image: the image.
105%
106*/
107MagickExport CacheView *AcquireCacheView(const Image *image)
108{
109 CacheView
110 *cache_view;
111
112 assert(image != (Image *) NULL);
113 assert(image->signature == MagickSignature);
114 if (image->debug != MagickFalse)
115 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
cristya64b85d2011-09-14 01:02:31 +0000116 cache_view=(CacheView *) AcquireQuantumMemory(1,sizeof(*cache_view));
cristy3ed852e2009-09-05 21:47:34 +0000117 if (cache_view == (CacheView *) NULL)
118 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
119 (void) ResetMagickMemory(cache_view,0,sizeof(*cache_view));
120 cache_view->image=ReferenceImage((Image *) image);
121 cache_view->number_threads=GetOpenMPMaximumThreads();
122 cache_view->nexus_info=AcquirePixelCacheNexus(cache_view->number_threads);
123 cache_view->virtual_pixel_method=GetImageVirtualPixelMethod(image);
124 cache_view->debug=IsEventLogging();
125 cache_view->signature=MagickSignature;
126 if (cache_view->nexus_info == (NexusInfo **) NULL)
127 ThrowFatalException(CacheFatalError,"UnableToAcquireCacheView");
128 return(cache_view);
129}
130
131/*
132%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
133% %
134% %
135% %
136% C l o n e C a c h e V i e w %
137% %
138% %
139% %
140%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
141%
142% CloneCacheView() makes an exact copy of the specified cache view.
143%
144% The format of the CloneCacheView method is:
145%
146% CacheView *CloneCacheView(const CacheView *cache_view)
147%
148% A description of each parameter follows:
149%
150% o cache_view: the cache view.
151%
152*/
153MagickExport CacheView *CloneCacheView(const CacheView *cache_view)
154{
155 CacheView
156 *clone_view;
157
158 assert(cache_view != (CacheView *) NULL);
159 assert(cache_view->signature == MagickSignature);
160 if (cache_view->debug != MagickFalse)
161 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
162 cache_view->image->filename);
cristya64b85d2011-09-14 01:02:31 +0000163 clone_view=(CacheView *) AcquireQuantumMemory(1,sizeof(*clone_view));
cristy3ed852e2009-09-05 21:47:34 +0000164 if (clone_view == (CacheView *) NULL)
165 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
166 (void) ResetMagickMemory(clone_view,0,sizeof(*clone_view));
167 clone_view->image=ReferenceImage(cache_view->image);
168 clone_view->number_threads=cache_view->number_threads;
169 clone_view->nexus_info=AcquirePixelCacheNexus(cache_view->number_threads);
170 clone_view->virtual_pixel_method=cache_view->virtual_pixel_method;
171 clone_view->debug=cache_view->debug;
172 clone_view->signature=MagickSignature;
173 return(clone_view);
174}
175
176/*
177%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
178% %
179% %
180% %
181% D e s t r o y C a c h e V i e w %
182% %
183% %
184% %
185%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
186%
187% DestroyCacheView() destroys the specified view returned by a previous call
188% to AcquireCacheView().
189%
190% The format of the DestroyCacheView method is:
191%
192% CacheView *DestroyCacheView(CacheView *cache_view)
193%
194% A description of each parameter follows:
195%
196% o cache_view: the cache view.
197%
198*/
199MagickExport CacheView *DestroyCacheView(CacheView *cache_view)
200{
201 assert(cache_view != (CacheView *) NULL);
202 assert(cache_view->signature == MagickSignature);
203 if (cache_view->debug != MagickFalse)
204 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
205 cache_view->image->filename);
206 if (cache_view->nexus_info != (NexusInfo **) NULL)
207 cache_view->nexus_info=DestroyPixelCacheNexus(cache_view->nexus_info,
208 cache_view->number_threads);
209 cache_view->image=DestroyImage(cache_view->image);
210 cache_view->signature=(~MagickSignature);
cristyb41ee102010-10-04 16:46:15 +0000211 cache_view=(CacheView *) RelinquishMagickMemory(cache_view);
cristy3ed852e2009-09-05 21:47:34 +0000212 return(cache_view);
213}
214
215/*
216%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
217% %
218% %
219% %
220% G e t C a c h e V i e w C o l o r s p a c e %
221% %
222% %
223% %
224%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
225%
226% GetCacheViewColorspace() returns the image colorspace associated with the
227% specified view.
228%
229% The format of the GetCacheViewColorspace method is:
230%
231% ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
232%
233% A description of each parameter follows:
234%
235% o cache_view: the cache view.
236%
237*/
238MagickExport ColorspaceType GetCacheViewColorspace(const CacheView *cache_view)
239{
240 assert(cache_view != (CacheView *) NULL);
241 assert(cache_view->signature == MagickSignature);
242 if (cache_view->debug != MagickFalse)
243 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
244 cache_view->image->filename);
cristy0d267172011-04-25 20:13:48 +0000245 return(GetPixelCacheColorspace(cache_view->image->cache));
cristy3ed852e2009-09-05 21:47:34 +0000246}
247
248/*
249%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
250% %
251% %
252% %
cristy3ed852e2009-09-05 21:47:34 +0000253+ G e t C a c h e V i e w E x t e n t %
254% %
255% %
256% %
257%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
258%
259% GetCacheViewExtent() returns the extent of the pixels associated with the
260% last call to QueueCacheViewAuthenticPixels() or
261% GetCacheViewAuthenticPixels().
262%
263% The format of the GetCacheViewExtent() method is:
264%
265% MagickSizeType GetCacheViewExtent(const CacheView *cache_view)
266%
267% A description of each parameter follows:
268%
269% o cache_view: the cache view.
270%
271*/
272MagickExport MagickSizeType GetCacheViewExtent(const CacheView *cache_view)
273{
cristy5c9e6f22010-09-17 17:31:01 +0000274 const int
275 id = GetOpenMPThreadId();
cristy4205a3c2010-09-12 20:19:59 +0000276
cristy4c08aed2011-07-01 19:47:50 +0000277 MagickSizeType
278 extent;
279
cristy3ed852e2009-09-05 21:47:34 +0000280 assert(cache_view != (CacheView *) NULL);
281 assert(cache_view->signature == MagickSignature);
282 if (cache_view->debug != MagickFalse)
283 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
284 cache_view->image->filename);
285 assert(cache_view->image->cache != (Cache) NULL);
cristy4205a3c2010-09-12 20:19:59 +0000286 assert(id < (int) cache_view->number_threads);
cristy4c08aed2011-07-01 19:47:50 +0000287 extent=GetPixelCacheNexusExtent(cache_view->image->cache,
288 cache_view->nexus_info[id]);
289 return(extent);
cristy3ed852e2009-09-05 21:47:34 +0000290}
291
292/*
293%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
294% %
295% %
296% %
297% G e t C a c h e V i e w S t o r a g e C l a s s %
298% %
299% %
300% %
301%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
302%
303% GetCacheViewStorageClass() returns the image storage class associated with
304% the specified view.
305%
306% The format of the GetCacheViewStorageClass method is:
307%
308% ClassType GetCacheViewStorageClass(const CacheView *cache_view)
309%
310% A description of each parameter follows:
311%
312% o cache_view: the cache view.
313%
314*/
315MagickExport ClassType GetCacheViewStorageClass(const CacheView *cache_view)
316{
317 assert(cache_view != (CacheView *) NULL);
318 assert(cache_view->signature == MagickSignature);
319 if (cache_view->debug != MagickFalse)
320 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
321 cache_view->image->filename);
cristy0d267172011-04-25 20:13:48 +0000322 return(GetPixelCacheStorageClass(cache_view->image->cache));
cristy3ed852e2009-09-05 21:47:34 +0000323}
324
325/*
326%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
327% %
328% %
329% %
330% G e t C a c h e V i e w A u t h e n t i c P i x e l s %
331% %
332% %
333% %
334%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
335%
336% GetCacheViewAuthenticPixels() gets pixels from the in-memory or disk pixel
337% cache as defined by the geometry parameters. A pointer to the pixels is
338% returned if the pixels are transferred, otherwise a NULL is returned.
339%
340% The format of the GetCacheViewAuthenticPixels method is:
341%
cristy4c08aed2011-07-01 19:47:50 +0000342% Quantum *GetCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000343% const ssize_t x,const ssize_t y,const size_t columns,
344% const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000345%
346% A description of each parameter follows:
347%
348% o cache_view: the cache view.
349%
350% o x,y,columns,rows: These values define the perimeter of a region of
351% pixels.
352%
353*/
cristy4c08aed2011-07-01 19:47:50 +0000354MagickExport Quantum *GetCacheViewAuthenticPixels(CacheView *cache_view,
cristy30097232010-07-01 02:16:30 +0000355 const ssize_t x,const ssize_t y,const size_t columns,const size_t rows,
356 ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000357{
cristy5c9e6f22010-09-17 17:31:01 +0000358 const int
359 id = GetOpenMPThreadId();
cristy4205a3c2010-09-12 20:19:59 +0000360
cristy4c08aed2011-07-01 19:47:50 +0000361 Quantum
cristy3ed852e2009-09-05 21:47:34 +0000362 *pixels;
363
364 assert(cache_view != (CacheView *) NULL);
365 assert(cache_view->signature == MagickSignature);
cristy4205a3c2010-09-12 20:19:59 +0000366 assert(id < (int) cache_view->number_threads);
cristy4c08aed2011-07-01 19:47:50 +0000367 pixels=GetAuthenticPixelCacheNexus(cache_view->image,x,y,columns,rows,
cristy3ed852e2009-09-05 21:47:34 +0000368 cache_view->nexus_info[id],exception);
cristy4c08aed2011-07-01 19:47:50 +0000369 return(pixels);
cristy3ed852e2009-09-05 21:47:34 +0000370}
371
372/*
373%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
374% %
375% %
376% %
cristy4c08aed2011-07-01 19:47:50 +0000377% G e t C a c h e V i e w A u t h e n t i c M e t a c o n t e n t %
cristy3ed852e2009-09-05 21:47:34 +0000378% %
379% %
380% %
381%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
382%
cristy4c08aed2011-07-01 19:47:50 +0000383% GetCacheViewAuthenticMetacontent() returns the meta-content corresponding
384% with the last call to SetCacheViewIndexes() or
385% GetCacheViewAuthenticMetacontent(). The meta-content are authentic and can
386% be updated.
cristy3ed852e2009-09-05 21:47:34 +0000387%
cristy4c08aed2011-07-01 19:47:50 +0000388% The format of the GetCacheViewAuthenticMetacontent() method is:
cristy3ed852e2009-09-05 21:47:34 +0000389%
cristy4c08aed2011-07-01 19:47:50 +0000390% void *GetCacheViewAuthenticMetacontent(CacheView *cache_view)
cristy3ed852e2009-09-05 21:47:34 +0000391%
392% A description of each parameter follows:
393%
394% o cache_view: the cache view.
395%
396*/
cristy4c08aed2011-07-01 19:47:50 +0000397MagickExport void *GetCacheViewAuthenticMetacontent(
398 CacheView *cache_view)
cristy3ed852e2009-09-05 21:47:34 +0000399{
cristy5c9e6f22010-09-17 17:31:01 +0000400 const int
401 id = GetOpenMPThreadId();
402
cristy4c08aed2011-07-01 19:47:50 +0000403 void
404 *metacontent;
405
cristy3ed852e2009-09-05 21:47:34 +0000406 assert(cache_view != (CacheView *) NULL);
407 assert(cache_view->signature == MagickSignature);
cristy3ed852e2009-09-05 21:47:34 +0000408 assert(cache_view->image->cache != (Cache) NULL);
cristy4205a3c2010-09-12 20:19:59 +0000409 assert(id < (int) cache_view->number_threads);
cristy4c08aed2011-07-01 19:47:50 +0000410 metacontent=GetPixelCacheNexusMetacontent(cache_view->image->cache,
411 cache_view->nexus_info[id]);
412 return(metacontent);
cristy3ed852e2009-09-05 21:47:34 +0000413}
414
415/*
416%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
417% %
418% %
419% %
420% G e t C a c h e V i e w A u t h e n t i c P i x e l Q u e u e %
421% %
422% %
423% %
424%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
425%
426% GetCacheViewAuthenticPixelQueue() returns the pixels associated with the
427% last call to QueueCacheViewAuthenticPixels() or
428% GetCacheViewAuthenticPixels(). The pixels are authentic and therefore can be
429% updated.
430%
431% The format of the GetCacheViewAuthenticPixelQueue() method is:
432%
cristy4c08aed2011-07-01 19:47:50 +0000433% Quantum *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
cristy3ed852e2009-09-05 21:47:34 +0000434%
435% A description of each parameter follows:
436%
437% o cache_view: the cache view.
438%
439*/
cristy4c08aed2011-07-01 19:47:50 +0000440MagickExport Quantum *GetCacheViewAuthenticPixelQueue(CacheView *cache_view)
cristy3ed852e2009-09-05 21:47:34 +0000441{
cristy5c9e6f22010-09-17 17:31:01 +0000442 const int
443 id = GetOpenMPThreadId();
cristy4205a3c2010-09-12 20:19:59 +0000444
cristy4c08aed2011-07-01 19:47:50 +0000445 Quantum
446 *pixels;
447
cristy3ed852e2009-09-05 21:47:34 +0000448 assert(cache_view != (CacheView *) NULL);
449 assert(cache_view->signature == MagickSignature);
cristy3ed852e2009-09-05 21:47:34 +0000450 assert(cache_view->image->cache != (Cache) NULL);
cristy4205a3c2010-09-12 20:19:59 +0000451 assert(id < (int) cache_view->number_threads);
cristy4c08aed2011-07-01 19:47:50 +0000452 pixels=GetPixelCacheNexusPixels(cache_view->image->cache,
453 cache_view->nexus_info[id]);
454 return(pixels);
cristy3ed852e2009-09-05 21:47:34 +0000455}
456
457/*
458%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
459% %
460% %
461% %
cristy4c08aed2011-07-01 19:47:50 +0000462% G e t C a c h e V i e w V i r t u a l M e t a c o n t e n t %
cristy3ed852e2009-09-05 21:47:34 +0000463% %
464% %
465% %
466%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
467%
cristy4c08aed2011-07-01 19:47:50 +0000468% GetCacheViewVirtualMetacontent() returns the meta-content corresponding
469% with the last call to GetCacheViewVirtualMetacontent(). The meta-content
470% is virtual and therefore cannot be updated.
cristy3ed852e2009-09-05 21:47:34 +0000471%
cristy4c08aed2011-07-01 19:47:50 +0000472% The format of the GetCacheViewVirtualMetacontent() method is:
cristy3ed852e2009-09-05 21:47:34 +0000473%
cristy4c08aed2011-07-01 19:47:50 +0000474% const void *GetCacheViewVirtualMetacontent(
cristy3ed852e2009-09-05 21:47:34 +0000475% const CacheView *cache_view)
476%
477% A description of each parameter follows:
478%
479% o cache_view: the cache view.
480%
481*/
cristy4c08aed2011-07-01 19:47:50 +0000482MagickExport const void *GetCacheViewVirtualMetacontent(
cristy3ed852e2009-09-05 21:47:34 +0000483 const CacheView *cache_view)
484{
cristy5c9e6f22010-09-17 17:31:01 +0000485 const int
486 id = GetOpenMPThreadId();
cristy3ed852e2009-09-05 21:47:34 +0000487
cristy4c08aed2011-07-01 19:47:50 +0000488 const void
489 *metacontent;
490
cristy3ed852e2009-09-05 21:47:34 +0000491 assert(cache_view != (const CacheView *) NULL);
492 assert(cache_view->signature == MagickSignature);
cristy3ed852e2009-09-05 21:47:34 +0000493 assert(cache_view->image->cache != (Cache) NULL);
cristy4205a3c2010-09-12 20:19:59 +0000494 assert(id < (int) cache_view->number_threads);
cristy4c08aed2011-07-01 19:47:50 +0000495 metacontent=GetVirtualMetacontentFromNexus(cache_view->image->cache,
496 cache_view->nexus_info[id]);
497 return(metacontent);
cristy3ed852e2009-09-05 21:47:34 +0000498}
499
500/*
501%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
502% %
503% %
504% %
505% G e t C a c h e V i e w V i r t u a l P i x e l Q u e u e %
506% %
507% %
508% %
509%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
510%
511% GetCacheViewVirtualPixelQueue() returns the the pixels associated with
512% the last call to GetCacheViewVirtualPixels(). The pixels are virtual
513% and therefore cannot be updated.
514%
515% The format of the GetCacheViewVirtualPixelQueue() method is:
516%
cristy4c08aed2011-07-01 19:47:50 +0000517% const Quantum *GetCacheViewVirtualPixelQueue(
cristy3ed852e2009-09-05 21:47:34 +0000518% const CacheView *cache_view)
519%
520% A description of each parameter follows:
521%
522% o cache_view: the cache view.
523%
524*/
cristy4c08aed2011-07-01 19:47:50 +0000525MagickExport const Quantum *GetCacheViewVirtualPixelQueue(
cristy3ed852e2009-09-05 21:47:34 +0000526 const CacheView *cache_view)
527{
cristy5c9e6f22010-09-17 17:31:01 +0000528 const int
529 id = GetOpenMPThreadId();
530
cristy4c08aed2011-07-01 19:47:50 +0000531 const Quantum
532 *pixels;
533
cristy3ed852e2009-09-05 21:47:34 +0000534 assert(cache_view != (const CacheView *) NULL);
535 assert(cache_view->signature == MagickSignature);
cristy3ed852e2009-09-05 21:47:34 +0000536 assert(cache_view->image->cache != (Cache) NULL);
cristy4205a3c2010-09-12 20:19:59 +0000537 assert(id < (int) cache_view->number_threads);
cristy4c08aed2011-07-01 19:47:50 +0000538 pixels=GetVirtualPixelsNexus(cache_view->image->cache,
539 cache_view->nexus_info[id]);
540 return(pixels);
cristy3ed852e2009-09-05 21:47:34 +0000541}
542
543/*
544%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
545% %
546% %
547% %
548% G e t C a c h e V i e w V i r t u a l P i x e l s %
549% %
550% %
551% %
552%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
553%
554% GetCacheViewVirtualPixels() gets virtual pixels from the in-memory or
555% disk pixel cache as defined by the geometry parameters. A pointer to the
556% pixels is returned if the pixels are transferred, otherwise a NULL is
557% returned.
558%
559% The format of the GetCacheViewVirtualPixels method is:
560%
cristy4c08aed2011-07-01 19:47:50 +0000561% const Quantum *GetCacheViewVirtualPixels(
cristybb503372010-05-27 20:51:26 +0000562% const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristye076a6e2010-08-15 19:59:43 +0000563% const size_t columns,const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000564%
565% A description of each parameter follows:
566%
567% o cache_view: the cache view.
568%
569% o x,y,columns,rows: These values define the perimeter of a region of
570% pixels.
571%
572% o exception: return any errors or warnings in this structure.
573%
574*/
cristy4c08aed2011-07-01 19:47:50 +0000575MagickExport const Quantum *GetCacheViewVirtualPixels(
cristybb503372010-05-27 20:51:26 +0000576 const CacheView *cache_view,const ssize_t x,const ssize_t y,
577 const size_t columns,const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000578{
cristy5c9e6f22010-09-17 17:31:01 +0000579 const int
580 id = GetOpenMPThreadId();
581
cristy4c08aed2011-07-01 19:47:50 +0000582 const Quantum
583 *pixels;
584
cristy3ed852e2009-09-05 21:47:34 +0000585 assert(cache_view != (CacheView *) NULL);
586 assert(cache_view->signature == MagickSignature);
cristy4205a3c2010-09-12 20:19:59 +0000587 assert(id < (int) cache_view->number_threads);
cristy4c08aed2011-07-01 19:47:50 +0000588 pixels=GetVirtualPixelsFromNexus(cache_view->image,
cristy3ed852e2009-09-05 21:47:34 +0000589 cache_view->virtual_pixel_method,x,y,columns,rows,
cristy4c08aed2011-07-01 19:47:50 +0000590 cache_view->nexus_info[id],exception);
591 return(pixels);
592}
593
594/*
595%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
596% %
597% %
598% %
599% G e t O n e C a c h e V i e w A u t h e n t i c P i x e l %
600% %
601% %
602% %
603%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
604%
605% GetOneCacheViewAuthenticPixel() returns a single pixel at the specified (x,y)
606% location. The image background color is returned if an error occurs.
607%
608% The format of the GetOneCacheViewAuthenticPixel method is:
609%
610% MagickBooleaNType GetOneCacheViewAuthenticPixel(
611% const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy2ed42f62011-10-02 19:49:57 +0000612% Quantum *pixel,ExceptionInfo *exception)
cristy4c08aed2011-07-01 19:47:50 +0000613%
614% A description of each parameter follows:
615%
616% o cache_view: the cache view.
617%
618% o x,y: These values define the offset of the pixel.
619%
620% o pixel: return a pixel at the specified (x,y) location.
621%
622% o exception: return any errors or warnings in this structure.
623%
624*/
625MagickExport MagickBooleanType GetOneCacheViewAuthenticPixel(
cristy2ed42f62011-10-02 19:49:57 +0000626 const CacheView *cache_view,const ssize_t x,const ssize_t y,Quantum *pixel,
627 ExceptionInfo *exception)
cristy4c08aed2011-07-01 19:47:50 +0000628{
629 const int
630 id = GetOpenMPThreadId();
631
632 Quantum
633 *p;
634
cristy2ed42f62011-10-02 19:49:57 +0000635 register ssize_t
636 i;
637
cristy4c08aed2011-07-01 19:47:50 +0000638 assert(cache_view != (CacheView *) NULL);
639 assert(cache_view->signature == MagickSignature);
cristy4c08aed2011-07-01 19:47:50 +0000640 assert(id < (int) cache_view->number_threads);
cristy2ed42f62011-10-02 19:49:57 +0000641 (void) memset(pixel,0,MaxPixelChannels*sizeof(*pixel));
cristy4c08aed2011-07-01 19:47:50 +0000642 p=GetAuthenticPixelCacheNexus(cache_view->image,x,y,1,1,
643 cache_view->nexus_info[id],exception);
644 if (p == (const Quantum *) NULL)
cristy2ed42f62011-10-02 19:49:57 +0000645 {
646 pixel[RedPixelChannel]=cache_view->image->background_color.red;
647 pixel[GreenPixelChannel]=cache_view->image->background_color.green;
648 pixel[BluePixelChannel]=cache_view->image->background_color.blue;
649 pixel[AlphaPixelChannel]=cache_view->image->background_color.alpha;
650 return(MagickFalse);
651 }
652 for (i=0; i < (ssize_t) GetPixelChannels(cache_view->image); i++)
653 {
654 PixelChannel
655 channel;
656
cristye2a912b2011-12-05 20:02:07 +0000657 channel=GetPixelChannelMapChannel(cache_view->image,i);
cristy2ed42f62011-10-02 19:49:57 +0000658 pixel[channel]=p[i];
659 }
cristy4c08aed2011-07-01 19:47:50 +0000660 return(MagickTrue);
cristy3ed852e2009-09-05 21:47:34 +0000661}
662
663/*
664%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
665% %
666% %
667% %
668% G e t O n e C a c h e V i e w V i r t u a l P i x e l %
669% %
670% %
671% %
672%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
673%
674% GetOneCacheViewVirtualPixel() returns a single pixel at the specified (x,y)
675% location. The image background color is returned if an error occurs. If
676% you plan to modify the pixel, use GetOneCacheViewAuthenticPixel() instead.
677%
678% The format of the GetOneCacheViewVirtualPixel method is:
679%
680% MagickBooleanType GetOneCacheViewVirtualPixel(
cristybb503372010-05-27 20:51:26 +0000681% const CacheView *cache_view,const ssize_t x,const ssize_t y,
cristy2ed42f62011-10-02 19:49:57 +0000682% Quantum *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000683%
684% A description of each parameter follows:
685%
686% o cache_view: the cache view.
687%
688% o x,y: These values define the offset of the pixel.
689%
690% o pixel: return a pixel at the specified (x,y) location.
691%
692% o exception: return any errors or warnings in this structure.
693%
694*/
695MagickExport MagickBooleanType GetOneCacheViewVirtualPixel(
cristy2ed42f62011-10-02 19:49:57 +0000696 const CacheView *cache_view,const ssize_t x,const ssize_t y,Quantum *pixel,
697 ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000698{
cristy5c9e6f22010-09-17 17:31:01 +0000699 const int
700 id = GetOpenMPThreadId();
701
cristy4c08aed2011-07-01 19:47:50 +0000702 const Quantum
703 *p;
cristy3ed852e2009-09-05 21:47:34 +0000704
cristy2ed42f62011-10-02 19:49:57 +0000705 register ssize_t
706 i;
707
cristy3ed852e2009-09-05 21:47:34 +0000708 assert(cache_view != (CacheView *) NULL);
709 assert(cache_view->signature == MagickSignature);
cristy4205a3c2010-09-12 20:19:59 +0000710 assert(id < (int) cache_view->number_threads);
cristy2ed42f62011-10-02 19:49:57 +0000711 (void) memset(pixel,0,MaxPixelChannels*sizeof(*pixel));
cristy4c08aed2011-07-01 19:47:50 +0000712 p=GetVirtualPixelsFromNexus(cache_view->image,
cristy3ed852e2009-09-05 21:47:34 +0000713 cache_view->virtual_pixel_method,x,y,1,1,cache_view->nexus_info[id],
714 exception);
cristy4c08aed2011-07-01 19:47:50 +0000715 if (p == (const Quantum *) NULL)
cristy2ed42f62011-10-02 19:49:57 +0000716 {
717 pixel[RedPixelChannel]=cache_view->image->background_color.red;
718 pixel[GreenPixelChannel]=cache_view->image->background_color.green;
719 pixel[BluePixelChannel]=cache_view->image->background_color.blue;
720 pixel[AlphaPixelChannel]=cache_view->image->background_color.alpha;
721 return(MagickFalse);
722 }
723 for (i=0; i < (ssize_t) GetPixelChannels(cache_view->image); i++)
724 {
725 PixelChannel
726 channel;
727
cristye2a912b2011-12-05 20:02:07 +0000728 channel=GetPixelChannelMapChannel(cache_view->image,i);
cristy2ed42f62011-10-02 19:49:57 +0000729 pixel[channel]=p[i];
730 }
cristy3ed852e2009-09-05 21:47:34 +0000731 return(MagickTrue);
732}
733
734/*
735%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
736% %
737% %
738% %
739% G e t O n e C a c h e V i e w V i r t u a l P i x e l %
740% %
741% %
742% %
743%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
744%
745% GetOneCacheViewVirtualMethodPixel() returns a single virtual pixel at
746% the specified (x,y) location. The image background color is returned if an
747% error occurs. If you plan to modify the pixel, use
748% GetOneCacheViewAuthenticPixel() instead.
749%
750% The format of the GetOneCacheViewVirtualPixel method is:
751%
752% MagickBooleanType GetOneCacheViewVirtualMethodPixel(
753% const CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000754% const VirtualPixelMethod virtual_pixel_method,const ssize_t x,
cristy2ed42f62011-10-02 19:49:57 +0000755% const ssize_t y,Quantum *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000756%
757% A description of each parameter follows:
758%
759% o cache_view: the cache view.
760%
761% o virtual_pixel_method: the virtual pixel method.
762%
763% o x,y: These values define the offset of the pixel.
764%
765% o pixel: return a pixel at the specified (x,y) location.
766%
767% o exception: return any errors or warnings in this structure.
768%
769*/
770MagickExport MagickBooleanType GetOneCacheViewVirtualMethodPixel(
771 const CacheView *cache_view,const VirtualPixelMethod virtual_pixel_method,
cristy2ed42f62011-10-02 19:49:57 +0000772 const ssize_t x,const ssize_t y,Quantum *pixel,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000773{
cristy5c9e6f22010-09-17 17:31:01 +0000774 const int
775 id = GetOpenMPThreadId();
776
cristy4c08aed2011-07-01 19:47:50 +0000777 const Quantum
778 *p;
cristy3ed852e2009-09-05 21:47:34 +0000779
cristy2ed42f62011-10-02 19:49:57 +0000780 register ssize_t
781 i;
782
cristy3ed852e2009-09-05 21:47:34 +0000783 assert(cache_view != (CacheView *) NULL);
784 assert(cache_view->signature == MagickSignature);
cristy4205a3c2010-09-12 20:19:59 +0000785 assert(id < (int) cache_view->number_threads);
cristy2ed42f62011-10-02 19:49:57 +0000786 (void) memset(pixel,0,MaxPixelChannels*sizeof(*pixel));
cristy4c08aed2011-07-01 19:47:50 +0000787 p=GetVirtualPixelsFromNexus(cache_view->image,virtual_pixel_method,x,y,1,1,
788 cache_view->nexus_info[id],exception);
789 if (p == (const Quantum *) NULL)
cristy2ed42f62011-10-02 19:49:57 +0000790 {
791 pixel[RedPixelChannel]=cache_view->image->background_color.red;
792 pixel[GreenPixelChannel]=cache_view->image->background_color.green;
793 pixel[BluePixelChannel]=cache_view->image->background_color.blue;
794 pixel[AlphaPixelChannel]=cache_view->image->background_color.alpha;
795 return(MagickFalse);
796 }
797 for (i=0; i < (ssize_t) GetPixelChannels(cache_view->image); i++)
798 {
799 PixelChannel
800 channel;
801
cristye2a912b2011-12-05 20:02:07 +0000802 channel=GetPixelChannelMapChannel(cache_view->image,i);
cristy2ed42f62011-10-02 19:49:57 +0000803 pixel[channel]=p[i];
804 }
cristy3ed852e2009-09-05 21:47:34 +0000805 return(MagickTrue);
806}
807
808/*
809%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
810% %
811% %
812% %
813% Q u e u e C a c h e V i e w A u t h e n t i c P i x e l s %
814% %
815% %
816% %
817%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
818%
819% QueueCacheViewAuthenticPixels() queues authentic pixels from the in-memory or
820% disk pixel cache as defined by the geometry parameters. A pointer to the
821% pixels is returned if the pixels are transferred, otherwise a NULL is
822% returned.
823%
824% The format of the QueueCacheViewAuthenticPixels method is:
825%
cristy4c08aed2011-07-01 19:47:50 +0000826% Quantum *QueueCacheViewAuthenticPixels(CacheView *cache_view,
cristybb503372010-05-27 20:51:26 +0000827% const ssize_t x,const ssize_t y,const size_t columns,
828% const size_t rows,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000829%
830% A description of each parameter follows:
831%
832% o cache_view: the cache view.
833%
834% o x,y,columns,rows: These values define the perimeter of a region of
835% pixels.
836%
837% o exception: return any errors or warnings in this structure.
838%
839*/
cristy4c08aed2011-07-01 19:47:50 +0000840MagickExport Quantum *QueueCacheViewAuthenticPixels(CacheView *cache_view,
cristy30097232010-07-01 02:16:30 +0000841 const ssize_t x,const ssize_t y,const size_t columns,const size_t rows,
842 ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000843{
cristy5c9e6f22010-09-17 17:31:01 +0000844 const int
845 id = GetOpenMPThreadId();
cristy4205a3c2010-09-12 20:19:59 +0000846
cristy4c08aed2011-07-01 19:47:50 +0000847 Quantum
848 *pixels;
849
cristy3ed852e2009-09-05 21:47:34 +0000850 assert(cache_view != (CacheView *) NULL);
851 assert(cache_view->signature == MagickSignature);
cristy4205a3c2010-09-12 20:19:59 +0000852 assert(id < (int) cache_view->number_threads);
cristy65dbf172011-10-06 17:32:04 +0000853 pixels=QueueAuthenticNexus(cache_view->image,x,y,columns,rows,MagickFalse,
cristy4c08aed2011-07-01 19:47:50 +0000854 cache_view->nexus_info[id],exception);
855 return(pixels);
cristy3ed852e2009-09-05 21:47:34 +0000856}
857
858/*
859%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
860% %
861% %
862% %
863% S e t C a c h e V i e w S t o r a g e C l a s s %
864% %
865% %
866% %
867%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
868%
869% SetCacheViewStorageClass() sets the image storage class associated with
870% the specified view.
871%
872% The format of the SetCacheViewStorageClass method is:
873%
874% MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
cristyc82a27b2011-10-21 01:07:16 +0000875% const ClassType storage_class,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000876%
877% A description of each parameter follows:
878%
879% o cache_view: the cache view.
880%
881% o storage_class: the image storage class: PseudoClass or DirectClass.
882%
cristyc82a27b2011-10-21 01:07:16 +0000883% o exception: return any errors or warnings in this structure.
884%
cristy3ed852e2009-09-05 21:47:34 +0000885*/
886MagickExport MagickBooleanType SetCacheViewStorageClass(CacheView *cache_view,
cristyc82a27b2011-10-21 01:07:16 +0000887 const ClassType storage_class,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000888{
889 assert(cache_view != (CacheView *) NULL);
890 assert(cache_view->signature == MagickSignature);
891 if (cache_view->debug != MagickFalse)
892 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
893 cache_view->image->filename);
cristyc82a27b2011-10-21 01:07:16 +0000894 return(SetImageStorageClass(cache_view->image,storage_class,exception));
cristy3ed852e2009-09-05 21:47:34 +0000895}
896
897/*
898%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
899% %
900% %
901% %
902% S e t C a c h e V i e w V i r t u a l P i x e l M e t h o d %
903% %
904% %
905% %
906%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
907%
908% SetCacheViewVirtualPixelMethod() sets the virtual pixel method associated
909% with the specified cache view.
910%
911% The format of the SetCacheViewVirtualPixelMethod method is:
912%
913% MagickBooleanType SetCacheViewVirtualPixelMethod(CacheView *cache_view,
914% const VirtualPixelMethod virtual_pixel_method)
915%
916% A description of each parameter follows:
917%
918% o cache_view: the cache view.
919%
920% o virtual_pixel_method: the virtual pixel method.
921%
922*/
923MagickExport MagickBooleanType SetCacheViewVirtualPixelMethod(
924 CacheView *cache_view,const VirtualPixelMethod virtual_pixel_method)
925{
926 assert(cache_view != (CacheView *) NULL);
927 assert(cache_view->signature == MagickSignature);
928 if (cache_view->debug != MagickFalse)
929 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
930 cache_view->image->filename);
931 cache_view->virtual_pixel_method=virtual_pixel_method;
932 return(MagickTrue);
933}
934
935/*
936%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
937% %
938% %
939% %
940% S y n c C a c h e V i e w A u t h e n t i c P i x e l s %
941% %
942% %
943% %
944%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
945%
946% SyncCacheViewAuthenticPixels() saves the cache view pixels to the in-memory
947% or disk cache. It returns MagickTrue if the pixel region is flushed,
948% otherwise MagickFalse.
949%
950% The format of the SyncCacheViewAuthenticPixels method is:
951%
952% MagickBooleanType SyncCacheViewAuthenticPixels(CacheView *cache_view,
953% ExceptionInfo *exception)
954%
955% A description of each parameter follows:
956%
957% o cache_view: the cache view.
958%
959% o exception: return any errors or warnings in this structure.
960%
961*/
962MagickExport MagickBooleanType SyncCacheViewAuthenticPixels(
963 CacheView *cache_view,ExceptionInfo *exception)
964{
cristy5c9e6f22010-09-17 17:31:01 +0000965 const int
966 id = GetOpenMPThreadId();
cristy4205a3c2010-09-12 20:19:59 +0000967
cristy4c08aed2011-07-01 19:47:50 +0000968 MagickBooleanType
969 status;
970
cristy3ed852e2009-09-05 21:47:34 +0000971 assert(cache_view != (CacheView *) NULL);
972 assert(cache_view->signature == MagickSignature);
cristy4205a3c2010-09-12 20:19:59 +0000973 assert(id < (int) cache_view->number_threads);
cristy4c08aed2011-07-01 19:47:50 +0000974 status=SyncAuthenticPixelCacheNexus(cache_view->image,
975 cache_view->nexus_info[id],exception);
976 return(status);
cristy3ed852e2009-09-05 21:47:34 +0000977}