2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % IIIII DDDD EEEEE N N TTTTT IIIII FFFFF Y Y %
7 % I D D E NN N T I F Y Y %
8 % I D D EEE N N N T I FFF Y %
9 % I D D E N NN T I F Y %
10 % IIIII DDDD EEEEE N N T IIIII F Y %
13 % Identify an Image Format and Characteristics. %
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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
36 % The identify program describes the format and characteristics of one or more
37 % image files. It also reports if an image is incomplete or corrupt. The
38 % information returned includes the image number, the file name, the width and
39 % height of the image, whether the image is colormapped or not, the number of
40 % colors in the image, the number of bytes in the image, the format of the
41 % image (JPEG, PNM, etc.), and finally the number of seconds it took to read
42 % and process the image. Many more attributes are available with the verbose
50 #include "MagickWand/studio.h"
51 #include "MagickWand/MagickWand.h"
52 #include "MagickWand/mogrify-private.h"
53 #include "MagickCore/string-private.h"
56 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
60 + I d e n t i f y I m a g e C o m m a n d %
64 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
66 % IdentifyImageCommand() describes the format and characteristics of one or
67 % more image files. It will also report if an image is incomplete or corrupt.
68 % The information displayed includes the scene number, the file name, the
69 % width and height of the image, whether the image is colormapped or not,
70 % the number of colors in the image, the number of bytes in the image, the
71 % format of the image (JPEG, PNM, etc.), and finally the number of seconds
72 % it took to read and process the image.
74 % The format of the IdentifyImageCommand method is:
76 % MagickBooleanType IdentifyImageCommand(ImageInfo *image_info,int argc,
77 % char **argv,char **metadata,ExceptionInfo *exception)
79 % A description of each parameter follows:
81 % o image_info: the image info.
83 % o argc: the number of elements in the argument vector.
85 % o argv: A text array containing the command line arguments.
87 % o metadata: any metadata is returned here.
89 % o exception: return any errors or warnings in this structure.
93 static MagickBooleanType IdentifyUsage(void)
101 "-debug events display copious debugging information",
102 "-help print program options",
103 "-list type print a list of supported option arguments",
104 "-log format format of debugging information",
105 "-version print version information",
110 "-grayscale method convert image to grayscale",
111 "-negate replace every pixel with its complementary color ",
116 "-alpha option on, activate, off, deactivate, set, opaque, copy",
117 " transparent, extract, background, or shape",
118 "-antialias remove pixel-aliasing",
119 "-authenticate password",
120 " decipher image with this password",
121 "-channel type apply option to select image channels",
122 "-clip clip along the first path from the 8BIM profile",
123 "-clip-mask filename associate a clip mask with the image",
124 "-clip-path id clip along a named path from the 8BIM profile",
125 "-colorspace type alternate image colorspace",
126 "-crop geometry cut out a rectangular region of the image",
127 "-define format:option",
128 " define one or more image format options",
129 "-density geometry horizontal and vertical density of the image",
130 "-depth value image depth",
131 "-endian type endianness (MSB or LSB) of the image",
132 "-extract geometry extract area from image",
133 "-features distance analyze image features (e.g. contrast, correlation)",
134 "-format \"string\" output formatted image characteristics",
135 "-fuzz distance colors within this distance are considered equal",
136 "-gamma value of gamma correction",
137 "-interlace type type of image interlacing scheme",
138 "-interpolate method pixel color interpolation method",
139 "-limit type value pixel cache resource limit",
140 "-mask filename associate a mask with the image",
141 "-matte store matte channel if the image has one",
142 "-monitor monitor progress",
143 "-ping efficiently determine image attributes",
144 "-precision value maximum number of significant digits to print",
145 "-quiet suppress all warning messages",
146 "-regard-warnings pay attention to warning messages",
147 "-respect-parentheses settings remain in effect until parenthesis boundary",
148 "-sampling-factor geometry",
149 " horizontal and vertical sampling factor",
150 "-seed value seed a new sequence of pseudo-random numbers",
151 "-set attribute value set an image attribute",
152 "-size geometry width and height of image",
153 "-strip strip image of all profiles and comments",
154 "-unique display the number of unique colors in the image",
155 "-units type the units of image resolution",
156 "-verbose print detailed information about the image",
157 "-virtual-pixel method",
158 " virtual pixel access method",
162 ListMagickVersion(stdout);
163 (void) printf("Usage: %s [options ...] file [ [options ...] "
164 "file ... ]\n",GetClientName());
165 (void) printf("\nImage Settings:\n");
166 for (p=settings; *p != (char *) NULL; p++)
167 (void) printf(" %s\n",*p);
168 (void) printf("\nImage Operators:\n");
169 for (p=operators; *p != (char *) NULL; p++)
170 (void) printf(" %s\n",*p);
171 (void) printf("\nMiscellaneous Options:\n");
172 for (p=miscellaneous; *p != (char *) NULL; p++)
173 (void) printf(" %s\n",*p);
175 "\nBy default, the image format of 'file' is determined by its magic\n");
177 "number. To specify a particular image format, precede the filename\n");
179 "with an image format name and a colon (i.e. ps:image) or specify the\n");
181 "image type as the filename suffix (i.e. image.ps). Specify 'file' as\n");
182 (void) printf("'-' for standard input or output.\n");
186 WandExport MagickBooleanType IdentifyImageCommand(ImageInfo *image_info,
187 int argc,char **argv,char **metadata,ExceptionInfo *exception)
189 #define DestroyIdentify() \
191 DestroyImageStack(); \
192 for (i=0; i < (ssize_t) argc; i++) \
193 argv[i]=DestroyString(argv[i]); \
194 argv=(char **) RelinquishMagickMemory(argv); \
196 #define ThrowIdentifyException(asperity,tag,option) \
198 (void) ThrowMagickException(exception,GetMagickModule(),asperity,tag,"`%s'", \
201 return(MagickFalse); \
203 #define ThrowIdentifyInvalidArgumentException(option,argument) \
205 (void) ThrowMagickException(exception,GetMagickModule(),OptionError, \
206 "InvalidArgument","'%s': %s",option,argument); \
208 return(MagickFalse); \
219 image_stack[MaxImageStackDepth+1];
242 assert(image_info != (ImageInfo *) NULL);
243 assert(image_info->signature == MagickSignature);
244 if (image_info->debug != MagickFalse)
245 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
246 assert(exception != (ExceptionInfo *) NULL);
250 if ((LocaleCompare("version",option+1) == 0) ||
251 (LocaleCompare("-version",option+1) == 0))
253 ListMagickVersion(stdout);
258 return(IdentifyUsage());
264 option=(char *) NULL;
266 respect_parenthesis=MagickFalse;
271 ReadCommandlLine(argc,&argv);
272 status=ExpandFilenames(&argc,&argv);
273 if (status == MagickFalse)
274 ThrowIdentifyException(ResourceLimitError,"MemoryAllocationFailed",
275 GetExceptionMessage(errno));
276 image_info->ping=MagickTrue;
277 for (i=1; i < (ssize_t) argc; i++)
280 if (LocaleCompare(option,"(") == 0)
282 FireImageStack(MagickFalse,MagickTrue,pend);
283 if (k == MaxImageStackDepth)
284 ThrowIdentifyException(OptionError,"ParenthesisNestedTooDeeply",
289 if (LocaleCompare(option,")") == 0)
291 FireImageStack(MagickFalse,MagickTrue,MagickTrue);
293 ThrowIdentifyException(OptionError,"UnableToParseExpression",option);
297 if (IsCommandOption(option) == MagickFalse)
311 FireImageStack(MagickFalse,MagickFalse,pend);
312 identify_info=CloneImageInfo(image_info);
313 identify_info->verbose=MagickFalse;
315 if ((LocaleCompare(filename,"--") == 0) && (i < (ssize_t) (argc-1)))
317 if (identify_info->ping != MagickFalse)
318 images=PingImages(identify_info,filename,exception);
320 images=ReadImages(identify_info,filename,exception);
321 identify_info=DestroyImageInfo(identify_info);
322 status&=(images != (Image *) NULL) &&
323 (exception->severity < ErrorException);
324 if (images == (Image *) NULL)
326 AppendImageStack(images);
327 FinalizeImageSettings(image_info,image,MagickFalse);
328 for ( ; image != (Image *) NULL; image=GetNextImageInList(image))
330 if (image->scene == 0)
331 image->scene=count++;
332 if (format == (char *) NULL)
334 (void) IdentifyImage(image,stdout,image_info->verbose,exception);
337 if (metadata != (char **) NULL)
342 text=InterpretImageProperties(image_info,image,format,exception);
343 if (text == (char *) NULL)
344 ThrowIdentifyException(ResourceLimitError,
345 "MemoryAllocationFailed",GetExceptionMessage(errno));
346 (void) ConcatenateString(&(*metadata),text);
347 text=DestroyString(text);
348 if (LocaleCompare(format,"%n") == 0)
352 RemoveAllImageStack();
355 pend=image != (Image *) NULL ? MagickTrue : MagickFalse;
360 if (LocaleCompare("alpha",option+1) == 0)
368 if (i == (ssize_t) argc)
369 ThrowIdentifyException(OptionError,"MissingArgument",option);
370 type=ParseCommandOption(MagickAlphaChannelOptions,MagickFalse,
373 ThrowIdentifyException(OptionError,
374 "UnrecognizedAlphaChannelOption",argv[i]);
377 if (LocaleCompare("antialias",option+1) == 0)
379 if (LocaleCompare("authenticate",option+1) == 0)
384 if (i == (ssize_t) (argc-1))
385 ThrowIdentifyException(OptionError,"MissingArgument",option);
388 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
392 if (LocaleCompare("cache",option+1) == 0)
397 if (i == (ssize_t) argc)
398 ThrowIdentifyException(OptionError,"MissingArgument",option);
399 if (IsGeometry(argv[i]) == MagickFalse)
400 ThrowIdentifyInvalidArgumentException(option,argv[i]);
403 if (LocaleCompare("channel",option+1) == 0)
411 if (i == (ssize_t) (argc-1))
412 ThrowIdentifyException(OptionError,"MissingArgument",option);
413 channel=ParseChannelOption(argv[i]);
415 ThrowIdentifyException(OptionError,"UnrecognizedChannelType",
419 if (LocaleCompare("clip",option+1) == 0)
421 if (LocaleCompare("clip-mask",option+1) == 0)
426 if (i == (ssize_t) (argc-1))
427 ThrowIdentifyException(OptionError,"MissingArgument",option);
430 if (LocaleCompare("clip-path",option+1) == 0)
433 if (i == (ssize_t) (argc-1))
434 ThrowIdentifyException(OptionError,"MissingArgument",option);
437 if (LocaleCompare("colorspace",option+1) == 0)
445 if (i == (ssize_t) (argc-1))
446 ThrowIdentifyException(OptionError,"MissingArgument",option);
447 colorspace=ParseCommandOption(MagickColorspaceOptions,
448 MagickFalse,argv[i]);
450 ThrowIdentifyException(OptionError,"UnrecognizedColorspace",
454 if (LocaleCompare("crop",option+1) == 0)
459 if (i == (ssize_t) (argc-1))
460 ThrowIdentifyException(OptionError,"MissingArgument",option);
461 if (IsGeometry(argv[i]) == MagickFalse)
462 ThrowIdentifyInvalidArgumentException(option,argv[i]);
463 image_info->ping=MagickFalse;
466 if (LocaleCompare("concurrent",option+1) == 0)
468 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
472 if (LocaleCompare("debug",option+1) == 0)
480 if (i == (ssize_t) argc)
481 ThrowIdentifyException(OptionError,"MissingArgument",option);
482 event=ParseCommandOption(MagickLogEventOptions,MagickFalse,argv[i]);
484 ThrowIdentifyException(OptionError,"UnrecognizedEventType",
486 (void) SetLogEventMask(argv[i]);
489 if (LocaleCompare("define",option+1) == 0)
492 if (i == (ssize_t) argc)
493 ThrowIdentifyException(OptionError,"MissingArgument",option);
499 define=GetImageOption(image_info,argv[i]);
500 if (define == (const char *) NULL)
501 ThrowIdentifyException(OptionError,"NoSuchOption",argv[i]);
504 if (LocaleNCompare("identify:locate",argv[i],14) == 0)
505 image_info->ping=MagickFalse;
508 if (LocaleCompare("density",option+1) == 0)
513 if (i == (ssize_t) argc)
514 ThrowIdentifyException(OptionError,"MissingArgument",option);
515 if (IsGeometry(argv[i]) == MagickFalse)
516 ThrowIdentifyInvalidArgumentException(option,argv[i]);
519 if (LocaleCompare("depth",option+1) == 0)
524 if (i == (ssize_t) argc)
525 ThrowIdentifyException(OptionError,"MissingArgument",option);
526 if (IsGeometry(argv[i]) == MagickFalse)
527 ThrowIdentifyInvalidArgumentException(option,argv[i]);
530 if (LocaleCompare("duration",option+1) == 0)
535 if (i == (ssize_t) (argc-1))
536 ThrowIdentifyException(OptionError,"MissingArgument",option);
537 if (IsGeometry(argv[i]) == MagickFalse)
538 ThrowIdentifyInvalidArgumentException(option,argv[i]);
541 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
545 if (LocaleCompare("endian",option+1) == 0)
553 if (i == (ssize_t) (argc-1))
554 ThrowIdentifyException(OptionError,"MissingArgument",option);
555 endian=ParseCommandOption(MagickEndianOptions,MagickFalse,
558 ThrowIdentifyException(OptionError,"UnrecognizedEndianType",
562 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
566 if (LocaleCompare("features",option+1) == 0)
571 if (i == (ssize_t) (argc-1))
572 ThrowIdentifyException(OptionError,"MissingArgument",option);
573 if (IsGeometry(argv[i]) == MagickFalse)
574 ThrowIdentifyInvalidArgumentException(option,argv[i]);
577 if (LocaleCompare("format",option+1) == 0)
579 format=(char *) NULL;
583 if (i == (ssize_t) argc)
584 ThrowIdentifyException(OptionError,"MissingArgument",option);
588 if (LocaleCompare("fuzz",option+1) == 0)
593 if (i == (ssize_t) (argc-1))
594 ThrowIdentifyException(OptionError,"MissingArgument",option);
595 if (IsGeometry(argv[i]) == MagickFalse)
596 ThrowIdentifyInvalidArgumentException(option,argv[i]);
599 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
603 if (LocaleCompare("gamma",option+1) == 0)
606 if (i == (ssize_t) (argc-1))
607 ThrowIdentifyException(OptionError,"MissingArgument",option);
608 if (IsGeometry(argv[i]) == MagickFalse)
609 ThrowIdentifyInvalidArgumentException(option,argv[i]);
612 if (LocaleCompare("grayscale",option+1) == 0)
620 if (i == (ssize_t) (argc-1))
621 ThrowIdentifyException(OptionError,"MissingArgument",option);
622 method=ParseCommandOption(MagickPixelIntensityOptions,MagickFalse,
625 ThrowIdentifyException(OptionError,"UnrecognizedIntensityMethod",
629 if (LocaleCompare("green-primary",option+1) == 0)
634 if (i == (ssize_t) (argc-1))
635 ThrowIdentifyException(OptionError,"MissingArgument",option);
636 if (IsGeometry(argv[i]) == MagickFalse)
637 ThrowIdentifyInvalidArgumentException(option,argv[i]);
640 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
644 if ((LocaleCompare("help",option+1) == 0) ||
645 (LocaleCompare("-help",option+1) == 0))
646 return(IdentifyUsage());
647 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
651 if (LocaleCompare("interlace",option+1) == 0)
659 if (i == (ssize_t) argc)
660 ThrowIdentifyException(OptionError,"MissingArgument",option);
661 interlace=ParseCommandOption(MagickInterlaceOptions,MagickFalse,
664 ThrowIdentifyException(OptionError,
665 "UnrecognizedInterlaceType",argv[i]);
668 if (LocaleCompare("interpolate",option+1) == 0)
676 if (i == (ssize_t) argc)
677 ThrowIdentifyException(OptionError,"MissingArgument",option);
678 interpolate=ParseCommandOption(MagickInterpolateOptions,MagickFalse,
681 ThrowIdentifyException(OptionError,
682 "UnrecognizedInterpolateMethod",argv[i]);
685 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
689 if (LocaleCompare("limit",option+1) == 0)
703 if (i == (ssize_t) argc)
704 ThrowIdentifyException(OptionError,"MissingArgument",option);
705 resource=ParseCommandOption(MagickResourceOptions,MagickFalse,
708 ThrowIdentifyException(OptionError,"UnrecognizedResourceType",
711 if (i == (ssize_t) argc)
712 ThrowIdentifyException(OptionError,"MissingArgument",option);
713 value=StringToDouble(argv[i],&p);
715 if ((p == argv[i]) && (LocaleCompare("unlimited",argv[i]) != 0))
716 ThrowIdentifyInvalidArgumentException(option,argv[i]);
719 if (LocaleCompare("list",option+1) == 0)
727 if (i == (ssize_t) argc)
728 ThrowIdentifyException(OptionError,"MissingArgument",option);
729 list=ParseCommandOption(MagickListOptions,MagickFalse,argv[i]);
731 ThrowIdentifyException(OptionError,"UnrecognizedListType",
733 status=MogrifyImageInfo(image_info,(int) (i-j+1),(const char **)
736 return(status != 0 ? MagickFalse : MagickTrue);
738 if (LocaleCompare("log",option+1) == 0)
743 if ((i == (ssize_t) argc) ||
744 (strchr(argv[i],'%') == (char *) NULL))
745 ThrowIdentifyException(OptionError,"MissingArgument",option);
748 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
752 if (LocaleCompare("mask",option+1) == 0)
757 if (i == (ssize_t) (argc-1))
758 ThrowIdentifyException(OptionError,"MissingArgument",option);
761 if (LocaleCompare("matte",option+1) == 0)
763 if (LocaleCompare("monitor",option+1) == 0)
765 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
769 if (LocaleCompare("negate",option+1) == 0)
771 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
775 if (LocaleCompare("ping",option+1) == 0)
777 if (LocaleCompare("precision",option+1) == 0)
782 if (i == (ssize_t) (argc-1))
783 ThrowIdentifyException(OptionError,"MissingArgument",option);
784 if (IsGeometry(argv[i]) == MagickFalse)
785 ThrowIdentifyInvalidArgumentException(option,argv[i]);
788 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
792 if (LocaleCompare("quiet",option+1) == 0)
794 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
798 if (LocaleCompare("regard-warnings",option+1) == 0)
800 if (LocaleNCompare("respect-parentheses",option+1,17) == 0)
802 respect_parenthesis=(*option == '-') ? MagickTrue : MagickFalse;
805 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
809 if (LocaleCompare("sampling-factor",option+1) == 0)
814 if (i == (ssize_t) argc)
815 ThrowIdentifyException(OptionError,"MissingArgument",option);
816 if (IsGeometry(argv[i]) == MagickFalse)
817 ThrowIdentifyInvalidArgumentException(option,argv[i]);
820 if (LocaleCompare("seed",option+1) == 0)
825 if (i == (ssize_t) (argc-1))
826 ThrowIdentifyException(OptionError,"MissingArgument",option);
827 if (IsGeometry(argv[i]) == MagickFalse)
828 ThrowIdentifyInvalidArgumentException(option,argv[i]);
831 if (LocaleCompare("set",option+1) == 0)
834 if (i == (ssize_t) argc)
835 ThrowIdentifyException(OptionError,"MissingArgument",option);
839 if (i == (ssize_t) argc)
840 ThrowIdentifyException(OptionError,"MissingArgument",option);
843 if (LocaleCompare("size",option+1) == 0)
848 if (i == (ssize_t) argc)
849 ThrowIdentifyException(OptionError,"MissingArgument",option);
850 if (IsGeometry(argv[i]) == MagickFalse)
851 ThrowIdentifyInvalidArgumentException(option,argv[i]);
854 if (LocaleCompare("strip",option+1) == 0)
856 if (LocaleCompare("support",option+1) == 0)
861 if (i == (ssize_t) argc)
862 ThrowIdentifyException(OptionError,"MissingArgument",option);
863 if (IsGeometry(argv[i]) == MagickFalse)
864 ThrowIdentifyInvalidArgumentException(option,argv[i]);
867 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
871 if (LocaleCompare("unique",option+1) == 0)
873 if (LocaleCompare("units",option+1) == 0)
881 if (i == (ssize_t) (argc-1))
882 ThrowIdentifyException(OptionError,"MissingArgument",option);
883 units=ParseCommandOption(MagickResolutionOptions,MagickFalse,
886 ThrowIdentifyException(OptionError,"UnrecognizedUnitsType",
890 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
894 if (LocaleCompare("verbose",option+1) == 0)
896 if (LocaleCompare("virtual-pixel",option+1) == 0)
904 if (i == (ssize_t) (argc-1))
905 ThrowIdentifyException(OptionError,"MissingArgument",option);
906 method=ParseCommandOption(MagickVirtualPixelOptions,MagickFalse,
909 ThrowIdentifyException(OptionError,
910 "UnrecognizedVirtualPixelMethod",argv[i]);
913 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
918 ThrowIdentifyException(OptionError,"UnrecognizedOption",option)
920 fire=(GetCommandOptionFlags(MagickCommandOptions,MagickFalse,option) &
921 FireOptionFlag) == 0 ? MagickFalse : MagickTrue;
922 if (fire != MagickFalse)
923 FireImageStack(MagickFalse,MagickTrue,MagickTrue);
926 ThrowIdentifyException(OptionError,"UnbalancedParenthesis",argv[i]);
927 if (i != (ssize_t) argc)
928 ThrowIdentifyException(OptionError,"MissingAnImageFilename",argv[i]);
930 return(status != 0 ? MagickTrue : MagickFalse);