/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%                                                                             %

%                                                                             %

%                                                                             %

%                            PPPP   IIIII  X   X                              %

%                            P   P    I     X X                               %

%                            PPPP     I      X                                %

%                            P        I     X X                               %

%                            P      IIIII  X   X                              %

%                                                                             %

%                                                                             %

%                    Read Alias/Wavefront RLE Image Format                    %

%                                                                             %

%                              Software Design                                %

%                                   Cristy                                    %

%                                 July 1992                                   %

%                                                                             %

%                                                                             %

%  Copyright @ 1999 ImageMagick Studio LLC, a non-profit organization         %

%  dedicated to making software imaging solutions freely available.           %

%                                                                             %

%  You may not use this file except in compliance with the License.  You may  %

%  obtain a copy of the License at                                            %

%                                                                             %

%    https://imagemagick.org/license/                                         %

%                                                                             %

%  Unless required by applicable law or agreed to in writing, software        %

%  distributed under the License is distributed on an "AS IS" BASIS,          %

%  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.   %

%  See the License for the specific language governing permissions and        %

%  limitations under the License.                                             %

%                                                                             %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%

%

*/

/*

  Include declarations.

*/

#include "MagickCore/studio.h"

#include "MagickCore/blob.h"

#include "MagickCore/blob-private.h"

#include "MagickCore/cache.h"

#include "MagickCore/colormap.h"

#include "MagickCore/exception.h"

#include "MagickCore/exception-private.h"

#include "MagickCore/image.h"

#include "MagickCore/image-private.h"

#include "MagickCore/list.h"

#include "MagickCore/magick.h"

#include "MagickCore/memory_.h"

#include "MagickCore/monitor.h"

#include "MagickCore/monitor-private.h"

#include "MagickCore/pixel-accessor.h"

#include "MagickCore/quantum-private.h"

#include "MagickCore/static.h"

#include "MagickCore/string_.h"

#include "MagickCore/module.h"

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%                                                                             %

%                                                                             %

%                                                                             %

%   R e a d P I X I m a g e                                                   %

%                                                                             %

%                                                                             %

%                                                                             %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%

%  ReadPIXImage() reads a Alias/Wavefront RLE image file and returns it.

%  It allocates the memory necessary for the new Image structure and returns a

%  pointer to the new image.

%

%  The format of the ReadPIXImage method is:

%

%      Image *ReadPIXImage(const ImageInfo *image_info,ExceptionInfo *exception)

%

%  A description of each parameter follows:

%

%    o image_info: the image info.

%

%    o exception: return any errors or warnings in this structure.

%

%

*/

static Image *ReadPIXImage(const ImageInfo *image_info,ExceptionInfo *exception)

