/*

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

%                                                                             %

%                                                                             %

%                             CCCC  IIIII  PPPP                               %

%                            C        I    P   P                              %

%                            C        I    PPPP                               %

%                            C        I    P                                  %

%                             CCCC  IIIII  P                                  %

%                                                                             %

%                                                                             %

%                  Read/Write Cisco IP Phone Image Format                     %

%                                                                             %

%                              Software Design                                %

%                                   Cristy                                    %

%                                April 2004                                   %

%                                                                             %

%                                                                             %

%  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/color-private.h"

#include "MagickCore/colorspace.h"

#include "MagickCore/colorspace-private.h"

#include "MagickCore/constitute.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/property.h"

#include "MagickCore/quantize.h"

#include "MagickCore/quantum-private.h"

#include "MagickCore/static.h"

#include "MagickCore/string_.h"

#include "MagickCore/module.h"

#include "MagickCore/utility.h"

#include "MagickCore/xml-tree-private.h"

/*

  Forward declarations.

*/

static MagickBooleanType

  WriteCIPImage(const ImageInfo *,Image *,ExceptionInfo *);

/*

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

%                                                                             %

%                                                                             %

%                                                                             %

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

%                                                                             %

%                                                                             %

%                                                                             %

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

%

%  RegisterCIPImage() adds properties for the CIP IP phone image format to

%  the list of supported formats.  The properties 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 RegisterCIPImage method is:

%

%      size_t RegisterCIPImage(void)

%

*/

ModuleExport size_t RegisterCIPImage(void)

{

  MagickInfo

    *entry;

  entry=AcquireMagickInfo("CIP","CIP","Cisco IP phone image format");

  entry->encoder=(EncodeImageHandler *) WriteCIPImage;

  entry->flags^=CoderAdjoinFlag;

  (void) RegisterMagickInfo(entry);

  return(MagickImageCoderSignature);

}

/*

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

%                                                                             %

%                                                                             %

%                                                                             %

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

%                                                                             %

%                                                                             %

%                                                                             %

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

%

%  UnregisterCIPImage() removes format registrations made by the

%  CIP module from the list of supported formats.

%

%  The format of the UnregisterCIPImage method is:

%

%      UnregisterCIPImage(void)

%

*/

ModuleExport void UnregisterCIPImage(void)

{

  (void) UnregisterMagickInfo("CIP");

}

/*

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

%                                                                             %

%                                                                             %

%                                                                             %

%   W r i t e C I P I m a g e                                                 %

%                                                                             %

%                                                                             %

%                                                                             %

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

%

%  Procedure WriteCIPImage() writes an image to a file in the Cisco IP phone

%  image format.

%

%  The format of the WriteCIPImage method is:

%

%      MagickBooleanType WriteCIPImage(const ImageInfo *image_info,

%        Image *image,ExceptionInfo *exception)

%

%  A description of each parameter follows.

%

%    o image_info: the image info.

%

%    o image:  The image.

%

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

%

*/

static MagickBooleanType WriteCIPImage(const ImageInfo *image_info,Image *image,

  ExceptionInfo *exception)

