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

   1 /*
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 %                                                                             %
   4 %                                                                             %
   5 %                                                                             %
   6 %                              OOO   TTTTT  BBBB                              %
   7 %                             O   O    T    B   B                             %
   8 %                             O   O    T    BBBB                              %
   9 %                             O   O    T    B   B                             %
  10 %                              OOO     T    BBBB                              %
  11 %                                                                             %
  12 %                                                                             %
  13 %                      Read/Write On-The-Air Image Format                     %
  14 %                                                                             %
  15 %                              Software Design                                %
  16 %                                John Cristy                                  %
  17 %                               January 2000                                  %
  18 %                                                                             %
  19 %                                                                             %
  20 %  Copyright 1999-2010 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 /*
  39   Include declarations.
  40 */
  41 #include "magick/studio.h"
  42 #include "magick/blob.h"
  43 #include "magick/blob-private.h"
  44 #include "magick/cache.h"
  45 #include "magick/color-private.h"
  46 #include "magick/colormap.h"
  47 #include "magick/colorspace.h"
  48 #include "magick/exception.h"
  49 #include "magick/exception-private.h"
  50 #include "magick/image.h"
  51 #include "magick/image-private.h"
  52 #include "magick/list.h"
  53 #include "magick/magick.h"
  54 #include "magick/memory_.h"
  55 #include "magick/monitor.h"
  56 #include "magick/monitor-private.h"
  57 #include "magick/quantum-private.h"
  58 #include "magick/static.h"
  59 #include "magick/string_.h"
  60 #include "magick/module.h"
  61 \f
  62 /*
  63   Forward declarations.
  64 */
  65 static MagickBooleanType
  66   WriteOTBImage(const ImageInfo *,Image *);
  67 \f
  68 /*
  69 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  70 %                                                                             %
  71 %                                                                             %
  72 %                                                                             %
  73 %   R e a d O T B I m a g e                                                   %
  74 %                                                                             %
  75 %                                                                             %
  76 %                                                                             %
  77 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  78 %
  79 %  ReadOTBImage() reads a on-the-air (level 0) bitmap and returns it.  It
  80 %  allocates the memory necessary for the new Image structure and returns a
  81 %  pointer to the new image.
  82 %
  83 %  The format of the ReadOTBImage method is:
  84 %
  85 %      Image *ReadOTBImage(const ImageInfo *image_info,ExceptionInfo *exception)
  86 %
  87 %  A description of each parameter follows:
  88 %
  89 %    o image_info: the image info.
  90 %
  91 %    o exception: return any errors or warnings in this structure.
  92 %
  93 %
  94 */
  95 static Image *ReadOTBImage(const ImageInfo *image_info,ExceptionInfo *exception)
  96 {
  97 #define GetBit(a,i) (((a) >> (i)) & 1L)
  98
  99   Image
 100     *image;
 101
 102   int
 103     byte;
 104
 105   ssize_t
 106     y;
 107
 108   MagickBooleanType
 109     status;
 110
 111   register IndexPacket
 112     *indexes;
 113
 114   register ssize_t
 115     x;
 116
 117   register PixelPacket
 118     *q;
 119
 120   unsigned char
 121     bit,
 122     info,
 123     depth;
 124
 125   /*
 126     Open image file.
 127   */
 128   assert(image_info != (const ImageInfo *) NULL);
 129   assert(image_info->signature == MagickSignature);
 130   if (image_info->debug != MagickFalse)
 131     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
 132       image_info->filename);
 133   assert(exception != (ExceptionInfo *) NULL);
 134   assert(exception->signature == MagickSignature);
 135   image=AcquireImage(image_info);
 136   status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
 137   if (status == MagickFalse)
 138     {
 139       image=DestroyImageList(image);
 140       return((Image *) NULL);
 141     }
 142   /*
 143     Initialize image structure.
 144   */
 145   info=(unsigned char) ReadBlobByte(image);
 146   if (GetBit(info,4) == 0)
 147     {
 148       image->columns=(size_t) ReadBlobByte(image);
 149       image->rows=(size_t) ReadBlobByte(image);
 150     }
 151   else
 152     {
 153       image->columns=(size_t) ReadBlobMSBShort(image);
 154       image->rows=(size_t) ReadBlobMSBShort(image);
 155     }
 156   if ((image->columns == 0) || (image->rows == 0))
 157     ThrowReaderException(CorruptImageError,"ImproperImageHeader");
 158   depth=(unsigned char) ReadBlobByte(image);
 159   if (depth != 1)
 160     ThrowReaderException(CoderError,"OnlyLevelZerofilesSupported");
 161   if (AcquireImageColormap(image,2) == MagickFalse)
 162     ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
 163   if (image_info->ping != MagickFalse)
 164     {
 165       (void) CloseBlob(image);
 166       return(GetFirstImageInList(image));
 167     }
 168   /*
 169     Convert bi-level image to pixel packets.
 170   */
 171   for (y=0; y < (ssize_t) image->rows; y++)
 172   {
 173     q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
 174     if (q == (PixelPacket *) NULL)
 175       break;
 176     indexes=GetAuthenticIndexQueue(image);
 177     bit=0;
 178     byte=0;
 179     for (x=0; x < (ssize_t) image->columns; x++)
 180     {
 181       if (bit == 0)
 182         {
 183           byte=ReadBlobByte(image);
 184           if (byte == EOF)
 185             ThrowReaderException(CorruptImageError,"CorruptImage");
 186         }
 187       indexes[x]=(IndexPacket) ((byte & (0x01 << (7-bit))) ? 0x00 : 0x01);
 188       bit++;
 189       if (bit == 8)
 190         bit=0;
 191     }
 192     if (SyncAuthenticPixels(image,exception) == MagickFalse)
 193       break;
 194     if (image->previous == (Image *) NULL)
 195       {
 196         status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
 197                 image->rows);
 198         if (status == MagickFalse)
 199           break;
 200       }
 201   }
 202   (void) SyncImage(image);
 203   if (EOFBlob(image) != MagickFalse)
 204     ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
 205       image->filename);
 206   (void) CloseBlob(image);
 207   return(GetFirstImageInList(image));
 208 }
 209 \f
 210 /*
 211 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 212 %                                                                             %
 213 %                                                                             %
 214 %                                                                             %
 215 %   R e g i s t e r O T B I m a g e                                           %
 216 %                                                                             %
 217 %                                                                             %
 218 %                                                                             %
 219 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 220 %
 221 %  RegisterOTBImage() adds attributes for the OTB image format to
 222 %  the list of supported formats.  The attributes include the image format
 223 %  tag, a method to read and/or write the format, whether the format
 224 %  supports the saving of more than one frame to the same file or blob,
 225 %  whether the format supports native in-memory I/O, and a brief
 226 %  description of the format.
 227 %
 228 %  The format of the RegisterOTBImage method is:
 229 %
 230 %      size_t RegisterOTBImage(void)
 231 %
 232 */
 233 ModuleExport size_t RegisterOTBImage(void)
 234 {
 235   MagickInfo
 236     *entry;
 237
 238   entry=SetMagickInfo("OTB");
 239   entry->decoder=(DecodeImageHandler *) ReadOTBImage;
 240   entry->encoder=(EncodeImageHandler *) WriteOTBImage;
 241   entry->adjoin=MagickFalse;
 242   entry->description=ConstantString("On-the-air bitmap");
 243   entry->module=ConstantString("OTB");
 244   (void) RegisterMagickInfo(entry);
 245   return(MagickImageCoderSignature);
 246 }
 247 \f
 248 /*
 249 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 250 %                                                                             %
 251 %                                                                             %
 252 %                                                                             %
 253 %   U n r e g i s t e r O T B I m a g e                                       %
 254 %                                                                             %
 255 %                                                                             %
 256 %                                                                             %
 257 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 258 %
 259 %  UnregisterOTBImage() removes format registrations made by the
 260 %  OTB module from the list of supported formats.
 261 %
 262 %  The format of the UnregisterOTBImage method is:
 263 %
 264 %      UnregisterOTBImage(void)
 265 %
 266 */
 267 ModuleExport void UnregisterOTBImage(void)
 268 {
 269   (void) UnregisterMagickInfo("OTB");
 270 }
 271 \f
 272 /*
 273 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 274 %                                                                             %
 275 %                                                                             %
 276 %                                                                             %
 277 %   W r i t e O T B I m a g e                                                 %
 278 %                                                                             %
 279 %                                                                             %
 280 %                                                                             %
 281 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 282 %
 283 %  WriteOTBImage() writes an image to a file in the On-the-air Bitmap
 284 %  (level 0) image format.
 285 %
 286 %  The format of the WriteOTBImage method is:
 287 %
 288 %      MagickBooleanType WriteOTBImage(const ImageInfo *image_info,Image *image)
 289 %
 290 %  A description of each parameter follows.
 291 %
 292 %    o image_info: the image info.
 293 %
 294 %    o image:  The image.
 295 %
 296 %
 297 */
 298 static MagickBooleanType WriteOTBImage(const ImageInfo *image_info,Image *image)
 299 {
 300 #define SetBit(a,i,set) \
 301   a=(unsigned char) ((set) ? (a) | (1L << (i)) : (a) & ~(1L << (i)))
 302
 303   ssize_t
 304     y;
 305
 306   MagickBooleanType
 307     status;
 308
 309   register const PixelPacket
 310     *p;
 311
 312   register ssize_t
 313     x;
 314
 315   unsigned char
 316     bit,
 317     byte,
 318     info;
 319
 320   /*
 321     Open output image file.
 322   */
 323   assert(image_info != (const ImageInfo *) NULL);
 324   assert(image_info->signature == MagickSignature);
 325   assert(image != (Image *) NULL);
 326   assert(image->signature == MagickSignature);
 327   if (image->debug != MagickFalse)
 328     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
 329   status=OpenBlob(image_info,image,WriteBinaryBlobMode,&image->exception);
 330   if (status == MagickFalse)
 331     return(status);
 332   if (image->colorspace != RGBColorspace)
 333     (void) TransformImageColorspace(image,RGBColorspace);
 334   /*
 335     Convert image to a bi-level image.
 336   */
 337   (void) SetImageType(image,BilevelType);
 338   info=0;
 339   if ((image->columns >= 256) || (image->rows >= 256))
 340     SetBit(info,4,1);
 341   (void) WriteBlobByte(image,info);
 342   if ((image->columns >= 256) || (image->rows >= 256))
 343     {
 344       (void) WriteBlobMSBShort(image,(unsigned short) image->columns);
 345       (void) WriteBlobMSBShort(image,(unsigned short) image->rows);
 346     }
 347   else
 348     {
 349       (void) WriteBlobByte(image,(unsigned char) image->columns);
 350       (void) WriteBlobByte(image,(unsigned char) image->rows);
 351     }
 352   (void) WriteBlobByte(image,1);  /* depth */
 353   for (y=0; y < (ssize_t) image->rows; y++)
 354   {
 355     p=GetVirtualPixels(image,0,y,image->columns,1,&image->exception);
 356     if (p == (const PixelPacket *) NULL)
 357       break;
 358     bit=0;
 359     byte=0;
 360     for (x=0; x < (ssize_t) image->columns; x++)
 361     {
 362       if (PixelIntensity(p) < ((Quantum) QuantumRange/2.0))
 363         byte|=0x1 << (7-bit);
 364       bit++;
 365       if (bit == 8)
 366         {
 367           (void) WriteBlobByte(image,byte);
 368           bit=0;
 369           byte=0;
 370         }
 371       p++;
 372     }
 373     if (bit != 0)
 374       (void) WriteBlobByte(image,byte);
 375     if (image->previous == (Image *) NULL)
 376       {
 377         status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
 378                 image->rows);
 379         if (status == MagickFalse)
 380           break;
 381       }
 382   }
 383   (void) CloseBlob(image);
 384   return(MagickTrue);
 385 }