2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10 % CCCC LLLLL IIIII P %
13 % Write Clip Mask To MIFF File. %
20 % Copyright 1999-2014 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/exception.h"
48 #include "MagickCore/exception-private.h"
49 #include "MagickCore/list.h"
50 #include "MagickCore/magick.h"
51 #include "MagickCore/memory_.h"
52 #include "MagickCore/monitor.h"
53 #include "MagickCore/monitor-private.h"
54 #include "MagickCore/quantum-private.h"
55 #include "MagickCore/static.h"
56 #include "MagickCore/string_.h"
57 #include "MagickCore/module.h"
62 static MagickBooleanType
63 WriteCLIPImage(const ImageInfo *,Image *,ExceptionInfo *);
66 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
70 % R e a d C L I P I m a g e %
74 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
76 % ReadCLIPImage returns the rendered clip path associated with the image.
78 % The format of the ReadCLIPImage method is:
80 % Image *ReadCLIPImage(const ImageInfo *image_info,
81 % ExceptionInfo *exception)
83 % A description of each parameter follows:
85 % o image_info: the image info.
87 % o exception: return any errors or warnings in this structure.
90 static Image *ReadCLIPImage(const ImageInfo *image_info,
91 ExceptionInfo *exception)
101 Initialize Image structure.
103 assert(image_info != (const ImageInfo *) NULL);
104 assert(image_info->signature == MagickSignature);
105 if (image_info->debug != MagickFalse)
106 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
107 image_info->filename);
108 assert(exception != (ExceptionInfo *) NULL);
109 assert(exception->signature == MagickSignature);
110 read_info=CloneImageInfo(image_info);
111 SetImageInfoBlob(read_info,(void *) NULL,0);
112 *read_info->magick='\0';
113 clip_image=ReadImage(read_info,exception);
114 read_info=DestroyImageInfo(read_info);
115 if (clip_image == (Image *) NULL)
116 return((Image *) NULL);
117 (void) ClipImage(clip_image,exception);
118 image=GetImageMask(clip_image,exception);
119 clip_image=DestroyImage(clip_image);
120 if (image == (Image *) NULL)
121 ThrowReaderException(CoderError,"ImageDoesNotHaveAClipMask");
122 return(GetFirstImageInList(image));
126 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
130 % R e g i s t e r C L I P I m a g e %
134 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
136 % RegisterCLIPImage() adds attributes for the CLIP image format to
137 % the list of supported formats. The attributes include the image format
138 % tag, a method to read and/or write the format, whether the format
139 % supports the saving of more than one frame to the same file or blob,
140 % whether the format supports native in-memory I/O, and a brief
141 % description of the format.
143 % The format of the RegisterCLIPImage method is:
145 % size_t RegisterCLIPImage(void)
148 ModuleExport size_t RegisterCLIPImage(void)
153 entry=SetMagickInfo("CLIP");
154 entry->decoder=(DecodeImageHandler *) ReadCLIPImage;
155 entry->encoder=(EncodeImageHandler *) WriteCLIPImage;
156 entry->description=ConstantString("Image Clip Mask");
157 entry->module=ConstantString("CLIP");
158 (void) RegisterMagickInfo(entry);
159 return(MagickImageCoderSignature);
163 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
167 % U n r e g i s t e r C L I P I m a g e %
171 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
173 % UnregisterCLIPImage() removes format registrations made by the
174 % CLIP module from the list of supported formats.
176 % The format of the UnregisterCLIPImage method is:
178 % UnregisterCLIPImage(void)
181 ModuleExport void UnregisterCLIPImage(void)
183 (void) UnregisterMagickInfo("CLIP");
187 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
191 % W r i t e C L I P I m a g e %
195 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
197 % WriteCLIPImage() writes an image of clip bytes to a file. It consists of
198 % data from the clip mask of the image.
200 % The format of the WriteCLIPImage method is:
202 % MagickBooleanType WriteCLIPImage(const ImageInfo *image_info,
203 % Image *image,ExceptionInfo *exception)
205 % A description of each parameter follows.
207 % o image_info: the image info.
209 % o image: The image.
211 % o exception: return any errors or warnings in this structure.
214 static MagickBooleanType WriteCLIPImage(const ImageInfo *image_info,
215 Image *image,ExceptionInfo *exception)
226 if (image->read_mask == MagickFalse)
227 (void) ClipImage(image,exception);
228 if (image->read_mask == MagickFalse)
229 ThrowWriterException(CoderError,"ImageDoesNotHaveAClipMask");
230 clip_image=GetImageMask(image,exception);
231 if (clip_image == (Image *) NULL)
233 (void) CopyMagickString(clip_image->filename,image->filename,MaxTextExtent);
234 write_info=CloneImageInfo(image_info);
235 (void) SetImageInfo(write_info,1,exception);
236 if (LocaleCompare(write_info->magick,"CLIP") == 0)
237 (void) FormatLocaleString(clip_image->filename,MaxTextExtent,"miff:%s",
238 write_info->filename);
239 status=WriteImage(write_info,clip_image,exception);
240 clip_image=DestroyImage(clip_image);
241 write_info=DestroyImageInfo(write_info);