MagickWand  6.9.13-23
Convert, Edit, Or Compose Bitmap Images
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 1999 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 "wand/studio.h"
49 #include "wand/MagickWand.h"
50 #include "wand/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 
90 static 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 
119 WandExport 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  *option;
146 
147  Image
148  *image;
149 
150  MagickStatusType
151  status;
152 
153  ssize_t
154  i;
155 
156  ssize_t
157  number_images;
158 
159  wand_unreferenced(metadata);
160 
161  /*
162  Set defaults.
163  */
164  assert(image_info != (ImageInfo *) NULL);
165  assert(image_info->signature == MagickCoreSignature);
166  assert(exception != (ExceptionInfo *) NULL);
167  if (IsEventLogging() != MagickFalse)
168  (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
169  if (argc < 2)
170  {
171  (void) ThrowMagickException(exception,GetMagickModule(),OptionError,
172  "MissingArgument","%s","");
173  (void) ConjureUsage();
174  return(MagickFalse);
175  }
176  image=NewImageList();
177  number_images=0;
178  option=(char *) NULL;
179  /*
180  Conjure an image.
181  */
182  ReadCommandlLine(argc,&argv);
183  status=ExpandFilenames(&argc,&argv);
184  if (status == MagickFalse)
185  ThrowConjureException(ResourceLimitError,"MemoryAllocationFailed",
186  GetExceptionMessage(errno));
187  for (i=1; i < (ssize_t) argc; i++)
188  {
189  option=argv[i];
190  if (IsCommandOption(option) != MagickFalse)
191  {
192  if (LocaleCompare("concurrent",option+1) == 0)
193  break;
194  if (LocaleCompare("debug",option+1) == 0)
195  {
196  ssize_t
197  event;
198 
199  if (*option == '+')
200  break;
201  i++;
202  if (i == (ssize_t) argc)
203  ThrowConjureException(OptionError,"MissingArgument",option);
204  event=ParseCommandOption(MagickLogEventOptions,MagickFalse,argv[i]);
205  if (event < 0)
206  ThrowConjureException(OptionError,"UnrecognizedEventType",
207  argv[i]);
208  (void) SetLogEventMask(argv[i]);
209  continue;
210  }
211  if (LocaleCompare("duration",option+1) == 0)
212  {
213  if (*option == '+')
214  break;
215  i++;
216  if (i == (ssize_t) argc)
217  ThrowConjureException(OptionError,"MissingArgument",option);
218  if (IsGeometry(argv[i]) == MagickFalse)
219  ThrowConjureInvalidArgumentException(option,argv[i]);
220  continue;
221  }
222  if ((LocaleCompare("help",option+1) == 0) ||
223  (LocaleCompare("-help",option+1) == 0))
224  {
225  if (*option == '-')
226  {
227  DestroyConjure();
228  return(ConjureUsage());
229  }
230  continue;
231  }
232  if (LocaleCompare("log",option+1) == 0)
233  {
234  if (*option == '-')
235  {
236  i++;
237  if (i == (ssize_t) argc)
238  ThrowConjureException(OptionError,"MissingLogFormat",option);
239  (void) SetLogFormat(argv[i]);
240  }
241  continue;
242  }
243  if (LocaleCompare("monitor",option+1) == 0)
244  continue;
245  if (LocaleCompare("quiet",option+1) == 0)
246  continue;
247  if (LocaleCompare("regard-warnings",option+1) == 0)
248  break;
249  if (LocaleCompare("seed",option+1) == 0)
250  {
251  if (*option == '+')
252  break;
253  i++;
254  if (i == (ssize_t) argc)
255  ThrowConjureException(OptionError,"MissingArgument",option);
256  if (IsGeometry(argv[i]) == MagickFalse)
257  ThrowConjureInvalidArgumentException(option,argv[i]);
258  break;
259  }
260  if (LocaleCompare("verbose",option+1) == 0)
261  {
262  image_info->verbose=(*option == '-') ? MagickTrue : MagickFalse;
263  continue;
264  }
265  if ((LocaleCompare("version",option+1) == 0) ||
266  (LocaleCompare("-version",option+1) == 0))
267  {
268  ListMagickVersion(stdout);
269  return(MagickTrue);
270  }
271  /*
272  Persist key/value pair.
273  */
274  (void) DeleteImageOption(image_info,option+1);
275  i++;
276  if (i == argc)
277  ThrowConjureException(OptionError,"MissingArgument",option);
278  status=SetImageOption(image_info,option+1,argv[i]);
279  if (status == MagickFalse)
280  ThrowConjureException(ImageError,"UnableToPersistKey",option);
281  continue;
282  }
283  /*
284  Interpret MSL script.
285  */
286  (void) DeleteImageOption(image_info,"filename");
287  status=SetImageOption(image_info,"filename",argv[i]);
288  if (status == MagickFalse)
289  ThrowConjureException(ImageError,"UnableToPersistKey",argv[i]);
290  (void) FormatLocaleString(image_info->filename,MaxTextExtent,"%s",argv[i]);
291  (void) SetImageOption(image_info,"filename",argv[i]);
292  image=ReadImages(image_info,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 }