2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % M M PPPP EEEEE GGGG %
8 % M M M PPPP EEE G GG %
13 % Read/Write MPEG Image Format %
20 % Copyright 1999-2018 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 % https://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"
185 assert(image_info != (const ImageInfo *) NULL);
186 assert(image_info->signature == MagickCoreSignature);
187 if (image_info->debug != MagickFalse)
188 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
189 image_info->filename);
190 assert(exception != (ExceptionInfo *) NULL);
191 assert(exception->signature == MagickCoreSignature);
192 image=AcquireImage(image_info,exception);
193 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
194 if (status == MagickFalse)
196 image=DestroyImageList(image);
197 return((Image *) NULL);
199 (void) CloseBlob(image);
200 (void) DestroyImageList(image);
202 Convert MPEG to PAM with delegate.
204 read_info=CloneImageInfo(image_info);
205 image=AcquireImage(image_info,exception);
206 (void) InvokeDelegate(read_info,image,"mpeg:decode",(char *) NULL,exception);
207 (void) FormatLocaleString(read_info->filename,MagickPathExtent,"%s.%s",
208 read_info->unique,ReadMPEGIntermediateFormat);
209 images=ReadImage(read_info,exception);
210 if (images != (Image *) NULL)
211 for (next=images; next != (Image *) NULL; next=next->next)
213 (void) CopyMagickString(next->filename,image->filename,MagickPathExtent);
214 (void) CopyMagickString(next->magick,image->magick,MagickPathExtent);
216 (void) RelinquishUniqueFileResource(read_info->filename);
217 read_info=DestroyImageInfo(read_info);
218 image=DestroyImage(image);
223 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
227 % R e g i s t e r M P E G I m a g e %
231 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
233 % RegisterMPEGImage() adds attributes for the MPEG image format to
234 % the list of supported formats. The attributes include the image format
235 % tag, a method to read and/or write the format, whether the format
236 % supports the saving of more than one frame to the same file or blob,
237 % whether the format supports native in-memory I/O, and a brief
238 % description of the format.
240 % The format of the RegisterMPEGImage method is:
242 % size_t RegisterMPEGImage(void)
245 ModuleExport size_t RegisterMPEGImage(void)
250 entry=AcquireMagickInfo("MPEG","3GP","Media Container");
251 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
252 entry->flags^=CoderBlobSupportFlag;
253 entry->flags|=CoderSeekableStreamFlag;
254 (void) RegisterMagickInfo(entry);
255 entry=AcquireMagickInfo("MPEG","3G2","Media Container");
256 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
257 entry->flags^=CoderBlobSupportFlag;
258 entry->flags|=CoderSeekableStreamFlag;
259 (void) RegisterMagickInfo(entry);
260 entry=AcquireMagickInfo("MPEG","AVI","Microsoft Audio/Visual Interleaved");
261 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
262 entry->magick=(IsImageFormatHandler *) IsAVI;
263 entry->flags^=CoderBlobSupportFlag;
264 (void) RegisterMagickInfo(entry);
265 entry=AcquireMagickInfo("MPEG","MKV","Multimedia Container");
266 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
267 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
268 entry->magick=(IsImageFormatHandler *) IsMPEG;
269 entry->flags^=CoderBlobSupportFlag;
270 (void) RegisterMagickInfo(entry);
271 entry=AcquireMagickInfo("MPEG","MOV","MPEG Video Stream");
272 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
273 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
274 entry->magick=(IsImageFormatHandler *) IsMPEG;
275 entry->flags^=CoderBlobSupportFlag;
276 (void) RegisterMagickInfo(entry);
277 entry=AcquireMagickInfo("MPEG","MPEG","MPEG Video Stream");
278 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
279 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
280 entry->magick=(IsImageFormatHandler *) IsMPEG;
281 entry->flags^=CoderBlobSupportFlag;
282 (void) RegisterMagickInfo(entry);
283 entry=AcquireMagickInfo("MPEG","MPG","MPEG Video Stream");
284 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
285 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
286 entry->magick=(IsImageFormatHandler *) IsMPEG;
287 entry->flags^=CoderBlobSupportFlag;
288 (void) RegisterMagickInfo(entry);
289 entry=AcquireMagickInfo("MPEG","MP4","MPEG-4 Video Stream");
290 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
291 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
292 entry->magick=(IsImageFormatHandler *) IsMPEG;
293 entry->flags^=CoderBlobSupportFlag;
294 (void) RegisterMagickInfo(entry);
295 entry=AcquireMagickInfo("MPEG","M2V","MPEG Video Stream");
296 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
297 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
298 entry->magick=(IsImageFormatHandler *) IsMPEG;
299 entry->flags^=CoderBlobSupportFlag;
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 (void) RegisterMagickInfo(entry);
307 entry=AcquireMagickInfo("MPEG","WMV","Windows Media Video");
308 entry->decoder=(DecodeImageHandler *) ReadMPEGImage;
309 entry->encoder=(EncodeImageHandler *) WriteMPEGImage;
310 entry->magick=(IsImageFormatHandler *) IsMPEG;
311 entry->flags^=CoderBlobSupportFlag;
312 (void) RegisterMagickInfo(entry);
313 return(MagickImageCoderSignature);
317 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
321 % U n r e g i s t e r M P E G I m a g e %
325 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
327 % UnregisterMPEGImage() removes format registrations made by the
328 % BIM module from the list of supported formats.
330 % The format of the UnregisterBIMImage method is:
332 % UnregisterMPEGImage(void)
335 ModuleExport void UnregisterMPEGImage(void)
337 (void) UnregisterMagickInfo("WMV");
338 (void) UnregisterMagickInfo("MOV");
339 (void) UnregisterMagickInfo("M4V");
340 (void) UnregisterMagickInfo("M2V");
341 (void) UnregisterMagickInfo("MP4");
342 (void) UnregisterMagickInfo("MPG");
343 (void) UnregisterMagickInfo("MPEG");
344 (void) UnregisterMagickInfo("MKV");
345 (void) UnregisterMagickInfo("AVI");
346 (void) UnregisterMagickInfo("3G2");
347 (void) UnregisterMagickInfo("3GP");
351 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
355 % W r i t e M P E G I m a g e %
359 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
361 % WriteMPEGImage() writes an image to a file in MPEG video stream format.
362 % Lawrence Livermore National Laboratory (LLNL) contributed code to adjust
363 % the MPEG parameters to correspond to the compression quality setting.
365 % The format of the WriteMPEGImage method is:
367 % MagickBooleanType WriteMPEGImage(const ImageInfo *image_info,
368 % Image *image,ExceptionInfo *exception)
370 % A description of each parameter follows.
372 % o image_info: the image info.
374 % o image: The image.
376 % o exception: return any errors or warnings in this structure.
379 static MagickBooleanType CopyDelegateFile(const char *source,
380 const char *destination)
406 Return if destination file already exists and is not empty.
408 assert(source != (const char *) NULL);
409 assert(destination != (char *) NULL);
410 status=GetPathAttributes(destination,&attributes);
411 if ((status != MagickFalse) && (attributes.st_size > 0))
414 Copy source file to destination.
416 destination_file=open_utf8(destination,O_WRONLY | O_BINARY | O_CREAT,S_MODE);
417 if (destination_file == -1)
419 source_file=open_utf8(source,O_RDONLY | O_BINARY,0);
420 if (source_file == -1)
422 (void) close(destination_file);
425 quantum=(size_t) MagickMaxBufferExtent;
426 if ((fstat(source_file,&attributes) == 0) && (attributes.st_size > 0))
427 quantum=(size_t) MagickMin((double) attributes.st_size,
428 MagickMaxBufferExtent);
429 buffer=(unsigned char *) AcquireQuantumMemory(quantum,sizeof(*buffer));
430 if (buffer == (unsigned char *) NULL)
432 (void) close(source_file);
433 (void) close(destination_file);
437 for (i=0; ; i+=count)
439 count=(ssize_t) read(source_file,buffer,quantum);
442 length=(size_t) count;
443 count=(ssize_t) write(destination_file,buffer,length);
444 if ((size_t) count != length)
447 (void) close(destination_file);
448 (void) close(source_file);
449 buffer=(unsigned char *) RelinquishMagickMemory(buffer);
450 return(i != 0 ? MagickTrue : MagickFalse);
453 static MagickBooleanType WriteMPEGImage(const ImageInfo *image_info,
454 Image *image,ExceptionInfo *exception)
456 #define WriteMPEGIntermediateFormat "jpg"
459 basename[MagickPathExtent],
460 filename[MagickPathExtent];
492 Open output image file.
494 assert(image_info != (const ImageInfo *) NULL);
495 assert(image_info->signature == MagickCoreSignature);
496 assert(image != (Image *) NULL);
497 assert(image->signature == MagickCoreSignature);
498 if (image->debug != MagickFalse)
499 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
500 assert(exception != (ExceptionInfo *) NULL);
501 assert(exception->signature == MagickCoreSignature);
502 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
503 if (status == MagickFalse)
505 (void) CloseBlob(image);
507 Write intermediate files.
509 coalesce_image=CoalesceImages(image,exception);
510 if (coalesce_image == (Image *) NULL)
512 file=AcquireUniqueFileResource(basename);
515 (void) FormatLocaleString(coalesce_image->filename,MagickPathExtent,"%s",
518 write_info=CloneImageInfo(image_info);
519 *write_info->magick='\0';
520 for (p=coalesce_image; p != (Image *) NULL; p=GetNextImageInList(p))
523 previous_image[MagickPathExtent];
525 blob=(unsigned char *) NULL;
528 delay=100.0*p->delay/MagickMax(1.0*p->ticks_per_second,1.0);
529 for (i=0; i < (ssize_t) MagickMax((1.0*delay+1.0)/3.0,1.0); i++)
541 (void) FormatLocaleString(p->filename,MagickPathExtent,"%s%.20g.%s",
542 basename,(double) p->scene,WriteMPEGIntermediateFormat);
543 (void) FormatLocaleString(filename,MagickPathExtent,"%s%.20g.%s",
544 basename,(double) p->scene,WriteMPEGIntermediateFormat);
545 (void) FormatLocaleString(previous_image,MagickPathExtent,
546 "%s%.20g.%s",basename,(double) p->scene,
547 WriteMPEGIntermediateFormat);
548 frame=CloneImage(p,0,0,MagickTrue,exception);
549 if (frame == (Image *) NULL)
551 status=WriteImage(write_info,frame,exception);
552 frame=DestroyImage(frame);
557 blob=(unsigned char *) FileToBlob(previous_image,~0UL,&length,
562 (void) FormatLocaleString(filename,MagickPathExtent,"%s%.20g.%s",
563 basename,(double) p->scene,WriteMPEGIntermediateFormat);
565 status=BlobToFile(filename,blob,length,exception);
569 if (image->debug != MagickFalse)
571 if (status != MagickFalse)
572 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
573 "%.20g. Wrote %s file for scene %.20g:",(double) i,
574 WriteMPEGIntermediateFormat,(double) p->scene);
576 (void) LogMagickEvent(CoderEvent,GetMagickModule(),
577 "%.20g. Failed to write %s file for scene %.20g:",(double) i,
578 WriteMPEGIntermediateFormat,(double) p->scene);
579 (void) LogMagickEvent(CoderEvent,GetMagickModule(),"%s",filename);
583 if (blob != (unsigned char *) NULL)
584 blob=(unsigned char *) RelinquishMagickMemory(blob);
585 if (status == MagickFalse)
589 Convert JPEG to MPEG.
591 (void) CopyMagickString(coalesce_image->magick_filename,basename,
593 (void) CopyMagickString(coalesce_image->filename,basename,MagickPathExtent);
594 GetPathComponent(image_info->filename,ExtensionPath,coalesce_image->magick);
595 if (*coalesce_image->magick == '\0')
596 (void) CopyMagickString(coalesce_image->magick,image->magick,
598 status=InvokeDelegate(write_info,coalesce_image,(char *) NULL,"mpeg:encode",
600 (void) FormatLocaleString(write_info->filename,MagickPathExtent,"%s.%s",
601 write_info->unique,coalesce_image->magick);
602 status=CopyDelegateFile(write_info->filename,image->filename);
603 (void) RelinquishUniqueFileResource(write_info->filename);
604 write_info=DestroyImageInfo(write_info);
606 Relinquish resources.
609 for (p=coalesce_image; p != (Image *) NULL; p=GetNextImageInList(p))
611 delay=100.0*p->delay/MagickMax(1.0*p->ticks_per_second,1.0);
612 for (i=0; i < (ssize_t) MagickMax((1.0*delay+1.0)/3.0,1.0); i++)
614 (void) FormatLocaleString(p->filename,MagickPathExtent,"%s%.20g.%s",
615 basename,(double) count++,WriteMPEGIntermediateFormat);
616 (void) RelinquishUniqueFileResource(p->filename);
618 (void) CopyMagickString(p->filename,image_info->filename,MagickPathExtent);
620 (void) RelinquishUniqueFileResource(basename);
621 coalesce_image=DestroyImageList(coalesce_image);
622 if (image->debug != MagickFalse)
623 (void) LogMagickEvent(CoderEvent,GetMagickModule(),"exit");