2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % M M PPPP EEEEE GGGG %
8 % M M M PPPP EEE G GG %
13 % Read/Write MPEG Image Format %
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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
41 #include "MagickCore/studio.h"
42 #include "MagickCore/blob.h"
43 #include "MagickCore/blob-private.h"
44 #include "MagickCore/constitute.h"
45 #include "MagickCore/delegate.h"
46 #include "MagickCore/exception.h"
47 #include "MagickCore/exception-private.h"
48 #include "MagickCore/geometry.h"
49 #include "MagickCore/image.h"
50 #include "MagickCore/image-private.h"
51 #include "MagickCore/layer.h"
52 #include "MagickCore/list.h"
53 #include "MagickCore/log.h"
54 #include "MagickCore/magick.h"
55 #include "MagickCore/memory_.h"
56 #include "MagickCore/resource_.h"
57 #include "MagickCore/quantum-private.h"
58 #include "MagickCore/static.h"
59 #include "MagickCore/string_.h"
60 #include "MagickCore/module.h"
61 #include "MagickCore/transform.h"
62 #include "MagickCore/utility.h"
63 #include "MagickCore/utility-private.h"
68 static MagickBooleanType
69 WriteMPEGImage(const ImageInfo *,Image *,ExceptionInfo *);
72 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
80 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
82 % IsAVI() returns MagickTrue if the image format type, identified by the
83 % magick string, is Audio/Video Interleaved file format.
85 % The format of the IsAVI method is:
87 % size_t IsAVI(const unsigned char *magick,const size_t length)
89 % A description of each parameter follows:
91 % o magick: compare image format pattern against these bytes.
93 % o length: Specifies the length of the magick string.
96 static MagickBooleanType IsAVI(const unsigned char *magick,const size_t length)
100 if (memcmp(magick,"RIFF",4) == 0)
106 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
114 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
116 % IsMPEG() returns MagickTrue if the image format type, identified by the
117 % magick string, is MPEG.
119 % The format of the IsMPEG method is:
121 % MagickBooleanType IsMPEG(const unsigned char *magick,const size_t length)
123 % A description of each parameter follows:
125 % o magick: compare image format pattern against these bytes.
127 % o length: Specifies the length of the magick string.
130 static MagickBooleanType IsMPEG(const unsigned char *magick,const size_t length)
134 if (memcmp(magick,"\000\000\001\263",4) == 0)
140 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
144 % R e a d M P E G I m a g e %
148 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
150 % ReadMPEGImage() reads an binary file in the MPEG video stream format
151 % and returns it. It allocates the memory necessary for the new Image
152 % structure and returns a pointer to the new image.
154 % The format of the ReadMPEGImage method is:
156 % Image *ReadMPEGImage(const ImageInfo *image_info,
157 % ExceptionInfo *exception)
159 % A description of each parameter follows:
161 % o image_info: the image info.
163 % o exception: return any errors or warnings in this structure.
166 static Image *ReadMPEGImage(const ImageInfo *image_info,
167 ExceptionInfo *exception)
169 #define ReadMPEGIntermediateFormat "pam"
184 assert(image_info != (const ImageInfo *) NULL);
185 assert(image_info->signature == MagickCoreSignature);
186 if (image_info->debug != MagickFalse)
187 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
188 image_info->filename);
189 assert(exception != (ExceptionInfo *) NULL);
190 assert(exception->signature == MagickCoreSignature);
191 image=AcquireImage(image_info,exception);
192 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
193 if (status == MagickFalse)
195 image=DestroyImageList(image);
196 return((Image *) NULL);
198 (void) CloseBlob(image);
199 (void) DestroyImageList(image);
201 Convert MPEG to PAM with delegate.
203 read_info=CloneImageInfo(image_info);
204 image=AcquireImage(image_info,exception);
205 (void) InvokeDelegate(read_info,image,"mpeg:decode",(char *) NULL,exception);
206 image=DestroyImage(image);
207 (void) FormatLocaleString(read_info->filename,MagickPathExtent,"%s.%s",
208 read_info->unique,ReadMPEGIntermediateFormat);
209 images=ReadImage(read_info,exception);
210 (void) RelinquishUniqueFileResource(read_info->filename);
211 read_info=DestroyImageInfo(read_info);
216 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
220 % R e g i s t e r M P E G I m a g e %
224 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
226 % RegisterMPEGImage() adds attributes for the MPEG image format to
227 % the list of supported formats. The attributes include the image format
228 % tag, a method to read and/or write the format, whether the format
229 % supports the saving of more than one frame to the same file or blob,
230 % whether the format supports native in-memory I/O, and a brief
231 % description of the format.
233 % The format of the RegisterMPEGImage method is:
235 % size_t RegisterMPEGImage(void)
238 ModuleExport size_t RegisterMPEGImage(void)
243 entry=AcquireMagickInfo("MPEG","3GP","Media Container");
244 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
245 entry->flags^=CoderBlobSupportFlag;
246 entry->flags|=CoderSeekableStreamFlag;
247 (void) RegisterMagickInfo(entry);
248 entry=AcquireMagickInfo("MPEG","3G2","Media Container");
249 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
250 entry->flags^=CoderBlobSupportFlag;
251 entry->flags|=CoderSeekableStreamFlag;
252 (void) RegisterMagickInfo(entry);
253 entry=AcquireMagickInfo("MPEG","AVI","Microsoft Audio/Visual Interleaved");
254 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
255 entry->magick=(IsImageFormatHandler *) IsAVI;
256 entry->flags^=CoderBlobSupportFlag;
257 entry->flags|=CoderSeekableStreamFlag;
258 (void) RegisterMagickInfo(entry);
259 entry=AcquireMagickInfo("MPEG","MKV","Multimedia Container");
260 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
261 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
262 entry->magick=(IsImageFormatHandler *) IsMPEG;
263 entry->flags^=CoderBlobSupportFlag;
264 entry->flags|=CoderSeekableStreamFlag;
265 (void) RegisterMagickInfo(entry);
266 entry=AcquireMagickInfo("MPEG","MOV","MPEG Video Stream");
267 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
268 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
269 entry->magick=(IsImageFormatHandler *) IsMPEG;
270 entry->flags^=CoderBlobSupportFlag;
271 entry->flags|=CoderSeekableStreamFlag;
272 (void) RegisterMagickInfo(entry);
273 entry=AcquireMagickInfo("MPEG","MPEG","MPEG Video Stream");
274 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
275 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
276 entry->magick=(IsImageFormatHandler *) IsMPEG;
277 entry->flags^=CoderBlobSupportFlag;
278 entry->flags|=CoderSeekableStreamFlag;
279 (void) RegisterMagickInfo(entry);
280 entry=AcquireMagickInfo("MPEG","MPG","MPEG Video Stream");
281 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
282 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
283 entry->magick=(IsImageFormatHandler *) IsMPEG;
284 entry->flags^=CoderBlobSupportFlag;
285 entry->flags|=CoderSeekableStreamFlag;
286 (void) RegisterMagickInfo(entry);
287 entry=AcquireMagickInfo("MPEG","MP4","MPEG-4 Video Stream");
288 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
289 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
290 entry->magick=(IsImageFormatHandler *) IsMPEG;
291 entry->flags^=CoderBlobSupportFlag;
292 entry->flags|=CoderSeekableStreamFlag;
293 (void) RegisterMagickInfo(entry);
294 entry=AcquireMagickInfo("MPEG","M2V","MPEG Video Stream");
295 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
296 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
297 entry->magick=(IsImageFormatHandler *) IsMPEG;
298 entry->flags^=CoderBlobSupportFlag;
299 entry->flags|=CoderSeekableStreamFlag;
300 (void) RegisterMagickInfo(entry);
301 entry=AcquireMagickInfo("MPEG","M4V","Raw MPEG-4 Video");
302 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
303 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
304 entry->magick=(IsImageFormatHandler *) IsMPEG;
305 entry->flags^=CoderBlobSupportFlag;
306 entry->flags|=CoderSeekableStreamFlag;
307 (void) RegisterMagickInfo(entry);
308 entry=AcquireMagickInfo("MPEG","WMV","Windows Media Video");
309 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
310 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
311 entry->magick=(IsImageFormatHandler *) IsMPEG;
312 entry->flags^=CoderBlobSupportFlag;
313 entry->flags|=CoderSeekableStreamFlag;
314 (void) RegisterMagickInfo(entry);
315 return(MagickImageCoderSignature);
319 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
323 % U n r e g i s t e r M P E G I m a g e %
327 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
329 % UnregisterMPEGImage() removes format registrations made by the
330 % BIM module from the list of supported formats.
332 % The format of the UnregisterBIMImage method is:
334 % UnregisterMPEGImage(void)
337 ModuleExport void UnregisterMPEGImage(void)
339 (void) UnregisterMagickInfo("WMV");
340 (void) UnregisterMagickInfo("MOV");
341 (void) UnregisterMagickInfo("M4V");
342 (void) UnregisterMagickInfo("M2V");
343 (void) UnregisterMagickInfo("MP4");
344 (void) UnregisterMagickInfo("MPG");
345 (void) UnregisterMagickInfo("MPEG");
346 (void) UnregisterMagickInfo("MKV");
347 (void) UnregisterMagickInfo("AVI");
348 (void) UnregisterMagickInfo("3G2");
349 (void) UnregisterMagickInfo("3GP");
353 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
357 % W r i t e M P E G I m a g e %
361 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
363 % WriteMPEGImage() writes an image to a file in MPEG video stream format.
364 % Lawrence Livermore National Laboratory (LLNL) contributed code to adjust
365 % the MPEG parameters to correspond to the compression quality setting.
367 % The format of the WriteMPEGImage method is:
369 % MagickBooleanType WriteMPEGImage(const ImageInfo *image_info,
370 % Image *image,ExceptionInfo *exception)
372 % A description of each parameter follows.
374 % o image_info: the image info.
376 % o image: The image.
378 % o exception: return any errors or warnings in this structure.
381 static MagickBooleanType CopyDelegateFile(const char *source,
382 const char *destination)
408 Return if destination file already exists and is not empty.
410 assert(source != (const char *) NULL);
411 assert(destination != (char *) NULL);
412 status=GetPathAttributes(destination,&attributes);
413 if ((status != MagickFalse) && (attributes.st_size > 0))
416 Copy source file to destination.
418 destination_file=open_utf8(destination,O_WRONLY | O_BINARY | O_CREAT,S_MODE);
419 if (destination_file == -1)
421 source_file=open_utf8(source,O_RDONLY | O_BINARY,0);
422 if (source_file == -1)
424 (void) close(destination_file);
427 quantum=(size_t) MagickMaxBufferExtent;
428 if ((fstat(source_file,&attributes) == 0) && (attributes.st_size > 0))
429 quantum=(size_t) MagickMin((double) attributes.st_size,
430 MagickMaxBufferExtent);
431 buffer=(unsigned char *) AcquireQuantumMemory(quantum,sizeof(*buffer));
432 if (buffer == (unsigned char *) NULL)
434 (void) close(source_file);
435 (void) close(destination_file);
439 for (i=0; ; i+=count)
441 count=(ssize_t) read(source_file,buffer,quantum);
444 length=(size_t) count;
445 count=(ssize_t) write(destination_file,buffer,length);
446 if ((size_t) count != length)
449 (void) close(destination_file);
450 (void) close(source_file);
451 buffer=(unsigned char *) RelinquishMagickMemory(buffer);
452 return(i != 0 ? MagickTrue : MagickFalse);
455 static MagickBooleanType WriteMPEGImage(const ImageInfo *image_info,
456 Image *image,ExceptionInfo *exception)
458 #define WriteMPEGIntermediateFormat "jpg"
461 basename[MagickPathExtent],
462 filename[MagickPathExtent];
494 Open output image file.
496 assert(image_info != (const ImageInfo *) NULL);
497 assert(image_info->signature == MagickCoreSignature);
498 assert(image != (Image *) NULL);
499 assert(image->signature == MagickCoreSignature);
500 if (image->debug != MagickFalse)
501 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
502 assert(exception != (ExceptionInfo *) NULL);
503 assert(exception->signature == MagickCoreSignature);
504 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
505 if (status == MagickFalse)
507 (void) CloseBlob(image);
509 Write intermediate files.
511 coalesce_image=CoalesceImages(image,exception);
512 if (coalesce_image == (Image *) NULL)
514 file=AcquireUniqueFileResource(basename);
517 (void) FormatLocaleString(coalesce_image->filename,MagickPathExtent,"%s",
520 write_info=CloneImageInfo(image_info);
521 *write_info->magick='\0';
522 for (p=coalesce_image; p != (Image *) NULL; p=GetNextImageInList(p))
525 previous_image[MagickPathExtent];
527 blob=(unsigned char *) NULL;
530 delay=100.0*p->delay/MagickMax(1.0*p->ticks_per_second,1.0);
531 for (i=0; i < (ssize_t) MagickMax((1.0*delay+1.0)/3.0,1.0); i++)
543 (void) FormatLocaleString(p->filename,MagickPathExtent,"%s%.20g.%s",
544 basename,(double) p->scene,WriteMPEGIntermediateFormat);
545 (void) FormatLocaleString(filename,MagickPathExtent,"%s%.20g.%s",
546 basename,(double) p->scene,WriteMPEGIntermediateFormat);
547 (void) FormatLocaleString(previous_image,MagickPathExtent,
548 "%s%.20g.%s",basename,(double) p->scene,
549 WriteMPEGIntermediateFormat);
550 frame=CloneImage(p,0,0,MagickTrue,exception);
551 if (frame == (Image *) NULL)
553 status=WriteImage(write_info,frame,exception);
554 frame=DestroyImage(frame);
559 blob=(unsigned char *) FileToBlob(previous_image,~0UL,&length,
564 (void) FormatLocaleString(filename,MagickPathExtent,"%s%.20g.%s",
565 basename,(double) p->scene,WriteMPEGIntermediateFormat);
567 status=BlobToFile(filename,blob,length,exception);
571 if (image->debug != MagickFalse)
573 if (status != MagickFalse)
574 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
575 "%.20g. Wrote %s file for scene %.20g:",(double) i,
576 WriteMPEGIntermediateFormat,(double) p->scene);
578 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
579 "%.20g. Failed to write %s file for scene %.20g:",(double) i,
580 WriteMPEGIntermediateFormat,(double) p->scene);
581 (void) LogMagickEvent(CoderEvent,GetMagickModule(),"%s",filename);
585 if (blob != (unsigned char *) NULL)
586 blob=(unsigned char *) RelinquishMagickMemory(blob);
587 if (status == MagickFalse)
591 Convert JPEG to MPEG.
593 (void) CopyMagickString(coalesce_image->magick_filename,basename,
595 (void) CopyMagickString(coalesce_image->filename,basename,MagickPathExtent);
596 GetPathComponent(image_info->filename,ExtensionPath,coalesce_image->magick);
597 if (*coalesce_image->magick == '\0')
598 (void) CopyMagickString(coalesce_image->magick,image->magick,MagickPathExtent);
599 status=InvokeDelegate(write_info,coalesce_image,(char *) NULL,"mpeg:encode",
601 (void) FormatLocaleString(write_info->filename,MagickPathExtent,"%s.%s",
602 write_info->unique,coalesce_image->magick);
603 status=CopyDelegateFile(write_info->filename,image->filename);
604 (void) RelinquishUniqueFileResource(write_info->filename);
605 write_info=DestroyImageInfo(write_info);
607 Relinquish resources.
610 for (p=coalesce_image; p != (Image *) NULL; p=GetNextImageInList(p))
612 delay=100.0*p->delay/MagickMax(1.0*p->ticks_per_second,1.0);
613 for (i=0; i < (ssize_t) MagickMax((1.0*delay+1.0)/3.0,1.0); i++)
615 (void) FormatLocaleString(p->filename,MagickPathExtent,"%s%.20g.%s",
616 basename,(double) count++,WriteMPEGIntermediateFormat);
617 (void) RelinquishUniqueFileResource(p->filename);
619 (void) CopyMagickString(p->filename,image_info->filename,MagickPathExtent);
621 (void) RelinquishUniqueFileResource(basename);
622 coalesce_image=DestroyImageList(coalesce_image);
623 if (image->debug != MagickFalse)
624 (void) LogMagickEvent(CoderEvent,GetMagickModule(),"exit");