2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % CCCC OOO N N JJJJJ U U RRRR EEEEE %
7 % C O O NN N J U U R R E %
8 % C O O N N N J U U RRRR EEE %
9 % C O O N NN J J U U R R E %
10 % CCCC OOO N N JJJ UUU R R EEEEE %
13 % Interpret Magick Scripting Language. %
20 % Copyright 1999-2017 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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
36 % The conjure program gives you the ability to perform custom image processing
37 % tasks from a script written in the Magick Scripting Language (MSL). MSL is
38 % XML-based and consists of action statements with attributes. Actions include
39 % reading an image, processing an image, getting attributes from an image,
40 % writing an image, and more. An attribute is a key/value pair that modifies
41 % the behavior of an action.
48 #include "MagickWand/studio.h"
49 #include "MagickWand/MagickWand.h"
50 #include "MagickWand/mogrify-private.h"
53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
57 + C o n j u r e I m a g e C o m m a n d %
61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
63 % ConjureImageCommand() describes the format and characteristics of one or
64 % more image files. It will also report if an image is incomplete or corrupt.
65 % The information displayed includes the scene number, the file name, the
66 % width and height of the image, whether the image is colormapped or not,
67 % the number of colors in the image, the number of bytes in the image, the
68 % format of the image (JPEG, PNM, etc.), and finally the number of seconds
69 % it took to read and process the image.
71 % The format of the ConjureImageCommand method is:
73 % MagickBooleanType ConjureImageCommand(ImageInfo *image_info,int argc,
74 % char **argv,char **metadata,ExceptionInfo *exception)
76 % A description of each parameter follows:
78 % o image_info: the image info.
80 % o argc: the number of elements in the argument vector.
82 % o argv: A text array containing the command line arguments.
84 % o metadata: any metadata is returned here.
86 % o exception: return any errors or warnings in this structure.
90 static MagickBooleanType ConjureUsage(void)
98 "-debug events display copious debugging information",
99 "-help print program options",
100 "-list type print a list of supported option arguments",
101 "-log format format of debugging information",
102 "-version print version information",
107 "-monitor monitor progress",
108 "-quiet suppress all warning messages",
109 "-regard-warnings pay attention to warning messages",
110 "-seed value seed a new sequence of pseudo-random numbers",
111 "-verbose print detailed information about the image",
115 ListMagickVersion(stdout);
116 (void) printf("Usage: %s [options ...] file [ [options ...] file ...]\n",
118 (void) printf("\nImage Settings:\n");
119 for (p=settings; *p != (char *) NULL; p++)
120 (void) printf(" %s\n",*p);
121 (void) printf("\nMiscellaneous Options:\n");
122 for (p=miscellaneous; *p != (char *) NULL; p++)
123 (void) printf(" %s\n",*p);
124 (void) printf("\nIn addition, define any key value pairs required by "
125 "your script. For\nexample,\n\n");
126 (void) printf(" conjure -size 100x100 -color blue -foo bar script.msl\n");
130 WandExport MagickBooleanType ConjureImageCommand(ImageInfo *image_info,
131 int argc,char **argv,char **wand_unused(metadata),ExceptionInfo *exception)
133 #define DestroyConjure() \
135 image=DestroyImageList(image); \
136 for (i=0; i < (ssize_t) argc; i++) \
137 argv[i]=DestroyString(argv[i]); \
138 argv=(char **) RelinquishMagickMemory(argv); \
140 #define ThrowConjureException(asperity,tag,option) \
142 (void) ThrowMagickException(exception,GetMagickModule(),asperity,tag,"`%s'", \
145 return(MagickFalse); \
147 #define ThrowConjureInvalidArgumentException(option,argument) \
149 (void) ThrowMagickException(exception,GetMagickModule(),OptionError, \
150 "InvalidArgument","'%s': %s",option,argument); \
152 return(MagickFalse); \
156 filename[MagickPathExtent],
171 wand_unreferenced(metadata);
176 assert(image_info != (ImageInfo *) NULL);
177 assert(image_info->signature == MagickCoreSignature);
178 if (image_info->debug != MagickFalse)
179 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
180 assert(exception != (ExceptionInfo *) NULL);
182 return(ConjureUsage());
183 image=NewImageList();
185 option=(char *) NULL;
189 ReadCommandlLine(argc,&argv);
190 status=ExpandFilenames(&argc,&argv);
191 if (status == MagickFalse)
192 ThrowConjureException(ResourceLimitError,"MemoryAllocationFailed",
193 GetExceptionMessage(errno));
194 for (i=1; i < (ssize_t) argc; i++)
197 if (IsCommandOption(option) != MagickFalse)
199 if (LocaleCompare("concurrent",option+1) == 0)
201 if (LocaleCompare("debug",option+1) == 0)
209 if (i == (ssize_t) argc)
210 ThrowConjureException(OptionError,"MissingArgument",option);
211 event=ParseCommandOption(MagickLogEventOptions,MagickFalse,argv[i]);
213 ThrowConjureException(OptionError,"UnrecognizedEventType",
215 (void) SetLogEventMask(argv[i]);
218 if (LocaleCompare("duration",option+1) == 0)
223 if (i == (ssize_t) argc)
224 ThrowConjureException(OptionError,"MissingArgument",option);
225 if (IsGeometry(argv[i]) == MagickFalse)
226 ThrowConjureInvalidArgumentException(option,argv[i]);
229 if ((LocaleCompare("help",option+1) == 0) ||
230 (LocaleCompare("-help",option+1) == 0))
233 return(ConjureUsage());
236 if (LocaleCompare("log",option+1) == 0)
241 if (i == (ssize_t) argc)
242 ThrowConjureException(OptionError,"MissingLogFormat",option);
243 (void) SetLogFormat(argv[i]);
247 if (LocaleCompare("monitor",option+1) == 0)
249 if (LocaleCompare("quiet",option+1) == 0)
251 if (LocaleCompare("regard-warnings",option+1) == 0)
253 if (LocaleCompare("seed",option+1) == 0)
258 if (i == (ssize_t) argc)
259 ThrowConjureException(OptionError,"MissingArgument",option);
260 if (IsGeometry(argv[i]) == MagickFalse)
261 ThrowConjureInvalidArgumentException(option,argv[i]);
264 if (LocaleCompare("verbose",option+1) == 0)
266 image_info->verbose=(*option == '-') ? MagickTrue : MagickFalse;
269 if ((LocaleCompare("version",option+1) == 0) ||
270 (LocaleCompare("-version",option+1) == 0))
272 ListMagickVersion(stdout);
276 Persist key/value pair.
278 (void) DeleteImageOption(image_info,option+1);
279 status=SetImageOption(image_info,option+1,argv[i+1]);
280 if (status == MagickFalse)
281 ThrowConjureException(ImageError,"UnableToPersistKey",option);
286 Interpret MSL script.
288 (void) DeleteImageOption(image_info,"filename");
289 status=SetImageOption(image_info,"filename",argv[i]);
290 if (status == MagickFalse)
291 ThrowConjureException(ImageError,"UnableToPersistKey",argv[i]);
292 (void) FormatLocaleString(filename,MagickPathExtent,"msl:%s",argv[i]);
293 image=ReadImages(image_info,filename,exception);
294 CatchException(exception);
295 if (image != (Image *) NULL)
296 image=DestroyImageList(image);
297 status=image != (Image *) NULL ? MagickTrue : MagickFalse;
300 if (i != (ssize_t) argc)
301 ThrowConjureException(OptionError,"MissingAnImageFilename",argv[i]);
302 if (number_images == 0)
303 ThrowConjureException(OptionError,"MissingAnImageFilename",argv[argc-1]);
304 if (image != (Image *) NULL)
305 image=DestroyImageList(image);
306 for (i=0; i < (ssize_t) argc; i++)
307 argv[i]=DestroyString(argv[i]);
308 argv=(char **) RelinquishMagickMemory(argv);
309 return(status != 0 ? MagickTrue : MagickFalse);