{

  Image

    *image;

  MagickBooleanType

    status;

  Quantum

    blue,

    green,

    index,

    red;

  ssize_t

    x;

  Quantum

    *q;

  size_t

    bits_per_pixel,

    height,

    length,

    width;

  ssize_t

    y;

  /*

    Open image file.

  */

  assert(image_info != (const ImageInfo *) NULL);

  assert(image_info->signature == MagickCoreSignature);

  assert(exception != (ExceptionInfo *) NULL);

  assert(exception->signature == MagickCoreSignature);

  if (IsEventLogging() != MagickFalse)

    (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",

      image_info->filename);

  image=AcquireImage(image_info,exception);

  status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);

  if (status == MagickFalse)

    {

      image=DestroyImageList(image);

      return((Image *) NULL);

    }

  /*

    Read PIX image.

  */

  width=ReadBlobMSBShort(image);

  height=ReadBlobMSBShort(image);

  (void) ReadBlobMSBShort(image);  /* x-offset */

  (void) ReadBlobMSBShort(image);  /* y-offset */

  bits_per_pixel=ReadBlobMSBShort(image);

  if ((width == 0UL) || (height == 0UL) || ((bits_per_pixel != 8) &&

      (bits_per_pixel != 24)))

    ThrowReaderException(CorruptImageError,"ImproperImageHeader");

  do

  {

    /*

      Initialize image structure.

    */

    image->columns=width;

    image->rows=height;

    if (bits_per_pixel == 8)

      if (AcquireImageColormap(image,256,exception) == MagickFalse)

        ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");

    if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))

      if (image->scene >= (image_info->scene+image_info->number_scenes-1))

        break;

    status=SetImageExtent(image,image->columns,image->rows,exception);

    if (status == MagickFalse)

      return(DestroyImageList(image));

    status=ResetImagePixels(image,exception);

    if (status == MagickFalse)

      return(DestroyImageList(image));

    /*

      Convert PIX raster image to pixel packets.

    */

    red=(Quantum) 0;

    green=(Quantum) 0;

    blue=(Quantum) 0;

    index=0;

    length=0;

    for (y=0; y < (ssize_t) image->rows; y++)

    {

      q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);

      if (q == (Quantum *) NULL)

        break;

      for (x=0; x < (ssize_t) image->columns; x++)

      {

        if (length == 0)

          {

            int

              c;

            c=ReadBlobByte(image);

            if ((c == 0) || (c == EOF))

              break;

            length=(size_t) c;

            if (bits_per_pixel == 8)

              index=ScaleCharToQuantum((unsigned char) ReadBlobByte(image));

            else

              {

                blue=ScaleCharToQuantum((unsigned char) ReadBlobByte(image));

                green=ScaleCharToQuantum((unsigned char) ReadBlobByte(image));

                red=ScaleCharToQuantum((unsigned char) ReadBlobByte(image));

              }

          }

        if (image->storage_class == PseudoClass)

          SetPixelIndex(image,index,q);

        SetPixelBlue(image,blue,q);

        SetPixelGreen(image,green,q);

        SetPixelRed(image,red,q);

        length--;

        q+=(ptrdiff_t) GetPixelChannels(image);

      }

      if (x < (ssize_t) image->columns)

        break;

      if (SyncAuthenticPixels(image,exception) == MagickFalse)

        break;

      if (image->previous == (Image *) NULL)

        {

          status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,

            image->rows);

          if (status == MagickFalse)

            break;

        }

    }

    if (image->storage_class == PseudoClass)

      (void) SyncImage(image,exception);

    if (EOFBlob(image) != MagickFalse)

      {

        ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",

          image->filename);

        break;

      }

    /*

      Proceed to next image.

    */

    if (image_info->number_scenes != 0)

      if (image->scene >= (image_info->scene+image_info->number_scenes-1))

        break;

    width=ReadBlobMSBLong(image);

    height=ReadBlobMSBLong(image);

    (void) ReadBlobMSBShort(image);

    (void) ReadBlobMSBShort(image);

    bits_per_pixel=ReadBlobMSBShort(image);

    status=(width != 0UL) && (height == 0UL) && ((bits_per_pixel == 8) ||

      (bits_per_pixel == 24)) ? MagickTrue : MagickFalse;

    if (status != MagickFalse)

      {

        /*

          Allocate next image structure.

        */

        AcquireNextImage(image_info,image,exception);

        if (GetNextImageInList(image) == (Image *) NULL)

          {

            status=MagickFalse;

            break;

          }

        image=SyncNextImageInList(image);

        status=SetImageProgress(image,LoadImagesTag,TellBlob(image),

          GetBlobSize(image));

        if (status == MagickFalse)

          break;

      }

  } while (status != MagickFalse);

  if (CloseBlob(image) == MagickFalse)

    status=MagickFalse;

  if (status == MagickFalse)

    return(DestroyImageList(image));

  return(GetFirstImageInList(image));

}

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%                                                                             %

%                                                                             %

%                                                                             %

%   R e g i s t e r P I X I m a g e                                           %

%                                                                             %

%                                                                             %

%                                                                             %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%

%  RegisterPIXImage() adds attributes for the PIX image format to

%  the list of supported formats.  The attributes include the image format

%  tag, a method to read and/or write the format, whether the format

%  supports the saving of more than one frame to the same file or blob,

%  whether the format supports native in-memory I/O, and a brief

%  description of the format.

%

%  The format of the RegisterPIXImage method is:

%

%      size_t RegisterPIXImage(void)

%

*/

ModuleExport size_t RegisterPIXImage(void)

{

  MagickInfo

    *entry;

  entry=AcquireMagickInfo("PIX","PIX","Alias/Wavefront RLE image format");

  entry->decoder=(DecodeImageHandler *) ReadPIXImage;

  (void) RegisterMagickInfo(entry);

  return(MagickImageCoderSignature);

}

/*

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%                                                                             %

%                                                                             %

%                                                                             %

%   U n r e g i s t e r P I X I m a g e                                       %

%                                                                             %

%                                                                             %

%                                                                             %

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

%

%  UnregisterPIXImage() removes format registrations made by the

%  PIX module from the list of supported formats.

%

%  The format of the UnregisterPIXImage method is:

%

%      UnregisterPIXImage(void)

%

*/

ModuleExport void UnregisterPIXImage(void)

{

  (void) UnregisterMagickInfo("PIX");

}