2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % SSSSS TTTTT RRRR EEEEE AAA M M %
7 % SS T R R E A A MM MM %
8 % SSS T RRRR EEE AAAAA M M M %
10 % SSSSS T R R EEEEE A A M M %
13 % Stream Image to a Raw Image Format %
20 % Copyright 1999-2010 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 % Stream is a lightweight tool to stream one or more pixel components of the
37 % image or portion of the image to your choice of storage formats. It writes
38 % the pixel components as they are read from the input image a row at a time
39 % making stream desirable when working with large images or when you require
40 % raw pixel components.
47 #include "wand/studio.h"
48 #include "wand/MagickWand.h"
49 #include "wand/mogrify-private.h"
50 #include "magick/stream-private.h"
53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
57 % S t r e a m I m a g e C o m m a n d %
61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
63 % StreamImageCommand() is a lightweight method designed to extract pixels
64 % from large image files to a raw format using a minimum of system resources.
65 % The entire image or any regular portion of the image can be extracted.
67 % The format of the StreamImageCommand method is:
69 % MagickBooleanType StreamImageCommand(ImageInfo *image_info,int argc,
70 % char **argv,char **metadata,ExceptionInfo *exception)
72 % A description of each parameter follows:
74 % o image_info: the image info.
76 % o argc: the number of elements in the argument vector.
78 % o argv: A text array containing the command line arguments.
80 % o metadata: any metadata is returned here.
82 % o exception: return any errors or warnings in this structure.
87 static MagickBooleanType StreamUsage(void)
95 "-debug events display copious debugging information",
96 "-help print program options",
97 "-list type print a list of supported option arguments",
98 "-log format format of debugging information",
99 "-version print version information",
104 "-authenticate password",
105 " decipher image with this password",
106 "-channel type apply option to select image channels",
107 "-colorspace type alternate image colorspace",
108 "-compress type type of pixel compression when writing the image",
109 "-define format:option",
110 " define one or more image format options",
111 "-density geometry horizontal and vertical density of the image",
112 "-depth value image depth",
113 "-extract geometry extract area from image",
114 "-identify identify the format and characteristics of the image",
115 "-interlace type type of image interlacing scheme",
116 "-interpolate method pixel color interpolation method",
117 "-limit type value pixel cache resource limit",
118 "-map components one or more pixel components",
119 "-monitor monitor progress",
120 "-quantize colorspace reduce colors in this colorspace",
121 "-quiet suppress all warning messages",
122 "-regard-warnings pay attention to warning messages",
123 "-respect-parentheses settings remain in effect until parenthesis boundary",
124 "-sampling-factor geometry",
125 " horizontal and vertical sampling factor",
126 "-seed value seed a new sequence of pseudo-random numbers",
127 "-set attribute value set an image attribute",
128 "-size geometry width and height of image",
129 "-storage-type type pixel storage type",
130 "-transparent-color color",
131 " transparent color",
132 "-verbose print detailed information about the image",
133 "-virtual-pixel method",
134 " virtual pixel access method",
138 (void) printf("Version: %s\n",GetMagickVersion((size_t *) NULL));
139 (void) printf("Copyright: %s\n",GetMagickCopyright());
140 (void) printf("Features: %s\n\n",GetMagickFeatures());
141 (void) printf("Usage: %s [options ...] input-image raw-image\n",
143 (void) printf("\nImage Settings:\n");
144 for (p=settings; *p != (char *) NULL; p++)
145 (void) printf(" %s\n",*p);
146 (void) printf("\nMiscellaneous Options:\n");
147 for (p=miscellaneous; *p != (char *) NULL; p++)
148 (void) printf(" %s\n",*p);
150 "\nBy default, the image format of `file' is determined by its magic\n");
152 "number. To specify a particular image format, precede the filename\n");
154 "with an image format name and a colon (i.e. ps:image) or specify the\n");
156 "image type as the filename suffix (i.e. image.ps). Specify 'file' as\n");
157 (void) printf("'-' for standard input or output.\n");
161 WandExport MagickBooleanType StreamImageCommand(ImageInfo *image_info,
162 int argc,char **argv,char **metadata,ExceptionInfo *exception)
164 #define DestroyStream() \
166 DestroyImageStack(); \
167 stream_info=DestroyStreamInfo(stream_info); \
168 for (i=0; i < (ssize_t) argc; i++) \
169 argv[i]=DestroyString(argv[i]); \
170 argv=(char **) RelinquishMagickMemory(argv); \
172 #define ThrowStreamException(asperity,tag,option) \
174 (void) ThrowMagickException(exception,GetMagickModule(),asperity,tag,"`%s'", \
177 return(MagickFalse); \
179 #define ThrowStreamInvalidArgumentException(option,argument) \
181 (void) ThrowMagickException(exception,GetMagickModule(),OptionError, \
182 "InvalidArgument","`%s': %s",option,argument); \
184 return(MagickFalse); \
198 image_stack[MaxImageStackDepth+1];
220 assert(image_info != (ImageInfo *) NULL);
221 assert(image_info->signature == MagickSignature);
222 if (image_info->debug != MagickFalse)
223 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"...");
224 assert(exception != (ExceptionInfo *) NULL);
229 if ((LocaleCompare("version",option+1) == 0) ||
230 (LocaleCompare("-version",option+1) == 0))
232 (void) fprintf(stdout,"Version: %s\n",
233 GetMagickVersion((size_t *) NULL));
234 (void) fprintf(stdout,"Copyright: %s\n",GetMagickCopyright());
235 (void) fprintf(stdout,"Features: %s\n\n",GetMagickFeatures());
240 return(StreamUsage());
245 option=(char *) NULL;
247 stream_info=AcquireStreamInfo(image_info);
252 ReadCommandlLine(argc,&argv);
253 status=ExpandFilenames(&argc,&argv);
254 if (status == MagickFalse)
255 ThrowStreamException(ResourceLimitError,"MemoryAllocationFailed",
256 GetExceptionMessage(errno));
257 status=OpenStream(image_info,stream_info,argv[argc-1],exception);
258 if (status == MagickFalse)
263 for (i=1; i < (ssize_t) (argc-1); i++)
266 if (LocaleCompare(option,"(") == 0)
268 FireImageStack(MagickFalse,MagickTrue,pend);
269 if (k == MaxImageStackDepth)
270 ThrowStreamException(OptionError,"ParenthesisNestedTooDeeply",option);
274 if (LocaleCompare(option,")") == 0)
276 FireImageStack(MagickFalse,MagickTrue,MagickTrue);
278 ThrowStreamException(OptionError,"UnableToParseExpression",option);
282 if (IsMagickOption(option) == MagickFalse)
290 FireImageStack(MagickFalse,MagickFalse,pend);
292 if ((LocaleCompare(filename,"--") == 0) && (i < (ssize_t) (argc-1)))
294 (void) CopyMagickString(image_info->filename,filename,MaxTextExtent);
295 images=StreamImage(image_info,stream_info,exception);
296 status&=(images != (Image *) NULL) &&
297 (exception->severity < ErrorException);
298 if (images == (Image *) NULL)
300 AppendImageStack(images);
303 pend=image != (Image *) NULL ? MagickTrue : MagickFalse;
308 if (LocaleCompare("authenticate",option+1) == 0)
313 if (i == (ssize_t) (argc-1))
314 ThrowStreamException(OptionError,"MissingArgument",option);
317 ThrowStreamException(OptionError,"UnrecognizedOption",option)
321 if (LocaleCompare("cache",option+1) == 0)
326 if (i == (ssize_t) argc)
327 ThrowStreamException(OptionError,"MissingArgument",option);
328 if (IsGeometry(argv[i]) == MagickFalse)
329 ThrowStreamInvalidArgumentException(option,argv[i]);
332 if (LocaleCompare("channel",option+1) == 0)
340 if (i == (ssize_t) (argc-1))
341 ThrowStreamException(OptionError,"MissingArgument",option);
342 channel=ParseChannelOption(argv[i]);
344 ThrowStreamException(OptionError,"UnrecognizedChannelType",
348 if (LocaleCompare("colorspace",option+1) == 0)
356 if (i == (ssize_t) (argc-1))
357 ThrowStreamException(OptionError,"MissingArgument",option);
358 colorspace=ParseMagickOption(MagickColorspaceOptions,MagickFalse,
361 ThrowStreamException(OptionError,"UnrecognizedColorspace",
365 if (LocaleCompare("compress",option+1) == 0)
373 if (i == (ssize_t) (argc-1))
374 ThrowStreamException(OptionError,"MissingArgument",option);
375 compress=ParseMagickOption(MagickCompressOptions,MagickFalse,
378 ThrowStreamException(OptionError,"UnrecognizedImageCompression",
382 if (LocaleCompare("concurrent",option+1) == 0)
384 ThrowStreamException(OptionError,"UnrecognizedOption",option)
388 if (LocaleCompare("debug",option+1) == 0)
396 if (i == (ssize_t) argc)
397 ThrowStreamException(OptionError,"MissingArgument",option);
398 event=ParseMagickOption(MagickLogEventOptions,MagickFalse,argv[i]);
400 ThrowStreamException(OptionError,"UnrecognizedEventType",argv[i]);
401 (void) SetLogEventMask(argv[i]);
404 if (LocaleCompare("define",option+1) == 0)
407 if (i == (ssize_t) argc)
408 ThrowStreamException(OptionError,"MissingArgument",option);
414 define=GetImageOption(image_info,argv[i]);
415 if (define == (const char *) NULL)
416 ThrowStreamException(OptionError,"NoSuchOption",argv[i]);
421 if (LocaleCompare("density",option+1) == 0)
426 if (i == (ssize_t) argc)
427 ThrowStreamException(OptionError,"MissingArgument",option);
428 if (IsGeometry(argv[i]) == MagickFalse)
429 ThrowStreamInvalidArgumentException(option,argv[i]);
432 if (LocaleCompare("depth",option+1) == 0)
437 if (i == (ssize_t) argc)
438 ThrowStreamException(OptionError,"MissingArgument",option);
439 if (IsGeometry(argv[i]) == MagickFalse)
440 ThrowStreamInvalidArgumentException(option,argv[i]);
443 if (LocaleCompare("duration",option+1) == 0)
448 if (i == (ssize_t) (argc-1))
449 ThrowStreamException(OptionError,"MissingArgument",option);
450 if (IsGeometry(argv[i]) == MagickFalse)
451 ThrowStreamInvalidArgumentException(option,argv[i]);
454 ThrowStreamException(OptionError,"UnrecognizedOption",option)
458 if (LocaleCompare("extract",option+1) == 0)
463 if (i == (ssize_t) (argc-1))
464 ThrowStreamException(OptionError,"MissingArgument",option);
465 if (IsGeometry(argv[i]) == MagickFalse)
466 ThrowStreamInvalidArgumentException(option,argv[i]);
469 ThrowStreamException(OptionError,"UnrecognizedOption",option)
473 if ((LocaleCompare("help",option+1) == 0) ||
474 (LocaleCompare("-help",option+1) == 0))
475 return(StreamUsage());
476 ThrowStreamException(OptionError,"UnrecognizedOption",option)
480 if (LocaleCompare("identify",option+1) == 0)
482 if (LocaleCompare("interlace",option+1) == 0)
490 if (i == (ssize_t) argc)
491 ThrowStreamException(OptionError,"MissingArgument",option);
492 interlace=ParseMagickOption(MagickInterlaceOptions,MagickFalse,
495 ThrowStreamException(OptionError,"UnrecognizedInterlaceType",
499 if (LocaleCompare("interpolate",option+1) == 0)
507 if (i == (ssize_t) argc)
508 ThrowStreamException(OptionError,"MissingArgument",option);
509 interpolate=ParseMagickOption(MagickInterpolateOptions,MagickFalse,
512 ThrowStreamException(OptionError,"UnrecognizedInterpolateMethod",
516 ThrowStreamException(OptionError,"UnrecognizedOption",option)
520 if (LocaleCompare("limit",option+1) == 0)
534 if (i == (ssize_t) argc)
535 ThrowStreamException(OptionError,"MissingArgument",option);
536 resource=ParseMagickOption(MagickResourceOptions,MagickFalse,
539 ThrowStreamException(OptionError,"UnrecognizedResourceType",
542 if (i == (ssize_t) argc)
543 ThrowStreamException(OptionError,"MissingArgument",option);
544 value=strtod(argv[i],&p);
545 if ((p == argv[i]) && (LocaleCompare("unlimited",argv[i]) != 0))
546 ThrowStreamInvalidArgumentException(option,argv[i]);
549 if (LocaleCompare("list",option+1) == 0)
557 if (i == (ssize_t) argc)
558 ThrowStreamException(OptionError,"MissingArgument",option);
559 list=ParseMagickOption(MagickListOptions,MagickFalse,argv[i]);
561 ThrowStreamException(OptionError,"UnrecognizedListType",argv[i]);
562 status=MogrifyImageInfo(image_info,(int) (i-j+1),(const char **)
565 return(status != 0 ? MagickFalse : MagickTrue);
567 if (LocaleCompare("log",option+1) == 0)
572 if ((i == (ssize_t) argc) || (strchr(argv[i],'%') == (char *) NULL))
573 ThrowStreamException(OptionError,"MissingArgument",option);
576 ThrowStreamException(OptionError,"UnrecognizedOption",option)
580 if (LocaleCompare("map",option+1) == 0)
582 (void) CopyMagickString(argv[i]+1,"san",MaxTextExtent);
586 SetStreamInfoMap(stream_info,argv[i]);
589 if (LocaleCompare("monitor",option+1) == 0)
591 ThrowStreamException(OptionError,"UnrecognizedOption",option)
595 if (LocaleCompare("quantize",option+1) == 0)
603 if (i == (ssize_t) (argc-1))
604 ThrowStreamException(OptionError,"MissingArgument",option);
605 colorspace=ParseMagickOption(MagickColorspaceOptions,
606 MagickFalse,argv[i]);
608 ThrowStreamException(OptionError,"UnrecognizedColorspace",
612 if (LocaleCompare("quiet",option+1) == 0)
614 ThrowStreamException(OptionError,"UnrecognizedOption",option)
618 if (LocaleCompare("regard-warnings",option+1) == 0)
620 if (LocaleNCompare("respect-parentheses",option+1,17) == 0)
622 respect_parenthesis=(*option == '-') ? MagickTrue : MagickFalse;
625 ThrowStreamException(OptionError,"UnrecognizedOption",option)
629 if (LocaleCompare("sampling-factor",option+1) == 0)
634 if (i == (ssize_t) argc)
635 ThrowStreamException(OptionError,"MissingArgument",option);
636 if (IsGeometry(argv[i]) == MagickFalse)
637 ThrowStreamInvalidArgumentException(option,argv[i]);
640 if (LocaleCompare("seed",option+1) == 0)
645 if (i == (ssize_t) (argc-1))
646 ThrowStreamException(OptionError,"MissingArgument",option);
647 if (IsGeometry(argv[i]) == MagickFalse)
648 ThrowStreamInvalidArgumentException(option,argv[i]);
651 if (LocaleCompare("set",option+1) == 0)
654 if (i == (ssize_t) argc)
655 ThrowStreamException(OptionError,"MissingArgument",option);
659 if (i == (ssize_t) argc)
660 ThrowStreamException(OptionError,"MissingArgument",option);
663 if (LocaleCompare("size",option+1) == 0)
668 if (i == (ssize_t) argc)
669 ThrowStreamException(OptionError,"MissingArgument",option);
670 if (IsGeometry(argv[i]) == MagickFalse)
671 ThrowStreamInvalidArgumentException(option,argv[i]);
674 if (LocaleCompare("storage-type",option+1) == 0)
682 if (i == (ssize_t) (argc-1))
683 ThrowStreamException(OptionError,"MissingArgument",option);
684 type=ParseMagickOption(MagickStorageOptions,MagickFalse,argv[i]);
686 ThrowStreamException(OptionError,"UnrecognizedStorageType",
688 SetStreamInfoStorageType(stream_info,(StorageType) type);
691 ThrowStreamException(OptionError,"UnrecognizedOption",option)
695 if (LocaleCompare("transparent-color",option+1) == 0)
700 if (i == (ssize_t) (argc-1))
701 ThrowStreamException(OptionError,"MissingArgument",option);
704 ThrowStreamException(OptionError,"UnrecognizedOption",option)
708 if (LocaleCompare("verbose",option+1) == 0)
710 if ((LocaleCompare("version",option+1) == 0) ||
711 (LocaleCompare("-version",option+1) == 0))
713 (void) fprintf(stdout,"Version: %s\n",
714 GetMagickVersion((size_t *) NULL));
715 (void) fprintf(stdout,"Copyright: %s\n",GetMagickCopyright());
716 (void) fprintf(stdout,"Features: %s\n\n",GetMagickFeatures());
719 if (LocaleCompare("virtual-pixel",option+1) == 0)
727 if (i == (ssize_t) (argc-1))
728 ThrowStreamException(OptionError,"MissingArgument",option);
729 method=ParseMagickOption(MagickVirtualPixelOptions,MagickFalse,
732 ThrowStreamException(OptionError,
733 "UnrecognizedVirtualPixelMethod",argv[i]);
736 ThrowStreamException(OptionError,"UnrecognizedOption",option)
741 ThrowStreamException(OptionError,"UnrecognizedOption",option)
743 fire=ParseMagickOption(MagickImageListOptions,MagickFalse,option+1) < 0 ?
744 MagickFalse : MagickTrue;
745 if (fire != MagickFalse)
746 FireImageStack(MagickFalse,MagickTrue,MagickTrue);
749 ThrowStreamException(OptionError,"UnbalancedParenthesis",argv[i]);
750 if (i-- != (ssize_t) (argc-1))
751 ThrowStreamException(OptionError,"MissingAnImageFilename",argv[i]);
752 if (image == (Image *) NULL)
753 ThrowStreamException(OptionError,"MissingAnImageFilename",argv[i]);
754 FinalizeImageSettings(image_info,image,MagickTrue);
755 if (image == (Image *) NULL)
756 ThrowStreamException(OptionError,"MissingAnImageFilename",argv[i]);
758 return(status != 0 ? MagickTrue : MagickFalse);