2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % W W EEEEE BBBB PPPP %
8 % W W W EEE BBBB PPPP %
13 % Read/Write WebP Image Format %
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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/artifact.h"
44 #include "MagickCore/blob.h"
45 #include "MagickCore/blob-private.h"
46 #include "MagickCore/client.h"
47 #include "MagickCore/colorspace-private.h"
48 #include "MagickCore/display.h"
49 #include "MagickCore/exception.h"
50 #include "MagickCore/exception-private.h"
51 #include "MagickCore/image.h"
52 #include "MagickCore/image-private.h"
53 #include "MagickCore/list.h"
54 #include "MagickCore/magick.h"
55 #include "MagickCore/monitor.h"
56 #include "MagickCore/monitor-private.h"
57 #include "MagickCore/memory_.h"
58 #include "MagickCore/option.h"
59 #include "MagickCore/pixel-accessor.h"
60 #include "MagickCore/quantum-private.h"
61 #include "MagickCore/static.h"
62 #include "MagickCore/string_.h"
63 #include "MagickCore/string-private.h"
64 #include "MagickCore/module.h"
65 #include "MagickCore/utility.h"
66 #include "MagickCore/xwindow.h"
67 #include "MagickCore/xwindow-private.h"
68 #if defined(MAGICKCORE_WEBP_DELEGATE)
69 #include <webp/decode.h>
70 #include <webp/encode.h>
76 #if defined(MAGICKCORE_WEBP_DELEGATE)
77 static MagickBooleanType
78 WriteWEBPImage(const ImageInfo *,Image *,ExceptionInfo *);
82 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
90 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
92 % IsWEBP() returns MagickTrue if the image format type, identified by the
93 % magick string, is WebP.
95 % The format of the IsWEBP method is:
97 % MagickBooleanType IsWEBP(const unsigned char *magick,const size_t length)
99 % A description of each parameter follows:
101 % o magick: compare image format pattern against these bytes.
103 % o length: Specifies the length of the magick string.
106 static MagickBooleanType IsWEBP(const unsigned char *magick,const size_t length)
110 if (LocaleNCompare((const char *) magick+8,"WEBP",4) == 0)
115 #if defined(MAGICKCORE_WEBP_DELEGATE)
117 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
121 % R e a d W E B P I m a g e %
125 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
127 % ReadWEBPImage() reads an image in the WebP image format.
129 % The format of the ReadWEBPImage method is:
131 % Image *ReadWEBPImage(const ImageInfo *image_info,
132 % ExceptionInfo *exception)
134 % A description of each parameter follows:
136 % o image_info: the image info.
138 % o exception: return any errors or warnings in this structure.
142 static inline uint32_t ReadWebPLSBWord(const unsigned char *restrict data)
144 register const unsigned char
151 value=(uint32_t) (*p++);
152 value|=((uint32_t) (*p++)) << 8;
153 value|=((uint32_t) (*p++)) << 16;
154 value|=((uint32_t) (*p++)) << 24;
158 static MagickBooleanType IsWEBPImageLossless(const unsigned char *stream,
161 #define VP8_CHUNK_INDEX 15
162 #define LOSSLESS_FLAG 'L'
163 #define EXTENDED_HEADER 'X'
164 #define VP8_CHUNK_HEADER "VP8"
165 #define VP8_CHUNK_HEADER_SIZE 3
166 #define RIFF_HEADER_SIZE 12
167 #define VP8X_CHUNK_SIZE 10
169 #define CHUNK_SIZE_BYTES 4
170 #define CHUNK_HEADER_SIZE 8
171 #define MAX_CHUNK_PAYLOAD (~0U-CHUNK_HEADER_SIZE-1)
179 if (stream[VP8_CHUNK_INDEX] != EXTENDED_HEADER)
180 return(stream[VP8_CHUNK_INDEX] == LOSSLESS_FLAG ? MagickTrue : MagickFalse);
182 Read extended header.
184 offset=RIFF_HEADER_SIZE+TAG_SIZE+CHUNK_SIZE_BYTES+VP8X_CHUNK_SIZE;
185 while (offset <= (ssize_t) length)
191 chunk_size=ReadWebPLSBWord(stream+offset+TAG_SIZE);
192 if (chunk_size > MAX_CHUNK_PAYLOAD)
194 chunk_size_pad=(CHUNK_HEADER_SIZE+chunk_size+1) & ~1;
195 if (memcmp(stream+offset,VP8_CHUNK_HEADER,VP8_CHUNK_HEADER_SIZE) == 0)
196 return(*(stream+offset+VP8_CHUNK_HEADER_SIZE) == LOSSLESS_FLAG ?
197 MagickTrue : MagickFalse);
198 offset+=chunk_size_pad;
203 static Image *ReadWEBPImage(const ImageInfo *image_info,
204 ExceptionInfo *exception)
215 register unsigned char
233 *restrict webp_image = &configure.output;
235 WebPBitstreamFeatures
236 *restrict features = &configure.input;
241 assert(image_info != (const ImageInfo *) NULL);
242 assert(image_info->signature == MagickSignature);
243 if (image_info->debug != MagickFalse)
244 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
245 image_info->filename);
246 assert(exception != (ExceptionInfo *) NULL);
247 assert(exception->signature == MagickSignature);
248 image=AcquireImage(image_info,exception);
249 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
250 if (status == MagickFalse)
252 image=DestroyImageList(image);
253 return((Image *) NULL);
255 if (WebPInitDecoderConfig(&configure) == 0)
256 ThrowReaderException(ResourceLimitError,"UnableToDecodeImageFile");
257 webp_image->colorspace=MODE_RGBA;
258 count=ReadBlob(image,12,header);
260 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
261 status=IsWEBP(header,count);
262 if (status == MagickFalse)
263 ThrowReaderException(CorruptImageError,"CorruptImage");
264 length=(size_t) (ReadWebPLSBWord(header+4)+8);
266 ThrowReaderException(CorruptImageError,"CorruptImage");
267 stream=(unsigned char *) AcquireQuantumMemory(length,sizeof(*stream));
268 if (stream == (unsigned char *) NULL)
269 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
270 memcpy(stream,header,12);
271 count=ReadBlob(image,length-12,stream+12);
272 if (count != (ssize_t) (length-12))
273 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
274 webp_status=WebPGetFeatures(stream,length,features);
275 if (webp_status == VP8_STATUS_OK)
277 image->columns=(size_t) features->width;
278 image->rows=(size_t) features->height;
280 image->alpha_trait=features->has_alpha != 0 ? BlendPixelTrait :
282 if (image_info->ping != MagickFalse)
284 stream=(unsigned char*) RelinquishMagickMemory(stream);
285 (void) CloseBlob(image);
286 return(GetFirstImageInList(image));
288 webp_status=WebPDecode(stream,length,&configure);
290 if (webp_status != VP8_STATUS_OK)
292 stream=(unsigned char*) RelinquishMagickMemory(stream);
295 case VP8_STATUS_OUT_OF_MEMORY:
297 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
300 case VP8_STATUS_INVALID_PARAM:
302 ThrowReaderException(CorruptImageError,"invalid parameter");
305 case VP8_STATUS_BITSTREAM_ERROR:
307 ThrowReaderException(CorruptImageError,"CorruptImage");
310 case VP8_STATUS_UNSUPPORTED_FEATURE:
312 ThrowReaderException(CoderError,"DataEncodingSchemeIsNotSupported");
315 case VP8_STATUS_SUSPENDED:
317 ThrowReaderException(CorruptImageError,"decoder suspended");
320 case VP8_STATUS_USER_ABORT:
322 ThrowReaderException(CorruptImageError,"user abort");
325 case VP8_STATUS_NOT_ENOUGH_DATA:
327 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
331 ThrowReaderException(CorruptImageError,"CorruptImage");
334 if (IsWEBPImageLossless(stream,length) != MagickFalse)
336 p=(unsigned char *) webp_image->u.RGBA.rgba;
337 for (y=0; y < (ssize_t) image->rows; y++)
345 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
346 if (q == (Quantum *) NULL)
348 for (x=0; x < (ssize_t) image->columns; x++)
350 SetPixelRed(image,ScaleCharToQuantum(*p++),q);
351 SetPixelGreen(image,ScaleCharToQuantum(*p++),q);
352 SetPixelBlue(image,ScaleCharToQuantum(*p++),q);
353 SetPixelAlpha(image,ScaleCharToQuantum(*p++),q);
354 q+=GetPixelChannels(image);
356 if (SyncAuthenticPixels(image,exception) == MagickFalse)
358 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
360 if (status == MagickFalse)
363 WebPFreeDecBuffer(webp_image);
364 stream=(unsigned char*) RelinquishMagickMemory(stream);
370 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
374 % R e g i s t e r W E B P I m a g e %
378 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
380 % RegisterWEBPImage() adds attributes for the WebP image format to
381 % the list of supported formats. The attributes include the image format
382 % tag, a method to read and/or write the format, whether the format
383 % supports the saving of more than one frame to the same file or blob,
384 % whether the format supports native in-memory I/O, and a brief
385 % description of the format.
387 % The format of the RegisterWEBPImage method is:
389 % size_t RegisterWEBPImage(void)
392 ModuleExport size_t RegisterWEBPImage(void)
395 version[MaxTextExtent];
401 entry=SetMagickInfo("WEBP");
402 #if defined(MAGICKCORE_WEBP_DELEGATE)
403 entry->decoder=(DecodeImageHandler *) ReadWEBPImage;
404 entry->encoder=(EncodeImageHandler *) WriteWEBPImage;
405 (void) FormatLocaleString(version,MaxTextExtent,"libwebp %d.%d.%d [%04X]",
406 (WebPGetDecoderVersion() >> 16) & 0xff,
407 (WebPGetDecoderVersion() >> 8) & 0xff,
408 (WebPGetDecoderVersion() >> 0) & 0xff,WEBP_DECODER_ABI_VERSION);
410 entry->description=ConstantString("WebP Image Format");
411 entry->mime_type=ConstantString("image/x-webp");
412 entry->adjoin=MagickFalse;
413 entry->module=ConstantString("WEBP");
414 entry->magick=(IsImageFormatHandler *) IsWEBP;
415 if (*version != '\0')
416 entry->version=ConstantString(version);
417 (void) RegisterMagickInfo(entry);
418 return(MagickImageCoderSignature);
422 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
426 % U n r e g i s t e r W E B P I m a g e %
430 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
432 % UnregisterWEBPImage() removes format registrations made by the WebP module
433 % from the list of supported formats.
435 % The format of the UnregisterWEBPImage method is:
437 % UnregisterWEBPImage(void)
440 ModuleExport void UnregisterWEBPImage(void)
442 (void) UnregisterMagickInfo("WEBP");
444 #if defined(MAGICKCORE_WEBP_DELEGATE)
447 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
451 % W r i t e W E B P I m a g e %
455 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
457 % WriteWEBPImage() writes an image in the WebP image format.
459 % The format of the WriteWEBPImage method is:
461 % MagickBooleanType WriteWEBPImage(const ImageInfo *image_info,
464 % A description of each parameter follows.
466 % o image_info: the image info.
468 % o image: The image.
472 #if WEBP_ENCODER_ABI_VERSION >= 0x0100
473 static int WebPEncodeProgress(int percent,const WebPPicture* picture)
475 #define EncodeImageTag "Encode/Image"
483 image=(Image *) picture->custom_ptr;
484 status=SetImageProgress(image,EncodeImageTag,percent-1,100);
485 return(status == MagickFalse ? 0 : 1);
489 static int WebPEncodeWriter(const unsigned char *stream,size_t length,
490 const WebPPicture *const picture)
495 image=(Image *) picture->custom_ptr;
496 return(length != 0 ? (int) WriteBlob(image,length,stream) : 1);
499 static MagickBooleanType WriteWEBPImage(const ImageInfo *image_info,
500 Image *image,ExceptionInfo *exception)
530 Open output image file.
532 assert(image_info != (const ImageInfo *) NULL);
533 assert(image_info->signature == MagickSignature);
534 assert(image != (Image *) NULL);
535 assert(image->signature == MagickSignature);
536 if (image->debug != MagickFalse)
537 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
538 if ((image->columns > 16383UL) || (image->rows > 16383UL))
539 ThrowWriterException(ImageError,"WidthOrHeightExceedsLimit");
540 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
541 if (status == MagickFalse)
543 if ((WebPPictureInit(&picture) == 0) || (WebPConfigInit(&configure) == 0))
544 ThrowWriterException(ResourceLimitError,"UnableToEncodeImageFile");
545 picture.writer=WebPEncodeWriter;
546 picture.custom_ptr=(void *) image;
547 #if WEBP_ENCODER_ABI_VERSION >= 0x0100
548 picture.progress_hook=WebPEncodeProgress;
550 picture.stats=(&statistics);
551 picture.width=(int) image->columns;
552 picture.height=(int) image->rows;
553 picture.argb_stride=(int) image->columns;
555 if (image->quality != UndefinedCompressionQuality)
556 configure.quality=(float) image->quality;
558 if (image->quality >= 100)
559 configure.lossless=1;
560 value=GetImageOption(image_info,"webp:lossless");
561 if (value != (char *) NULL)
562 configure.lossless=(int) ParseCommandOption(MagickBooleanOptions,
564 value=GetImageOption(image_info,"webp:method");
565 if (value != (char *) NULL)
566 configure.method=StringToInteger(value);
567 value=GetImageOption(image_info,"webp:image-hint");
568 if (value != (char *) NULL)
570 if (LocaleCompare(value,"default") == 0)
571 configure.image_hint=WEBP_HINT_DEFAULT;
572 if (LocaleCompare(value,"photo") == 0)
573 configure.image_hint=WEBP_HINT_PHOTO;
574 if (LocaleCompare(value,"picture") == 0)
575 configure.image_hint=WEBP_HINT_PICTURE;
576 #if WEBP_ENCODER_ABI_VERSION >= 0x0200
577 if (LocaleCompare(value,"graph") == 0)
578 configure.image_hint=WEBP_HINT_GRAPH;
581 value=GetImageOption(image_info,"webp:target-size");
582 if (value != (char *) NULL)
583 configure.target_size=StringToInteger(value);
584 value=GetImageOption(image_info,"webp:target-psnr");
585 if (value != (char *) NULL)
586 configure.target_PSNR=(float) StringToDouble(value,(char **) NULL);
587 value=GetImageOption(image_info,"webp:segments");
588 if (value != (char *) NULL)
589 configure.segments=StringToInteger(value);
590 value=GetImageOption(image_info,"webp:sns-strength");
591 if (value != (char *) NULL)
592 configure.sns_strength=StringToInteger(value);
593 value=GetImageOption(image_info,"webp:filter-strength");
594 if (value != (char *) NULL)
595 configure.filter_strength=StringToInteger(value);
596 value=GetImageOption(image_info,"webp:filter-sharpness");
597 if (value != (char *) NULL)
598 configure.filter_sharpness=StringToInteger(value);
599 value=GetImageOption(image_info,"webp:filter-type");
600 if (value != (char *) NULL)
601 configure.filter_type=StringToInteger(value);
602 value=GetImageOption(image_info,"webp:auto-filter");
603 if (value != (char *) NULL)
604 configure.autofilter=(int) ParseCommandOption(MagickBooleanOptions,
606 value=GetImageOption(image_info,"webp:alpha-compression");
607 if (value != (char *) NULL)
608 configure.alpha_compression=StringToInteger(value);
609 value=GetImageOption(image_info,"webp:alpha-filtering");
610 if (value != (char *) NULL)
611 configure.alpha_filtering=StringToInteger(value);
612 value=GetImageOption(image_info,"webp:alpha-quality");
613 if (value != (char *) NULL)
614 configure.alpha_quality=StringToInteger(value);
615 value=GetImageOption(image_info,"webp:pass");
616 if (value != (char *) NULL)
617 configure.pass=StringToInteger(value);
618 value=GetImageOption(image_info,"webp:show-compressed");
619 if (value != (char *) NULL)
620 configure.show_compressed=StringToInteger(value);
621 value=GetImageOption(image_info,"webp:preprocessing");
622 if (value != (char *) NULL)
623 configure.preprocessing=StringToInteger(value);
624 value=GetImageOption(image_info,"webp:partitions");
625 if (value != (char *) NULL)
626 configure.partitions=StringToInteger(value);
627 value=GetImageOption(image_info,"webp:partition-limit");
628 if (value != (char *) NULL)
629 configure.partition_limit=StringToInteger(value);
630 #if WEBP_ENCODER_ABI_VERSION >= 0x0201
631 value=GetImageOption(image_info,"webp:low-memory");
632 if (value != (char *) NULL)
633 configure.low_memory=(int) ParseCommandOption(MagickBooleanOptions,
635 value=GetImageOption(image_info,"webp:partition-limit");
636 if (value != (char *) NULL)
637 configure.emulate_jpeg_size=(int) ParseCommandOption(MagickBooleanOptions,
639 value=GetImageOption(image_info,"webp:thread-level");
640 if (value != (char *) NULL)
641 configure.thread_level=StringToInteger(value);
643 if (WebPValidateConfig(&configure) == 0)
644 ThrowWriterException(ResourceLimitError,"UnableToEncodeImageFile");
646 Allocate memory for pixels.
648 (void) TransformImageColorspace(image,sRGBColorspace,exception);
649 pixel_info=AcquireVirtualMemory(image->columns,image->rows*
650 sizeof(*picture.argb));
651 if (pixel_info == (MemoryInfo *) NULL)
652 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
653 picture.argb=(uint32_t *) GetVirtualMemoryBlob(pixel_info);
655 Convert image to WebP raster pixels.
658 for (y=0; y < (ssize_t) image->rows; y++)
660 register const Quantum
666 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
667 if (p == (const Quantum *) NULL)
669 for (x=0; x < (ssize_t) image->columns; x++)
671 *q++=(uint32_t) (image->alpha_trait == BlendPixelTrait ?
672 ScaleQuantumToChar(GetPixelAlpha(image,p)) << 24 : 0xff000000) |
673 (ScaleQuantumToChar(GetPixelRed(image,p)) << 16) |
674 (ScaleQuantumToChar(GetPixelGreen(image,p)) << 8) |
675 (ScaleQuantumToChar(GetPixelBlue(image,p)));
676 p+=GetPixelChannels(image);
678 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
680 if (status == MagickFalse)
683 webp_status=WebPEncode(&configure,&picture);
684 if (webp_status == 0)
689 switch (picture.error_code)
691 case VP8_ENC_ERROR_OUT_OF_MEMORY:
693 message="out of memory";
696 case VP8_ENC_ERROR_BITSTREAM_OUT_OF_MEMORY:
698 message="bitstream out of memory";
701 case VP8_ENC_ERROR_NULL_PARAMETER:
703 message="NULL parameter";
706 case VP8_ENC_ERROR_INVALID_CONFIGURATION:
708 message="invalid configuration";
711 case VP8_ENC_ERROR_BAD_DIMENSION:
713 message="bad dimension";
716 case VP8_ENC_ERROR_PARTITION0_OVERFLOW:
718 message="partition 0 overflow (> 512K)";
721 case VP8_ENC_ERROR_PARTITION_OVERFLOW:
723 message="partition overflow (> 16M)";
726 case VP8_ENC_ERROR_BAD_WRITE:
731 case VP8_ENC_ERROR_FILE_TOO_BIG:
733 message="file too big (> 4GB)";
736 #if WEBP_ENCODER_ABI_VERSION >= 0x0100
737 case VP8_ENC_ERROR_USER_ABORT:
739 message="user abort";
745 message="unknown exception";
749 (void) ThrowMagickException(exception,GetMagickModule(),CorruptImageError,
750 (char *) message,"`%s'",image->filename);
752 WebPPictureFree(&picture);
753 pixel_info=RelinquishVirtualMemory(pixel_info);
754 (void) CloseBlob(image);
755 return(webp_status == 0 ? MagickFalse : MagickTrue);