2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Read/Write Radiance RGBE 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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/blob.h"
44 #include "MagickCore/blob-private.h"
45 #include "MagickCore/cache.h"
46 #include "MagickCore/colorspace.h"
47 #include "MagickCore/colorspace-private.h"
48 #include "MagickCore/exception.h"
49 #include "MagickCore/exception-private.h"
50 #include "MagickCore/image.h"
51 #include "MagickCore/image-private.h"
52 #include "MagickCore/list.h"
53 #include "MagickCore/magick.h"
54 #include "MagickCore/memory_.h"
55 #include "MagickCore/monitor.h"
56 #include "MagickCore/monitor-private.h"
57 #include "MagickCore/pixel-accessor.h"
58 #include "MagickCore/property.h"
59 #include "MagickCore/quantum-private.h"
60 #include "MagickCore/static.h"
61 #include "MagickCore/string_.h"
62 #include "MagickCore/string-private.h"
63 #include "MagickCore/module.h"
68 static MagickBooleanType
69 WriteHDRImage(const ImageInfo *,Image *,ExceptionInfo *);
72 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
80 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
82 % IsHDR() returns MagickTrue if the image format type, identified by the
83 % magick string, is Radiance RGBE image format.
85 % The format of the IsHDR method is:
87 % MagickBooleanType IsHDR(const unsigned char *magick,
88 % const size_t length)
90 % A description of each parameter follows:
92 % o magick: compare image format pattern against these bytes.
94 % o length: Specifies the length of the magick string.
97 static MagickBooleanType IsHDR(const unsigned char *magick,
102 if (LocaleNCompare((const char *) magick,"#?RADIANCE",10) == 0)
104 if (LocaleNCompare((const char *) magick,"#?RGBE",6) == 0)
110 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
114 % R e a d H D R I m a g e %
118 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
120 % ReadHDRImage() reads the Radiance RGBE image format and returns it. It
121 % allocates the memory necessary for the new Image structure and returns a
122 % pointer to the new image.
124 % The format of the ReadHDRImage method is:
126 % Image *ReadHDRImage(const ImageInfo *image_info,ExceptionInfo *exception)
128 % A description of each parameter follows:
130 % o image_info: the image info.
132 % o exception: return any errors or warnings in this structure.
135 static Image *ReadHDRImage(const ImageInfo *image_info,ExceptionInfo *exception)
138 format[MagickPathExtent],
139 keyword[MagickPathExtent],
140 tag[MagickPathExtent],
141 value[MagickPathExtent];
163 register unsigned char
178 assert(image_info != (const ImageInfo *) NULL);
179 assert(image_info->signature == MagickCoreSignature);
180 if (image_info->debug != MagickFalse)
181 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
182 image_info->filename);
183 assert(exception != (ExceptionInfo *) NULL);
184 assert(exception->signature == MagickCoreSignature);
185 image=AcquireImage(image_info,exception);
186 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
187 if (status == MagickFalse)
189 image=DestroyImageList(image);
190 return((Image *) NULL);
198 c=ReadBlobByte(image);
201 image=DestroyImage(image);
202 return((Image *) NULL);
204 while (isgraph(c) && (image->columns == 0) && (image->rows == 0))
218 Read comment-- any text between # and end-of-line.
220 length=MagickPathExtent;
221 comment=AcquireString((char *) NULL);
222 for (p=comment; comment != (char *) NULL; p++)
224 c=ReadBlobByte(image);
225 if ((c == EOF) || (c == (int) '\n'))
227 if ((size_t) (p-comment+1) >= length)
231 comment=(char *) ResizeQuantumMemory(comment,length+
232 MagickPathExtent,sizeof(*comment));
233 if (comment == (char *) NULL)
235 p=comment+strlen(comment);
239 if (comment == (char *) NULL)
240 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
242 (void) SetImageProperty(image,"comment",comment,exception);
243 comment=DestroyString(comment);
244 c=ReadBlobByte(image);
247 if (isalnum(c) == MagickFalse)
248 c=ReadBlobByte(image);
255 Determine a keyword and its value.
260 if ((size_t) (p-keyword) < (MagickPathExtent-1))
262 c=ReadBlobByte(image);
263 } while (isalnum(c) || (c == '_'));
265 value_expected=MagickFalse;
266 while ((isspace((int) ((unsigned char) c)) != 0) || (c == '='))
269 value_expected=MagickTrue;
270 c=ReadBlobByte(image);
272 if (LocaleCompare(keyword,"Y") == 0)
273 value_expected=MagickTrue;
274 if (value_expected == MagickFalse)
277 while ((c != '\n') && (c != '\0') && (c != EOF))
279 if ((size_t) (p-value) < (MagickPathExtent-1))
281 c=ReadBlobByte(image);
285 Assign a value to the specified keyword.
292 if (LocaleCompare(keyword,"format") == 0)
294 (void) CopyMagickString(format,value,MagickPathExtent);
297 (void) FormatLocaleString(tag,MagickPathExtent,"hdr:%s",keyword);
298 (void) SetImageProperty(image,tag,value,exception);
304 if (LocaleCompare(keyword,"gamma") == 0)
306 image->gamma=StringToDouble(value,(char **) NULL);
309 (void) FormatLocaleString(tag,MagickPathExtent,"hdr:%s",keyword);
310 (void) SetImageProperty(image,tag,value,exception);
316 if (LocaleCompare(keyword,"primaries") == 0)
325 count=sscanf(value,"%g %g %g %g %g %g %g %g",&chromaticity[0],
326 &chromaticity[1],&chromaticity[2],&chromaticity[3],
327 &chromaticity[4],&chromaticity[5],&white_point[0],
331 image->chromaticity.red_primary.x=chromaticity[0];
332 image->chromaticity.red_primary.y=chromaticity[1];
333 image->chromaticity.green_primary.x=chromaticity[2];
334 image->chromaticity.green_primary.y=chromaticity[3];
335 image->chromaticity.blue_primary.x=chromaticity[4];
336 image->chromaticity.blue_primary.y=chromaticity[5];
337 image->chromaticity.white_point.x=white_point[0],
338 image->chromaticity.white_point.y=white_point[1];
342 (void) FormatLocaleString(tag,MagickPathExtent,"hdr:%s",keyword);
343 (void) SetImageProperty(image,tag,value,exception);
352 if (strcmp(keyword,target) == 0)
358 if (sscanf(value,"%d +X %d",&height,&width) == 2)
360 image->columns=(size_t) width;
361 image->rows=(size_t) height;
365 (void) FormatLocaleString(tag,MagickPathExtent,"hdr:%s",keyword);
366 (void) SetImageProperty(image,tag,value,exception);
371 (void) FormatLocaleString(tag,MagickPathExtent,"hdr:%s",keyword);
372 (void) SetImageProperty(image,tag,value,exception);
377 if ((image->columns == 0) && (image->rows == 0))
378 while (isspace((int) ((unsigned char) c)) != 0)
379 c=ReadBlobByte(image);
381 if ((LocaleCompare(format,"32-bit_rle_rgbe") != 0) &&
382 (LocaleCompare(format,"32-bit_rle_xyze") != 0))
383 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
384 if ((image->columns == 0) || (image->rows == 0))
385 ThrowReaderException(CorruptImageError,"NegativeOrZeroImageSize");
386 (void) SetImageColorspace(image,RGBColorspace,exception);
387 if (LocaleCompare(format,"32-bit_rle_xyze") == 0)
388 (void) SetImageColorspace(image,XYZColorspace,exception);
389 image->compression=(image->columns < 8) || (image->columns > 0x7ffff) ?
390 NoCompression : RLECompression;
391 if (image_info->ping != MagickFalse)
393 (void) CloseBlob(image);
394 return(GetFirstImageInList(image));
396 status=SetImageExtent(image,image->columns,image->rows,exception);
397 if (status == MagickFalse)
398 return(DestroyImageList(image));
400 Read RGBE (red+green+blue+exponent) pixels.
402 pixels=(unsigned char *) AcquireQuantumMemory(image->columns,4*
404 if (pixels == (unsigned char *) NULL)
405 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
406 (void) memset(pixels,0,4*image->columns*sizeof(*pixels));
407 for (y=0; y < (ssize_t) image->rows; y++)
409 if (image->compression != RLECompression)
411 count=ReadBlob(image,4*image->columns*sizeof(*pixels),pixels);
412 if (count != (ssize_t) (4*image->columns*sizeof(*pixels)))
417 count=ReadBlob(image,4*sizeof(*pixel),pixel);
420 if ((size_t) ((((size_t) pixel[2]) << 8) | pixel[3]) != image->columns)
422 (void) memcpy(pixels,pixel,4*sizeof(*pixel));
423 count=ReadBlob(image,4*(image->columns-1)*sizeof(*pixels),pixels+4);
424 image->compression=NoCompression;
429 for (i=0; i < 4; i++)
431 end=&pixels[(i+1)*image->columns];
434 count=ReadBlob(image,2*sizeof(*pixel),pixel);
439 count=(ssize_t) pixel[0]-128;
440 if ((count == 0) || (count > (ssize_t) (end-p)))
447 count=(ssize_t) pixel[0];
448 if ((count == 0) || (count > (ssize_t) (end-p)))
453 count=ReadBlob(image,(size_t) count*sizeof(*p),p);
463 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
464 if (q == (Quantum *) NULL)
467 for (x=0; x < (ssize_t) image->columns; x++)
469 if (image->compression == RLECompression)
472 pixel[1]=pixels[x+image->columns];
473 pixel[2]=pixels[x+2*image->columns];
474 pixel[3]=pixels[x+3*image->columns];
478 pixel[0]=pixels[i++];
479 pixel[1]=pixels[i++];
480 pixel[2]=pixels[i++];
481 pixel[3]=pixels[i++];
483 SetPixelRed(image,0,q);
484 SetPixelGreen(image,0,q);
485 SetPixelBlue(image,0,q);
488 gamma=pow(2.0,pixel[3]-(128.0+8.0));
489 SetPixelRed(image,ClampToQuantum(QuantumRange*gamma*pixel[0]),q);
490 SetPixelGreen(image,ClampToQuantum(QuantumRange*gamma*pixel[1]),q);
491 SetPixelBlue(image,ClampToQuantum(QuantumRange*gamma*pixel[2]),q);
493 q+=GetPixelChannels(image);
495 if (SyncAuthenticPixels(image,exception) == MagickFalse)
497 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
499 if (status == MagickFalse)
502 pixels=(unsigned char *) RelinquishMagickMemory(pixels);
503 if (EOFBlob(image) != MagickFalse)
504 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
506 (void) CloseBlob(image);
507 return(GetFirstImageInList(image));
511 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
515 % R e g i s t e r H D R I m a g e %
519 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
521 % RegisterHDRImage() adds attributes for the Radiance RGBE image format to the
522 % list of supported formats. The attributes include the image format tag, a
523 % method to read and/or write the format, whether the format supports the
524 % saving of more than one frame to the same file or blob, whether the format
525 % supports native in-memory I/O, and a brief description of the format.
527 % The format of the RegisterHDRImage method is:
529 % size_t RegisterHDRImage(void)
532 ModuleExport size_t RegisterHDRImage(void)
537 entry=AcquireMagickInfo("HDR","HDR","Radiance RGBE image format");
538 entry->decoder=(DecodeImageHandler *) ReadHDRImage;
539 entry->encoder=(EncodeImageHandler *) WriteHDRImage;
540 entry->magick=(IsImageFormatHandler *) IsHDR;
541 (void) RegisterMagickInfo(entry);
542 return(MagickImageCoderSignature);
546 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
550 % U n r e g i s t e r H D R I m a g e %
554 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
556 % UnregisterHDRImage() removes format registrations made by the
557 % HDR module from the list of supported formats.
559 % The format of the UnregisterHDRImage method is:
561 % UnregisterHDRImage(void)
564 ModuleExport void UnregisterHDRImage(void)
566 (void) UnregisterMagickInfo("HDR");
570 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
574 % W r i t e H D R I m a g e %
578 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
580 % WriteHDRImage() writes an image in the Radience RGBE image format.
582 % The format of the WriteHDRImage method is:
584 % MagickBooleanType WriteHDRImage(const ImageInfo *image_info,
585 % Image *image,ExceptionInfo *exception)
587 % A description of each parameter follows.
589 % o image_info: the image info.
591 % o image: The image.
595 static size_t HDRWriteRunlengthPixels(Image *image,unsigned char *pixels)
597 #define MinimumRunlength 4
613 for (p=0; p < image->columns; )
618 while ((runlength < MinimumRunlength) && (q < image->columns))
621 previous_count=(ssize_t) runlength;
623 while ((pixels[q] == pixels[q+runlength]) &&
624 ((q+runlength) < image->columns) && (runlength < 127))
627 if ((previous_count > 1) && (previous_count == (ssize_t) (q-p)))
629 pixel[0]=(unsigned char) (128+previous_count);
631 if (WriteBlob(image,2*sizeof(*pixel),pixel) < 1)
637 count=(ssize_t) (q-p);
640 pixel[0]=(unsigned char) count;
641 if (WriteBlob(image,sizeof(*pixel),pixel) < 1)
643 if (WriteBlob(image,(size_t) count*sizeof(*pixel),&pixels[p]) < 1)
647 if (runlength >= MinimumRunlength)
649 pixel[0]=(unsigned char) (128+runlength);
651 if (WriteBlob(image,2*sizeof(*pixel),pixel) < 1)
659 static MagickBooleanType WriteHDRImage(const ImageInfo *image_info,Image *image,
660 ExceptionInfo *exception)
663 header[MagickPathExtent];
671 register const Quantum
690 Open output image file.
692 assert(image_info != (const ImageInfo *) NULL);
693 assert(image_info->signature == MagickCoreSignature);
694 assert(image != (Image *) NULL);
695 assert(image->signature == MagickCoreSignature);
696 if (image->debug != MagickFalse)
697 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
698 assert(exception != (ExceptionInfo *) NULL);
699 assert(exception->signature == MagickCoreSignature);
700 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
701 if (status == MagickFalse)
703 if (IsRGBColorspace(image->colorspace) == MagickFalse)
704 (void) TransformImageColorspace(image,RGBColorspace,exception);
708 (void) memset(header,' ',MagickPathExtent);
709 length=CopyMagickString(header,"#?RADIANCE\n",MagickPathExtent);
710 (void) WriteBlob(image,length,(unsigned char *) header);
711 property=GetImageProperty(image,"comment",exception);
712 if ((property != (const char *) NULL) &&
713 (strchr(property,'\n') == (char *) NULL))
715 count=FormatLocaleString(header,MagickPathExtent,"#%.*s\n",
716 MagickPathExtent-3,property);
717 (void) WriteBlob(image,(size_t) count,(unsigned char *) header);
719 property=GetImageProperty(image,"hdr:exposure",exception);
720 if (property != (const char *) NULL)
722 count=FormatLocaleString(header,MagickPathExtent,"EXPOSURE=%g\n",
723 strtod(property,(char **) NULL));
724 (void) WriteBlob(image,(size_t) count,(unsigned char *) header);
726 if (image->gamma != 0.0)
728 count=FormatLocaleString(header,MagickPathExtent,"GAMMA=%g\n",
730 (void) WriteBlob(image,(size_t) count,(unsigned char *) header);
732 count=FormatLocaleString(header,MagickPathExtent,
733 "PRIMARIES=%g %g %g %g %g %g %g %g\n",
734 image->chromaticity.red_primary.x,image->chromaticity.red_primary.y,
735 image->chromaticity.green_primary.x,image->chromaticity.green_primary.y,
736 image->chromaticity.blue_primary.x,image->chromaticity.blue_primary.y,
737 image->chromaticity.white_point.x,image->chromaticity.white_point.y);
738 (void) WriteBlob(image,(size_t) count,(unsigned char *) header);
739 length=CopyMagickString(header,"FORMAT=32-bit_rle_rgbe\n\n",MagickPathExtent);
740 (void) WriteBlob(image,length,(unsigned char *) header);
741 count=FormatLocaleString(header,MagickPathExtent,"-Y %.20g +X %.20g\n",
742 (double) image->rows,(double) image->columns);
743 (void) WriteBlob(image,(size_t) count,(unsigned char *) header);
747 pixels=(unsigned char *) AcquireQuantumMemory(image->columns+128,4*
749 if (pixels == (unsigned char *) NULL)
750 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
751 (void) memset(pixels,0,4*(image->columns+128)*sizeof(*pixels));
752 for (y=0; y < (ssize_t) image->rows; y++)
754 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
755 if (p == (const Quantum *) NULL)
757 if ((image->columns >= 8) && (image->columns <= 0x7ffff))
761 pixel[2]=(unsigned char) (image->columns >> 8);
762 pixel[3]=(unsigned char) (image->columns & 0xff);
763 count=WriteBlob(image,4*sizeof(*pixel),pixel);
764 if (count != (ssize_t) (4*sizeof(*pixel)))
768 for (x=0; x < (ssize_t) image->columns; x++)
777 gamma=QuantumScale*GetPixelRed(image,p);
778 if ((QuantumScale*GetPixelGreen(image,p)) > gamma)
779 gamma=QuantumScale*GetPixelGreen(image,p);
780 if ((QuantumScale*GetPixelBlue(image,p)) > gamma)
781 gamma=QuantumScale*GetPixelBlue(image,p);
782 if (gamma > MagickEpsilon)
787 gamma=frexp(gamma,&exponent)*256.0/gamma;
788 pixel[0]=(unsigned char) (gamma*QuantumScale*GetPixelRed(image,p));
789 pixel[1]=(unsigned char) (gamma*QuantumScale*GetPixelGreen(image,p));
790 pixel[2]=(unsigned char) (gamma*QuantumScale*GetPixelBlue(image,p));
791 pixel[3]=(unsigned char) (exponent+128);
793 if ((image->columns >= 8) && (image->columns <= 0x7ffff))
796 pixels[x+image->columns]=pixel[1];
797 pixels[x+2*image->columns]=pixel[2];
798 pixels[x+3*image->columns]=pixel[3];
802 pixels[i++]=pixel[0];
803 pixels[i++]=pixel[1];
804 pixels[i++]=pixel[2];
805 pixels[i++]=pixel[3];
807 p+=GetPixelChannels(image);
809 if ((image->columns >= 8) && (image->columns <= 0x7ffff))
811 for (i=0; i < 4; i++)
812 length=HDRWriteRunlengthPixels(image,&pixels[i*image->columns]);
816 count=WriteBlob(image,4*image->columns*sizeof(*pixels),pixels);
817 if (count != (ssize_t) (4*image->columns*sizeof(*pixels)))
820 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
822 if (status == MagickFalse)
825 pixels=(unsigned char *) RelinquishMagickMemory(pixels);
826 (void) CloseBlob(image);