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

   1 /*
   2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
   3 %                                                                             %
   4 %                                                                             %
   5 %                                                                             %
   6 %                     V   V  IIIII   CCCC   AAA   RRRR                        %
   7 %                     V   V    I    C      A   A  R   R                       %
   8 %                     V   V    I    C      AAAAA  RRRR                        %
   9 %                      V V     I    C      A   A  R R                         %
  10 %                       V    IIIII   CCCC  A   A  R  R                        %
  11 %                                                                             %
  12 %                                                                             %
  13 %                    Read/Write VICAR Rasterfile 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/cache.h"
  46 #include "MagickCore/colormap.h"
  47 #include "MagickCore/colorspace.h"
  48 #include "MagickCore/colorspace-private.h"
  49 #include "MagickCore/constitute.h"
  50 #include "MagickCore/exception.h"
  51 #include "MagickCore/exception-private.h"
  52 #include "MagickCore/image.h"
  53 #include "MagickCore/image-private.h"
  54 #include "MagickCore/list.h"
  55 #include "MagickCore/magick.h"
  56 #include "MagickCore/memory_.h"
  57 #include "MagickCore/module.h"
  58 #include "MagickCore/monitor.h"
  59 #include "MagickCore/monitor-private.h"
  60 #include "MagickCore/quantum-private.h"
  61 #include "MagickCore/quantum-private.h"
  62 #include "MagickCore/static.h"
  63 #include "MagickCore/string_.h"
  64 #include "MagickCore/string-private.h"
  65 \f
  66 /*
  67   Forward declarations.
  68 */
  69 static MagickBooleanType
  70   WriteVICARImage(const ImageInfo *,Image *,ExceptionInfo *);
  71 \f
  72 /*
  73 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  74 %                                                                             %
  75 %                                                                             %
  76 %                                                                             %
  77 %   I s V I C A R                                                             %
  78 %                                                                             %
  79 %                                                                             %
  80 %                                                                             %
  81 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  82 %
  83 %  IsVICAR() returns MagickTrue if the image format type, identified by the
  84 %  magick string, is VICAR.
  85 %
  86 %  The format of the IsVICAR method is:
  87 %
  88 %      MagickBooleanType IsVICAR(const unsigned char *magick,
  89 %        const size_t length)
  90 %
  91 %  A description of each parameter follows:
  92 %
  93 %    o magick: compare image format pattern against these bytes.
  94 %
  95 %    o length: Specifies the length of the magick string.
  96 %
  97 */
  98 static MagickBooleanType IsVICAR(const unsigned char *magick,
  99   const size_t length)
 100 {
 101   if (length < 14)
 102     return(MagickFalse);
 103   if (LocaleNCompare((const char *) magick,"LBLSIZE",7) == 0)
 104     return(MagickTrue);
 105   if (LocaleNCompare((const char *) magick,"NJPL1I",6) == 0)
 106     return(MagickTrue);
 107   if (LocaleNCompare((const char *) magick,"PDS_VERSION_ID",14) == 0)
 108     return(MagickTrue);
 109   return(MagickFalse);
 110 }
 111 \f
 112 /*
 113 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 114 %                                                                             %
 115 %                                                                             %
 116 %                                                                             %
 117 %   R e a d V I C A R I m a g e                                               %
 118 %                                                                             %
 119 %                                                                             %
 120 %                                                                             %
 121 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 122 %
 123 %  ReadVICARImage() reads a VICAR image file and returns it.  It
 124 %  allocates the memory necessary for the new Image structure and returns a
 125 %  pointer to the new image.
 126 %
 127 %  The format of the ReadVICARImage method is:
 128 %
 129 %      Image *ReadVICARImage(const ImageInfo *image_info,
 130 %        ExceptionInfo *exception)
 131 %
 132 %  A description of each parameter follows:
 133 %
 134 %    o image: Method ReadVICARImage returns a pointer to the image after
 135 %      reading.  A null image is returned if there is a memory shortage or if
 136 %      the image cannot be read.
 137 %
 138 %    o image_info: the image info.
 139 %
 140 %    o exception: return any errors or warnings in this structure.
 141 %
 142 %
 143 */
 144 static Image *ReadVICARImage(const ImageInfo *image_info,
 145   ExceptionInfo *exception)
 146 {
 147   char
 148     keyword[MaxTextExtent],
 149     value[MaxTextExtent];
 150
 151   Image
 152     *image;
 153
 154   int
 155     c;
 156
 157   MagickBooleanType
 158     status,
 159     value_expected;
 160
 161   QuantumInfo
 162     *quantum_info;
 163
 164   QuantumType
 165     quantum_type;
 166
 167   register Quantum
 168     *q;
 169
 170   size_t
 171     length;
 172
 173   ssize_t
 174     count,
 175     y;
 176
 177   unsigned char
 178     *pixels;
 179
 180   /*
 181     Open image file.
 182   */
 183   assert(image_info != (const ImageInfo *) NULL);
 184   assert(image_info->signature == MagickSignature);
 185   if (image_info->debug != MagickFalse)
 186     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
 187       image_info->filename);
 188   assert(exception != (ExceptionInfo *) NULL);
 189   assert(exception->signature == MagickSignature);
 190   image=AcquireImage(image_info,exception);
 191   status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
 192   if (status == MagickFalse)
 193     {
 194       image=DestroyImageList(image);
 195       return((Image *) NULL);
 196     }
 197   /*
 198     Decode image header.
 199   */
 200   c=ReadBlobByte(image);
 201   count=1;
 202   if (c == EOF)
 203     {
 204       image=DestroyImage(image);
 205       return((Image *) NULL);
 206     }
 207   length=0;
 208   image->columns=0;
 209   image->rows=0;
 210   while (isgraph(c) && ((image->columns == 0) || (image->rows == 0)))
 211   {
 212     if (isalnum(c) == MagickFalse)
 213       {
 214         c=ReadBlobByte(image);
 215         count++;
 216       }
 217     else
 218       {
 219         register char
 220           *p;
 221
 222         /*
 223           Determine a keyword and its value.
 224         */
 225         p=keyword;
 226         do
 227         {
 228           if ((size_t) (p-keyword) < (MaxTextExtent-1))
 229             *p++=c;
 230           c=ReadBlobByte(image);
 231           count++;
 232         } while (isalnum(c) || (c == '_'));
 233         *p='\0';
 234         value_expected=MagickFalse;
 235         while ((isspace((int) ((unsigned char) c)) != 0) || (c == '='))
 236         {
 237           if (c == '=')
 238             value_expected=MagickTrue;
 239           c=ReadBlobByte(image);
 240           count++;
 241         }
 242         if (value_expected == MagickFalse)
 243           continue;
 244         p=value;
 245         while (isalnum(c))
 246         {
 247           if ((size_t) (p-value) < (MaxTextExtent-1))
 248             *p++=c;
 249           c=ReadBlobByte(image);
 250           count++;
 251         }
 252         *p='\0';
 253         /*
 254           Assign a value to the specified keyword.
 255         */
 256         if (LocaleCompare(keyword,"Label_RECORDS") == 0)
 257           length=(ssize_t) StringToLong(value);
 258         if (LocaleCompare(keyword,"LBLSIZE") == 0)
 259           length=(ssize_t) StringToLong(value);
 260         if (LocaleCompare(keyword,"RECORD_BYTES") == 0)
 261           image->columns=StringToUnsignedLong(value);
 262         if (LocaleCompare(keyword,"NS") == 0)
 263           image->columns=StringToUnsignedLong(value);
 264         if (LocaleCompare(keyword,"LINES") == 0)
 265           image->rows=StringToUnsignedLong(value);
 266         if (LocaleCompare(keyword,"NL") == 0)
 267           image->rows=StringToUnsignedLong(value);
 268       }
 269     while (isspace((int) ((unsigned char) c)) != 0)
 270     {
 271       c=ReadBlobByte(image);
 272       count++;
 273     }
 274   }
 275   while (count < (ssize_t) length)
 276   {
 277     c=ReadBlobByte(image);
 278     count++;
 279   }
 280   if ((image->columns == 0) || (image->rows == 0))
 281     ThrowReaderException(CorruptImageError,"NegativeOrZeroImageSize");
 282   image->depth=8;
 283   if (AcquireImageColormap(image,256,exception) == MagickFalse)
 284     ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
 285   if (image_info->ping != MagickFalse)
 286     {
 287       (void) CloseBlob(image);
 288       return(GetFirstImageInList(image));
 289     }
 290   /*
 291     Read VICAR pixels.
 292   */
 293   quantum_type=IndexQuantum;
 294   quantum_info=AcquireQuantumInfo(image_info,image);
 295   if (quantum_info == (QuantumInfo *) NULL)
 296     ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
 297   pixels=GetQuantumPixels(quantum_info);
 298   length=GetQuantumExtent(image,quantum_info,IndexQuantum);
 299   for (y=0; y < (ssize_t) image->rows; y++)
 300   {
 301     q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
 302     if (q == (Quantum *) NULL)
 303       break;
 304     count=ReadBlob(image,length,pixels);
 305     (void) ImportQuantumPixels(image,(CacheView *) NULL,quantum_info,
 306       quantum_type,pixels,exception);
 307     if (SyncAuthenticPixels(image,exception) == MagickFalse)
 308       break;
 309     status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
 310       image->rows);
 311     if (status == MagickFalse)
 312       break;
 313   }
 314   SetQuantumImageType(image,quantum_type);
 315   quantum_info=DestroyQuantumInfo(quantum_info);
 316   if (EOFBlob(image) != MagickFalse)
 317     ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
 318       image->filename);
 319   (void) CloseBlob(image);
 320   return(GetFirstImageInList(image));
 321 }
 322 \f
 323 /*
 324 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 325 %                                                                             %
 326 %                                                                             %
 327 %                                                                             %
 328 %   R e g i s t e r V I C A R I m a g e                                       %
 329 %                                                                             %
 330 %                                                                             %
 331 %                                                                             %
 332 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 333 %
 334 %  RegisterVICARImage() adds attributes for the VICAR image format to
 335 %  the list of supported formats.  The attributes include the image format
 336 %  tag, a method to read and/or write the format, whether the format
 337 %  supports the saving of more than one frame to the same file or blob,
 338 %  whether the format supports native in-memory I/O, and a brief
 339 %  description of the format.
 340 %
 341 %  The format of the RegisterVICARImage method is:
 342 %
 343 %      size_t RegisterVICARImage(void)
 344 %
 345 */
 346 ModuleExport size_t RegisterVICARImage(void)
 347 {
 348   MagickInfo
 349     *entry;
 350
 351   entry=SetMagickInfo("VICAR");
 352   entry->decoder=(DecodeImageHandler *) ReadVICARImage;
 353   entry->encoder=(EncodeImageHandler *) WriteVICARImage;
 354   entry->magick=(IsImageFormatHandler *) IsVICAR;
 355   entry->adjoin=MagickFalse;
 356   entry->description=ConstantString("VICAR rasterfile format");
 357   entry->module=ConstantString("VICAR");
 358   (void) RegisterMagickInfo(entry);
 359   return(MagickImageCoderSignature);
 360 }
 361 \f
 362 /*
 363 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 364 %                                                                             %
 365 %                                                                             %
 366 %                                                                             %
 367 %   U n r e g i s t e r V I C A R I m a g e                                   %
 368 %                                                                             %
 369 %                                                                             %
 370 %                                                                             %
 371 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 372 %
 373 %  UnregisterVICARImage() removes format registrations made by the
 374 %  VICAR module from the list of supported formats.
 375 %
 376 %  The format of the UnregisterVICARImage method is:
 377 %
 378 %      UnregisterVICARImage(void)
 379 %
 380 */
 381 ModuleExport void UnregisterVICARImage(void)
 382 {
 383   (void) UnregisterMagickInfo("VICAR");
 384 }
 385 \f
 386 /*
 387 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 388 %                                                                             %
 389 %                                                                             %
 390 %                                                                             %
 391 %   W r i t e V I C A R I m a g e                                             %
 392 %                                                                             %
 393 %                                                                             %
 394 %                                                                             %
 395 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 396 %
 397 %  WriteVICARImage() writes an image in the VICAR rasterfile format.
 398 %  Vicar files contain a text header, followed by one or more planes of binary
 399 %  grayscale image data.  Vicar files are designed to allow many planes to be
 400 %  stacked together to form image cubes.  This method only writes a single
 401 %  grayscale plane.
 402 %
 403 %  WriteVICARImage was written contributed by gorelick@esther.la.asu.edu.
 404 %
 405 %  The format of the WriteVICARImage method is:
 406 %
 407 %      MagickBooleanType WriteVICARImage(const ImageInfo *image_info,
 408 %        Image *image,ExceptionInfo *exception)
 409 %
 410 %  A description of each parameter follows.
 411 %
 412 %    o image_info: the image info.
 413 %
 414 %    o image:  The image.
 415 %
 416 %    o exception: return any errors or warnings in this structure.
 417 %
 418 */
 419 static MagickBooleanType WriteVICARImage(const ImageInfo *image_info,
 420   Image *image,ExceptionInfo *exception)
 421 {
 422   char
 423     header[MaxTextExtent];
 424
 425   int
 426     y;
 427
 428   MagickBooleanType
 429     status;
 430
 431   QuantumInfo
 432     *quantum_info;
 433
 434   register const Quantum
 435     *p;
 436
 437   size_t
 438     length;
 439
 440   ssize_t
 441     count;
 442
 443   unsigned char
 444     *pixels;
 445
 446   /*
 447     Open output image file.
 448   */
 449   assert(image_info != (const ImageInfo *) NULL);
 450   assert(image_info->signature == MagickSignature);
 451   assert(image != (Image *) NULL);
 452   assert(image->signature == MagickSignature);
 453   if (image->debug != MagickFalse)
 454     (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
 455   assert(exception != (ExceptionInfo *) NULL);
 456   assert(exception->signature == MagickSignature);
 457   status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
 458   if (status == MagickFalse)
 459     return(status);
 460   if (IsRGBColorspace(image->colorspace) == MagickFalse)
 461     (void) TransformImageColorspace(image,RGBColorspace,exception);
 462   /*
 463     Write header.
 464   */
 465   (void) ResetMagickMemory(header,' ',MaxTextExtent);
 466   (void) FormatLocaleString(header,MaxTextExtent,
 467     "LBLSIZE=%.20g FORMAT='BYTE' TYPE='IMAGE' BUFSIZE=20000 DIM=2 EOL=0 "
 468     "RECSIZE=%.20g ORG='BSQ' NL=%.20g NS=%.20g NB=1 N1=0 N2=0 N3=0 N4=0 NBB=0 "
 469     "NLB=0 TASK='ImageMagick'",(double) MaxTextExtent,(double) image->columns,
 470     (double) image->rows,(double) image->columns);
 471   (void) WriteBlob(image,MaxTextExtent,(unsigned char *) header);
 472   /*
 473     Write VICAR pixels.
 474   */
 475   image->depth=8;
 476   quantum_info=AcquireQuantumInfo(image_info,image);
 477   if (quantum_info == (QuantumInfo *) NULL)
 478     ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
 479   pixels=GetQuantumPixels(quantum_info);
 480   for (y=0; y < (ssize_t) image->rows; y++)
 481   {
 482     p=GetVirtualPixels(image,0,y,image->columns,1,exception);
 483     if (p == (const Quantum *) NULL)
 484       break;
 485     length=ExportQuantumPixels(image,(CacheView *) NULL,quantum_info,
 486       GrayQuantum,pixels,exception);
 487     count=WriteBlob(image,length,pixels);
 488     if (count != (ssize_t) length)
 489       break;
 490     status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
 491       image->rows);
 492     if (status == MagickFalse)
 493       break;
 494   }
 495   quantum_info=DestroyQuantumInfo(quantum_info);
 496   (void) CloseBlob(image);
 497   return(MagickTrue);
 498 }