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","AVI","Microsoft Audio/Visual Interleaved");
244 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
245 entry->magick=(IsImageFormatHandler *) IsAVI;
246 entry->flags^=CoderBlobSupportFlag;
247 entry->flags|=CoderSeekableStreamFlag;
248 (void) RegisterMagickInfo(entry);
249 entry=AcquireMagickInfo("MPEG","MKV","Multimedia Container");
250 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
251 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
252 entry->magick=(IsImageFormatHandler *) IsMPEG;
253 entry->flags^=CoderBlobSupportFlag;
254 entry->flags|=CoderSeekableStreamFlag;
255 (void) RegisterMagickInfo(entry);
256 entry=AcquireMagickInfo("MPEG","MOV","MPEG Video Stream");
257 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
258 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
259 entry->magick=(IsImageFormatHandler *) IsMPEG;
260 entry->flags^=CoderBlobSupportFlag;
261 entry->flags|=CoderSeekableStreamFlag;
262 (void) RegisterMagickInfo(entry);
263 entry=AcquireMagickInfo("MPEG","MPEG","MPEG Video Stream");
264 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
265 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
266 entry->magick=(IsImageFormatHandler *) IsMPEG;
267 entry->flags^=CoderBlobSupportFlag;
268 entry->flags|=CoderSeekableStreamFlag;
269 (void) RegisterMagickInfo(entry);
270 entry=AcquireMagickInfo("MPEG","MPG","MPEG Video Stream");
271 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
272 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
273 entry->magick=(IsImageFormatHandler *) IsMPEG;
274 entry->flags^=CoderBlobSupportFlag;
275 entry->flags|=CoderSeekableStreamFlag;
276 (void) RegisterMagickInfo(entry);
277 entry=AcquireMagickInfo("MPEG","MP4","MPEG-4 Video Stream");
278 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
279 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
280 entry->magick=(IsImageFormatHandler *) IsMPEG;
281 entry->flags^=CoderBlobSupportFlag;
282 entry->flags|=CoderSeekableStreamFlag;
283 (void) RegisterMagickInfo(entry);
284 entry=AcquireMagickInfo("MPEG","M2V","MPEG Video Stream");
285 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
286 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
287 entry->magick=(IsImageFormatHandler *) IsMPEG;
288 entry->flags^=CoderBlobSupportFlag;
289 entry->flags|=CoderSeekableStreamFlag;
290 (void) RegisterMagickInfo(entry);
291 entry=AcquireMagickInfo("MPEG","M4V","Raw MPEG-4 Video");
292 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
293 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
294 entry->magick=(IsImageFormatHandler *) IsMPEG;
295 entry->flags^=CoderBlobSupportFlag;
296 entry->flags|=CoderSeekableStreamFlag;
297 (void) RegisterMagickInfo(entry);
298 entry=AcquireMagickInfo("MPEG","WMV","Windows Media Video");
299 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
300 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
301 entry->magick=(IsImageFormatHandler *) IsMPEG;
302 entry->flags^=CoderBlobSupportFlag;
303 entry->flags|=CoderSeekableStreamFlag;
304 (void) RegisterMagickInfo(entry);
305 return(MagickImageCoderSignature);
309 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
313 % U n r e g i s t e r M P E G I m a g e %
317 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
319 % UnregisterMPEGImage() removes format registrations made by the
320 % BIM module from the list of supported formats.
322 % The format of the UnregisterBIMImage method is:
324 % UnregisterMPEGImage(void)
327 ModuleExport void UnregisterMPEGImage(void)
329 (void) UnregisterMagickInfo("WMV");
330 (void) UnregisterMagickInfo("MOV");
331 (void) UnregisterMagickInfo("M4V");
332 (void) UnregisterMagickInfo("M2V");
333 (void) UnregisterMagickInfo("MP4");
334 (void) UnregisterMagickInfo("MPG");
335 (void) UnregisterMagickInfo("MPEG");
336 (void) UnregisterMagickInfo("MKV");
337 (void) UnregisterMagickInfo("AVI");
341 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
345 % W r i t e M P E G I m a g e %
349 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
351 % WriteMPEGImage() writes an image to a file in MPEG video stream format.
352 % Lawrence Livermore National Laboratory (LLNL) contributed code to adjust
353 % the MPEG parameters to correspond to the compression quality setting.
355 % The format of the WriteMPEGImage method is:
357 % MagickBooleanType WriteMPEGImage(const ImageInfo *image_info,
358 % Image *image,ExceptionInfo *exception)
360 % A description of each parameter follows.
362 % o image_info: the image info.
364 % o image: The image.
366 % o exception: return any errors or warnings in this structure.
369 static MagickBooleanType CopyDelegateFile(const char *source,
370 const char *destination)
396 Return if destination file already exists and is not empty.
398 assert(source != (const char *) NULL);
399 assert(destination != (char *) NULL);
400 status=GetPathAttributes(destination,&attributes);
401 if ((status != MagickFalse) && (attributes.st_size > 0))
404 Copy source file to destination.
406 destination_file=open_utf8(destination,O_WRONLY | O_BINARY | O_CREAT,S_MODE);
407 if (destination_file == -1)
409 source_file=open_utf8(source,O_RDONLY | O_BINARY,0);
410 if (source_file == -1)
412 (void) close(destination_file);
415 quantum=(size_t) MagickMaxBufferExtent;
416 if ((fstat(source_file,&attributes) == 0) && (attributes.st_size > 0))
417 quantum=(size_t) MagickMin((double) attributes.st_size,
418 MagickMaxBufferExtent);
419 buffer=(unsigned char *) AcquireQuantumMemory(quantum,sizeof(*buffer));
420 if (buffer == (unsigned char *) NULL)
422 (void) close(source_file);
423 (void) close(destination_file);
427 for (i=0; ; i+=count)
429 count=(ssize_t) read(source_file,buffer,quantum);
432 length=(size_t) count;
433 count=(ssize_t) write(destination_file,buffer,length);
434 if ((size_t) count != length)
437 (void) close(destination_file);
438 (void) close(source_file);
439 buffer=(unsigned char *) RelinquishMagickMemory(buffer);
440 return(i != 0 ? MagickTrue : MagickFalse);
443 static MagickBooleanType WriteMPEGImage(const ImageInfo *image_info,
444 Image *image,ExceptionInfo *exception)
446 #define WriteMPEGIntermediateFormat "jpg"
449 basename[MagickPathExtent],
450 filename[MagickPathExtent];
482 Open output image file.
484 assert(image_info != (const ImageInfo *) NULL);
485 assert(image_info->signature == MagickCoreSignature);
486 assert(image != (Image *) NULL);
487 assert(image->signature == MagickCoreSignature);
488 if (image->debug != MagickFalse)
489 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
490 assert(exception != (ExceptionInfo *) NULL);
491 assert(exception->signature == MagickCoreSignature);
492 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
493 if (status == MagickFalse)
495 (void) CloseBlob(image);
497 Write intermediate files.
499 coalesce_image=CoalesceImages(image,exception);
500 if (coalesce_image == (Image *) NULL)
502 file=AcquireUniqueFileResource(basename);
505 (void) FormatLocaleString(coalesce_image->filename,MagickPathExtent,"%s",
508 write_info=CloneImageInfo(image_info);
509 *write_info->magick='\0';
510 for (p=coalesce_image; p != (Image *) NULL; p=GetNextImageInList(p))
513 previous_image[MagickPathExtent];
515 blob=(unsigned char *) NULL;
518 delay=100.0*p->delay/MagickMax(1.0*p->ticks_per_second,1.0);
519 for (i=0; i < (ssize_t) MagickMax((1.0*delay+1.0)/3.0,1.0); i++)
531 (void) FormatLocaleString(p->filename,MagickPathExtent,"%s%.20g.%s",
532 basename,(double) p->scene,WriteMPEGIntermediateFormat);
533 (void) FormatLocaleString(filename,MagickPathExtent,"%s%.20g.%s",
534 basename,(double) p->scene,WriteMPEGIntermediateFormat);
535 (void) FormatLocaleString(previous_image,MagickPathExtent,
536 "%s%.20g.%s",basename,(double) p->scene,
537 WriteMPEGIntermediateFormat);
538 frame=CloneImage(p,0,0,MagickTrue,exception);
539 if (frame == (Image *) NULL)
541 status=WriteImage(write_info,frame,exception);
542 frame=DestroyImage(frame);
547 blob=(unsigned char *) FileToBlob(previous_image,~0UL,&length,
552 (void) FormatLocaleString(filename,MagickPathExtent,"%s%.20g.%s",
553 basename,(double) p->scene,WriteMPEGIntermediateFormat);
555 status=BlobToFile(filename,blob,length,exception);
559 if (image->debug != MagickFalse)
561 if (status != MagickFalse)
562 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
563 "%.20g. Wrote %s file for scene %.20g:",(double) i,
564 WriteMPEGIntermediateFormat,(double) p->scene);
566 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
567 "%.20g. Failed to write %s file for scene %.20g:",(double) i,
568 WriteMPEGIntermediateFormat,(double) p->scene);
569 (void) LogMagickEvent(CoderEvent,GetMagickModule(),"%s",filename);
573 if (blob != (unsigned char *) NULL)
574 blob=(unsigned char *) RelinquishMagickMemory(blob);
575 if (status == MagickFalse)
579 Convert JPEG to MPEG.
581 (void) CopyMagickString(coalesce_image->magick_filename,basename,
583 (void) CopyMagickString(coalesce_image->filename,basename,MagickPathExtent);
584 GetPathComponent(image_info->filename,ExtensionPath,coalesce_image->magick);
585 if (*coalesce_image->magick == '\0')
586 (void) CopyMagickString(coalesce_image->magick,image->magick,MagickPathExtent);
587 status=InvokeDelegate(write_info,coalesce_image,(char *) NULL,"mpeg:encode",
589 (void) FormatLocaleString(write_info->filename,MagickPathExtent,"%s.%s",
590 write_info->unique,coalesce_image->magick);
591 status=CopyDelegateFile(write_info->filename,image->filename);
592 (void) RelinquishUniqueFileResource(write_info->filename);
593 write_info=DestroyImageInfo(write_info);
595 Relinquish resources.
598 for (p=coalesce_image; p != (Image *) NULL; p=GetNextImageInList(p))
600 delay=100.0*p->delay/MagickMax(1.0*p->ticks_per_second,1.0);
601 for (i=0; i < (ssize_t) MagickMax((1.0*delay+1.0)/3.0,1.0); i++)
603 (void) FormatLocaleString(p->filename,MagickPathExtent,"%s%.20g.%s",
604 basename,(double) count++,WriteMPEGIntermediateFormat);
605 (void) RelinquishUniqueFileResource(p->filename);
607 (void) CopyMagickString(p->filename,image_info->filename,MagickPathExtent);
609 (void) RelinquishUniqueFileResource(basename);
610 coalesce_image=DestroyImageList(coalesce_image);
611 if (image->debug != MagickFalse)
612 (void) LogMagickEvent(CoderEvent,GetMagickModule(),"exit");