2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % CCCC H H AAA N N N N EEEEE L %
7 % C H H A A NN N NN N E L %
8 % C HHHHH AAAAA N N N N N N RRR L %
9 % C H H A A N NN N NN E L %
10 % CCCC H H A A N N N N EEEEE LLLLL %
13 % MagickCore Image Channel Methods %
20 % Copyright 1999-2012 ImageMagick Studio LLC, a non-profit organization %
21 % dedicated to making software imaging solutions freely available. %
23 % You may not use this file except in compliance with the License. You may %
24 % obtain a copy of the License at %
26 % http://www.imagemagick.org/script/license.php %
28 % Unless required by applicable law or agreed to in writing, software %
29 % distributed under the License is distributed on an "AS IS" BASIS, %
30 % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31 % See the License for the specific language governing permissions and %
32 % limitations under the License. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
43 #include "MagickCore/studio.h"
44 #include "MagickCore/image.h"
45 #include "MagickCore/list.h"
46 #include "MagickCore/log.h"
47 #include "MagickCore/monitor.h"
48 #include "MagickCore/monitor-private.h"
49 #include "MagickCore/option.h"
50 #include "MagickCore/pixel-accessor.h"
51 #include "MagickCore/string-private.h"
52 #include "MagickCore/token.h"
53 #include "MagickCore/utility.h"
54 #include "MagickCore/version.h"
57 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
61 % C h a n n e l F x I m a g e %
65 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67 % ChannelFxImage() applies a channel expression to the specified image. The
68 % expression consists of one or more channels, either mnemonic or numeric (e.g.
69 % red, 1), separated by actions as follows:
71 % <=> exchange two channels (e.g. red<=>blue)
72 % => copy one channel to another channel (e.g. red=>green)
73 % = assign a constant value to a channel (e.g. red=50%)
74 % , write new image channels in the specified order (e.g. red, green)
75 % | add a new output image for the next set of channel operations
76 % ; move to the next input image for the source of channel data
78 % For example, to create 3 grayscale images from the red, green, and blue
79 % channels of an image, use:
81 % -channel-fx "red; green; blue"
83 % A channel without an operation symbol implies separate (i.e, semicolon).
85 % The format of the ChannelFxImage method is:
87 % Image *ChannelFxImage(const Image *image,const char *expression,
88 % ExceptionInfo *exception)
90 % A description of each parameter follows:
94 % o expression: A channel expression.
96 % o exception: return any errors or warnings in this structure.
108 static inline size_t MagickMin(const size_t x,const size_t y)
115 static MagickBooleanType ChannelImage(Image *destination_image,
116 const PixelChannel destination_channel,const ChannelFx channel_op,
117 const Image *source_image,const PixelChannel source_channel,
118 const Quantum pixel,ExceptionInfo *exception)
134 source_view=AcquireCacheView(source_image);
135 destination_view=AcquireCacheView(destination_image);
136 height=MagickMin(source_image->rows,destination_image->rows);
137 #if defined(MAGICKCORE_OPENMP_SUPPORT)
138 #pragma omp parallel for schedule(static) shared(status)
140 for (y=0; y < (ssize_t) height; y++)
146 register const Quantum
158 if (status == MagickFalse)
160 p=GetCacheViewVirtualPixels(source_view,0,y,source_image->columns,1,
162 q=GetCacheViewAuthenticPixels(destination_view,0,y,
163 destination_image->columns,1,exception);
164 if ((p == (const Quantum *) NULL) || (q == (Quantum *) NULL))
169 destination_traits=GetPixelChannelMapTraits(destination_image,
170 destination_channel);
171 source_traits=GetPixelChannelMapTraits(source_image,source_channel);
172 if ((destination_traits == UndefinedPixelTrait) ||
173 (source_traits == UndefinedPixelTrait))
175 width=MagickMin(source_image->columns,destination_image->columns);
176 for (x=0; x < (ssize_t) width; x++)
178 if (channel_op == AssignChannelOp)
179 SetPixelChannel(destination_image,destination_channel,pixel,q);
181 SetPixelChannel(destination_image,destination_channel,
182 GetPixelChannel(source_image,source_channel,p),q);
183 p+=GetPixelChannels(source_image);
184 q+=GetPixelChannels(destination_image);
186 if (SyncCacheViewAuthenticPixels(destination_view,exception) == MagickFalse)
189 destination_view=DestroyCacheView(destination_view);
190 source_view=DestroyCacheView(source_view);
194 MagickExport Image *ChannelFxImage(const Image *image,const char *expression,
195 ExceptionInfo *exception)
197 #define ChannelFxImageTag "ChannelFx/Image"
203 token[MaxTextExtent];
227 assert(image != (Image *) NULL);
228 assert(image->signature == MagickSignature);
229 if (image->debug != MagickFalse)
230 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
231 assert(exception != (ExceptionInfo *) NULL);
232 assert(exception->signature == MagickSignature);
234 destination_image=CloneImage(source_image,0,0,MagickTrue,exception);
235 if (destination_image == (Image *) NULL)
236 return((Image *) NULL);
237 if (destination_image->colorspace == GRAYColorspace)
238 destination_image->colorspace=RGBColorspace;
239 if (expression == (const char *) NULL)
240 return(destination_image);
241 destination_channel=RedPixelChannel;
243 p=(char *) expression;
244 GetMagickToken(p,&p,token);
245 channel_op=ExtractChannelOp;
246 for (channels=0; *token != '\0'; )
252 Interpret channel expression.
256 destination_channel=(PixelChannel) ((ssize_t) destination_channel+1);
257 GetMagickToken(p,&p,token);
261 if (GetNextImageInList(source_image) != (Image *) NULL)
262 source_image=GetNextImageInList(source_image);
264 source_image=GetFirstImageInList(source_image);
265 GetMagickToken(p,&p,token);
272 status=SetImageStorageClass(destination_image,DirectClass,exception);
273 if (status == MagickFalse)
275 destination_image=DestroyImageList(destination_image);
276 return(destination_image);
278 canvas=CloneImage(source_image,0,0,MagickTrue,exception);
279 if (canvas == (Image *) NULL)
281 destination_image=DestroyImageList(destination_image);
282 return(destination_image);
284 if (canvas->colorspace == GRAYColorspace)
285 canvas->colorspace=RGBColorspace;
286 AppendImageToList(&destination_image,canvas);
287 destination_image=GetLastImageInList(destination_image);
288 GetMagickToken(p,&p,token);
290 destination_channel=RedPixelChannel;
292 i=ParsePixelChannelOption(token);
295 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
296 "UnrecognizedChannelType","`%s'",token);
297 destination_image=DestroyImageList(destination_image);
298 return(destination_image);
300 source_channel=(PixelChannel) i;
301 channel_op=ExtractChannelOp;
302 GetMagickToken(p,&p,token);
305 channel_op=ExchangeChannelOp;
306 GetMagickToken(p,&p,token);
310 if (channel_op != ExchangeChannelOp)
311 channel_op=AssignChannelOp;
312 GetMagickToken(p,&p,token);
316 if (channel_op != ExchangeChannelOp)
317 channel_op=TransferChannelOp;
318 GetMagickToken(p,&p,token);
322 case AssignChannelOp:
324 pixel=StringToDoubleInterval(token,(double) QuantumRange+1.0);
325 GetMagickToken(p,&p,token);
328 case ExchangeChannelOp:
329 case TransferChannelOp:
331 i=ParsePixelChannelOption(token);
334 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
335 "UnrecognizedChannelType","`%s'",token);
336 destination_image=DestroyImageList(destination_image);
337 return(destination_image);
339 destination_channel=(PixelChannel) i;
340 if (LocaleCompare(token,"gray") == 0)
341 (void) SetImageAlpha(destination_image,GrayColorspace,exception);
342 if ((LocaleCompare(token,"black") == 0) ||
343 (LocaleCompare(token,"c") == 0) ||
344 (LocaleCompare(token,"cyan") == 0) ||
345 (LocaleCompare(token,"k") == 0) ||
346 (LocaleCompare(token,"m") == 0) ||
347 (LocaleCompare(token,"magenta") == 0) ||
348 (LocaleCompare(token,"y") == 0) ||
349 (LocaleCompare(token,"yellow") == 0))
350 (void) SetImageColorspace(destination_image,CMYKColorspace,exception);
351 if ((LocaleCompare(token,"Cb") == 0) ||
352 (LocaleCompare(token,"Cr") == 0))
353 (void) SetImageColorspace(destination_image,YCbCrColorspace,
355 if (LocaleCompare(token,"alpha") == 0)
356 (void) SetImageAlpha(destination_image,OpaqueAlpha,exception);
357 if (i >= (ssize_t) GetPixelChannels(destination_image))
358 (void) SetPixelMetaChannels(destination_image,(size_t) (i-
359 GetPixelChannels(destination_image)+1),exception);
360 GetMagickToken(p,&p,token);
363 case ExtractChannelOp:
365 destination_channel++;
369 status=ChannelImage(destination_image,destination_channel,channel_op,
370 source_image,source_channel,ClampToQuantum(pixel),exception);
371 if (status == MagickFalse)
373 destination_image=DestroyImageList(destination_image);
377 if (channel_op == ExchangeChannelOp)
379 status=ChannelImage(destination_image,source_channel,channel_op,
380 source_image,destination_channel,ClampToQuantum(pixel),exception);
381 if (status == MagickFalse)
383 destination_image=DestroyImageList(destination_image);
388 status=SetImageProgress(source_image,ChannelFxImageTag,p-expression,
390 if (status == MagickFalse)
393 status=SetImageStorageClass(destination_image,DirectClass,exception);
394 if (status == MagickFalse)
396 destination_image=GetLastImageInList(destination_image);
397 return((Image *) NULL);
399 return(GetFirstImageInList(destination_image));
403 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
407 % C o m b i n e I m a g e s %
411 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
413 % CombineImages() combines one or more images into a single image. The
414 % grayscale value of the pixels of each image in the sequence is assigned in
415 % order to the specified channels of the combined image. The typical
416 % ordering would be image 1 => Red, 2 => Green, 3 => Blue, etc.
418 % The format of the CombineImages method is:
420 % Image *CombineImages(const Image *image,ExceptionInfo *exception)
422 % A description of each parameter follows:
424 % o image: the image.
426 % o exception: return any errors or warnings in this structure.
429 MagickExport Image *CombineImages(const Image *image,ExceptionInfo *exception)
431 #define CombineImageTag "Combine/Image"
449 Ensure the image are the same size.
451 assert(image != (const Image *) NULL);
452 assert(image->signature == MagickSignature);
453 if (image->debug != MagickFalse)
454 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
455 assert(exception != (ExceptionInfo *) NULL);
456 assert(exception->signature == MagickSignature);
457 combine_image=CloneImage(image,0,0,MagickTrue,exception);
458 if (combine_image == (Image *) NULL)
459 return((Image *) NULL);
460 if (SetImageStorageClass(combine_image,DirectClass,exception) == MagickFalse)
462 combine_image=DestroyImage(combine_image);
463 return((Image *) NULL);
465 if ((GetPixelAlphaTraits(image) & UpdatePixelTrait) != 0)
466 combine_image->matte=MagickTrue;
472 combine_view=AcquireCacheView(combine_image);
473 for (y=0; y < (ssize_t) combine_image->rows; y++)
484 register const Quantum
493 if (status == MagickFalse)
495 pixels=GetCacheViewAuthenticPixels(combine_view,0,y,combine_image->columns,
497 if (pixels == (Quantum *) NULL)
503 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
515 if (next == (Image *) NULL)
517 channel=GetPixelChannelMapChannel(image,i);
518 traits=GetPixelChannelMapTraits(image,channel);
519 combine_traits=GetPixelChannelMapTraits(combine_image,channel);
520 if ((traits == UndefinedPixelTrait) ||
521 (combine_traits == UndefinedPixelTrait))
523 image_view=AcquireCacheView(next);
524 p=GetCacheViewVirtualPixels(image_view,0,y,next->columns,1,exception);
525 if (p == (const Quantum *) NULL)
528 for (x=0; x < (ssize_t) combine_image->columns; x++)
530 if (x < (ssize_t) image->columns)
532 q[i]=GetPixelGray(image,p);
533 p+=GetPixelChannels(image);
535 q+=GetPixelChannels(combine_image);
537 image_view=DestroyCacheView(image_view);
538 next=GetNextImageInList(next);
539 if (SyncCacheViewAuthenticPixels(combine_view,exception) == MagickFalse)
541 if (image->progress_monitor != (MagickProgressMonitor) NULL)
546 proceed=SetImageProgress(image,CombineImageTag,progress++,
547 combine_image->rows);
548 if (proceed == MagickFalse)
553 combine_view=DestroyCacheView(combine_view);
554 if (status == MagickFalse)
555 combine_image=DestroyImage(combine_image);
556 return(combine_image);
560 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
564 % S e p a r a t e I m a g e %
568 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
570 % SeparateImage() separates a channel from the image and returns it as a
573 % The format of the SeparateImage method is:
575 % Image *SeparateImage(const Image *image,const ChannelType channel,
576 % ExceptionInfo *exception)
578 % A description of each parameter follows:
580 % o image: the image.
582 % o channel: the image channel.
584 % o exception: return any errors or warnings in this structure.
587 MagickExport Image *SeparateImage(const Image *image,
588 const ChannelType channel_type,ExceptionInfo *exception)
590 #define GetChannelBit(mask,bit) (((size_t) (mask) >> (size_t) (bit)) & 0x01)
591 #define SeparateImageTag "Separate/Image"
610 Initialize spread image attributes.
612 assert(image != (Image *) NULL);
613 assert(image->signature == MagickSignature);
614 if (image->debug != MagickFalse)
615 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
616 assert(exception != (ExceptionInfo *) NULL);
617 assert(exception->signature == MagickSignature);
618 separate_image=CloneImage(image,image->columns,image->rows,MagickTrue,
620 if (separate_image == (Image *) NULL)
621 return((Image *) NULL);
622 if (SetImageStorageClass(separate_image,DirectClass,exception) == MagickFalse)
624 separate_image=DestroyImage(separate_image);
625 return((Image *) NULL);
627 separate_image->colorspace=GRAYColorspace;
633 image_view=AcquireCacheView(image);
634 separate_view=AcquireCacheView(separate_image);
635 #if defined(MAGICKCORE_OPENMP_SUPPORT)
636 #pragma omp parallel for schedule(static) shared(progress,status)
638 for (y=0; y < (ssize_t) image->rows; y++)
640 register const Quantum
649 if (status == MagickFalse)
651 p=GetCacheViewVirtualPixels(image_view,0,y,image->columns,1,exception);
652 q=QueueCacheViewAuthenticPixels(separate_view,0,y,separate_image->columns,1,
654 if ((p == (const Quantum *) NULL) || (q == (Quantum *) NULL))
659 for (x=0; x < (ssize_t) image->columns; x++)
664 if (GetPixelMask(image,p) != 0)
666 p+=GetPixelChannels(image);
667 q+=GetPixelChannels(separate_image);
670 SetPixelChannel(separate_image,GrayPixelChannel,0,q);
671 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
679 channel=GetPixelChannelMapChannel(image,i);
680 traits=GetPixelChannelMapTraits(image,channel);
681 if ((traits == UndefinedPixelTrait) ||
682 (GetChannelBit(channel_type,channel) == 0))
684 SetPixelChannel(separate_image,GrayPixelChannel,p[i],q);
686 p+=GetPixelChannels(image);
687 q+=GetPixelChannels(separate_image);
689 if (SyncCacheViewAuthenticPixels(separate_view,exception) == MagickFalse)
691 if (image->progress_monitor != (MagickProgressMonitor) NULL)
696 #if defined(MAGICKCORE_OPENMP_SUPPORT)
697 #pragma omp critical (MagickCore_SeparateImage)
699 proceed=SetImageProgress(image,SeparateImageTag,progress++,image->rows);
700 if (proceed == MagickFalse)
704 separate_view=DestroyCacheView(separate_view);
705 image_view=DestroyCacheView(image_view);
706 return(separate_image);
710 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
714 % S e p a r a t e I m a g e s %
718 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
720 % SeparateImages() returns a separate grayscale image for each channel
723 % The format of the SeparateImages method is:
725 % Image *SeparateImages(const Image *image,ExceptionInfo *exception)
727 % A description of each parameter follows:
729 % o image: the image.
731 % o exception: return any errors or warnings in this structure.
734 MagickExport Image *SeparateImages(const Image *image,ExceptionInfo *exception)
743 assert(image != (Image *) NULL);
744 assert(image->signature == MagickSignature);
745 if (image->debug != MagickFalse)
746 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
747 images=NewImageList();
748 for (i=0; i < (ssize_t) GetPixelChannels(image); i++)
756 channel=GetPixelChannelMapChannel(image,i);
757 traits=GetPixelChannelMapTraits(image,channel);
758 if ((traits == UndefinedPixelTrait) ||
759 ((traits & UpdatePixelTrait) == 0))
761 separate_image=SeparateImage(image,(ChannelType) (1 << channel),exception);
762 if (separate_image != (Image *) NULL)
763 AppendImageToList(&images,separate_image);