2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
8 % M M M AAAAA SSS KKK %
20 % Copyright 1999-2013 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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/attribute.h"
44 #include "MagickCore/blob.h"
45 #include "MagickCore/blob-private.h"
46 #include "MagickCore/constitute.h"
47 #include "MagickCore/enhance.h"
48 #include "MagickCore/exception.h"
49 #include "MagickCore/exception-private.h"
50 #include "MagickCore/list.h"
51 #include "MagickCore/magick.h"
52 #include "MagickCore/memory_.h"
53 #include "MagickCore/monitor.h"
54 #include "MagickCore/monitor-private.h"
55 #include "MagickCore/pixel-accessor.h"
56 #include "MagickCore/quantum-private.h"
57 #include "MagickCore/static.h"
58 #include "MagickCore/string_.h"
59 #include "MagickCore/module.h"
64 static MagickBooleanType
65 WriteMASKImage(const ImageInfo *,Image *,ExceptionInfo *);
68 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
72 % R e a d M A S K I m a g e %
76 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
78 % ReadMASKImage returns the image mask associated with the image.
80 % The format of the ReadMASKImage method is:
82 % Image *ReadMASKImage(const ImageInfo *image_info,
83 % ExceptionInfo *exception)
85 % A description of each parameter follows:
87 % o image_info: the image info.
89 % o exception: return any errors or warnings in this structure.
92 static Image *ReadMASKImage(const ImageInfo *image_info,
93 ExceptionInfo *exception)
102 Initialize Image structure.
104 assert(image_info != (const ImageInfo *) NULL);
105 assert(image_info->signature == MagickSignature);
106 if (image_info->debug != MagickFalse)
107 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
108 image_info->filename);
109 assert(exception != (ExceptionInfo *) NULL);
110 assert(exception->signature == MagickSignature);
111 read_info=CloneImageInfo(image_info);
112 SetImageInfoBlob(read_info,(void *) NULL,0);
113 *read_info->magick='\0';
114 image=ReadImage(read_info,exception);
115 read_info=DestroyImageInfo(read_info);
116 if (image != (Image *) NULL)
121 status=GrayscaleImage(image,image->intensity,exception);
122 if (status == MagickFalse)
123 image=DestroyImage(image);
125 return(GetFirstImageInList(image));
129 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
133 % R e g i s t e r M A S K I m a g e %
137 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
139 % RegisterMASKImage() adds attributes for the MASK image format to
140 % the list of supported formats. The attributes include the image format
141 % tag, a method to read and/or write the format, whether the format
142 % supports the saving of more than one frame to the same file or blob,
143 % whether the format supports native in-memory I/O, and a brief
144 % description of the format.
146 % The format of the RegisterMASKImage method is:
148 % size_t RegisterMASKImage(void)
151 ModuleExport size_t RegisterMASKImage(void)
156 entry=SetMagickInfo("MASK");
157 entry->decoder=(DecodeImageHandler *) ReadMASKImage;
158 entry->encoder=(EncodeImageHandler *) WriteMASKImage;
159 entry->description=ConstantString("Image Clip Mask");
160 entry->module=ConstantString("MASK");
161 (void) RegisterMagickInfo(entry);
162 return(MagickImageCoderSignature);
166 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
170 % U n r e g i s t e r M A S K I m a g e %
174 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
176 % UnregisterMASKImage() removes format registrations made by the
177 % MASK module from the list of supported formats.
179 % The format of the UnregisterMASKImage method is:
181 % UnregisterMASKImage(void)
184 ModuleExport void UnregisterMASKImage(void)
186 (void) UnregisterMagickInfo("MASK");
190 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
194 % W r i t e M A S K I m a g e %
198 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
200 % WriteMASKImage() writes an image mask to a file.
202 % The format of the WriteMASKImage method is:
204 % MagickBooleanType WriteMASKImage(const ImageInfo *image_info,
205 % Image *image,ExceptionInfo *exception)
207 % A description of each parameter follows.
209 % o image_info: the image info.
211 % o image: The image.
213 % o exception: return any errors or warnings in this structure.
217 static Image *MaskImage(const Image *image,ExceptionInfo *exception)
232 mask_image=CloneImage(image,image->columns,image->rows,MagickTrue,
234 if (mask_image == (Image *) NULL)
235 return((Image *) NULL);
236 if (SetImageStorageClass(mask_image,DirectClass,exception) == MagickFalse)
238 mask_image=DestroyImage(mask_image);
239 return((Image *) NULL);
241 mask_image->alpha_trait=UndefinedPixelTrait;
242 (void) SetImageColorspace(mask_image,GRAYColorspace,exception);
247 image_view=AcquireVirtualCacheView(image,exception);
248 mask_view=AcquireAuthenticCacheView(mask_image,exception);
249 for (y=0; y < (ssize_t) image->rows; y++)
251 register const Quantum
260 if (status == MagickFalse)
262 p=GetCacheViewVirtualPixels(image_view,0,y,image->columns,1,exception);
263 q=QueueCacheViewAuthenticPixels(mask_view,0,y,mask_image->columns,1,
265 if ((p == (const Quantum *) NULL) || (q == (Quantum *) NULL))
270 for (x=0; x < (ssize_t) image->columns; x++)
272 SetPixelChannel(mask_image,GrayPixelChannel,0,q);
273 SetPixelChannel(mask_image,GrayPixelChannel,GetPixelReadMask(image,p),q);
274 p+=GetPixelChannels(image);
275 q+=GetPixelChannels(mask_image);
277 if (SyncCacheViewAuthenticPixels(mask_view,exception) == MagickFalse)
280 mask_view=DestroyCacheView(mask_view);
281 image_view=DestroyCacheView(image_view);
282 if (status == MagickFalse)
283 mask_image=DestroyImage(mask_image);
287 static MagickBooleanType WriteMASKImage(const ImageInfo *image_info,
288 Image *image,ExceptionInfo *exception)
299 mask_image=MaskImage(image,exception);
300 if (mask_image == (Image *) NULL)
302 (void) CopyMagickString(mask_image->filename,image->filename,MaxTextExtent);
303 write_info=CloneImageInfo(image_info);
304 (void) SetImageInfo(write_info,1,exception);
305 if (LocaleCompare(write_info->magick,"MASK") == 0)
306 (void) FormatLocaleString(mask_image->filename,MaxTextExtent,"miff:%s",
307 write_info->filename);
308 status=WriteImage(write_info,mask_image,exception);
309 mask_image=DestroyImage(mask_image);
310 write_info=DestroyImageInfo(write_info);