granicus.if.org Git - imagemagick/blob - coders/fax.c

   1 /*
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 %                                                                             %
   4 %                                                                             %
   5 %                                                                             %
   6 %                            FFFFF   AAA   X   X                              %
   7 %                            F      A   A   X X                               %
   8 %                            FFF    AAAAA    X                                %
   9 %                            F      A   A   X X                               %
  10 %                            F      A   A  X   X                              %
  11 %                                                                             %
  12 %                                                                             %
  13 %                   Read/Write Group 3 Fax Image Format                       %
  14 %                                                                             %
  15 %                              Software Design                                %
  16 %                                John Cristy                                  %
  17 %                                 July 1992                                   %
  18 %                                                                             %
  19 %                                                                             %
  20 %  Copyright 1999-2011 ImageMagick Studio LLC, a non-profit organization      %
  21 %  dedicated to making software imaging solutions freely available.           %
  22 %                                                                             %
  23 %  You may not use this file except in compliance with the License.  You may  %
  24 %  obtain a copy of the License at                                            %
  25 %                                                                             %
  26 %    http://www.imagemagick.org/script/license.php                            %
  27 %                                                                             %
  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.                                             %
  33 %                                                                             %
  34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  35 %
  36 %
  37 */
  38 \f
  39 /*
  40   Include declarations.
  41 */
  42 #include "MagickCore/studio.h"
  43 #include "MagickCore/blob.h"
  44 #include "MagickCore/blob-private.h"
  45 #include "MagickCore/colormap.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/compress.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/memory_.h"
  56 #include "MagickCore/monitor.h"
  57 #include "MagickCore/monitor-private.h"
  58 #include "MagickCore/quantum-private.h"
  59 #include "MagickCore/static.h"
  60 #include "MagickCore/string_.h"
  61 #include "MagickCore/module.h"
  62 \f
  63 /*
  64   Forward declarations.
  65 */
  66 static MagickBooleanType
  67   WriteFAXImage(const ImageInfo *,Image *,ExceptionInfo *);
  68 \f
  69 /*
  70 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  71 %                                                                             %
  72 %                                                                             %
  73 %                                                                             %
  74 %   I s F A X                                                                 %
  75 %                                                                             %
  76 %                                                                             %
  77 %                                                                             %
  78 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  79 %
  80 %  IsFAX() returns MagickTrue if the image format type, identified by the
  81 %  magick string, is FAX.
  82 %
  83 %  The format of the IsFAX method is:
  84 %
  85 %      MagickBooleanType IsFAX(const unsigned char *magick,const size_t length)
  86 %
  87 %  A description of each parameter follows:
  88 %
  89 %    o magick: compare image format pattern against these bytes.
  90 %
  91 %    o length: Specifies the length of the magick string.
  92 %
  93 %
  94 */
  95 static MagickBooleanType IsFAX(const unsigned char *magick,const size_t length)
  96 {
  97   if (length < 4)
  98     return(MagickFalse);
  99   if (LocaleNCompare((char *) magick,"DFAX",4) == 0)
 100     return(MagickTrue);
 101   return(MagickFalse);
 102 }
 103 \f
 104 /*
 105 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 106 %                                                                             %
 107 %                                                                             %
 108 %                                                                             %
 109 %   R e a d F A X I m a g e                                                   %
 110 %                                                                             %
 111 %                                                                             %
 112 %                                                                             %
 113 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 114 %
 115 %  ReadFAXImage() reads a Group 3 FAX image file and returns it.  It
 116 %  allocates the memory necessary for the new Image structure and returns a
 117 %  pointer to the new image.
 118 %
 119 %  The format of the ReadFAXImage method is:
 120 %
 121 %      Image *ReadFAXImage(const ImageInfo *image_info,ExceptionInfo *exception)
 122 %
 123 %  A description of each parameter follows:
 124 %
 125 %    o image_info: the image info.
 126 %
 127 %    o exception: return any errors or warnings in this structure.
 128 %
 129 */
 130 static Image *ReadFAXImage(const ImageInfo *image_info,ExceptionInfo *exception)
 131 {
 132   Image
 133     *image;
 134
 135   MagickBooleanType
 136     status;
 137
 138   /*
 139     Open image file.
 140   */
 141   assert(image_info != (const ImageInfo *) NULL);
 142   assert(image_info->signature == MagickSignature);
 143   if (image_info->debug != MagickFalse)
 144     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
 145       image_info->filename);
 146   assert(exception != (ExceptionInfo *) NULL);
 147   assert(exception->signature == MagickSignature);
 148   image=AcquireImage(image_info,exception);
 149   status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
 150   if (status == MagickFalse)
 151     {
 152       image=DestroyImageList(image);
 153       return((Image *) NULL);
 154     }
 155   /*
 156     Initialize image structure.
 157   */
 158   image->storage_class=PseudoClass;
 159   if (image->columns == 0)
 160     image->columns=2592;
 161   if (image->rows == 0)
 162     image->rows=3508;
 163   image->depth=8;
 164   if (AcquireImageColormap(image,2,exception) == MagickFalse)
 165     ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
 166   /*
 167     Monochrome colormap.
 168   */
 169   image->colormap[0].red=(Quantum) QuantumRange;
 170   image->colormap[0].green=(Quantum) QuantumRange;
 171   image->colormap[0].blue=(Quantum) QuantumRange;
 172   image->colormap[1].red=(Quantum) 0;
 173   image->colormap[1].green=(Quantum) 0;
 174   image->colormap[1].blue=(Quantum) 0;
 175   if (image_info->ping != MagickFalse)
 176     {
 177       (void) CloseBlob(image);
 178       return(GetFirstImageInList(image));
 179     }
 180   status=HuffmanDecodeImage(image,exception);
 181   if (status == MagickFalse)
 182     ThrowReaderException(CorruptImageError,"UnableToReadImageData");
 183   if (EOFBlob(image) != MagickFalse)
 184     ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
 185       image->filename);
 186   (void) CloseBlob(image);
 187   return(GetFirstImageInList(image));
 188 }
 189 \f
 190 /*
 191 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 192 %                                                                             %
 193 %                                                                             %
 194 %                                                                             %
 195 %   R e g i s t e r F A X I m a g e                                           %
 196 %                                                                             %
 197 %                                                                             %
 198 %                                                                             %
 199 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 200 %
 201 %  RegisterFAXImage() adds attributes for the FAX image format to
 202 %  the list of supported formats.  The attributes include the image format
 203 %  tag, a method to read and/or write the format, whether the format
 204 %  supports the saving of more than one frame to the same file or blob,
 205 %  whether the format supports native in-memory I/O, and a brief
 206 %  description of the format.
 207 %
 208 %  The format of the RegisterFAXImage method is:
 209 %
 210 %      size_t RegisterFAXImage(void)
 211 %
 212 */
 213 ModuleExport size_t RegisterFAXImage(void)
 214 {
 215   MagickInfo
 216     *entry;
 217
 218   static const char
 219     *Note=
 220     {
 221       "FAX machines use non-square pixels which are 1.5 times wider than\n"
 222       "they are tall but computer displays use square pixels, therefore\n"
 223       "FAX images may appear to be narrow unless they are explicitly\n"
 224       "resized using a geometry of \"150x100%\".\n"
 225     };
 226
 227   entry=SetMagickInfo("FAX");
 228   entry->decoder=(DecodeImageHandler *) ReadFAXImage;
 229   entry->encoder=(EncodeImageHandler *) WriteFAXImage;
 230   entry->magick=(IsImageFormatHandler *) IsFAX;
 231   entry->description=ConstantString("Group 3 FAX");
 232   entry->note=ConstantString(Note);
 233   entry->module=ConstantString("FAX");
 234   (void) RegisterMagickInfo(entry);
 235   entry=SetMagickInfo("G3");
 236   entry->decoder=(DecodeImageHandler *) ReadFAXImage;
 237   entry->encoder=(EncodeImageHandler *) WriteFAXImage;
 238   entry->magick=(IsImageFormatHandler *) IsFAX;
 239   entry->adjoin=MagickFalse;
 240   entry->description=ConstantString("Group 3 FAX");
 241   entry->module=ConstantString("FAX");
 242   (void) RegisterMagickInfo(entry);
 243   return(MagickImageCoderSignature);
 244 }
 245 \f
 246 /*
 247 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 248 %                                                                             %
 249 %                                                                             %
 250 %                                                                             %
 251 %   U n r e g i s t e r F A X I m a g e                                       %
 252 %                                                                             %
 253 %                                                                             %
 254 %                                                                             %
 255 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 256 %
 257 %  UnregisterFAXImage() removes format registrations made by the
 258 %  FAX module from the list of supported formats.
 259 %
 260 %  The format of the UnregisterFAXImage method is:
 261 %
 262 %      UnregisterFAXImage(void)
 263 %
 264 */
 265 ModuleExport void UnregisterFAXImage(void)
 266 {
 267   (void) UnregisterMagickInfo("FAX");
 268   (void) UnregisterMagickInfo("G3");
 269 }
 270 \f
 271 /*
 272 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 273 %                                                                             %
 274 %                                                                             %
 275 %                                                                             %
 276 %   W r i t e F A X I m a g e                                                 %
 277 %                                                                             %
 278 %                                                                             %
 279 %                                                                             %
 280 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 281 %
 282 %  WriteFAXImage() writes an image to a file in 1 dimensional Huffman encoded
 283 %  format.
 284 %
 285 %  The format of the WriteFAXImage method is:
 286 %
 287 %      MagickBooleanType WriteFAXImage(const ImageInfo *image_info,
 288 %        Image *image,ExceptionInfo *exception)
 289 %
 290 %  A description of each parameter follows.
 291 %
 292 %    o image_info: the image info.
 293 %
 294 %    o image:  The image.
 295 %
 296 %    o exception: return any errors or warnings in this structure.
 297 %
 298 */
 299 static MagickBooleanType WriteFAXImage(const ImageInfo *image_info,Image *image,
 300   ExceptionInfo *exception)
 301 {
 302   ImageInfo
 303     *write_info;
 304
 305   MagickBooleanType
 306     status;
 307
 308   MagickOffsetType
 309     scene;
 310
 311   /*
 312     Open output image file.
 313   */
 314   assert(image_info != (const ImageInfo *) NULL);
 315   assert(image_info->signature == MagickSignature);
 316   assert(image != (Image *) NULL);
 317   assert(image->signature == MagickSignature);
 318   if (image->debug != MagickFalse)
 319     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
 320   assert(exception != (ExceptionInfo *) NULL);
 321   assert(exception->signature == MagickSignature);
 322   status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
 323   if (status == MagickFalse)
 324     return(status);
 325   write_info=CloneImageInfo(image_info);
 326   (void) CopyMagickString(write_info->magick,"FAX",MaxTextExtent);
 327   scene=0;
 328   do
 329   {
 330     /*
 331       Convert MIFF to monochrome.
 332     */
 333     if (IsRGBColorspace(image->colorspace) == MagickFalse)
 334       (void) TransformImageColorspace(image,RGBColorspace);
 335     status=HuffmanEncodeImage(write_info,image,image,exception);
 336     if (GetNextImageInList(image) == (Image *) NULL)
 337       break;
 338     image=SyncNextImageInList(image);
 339     status=SetImageProgress(image,SaveImagesTag,scene++,
 340       GetImageListLength(image));
 341     if (status == MagickFalse)
 342       break;
 343   } while (write_info->adjoin != MagickFalse);
 344   write_info=DestroyImageInfo(write_info);
 345   (void) CloseBlob(image);
 346   return(status);
 347 }