MagickWand 7.1.1
Convert, Edit, Or Compose Bitmap Images
Loading...
Searching...
No Matches
conjure.c
1/*
2%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3% %
4% %
5% %
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 %
11% %
12% %
13% Interpret Magick Scripting Language. %
14% %
15% Software Design %
16% Cristy %
17% December 2001 %
18% %
19% %
20% Copyright @ 2001 ImageMagick Studio LLC, a non-profit organization %
21% dedicated to making software imaging solutions freely available. %
22% %
23% You may not use this file except in compliance with the License. You may %
24% obtain a copy of the License at %
25% %
26% https://imagemagick.org/script/license.php %
27% %
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. %
33% %
34%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
35%
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.
42%
43*/
44␌
45/*
46 Include declarations.
47*/
48#include "MagickWand/studio.h"
49#include "MagickWand/MagickWand.h"
50#include "MagickWand/mogrify-private.h"
51␌
52/*
53%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
54% %
55% %
56% %
57+ C o n j u r e I m a g e C o m m a n d %
58% %
59% %
60% %
61%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
62%
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.
70%
71% The format of the ConjureImageCommand method is:
72%
73% MagickBooleanType ConjureImageCommand(ImageInfo *image_info,int argc,
74% char **argv,char **metadata,ExceptionInfo *exception)
75%
76% A description of each parameter follows:
77%
78% o image_info: the image info.
79%
80% o argc: the number of elements in the argument vector.
81%
82% o argv: A text array containing the command line arguments.
83%
84% o metadata: any metadata is returned here.
85%
86% o exception: return any errors or warnings in this structure.
87%
88*/
89
90static MagickBooleanType ConjureUsage(void)
91{
92 static const char
93 miscellaneous[] =
94 " -debug events display copious debugging information\n"
95 " -help print program options\n"
96 " -list type print a list of supported option arguments\n"
97 " -log format format of debugging information\n"
98 " -version print version information",
99 settings[] =
100 " -monitor monitor progress\n"
101 " -quiet suppress all warning messages\n"
102 " -regard-warnings pay attention to warning messages\n"
103 " -seed value seed a new sequence of pseudo-random numbers\n"
104 " -verbose print detailed information about the image";
105
106 ListMagickVersion(stdout);
107 (void) printf("Usage: %s [options ...] file [ [options ...] file ...]\n",
108 GetClientName());
109 (void) printf("\nImage Settings:\n");
110 (void) puts(settings);
111 (void) printf("\nMiscellaneous Options:\n");
112 (void) puts(miscellaneous);
113 (void) printf("\nIn addition, define any key value pairs required by "
114 "your script. For\nexample,\n\n");
115 (void) printf(" conjure -size 100x100 -color blue -foo bar script.msl\n");
116 return(MagickTrue);
117}
118
119WandExport MagickBooleanType ConjureImageCommand(ImageInfo *image_info,
120 int argc,char **argv,char **wand_unused(metadata),ExceptionInfo *exception)
121{
122#define DestroyConjure() \
123{ \
124 image=DestroyImageList(image); \
125 for (i=0; i < (ssize_t) argc; i++) \
126 argv[i]=DestroyString(argv[i]); \
127 argv=(char **) RelinquishMagickMemory(argv); \
128}
129#define ThrowConjureException(asperity,tag,option) \
130{ \
131 (void) ThrowMagickException(exception,GetMagickModule(),asperity,tag,"`%s'", \
132 option); \
133 DestroyConjure(); \
134 return(MagickFalse); \
135}
136#define ThrowConjureInvalidArgumentException(option,argument) \
137{ \
138 (void) ThrowMagickException(exception,GetMagickModule(),OptionError, \
139 "InvalidArgument","'%s': %s",option,argument); \
140 DestroyConjure(); \
141 return(MagickFalse); \
142}
143
144 char
145 filename[MagickPathExtent],
146 *option;
147
148 Image
149 *image;
150
151 MagickStatusType
152 status;
153
154 ssize_t
155 i;
156
157 ssize_t
158 number_images;
159
160 wand_unreferenced(metadata);
161
162 /*
163 Set defaults.
164 */
165 assert(image_info != (ImageInfo *) NULL);
166 assert(image_info->signature == MagickCoreSignature);
167 assert(exception != (ExceptionInfo *) NULL);
168 if (IsEventLogging() != MagickFalse)
169 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
170 if (argc < 2)
171 {
172 (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
173 "MissingArgument","%s","");
174 (void) ConjureUsage();
175 return(MagickFalse);
176 }
177 image=NewImageList();
178 number_images=0;
179 option=(char *) NULL;
180 /*
181 Conjure an image.
182 */
183 ReadCommandlLine(argc,&argv);
184 status=ExpandFilenames(&argc,&argv);
185 if (status == MagickFalse)
186 ThrowConjureException(ResourceLimitError,"MemoryAllocationFailed",
187 GetExceptionMessage(errno));
188 for (i=1; i < (ssize_t) argc; i++)
189 {
190 option=argv[i];
191 if (IsCommandOption(option) != MagickFalse)
192 {
193 if (LocaleCompare("concurrent",option+1) == 0)
194 break;
195 if (LocaleCompare("debug",option+1) == 0)
196 {
197 ssize_t
198 event;
199
200 if (*option == '+')
201 break;
202 i++;
203 if (i == (ssize_t) argc)
204 ThrowConjureException(OptionError,"MissingArgument",option);
205 event=ParseCommandOption(MagickLogEventOptions,MagickFalse,argv[i]);
206 if (event < 0)
207 ThrowConjureException(OptionError,"UnrecognizedEventType",
208 argv[i]);
209 (void) SetLogEventMask(argv[i]);
210 continue;
211 }
212 if (LocaleCompare("duration",option+1) == 0)
213 {
214 if (*option == '+')
215 break;
216 i++;
217 if (i == (ssize_t) argc)
218 ThrowConjureException(OptionError,"MissingArgument",option);
219 if (IsGeometry(argv[i]) == MagickFalse)
220 ThrowConjureInvalidArgumentException(option,argv[i]);
221 continue;
222 }
223 if ((LocaleCompare("help",option+1) == 0) ||
224 (LocaleCompare("-help",option+1) == 0))
225 {
226 if (*option == '-')
227 {
228 DestroyConjure();
229 return(ConjureUsage());
230 }
231 continue;
232 }
233 if (LocaleCompare("log",option+1) == 0)
234 {
235 if (*option == '-')
236 {
237 i++;
238 if (i == (ssize_t) argc)
239 ThrowConjureException(OptionError,"MissingLogFormat",option);
240 (void) SetLogFormat(argv[i]);
241 }
242 continue;
243 }
244 if (LocaleCompare("monitor",option+1) == 0)
245 continue;
246 if (LocaleCompare("quiet",option+1) == 0)
247 continue;
248 if (LocaleCompare("regard-warnings",option+1) == 0)
249 break;
250 if (LocaleCompare("seed",option+1) == 0)
251 {
252 if (*option == '+')
253 break;
254 i++;
255 if (i == (ssize_t) argc)
256 ThrowConjureException(OptionError,"MissingArgument",option);
257 if (IsGeometry(argv[i]) == MagickFalse)
258 ThrowConjureInvalidArgumentException(option,argv[i]);
259 break;
260 }
261 if (LocaleCompare("verbose",option+1) == 0)
262 {
263 image_info->verbose=(*option == '-') ? MagickTrue : MagickFalse;
264 continue;
265 }
266 if ((LocaleCompare("version",option+1) == 0) ||
267 (LocaleCompare("-version",option+1) == 0))
268 {
269 ListMagickVersion(stdout);
270 return(MagickTrue);
271 }
272 /*
273 Persist key/value pair.
274 */
275 (void) DeleteImageOption(image_info,option+1);
276 i++;
277 if (i == argc)
278 ThrowConjureException(OptionError,"MissingArgument",option);
279 status=SetImageOption(image_info,option+1,argv[i]);
280 if (status == MagickFalse)
281 ThrowConjureException(ImageError,"UnableToPersistKey",option);
282 continue;
283 }
284 /*
285 Interpret MSL script.
286 */
287 (void) DeleteImageOption(image_info,"filename");
288 status=SetImageOption(image_info,"filename",argv[i]);
289 if (status == MagickFalse)
290 ThrowConjureException(ImageError,"UnableToPersistKey",argv[i]);
291 (void) FormatLocaleString(filename,MagickPathExtent,"%s",argv[i]);
292 image=ReadImages(image_info,filename,exception);
293 CatchException(exception);
294 if (image != (Image *) NULL)
295 image=DestroyImageList(image);
296 status=image != (Image *) NULL ? MagickTrue : MagickFalse;
297 number_images++;
298 }
299 if (i != (ssize_t) argc)
300 ThrowConjureException(OptionError,"MissingAnImageFilename",argv[i]);
301 if (number_images == 0)
302 ThrowConjureException(OptionError,"MissingAnImageFilename",argv[argc-1]);
303 if (image != (Image *) NULL)
304 image=DestroyImageList(image);
305 for (i=0; i < (ssize_t) argc; i++)
306 argv[i]=DestroyString(argv[i]);
307 argv=(char **) RelinquishMagickMemory(argv);
308 return(status != 0 ? MagickTrue : MagickFalse);
309}