{

  char

    buffer[MagickPathExtent],

    *escaped;

  const char

    *hex_digits="0123456789abcdef",

    *value;

  MagickBooleanType

    status;

  const Quantum

    *p;

  size_t

    row_extent;

  ssize_t

    i,

    x;

  ssize_t

    y;

  unsigned char

    byte,

    *pixels,

    *q;

  /*

    Open output image file.

  */

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

  assert(image_info->signature == MagickCoreSignature);

  assert(image != (Image *) NULL);

  assert(image->signature == MagickCoreSignature);

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

  assert(exception->signature == MagickCoreSignature);

  if (IsEventLogging() != MagickFalse)

    (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);

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

  if (status == MagickFalse)

    return(status);

  (void) WriteBlobString(image,"<CiscoIPPhoneImage>\n");

  value=GetImageProperty(image,"label",exception);

  if (value == (const char *) NULL)

    {

      GetPathComponent(image->filename,BasePath,buffer);

      value=buffer;

    }

  escaped=SubstituteXMLEntities(value,MagickFalse);

  (void) WriteBlobString(image,"<Title>");

  if (escaped != (char*)NULL)

    (void) WriteBlobString(image,escaped);

  (void) WriteBlobString(image,"</Title>\n");

  escaped=DestroyString(escaped);

  (void) FormatLocaleString(buffer,MagickPathExtent,

    "<LocationX>%.17g</LocationX>\n",(double) image->page.x);

  (void) WriteBlobString(image,buffer);

  (void) FormatLocaleString(buffer,MagickPathExtent,

    "<LocationY>%.17g</LocationY>\n",(double) image->page.y);

  (void) WriteBlobString(image,buffer);

  (void) FormatLocaleString(buffer,MagickPathExtent,"<Width>%.17g</Width>\n",

    (double) (image->columns+(image->columns % 2)));

  (void) WriteBlobString(image,buffer);

  (void) FormatLocaleString(buffer,MagickPathExtent,"<Height>%.17g</Height>\n",

    (double) image->rows);

  (void) WriteBlobString(image,buffer);

  (void) FormatLocaleString(buffer,MagickPathExtent,"<Depth>2</Depth>\n");

  (void) WriteBlobString(image,buffer);

  (void) WriteBlobString(image,"<Data>");

  if (IssRGBCompatibleColorspace(image->colorspace) == MagickFalse)

    (void) TransformImageColorspace(image,sRGBColorspace,exception);

  row_extent=image->columns/4;

  if (row_extent > ((size_t) MAGICK_SSIZE_MAX-2*sizeof(unsigned int))/2)

    ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");

  /* Allow space for the existing trailing-byte hexadecimal formatting. */

  row_extent=2*row_extent+2*sizeof(unsigned int);

  pixels=(unsigned char *) AcquireQuantumMemory(row_extent,sizeof(*pixels));

  if (pixels == (unsigned char *) NULL)

    ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");

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

  {

    p=GetVirtualPixels(image,0,y,image->columns,1,exception);

    if (p == (const Quantum *) NULL)

      {

        status=MagickFalse;

        break;

      }

    q=pixels;

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

    {

      byte=(unsigned char)

        ((((size_t) (3*ClampToQuantum(GetPixelLuma(image,p+3*GetPixelChannels(image)))/QuantumRange) & 0x03) << 6) |

         (((size_t) (3*ClampToQuantum(GetPixelLuma(image,p+2*GetPixelChannels(image)))/QuantumRange) & 0x03) << 4) |

         (((size_t) (3*ClampToQuantum(GetPixelLuma(image,p+1*GetPixelChannels(image)))/QuantumRange) & 0x03) << 2) |

         (((size_t) (3*ClampToQuantum(GetPixelLuma(image,p+0*GetPixelChannels(image)))/QuantumRange) & 0x03) << 0));

      *q++=(unsigned char) hex_digits[byte >> 4];

      *q++=(unsigned char) hex_digits[byte & 0x0f];

      p+=(ptrdiff_t) GetPixelChannels(image);

    }

    if ((image->columns % 4) != 0)

      {

        byte=0;

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

        {

          i=x % 4;

          switch (i)

          {

            case 0:

            {

              byte|=(unsigned char) (((size_t) (3*ClampToQuantum(GetPixelLuma(

                image,p+MagickMin(i,3)*(ssize_t) GetPixelChannels(image)))/

                QuantumRange) & 0x03) << 6);

              break;

            }

            case 1:

            {

              byte|=(unsigned char) (((size_t) (3*ClampToQuantum(GetPixelLuma(

                image,p+MagickMin(i,2)*(ssize_t) GetPixelChannels(image)))/

                QuantumRange) & 0x03) << 4);

              break;

            }

            case 2:

            {

              byte|=(unsigned char) (((size_t) (3*ClampToQuantum(GetPixelLuma(

                image,p+MagickMin(i,1)*(ssize_t) GetPixelChannels(image)))/

                QuantumRange) & 0x03) << 2);

              break;

            }

            case 3:

            {

              byte|=(unsigned char) (((size_t) (3*ClampToQuantum(GetPixelLuma(

                image,p+MagickMin(i,0)*(ssize_t) GetPixelChannels(image)))/

                QuantumRange) & 0x03) << 0);

              break;

            }

          }

        }

        (void) FormatLocaleString(buffer,MagickPathExtent,"%02x",~byte);

        (void) memcpy(q,buffer,strlen(buffer));

        q+=strlen(buffer);

      }

    if (WriteBlob(image,(size_t) (q-pixels),pixels) != (ssize_t) (q-pixels))

      {

        status=MagickFalse;

        break;

      }

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

      image->rows);

    if (status == MagickFalse)

      break;

  }

  pixels=(unsigned char *) RelinquishMagickMemory(pixels);

  (void) WriteBlobString(image,"</Data>\n");

  (void) WriteBlobString(image,"</CiscoIPPhoneImage>\n");

  if (CloseBlob(image) == MagickFalse)

    status=MagickFalse;

  return(status);

}