2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % W W EEEEE BBBB PPPP %
8 % W W W EEE BBBB PPPP %
13 % Read/Write WebP Image Format %
20 % Copyright 1999-2014 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 (~0UL-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)
212 register unsigned char
229 *restrict webp_image = &configure.output;
231 WebPBitstreamFeatures
232 *restrict features = &configure.input;
237 assert(image_info != (const ImageInfo *) NULL);
238 assert(image_info->signature == MagickSignature);
239 if (image_info->debug != MagickFalse)
240 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
241 image_info->filename);
242 assert(exception != (ExceptionInfo *) NULL);
243 assert(exception->signature == MagickSignature);
244 image=AcquireImage(image_info,exception);
245 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
246 if (status == MagickFalse)
248 image=DestroyImageList(image);
249 return((Image *) NULL);
251 if (WebPInitDecoderConfig(&configure) == 0)
252 ThrowReaderException(ResourceLimitError,"UnableToDecodeImageFile");
253 length=(size_t) GetBlobSize(image);
254 stream=(unsigned char *) AcquireQuantumMemory(length,sizeof(*stream));
255 if (stream == (unsigned char *) NULL)
256 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
257 count=ReadBlob(image,length,stream);
258 if (count != (ssize_t) length)
259 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
260 if (WebPGetFeatures(stream,length,features) != 0)
262 stream=(unsigned char*) RelinquishMagickMemory(stream);
263 ThrowReaderException(ResourceLimitError,"UnableToDecodeImageFile");
265 webp_image->colorspace=MODE_RGBA;
266 if (WebPDecode(stream,length,&configure) != 0)
268 stream=(unsigned char*) RelinquishMagickMemory(stream);
269 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
271 image->columns=(size_t) webp_image->width;
272 image->rows=(size_t) webp_image->height;
273 image->alpha_trait=features->has_alpha != 0 ? BlendPixelTrait :
275 if (IsWEBPImageLossless(stream,length) != MagickFalse)
277 p=webp_image->u.RGBA.rgba;
278 for (y=0; y < (ssize_t) image->rows; y++)
286 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
287 if (q == (Quantum *) NULL)
289 for (x=0; x < (ssize_t) image->columns; x++)
291 SetPixelRed(image,ScaleCharToQuantum(*p++),q);
292 SetPixelGreen(image,ScaleCharToQuantum(*p++),q);
293 SetPixelBlue(image,ScaleCharToQuantum(*p++),q);
294 SetPixelAlpha(image,ScaleCharToQuantum(*p++),q);
295 q+=GetPixelChannels(image);
297 if (SyncAuthenticPixels(image,exception) == MagickFalse)
299 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
301 if (status == MagickFalse)
304 WebPFreeDecBuffer(webp_image);
305 stream=(unsigned char*) RelinquishMagickMemory(stream);
311 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
315 % R e g i s t e r W E B P I m a g e %
319 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
321 % RegisterWEBPImage() adds attributes for the WebP image format to
322 % the list of supported formats. The attributes include the image format
323 % tag, a method to read and/or write the format, whether the format
324 % supports the saving of more than one frame to the same file or blob,
325 % whether the format supports native in-memory I/O, and a brief
326 % description of the format.
328 % The format of the RegisterWEBPImage method is:
330 % size_t RegisterWEBPImage(void)
333 ModuleExport size_t RegisterWEBPImage(void)
336 version[MaxTextExtent];
342 entry=SetMagickInfo("WEBP");
343 #if defined(MAGICKCORE_WEBP_DELEGATE)
344 entry->decoder=(DecodeImageHandler *) ReadWEBPImage;
345 entry->encoder=(EncodeImageHandler *) WriteWEBPImage;
346 (void) FormatLocaleString(version,MaxTextExtent,"libwebp %d.%d.%d",
347 (WebPGetDecoderVersion() >> 16) & 0xff,
348 (WebPGetDecoderVersion() >> 8) & 0xff,
349 (WebPGetDecoderVersion() >> 0) & 0xff);
351 entry->description=ConstantString("WebP Image Format");
352 entry->adjoin=MagickFalse;
353 entry->module=ConstantString("WEBP");
354 entry->magick=(IsImageFormatHandler *) IsWEBP;
355 if (*version != '\0')
356 entry->version=ConstantString(version);
357 (void) RegisterMagickInfo(entry);
358 return(MagickImageCoderSignature);
362 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
366 % U n r e g i s t e r W E B P I m a g e %
370 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
372 % UnregisterWEBPImage() removes format registrations made by the WebP module
373 % from the list of supported formats.
375 % The format of the UnregisterWEBPImage method is:
377 % UnregisterWEBPImage(void)
380 ModuleExport void UnregisterWEBPImage(void)
382 (void) UnregisterMagickInfo("WEBP");
384 #if defined(MAGICKCORE_WEBP_DELEGATE)
387 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
391 % W r i t e W E B P I m a g e %
395 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
397 % WriteWEBPImage() writes an image in the WebP image format.
399 % The format of the WriteWEBPImage method is:
401 % MagickBooleanType WriteWEBPImage(const ImageInfo *image_info,
404 % A description of each parameter follows.
406 % o image_info: the image info.
408 % o image: The image.
412 static int WebPWriter(const unsigned char *stream,size_t length,
413 const WebPPicture *const picture)
418 image=(Image *) picture->custom_ptr;
419 return(length != 0 ? (int) WriteBlob(image,length,stream) : 1);
422 static MagickBooleanType WriteWEBPImage(const ImageInfo *image_info,
423 Image *image,ExceptionInfo *exception)
453 Open output image file.
455 assert(image_info != (const ImageInfo *) NULL);
456 assert(image_info->signature == MagickSignature);
457 assert(image != (Image *) NULL);
458 assert(image->signature == MagickSignature);
459 if (image->debug != MagickFalse)
460 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
461 if ((image->columns > 16383UL) || (image->rows > 16383UL))
462 ThrowWriterException(ImageError,"WidthOrHeightExceedsLimit");
463 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
464 if (status == MagickFalse)
466 if ((WebPPictureInit(&picture) == 0) || (WebPConfigInit(&configure) == 0))
467 ThrowWriterException(ResourceLimitError,"UnableToEncodeImageFile");
468 picture.writer=WebPWriter;
469 picture.custom_ptr=(void *) image;
470 picture.stats=(&statistics);
471 picture.width=(int) image->columns;
472 picture.height=(int) image->rows;
473 picture.argb_stride=(int) image->columns;
475 if (image->quality != UndefinedCompressionQuality)
476 configure.quality=(float) image->quality;
478 if (image->quality >= 100)
479 configure.lossless=1;
480 value=GetImageOption(image_info,"webp:lossless");
481 if (value != (char *) NULL)
482 configure.lossless=ParseCommandOption(MagickBooleanOptions,MagickFalse,
484 value=GetImageOption(image_info,"webp:method");
485 if (value != (char *) NULL)
486 configure.method=StringToInteger(value);
487 value=GetImageOption(image_info,"webp:image-hint");
488 if (value != (char *) NULL)
490 if (LocaleCompare(value,"graph") == 0)
491 configure.image_hint=WEBP_HINT_GRAPH;
492 if (LocaleCompare(value,"photo") == 0)
493 configure.image_hint=WEBP_HINT_PHOTO;
494 if (LocaleCompare(value,"picture") == 0)
495 configure.image_hint=WEBP_HINT_PICTURE;
497 value=GetImageOption(image_info,"webp:target-size");
498 if (value != (char *) NULL)
499 configure.target_size=StringToInteger(value);
500 value=GetImageOption(image_info,"webp:target-psnr");
501 if (value != (char *) NULL)
502 configure.target_PSNR=(float) StringToDouble(value,(char **) NULL);
503 value=GetImageOption(image_info,"webp:segments");
504 if (value != (char *) NULL)
505 configure.segments=StringToInteger(value);
506 value=GetImageOption(image_info,"webp:sns-strength");
507 if (value != (char *) NULL)
508 configure.sns_strength=StringToInteger(value);
509 value=GetImageOption(image_info,"webp:filter-strength");
510 if (value != (char *) NULL)
511 configure.filter_strength=StringToInteger(value);
512 value=GetImageOption(image_info,"webp:filter-sharpness");
513 if (value != (char *) NULL)
514 configure.filter_sharpness=StringToInteger(value);
515 value=GetImageOption(image_info,"webp:filter-type");
516 if (value != (char *) NULL)
517 configure.filter_type=StringToInteger(value);
518 value=GetImageOption(image_info,"webp:auto-filter");
519 if (value != (char *) NULL)
520 configure.autofilter=ParseCommandOption(MagickBooleanOptions,MagickFalse,
522 value=GetImageOption(image_info,"webp:alpha-compression");
523 if (value != (char *) NULL)
524 configure.alpha_compression=StringToInteger(value);
525 value=GetImageOption(image_info,"webp:alpha-filtering");
526 if (value != (char *) NULL)
527 configure.alpha_filtering=StringToInteger(value);
528 value=GetImageOption(image_info,"webp:alpha-quality");
529 if (value != (char *) NULL)
530 configure.alpha_quality=StringToInteger(value);
531 value=GetImageOption(image_info,"webp:pass");
532 if (value != (char *) NULL)
533 configure.pass=StringToInteger(value);
534 value=GetImageOption(image_info,"webp:show-compressed");
535 if (value != (char *) NULL)
536 configure.show_compressed=StringToInteger(value);
537 value=GetImageOption(image_info,"webp:preprocessing");
538 if (value != (char *) NULL)
539 configure.preprocessing=StringToInteger(value);
540 value=GetImageOption(image_info,"webp:partitions");
541 if (value != (char *) NULL)
542 configure.partitions=StringToInteger(value);
543 value=GetImageOption(image_info,"webp:partition-limit");
544 if (value != (char *) NULL)
545 configure.partition_limit=StringToInteger(value);
546 if (WebPValidateConfig(&configure) == 0)
547 ThrowWriterException(ResourceLimitError,"UnableToEncodeImageFile");
549 Allocate memory for pixels.
551 if (IssRGBCompatibleColorspace(image->colorspace) == MagickFalse)
552 (void) TransformImageColorspace(image,sRGBColorspace,exception);
553 pixel_info=AcquireVirtualMemory(image->columns,image->rows*
554 sizeof(*picture.argb));
555 if (pixel_info == (MemoryInfo *) NULL)
556 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
557 picture.argb=(uint32_t *) GetVirtualMemoryBlob(pixel_info);
559 Convert image to WebP raster pixels.
562 for (y=0; y < (ssize_t) image->rows; y++)
564 register const Quantum
570 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
571 if (p == (const Quantum *) NULL)
573 for (x=0; x < (ssize_t) image->columns; x++)
575 *q++=(uint32_t) (image->alpha_trait == BlendPixelTrait ?
576 ScaleQuantumToChar(GetPixelAlpha(image,p)) << 24 : 0xff000000) |
577 (ScaleQuantumToChar(GetPixelRed(image,p)) << 16) |
578 (ScaleQuantumToChar(GetPixelGreen(image,p)) << 8) |
579 (ScaleQuantumToChar(GetPixelBlue(image,p)));
580 p+=GetPixelChannels(image);
582 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
584 if (status == MagickFalse)
587 webp_status=WebPEncode(&configure,&picture);
588 WebPPictureFree(&picture);
589 pixel_info=RelinquishVirtualMemory(pixel_info);
590 (void) CloseBlob(image);
591 return(webp_status == 0 ? MagickFalse : MagickTrue);