2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Read PSX TIM Image Format %
20 % Copyright 1999-2012 ImageMagick Studio LLC, a non-profit organization %
21 % dedicated to making software imaging solutions freely available. %
23 % You may not use this file except in compliance with the License. You may %
24 % obtain a copy of the License at %
26 % http://www.imagemagick.org/script/license.php %
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. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
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/exception.h"
48 #include "MagickCore/exception-private.h"
49 #include "MagickCore/image.h"
50 #include "MagickCore/image-private.h"
51 #include "MagickCore/list.h"
52 #include "MagickCore/magick.h"
53 #include "MagickCore/memory_.h"
54 #include "MagickCore/monitor.h"
55 #include "MagickCore/monitor-private.h"
56 #include "MagickCore/pixel-accessor.h"
57 #include "MagickCore/quantum-private.h"
58 #include "MagickCore/static.h"
59 #include "MagickCore/string_.h"
60 #include "MagickCore/module.h"
63 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
67 % R e a d T I M I m a g e %
71 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
73 % ReadTIMImage() reads a PSX TIM image file and returns it. It
74 % allocates the memory necessary for the new Image structure and returns a
75 % pointer to the new image.
77 % Contributed by os@scee.sony.co.uk.
79 % The format of the ReadTIMImage method is:
81 % Image *ReadTIMImage(const ImageInfo *image_info,ExceptionInfo *exception)
83 % A description of each parameter follows:
85 % o image_info: the image info.
87 % o exception: return any errors or warnings in this structure.
90 static Image *ReadTIMImage(const ImageInfo *image_info,ExceptionInfo *exception)
92 typedef struct _TIMInfo
121 register unsigned char
145 assert(image_info != (const ImageInfo *) NULL);
146 assert(image_info->signature == MagickSignature);
147 if (image_info->debug != MagickFalse)
148 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
149 image_info->filename);
150 assert(exception != (ExceptionInfo *) NULL);
151 assert(exception->signature == MagickSignature);
152 image=AcquireImage(image_info,exception);
153 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
154 if (status == MagickFalse)
156 image=DestroyImageList(image);
157 return((Image *) NULL);
160 Determine if this a TIM file.
162 tim_info.id=ReadBlobLSBLong(image);
166 Verify TIM identifier.
168 if (tim_info.id != 0x00000010)
169 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
170 tim_info.flag=ReadBlobLSBLong(image);
171 has_clut=tim_info.flag & (1 << 3) ? 1 : 0;
172 pixel_mode=tim_info.flag & 0x07;
173 switch ((int) pixel_mode)
175 case 0: bits_per_pixel=4; break;
176 case 1: bits_per_pixel=8; break;
177 case 2: bits_per_pixel=16; break;
178 case 3: bits_per_pixel=24; break;
179 default: bits_per_pixel=4; break;
187 Read TIM raster colormap.
189 (void)ReadBlobLSBLong(image);
190 (void)ReadBlobLSBShort(image);
191 (void)ReadBlobLSBShort(image);
192 width=ReadBlobLSBShort(image);
193 height=ReadBlobLSBShort(image);
194 image->columns=width;
196 if (AcquireImageColormap(image,pixel_mode == 1 ? 256UL : 16UL,exception) == MagickFalse)
197 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
198 tim_colormap=(unsigned char *) AcquireQuantumMemory(image->colors,
199 2UL*sizeof(*tim_colormap));
200 if (tim_colormap == (unsigned char *) NULL)
201 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
202 count=ReadBlob(image,2*image->colors,tim_colormap);
203 if (count != (ssize_t) (2*image->colors))
204 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
206 for (i=0; i < (ssize_t) image->colors; i++)
209 word|=(unsigned short) (*p++ << 8);
210 image->colormap[i].blue=ScaleCharToQuantum(
211 ScaleColor5to8(1UL*(word >> 10) & 0x1f));
212 image->colormap[i].green=ScaleCharToQuantum(
213 ScaleColor5to8(1UL*(word >> 5) & 0x1f));
214 image->colormap[i].red=ScaleCharToQuantum(
215 ScaleColor5to8(1UL*word & 0x1f));
217 tim_colormap=(unsigned char *) RelinquishMagickMemory(tim_colormap);
219 if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))
220 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
225 (void) ReadBlobLSBLong(image);
226 (void) ReadBlobLSBShort(image);
227 (void) ReadBlobLSBShort(image);
228 width=ReadBlobLSBShort(image);
229 height=ReadBlobLSBShort(image);
230 image_size=2*width*height;
231 bytes_per_line=width*2;
232 width=(width*16)/bits_per_pixel;
233 tim_data=(unsigned char *) AcquireQuantumMemory(image_size,
235 if (tim_data == (unsigned char *) NULL)
236 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
237 count=ReadBlob(image,image_size,tim_data);
238 if (count != (ssize_t) (image_size))
239 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
242 Initialize image structure.
244 image->columns=width;
247 Convert TIM raster image to pixel packets.
249 switch (bits_per_pixel)
254 Convert PseudoColor scanline.
256 for (y=(ssize_t) image->rows-1; y >= 0; y--)
258 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
259 if (q == (Quantum *) NULL)
261 p=tim_pixels+y*bytes_per_line;
262 for (x=0; x < ((ssize_t) image->columns-1); x+=2)
264 SetPixelIndex(image,(*p) & 0x0f,q);
265 q+=GetPixelChannels(image);
266 SetPixelIndex(image,(*p >> 4) & 0x0f,q);
268 q+=GetPixelChannels(image);
270 if ((image->columns % 2) != 0)
272 SetPixelIndex(image,(*p >> 4) & 0x0f,q);
274 q+=GetPixelChannels(image);
276 if (SyncAuthenticPixels(image,exception) == MagickFalse)
278 if (image->previous == (Image *) NULL)
280 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
282 if (status == MagickFalse)
291 Convert PseudoColor scanline.
293 for (y=(ssize_t) image->rows-1; y >= 0; y--)
295 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
296 if (q == (Quantum *) NULL)
298 p=tim_pixels+y*bytes_per_line;
299 for (x=0; x < (ssize_t) image->columns; x++)
301 SetPixelIndex(image,*p++,q);
302 q+=GetPixelChannels(image);
304 if (SyncAuthenticPixels(image,exception) == MagickFalse)
306 if (image->previous == (Image *) NULL)
308 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
310 if (status == MagickFalse)
319 Convert DirectColor scanline.
321 for (y=(ssize_t) image->rows-1; y >= 0; y--)
323 p=tim_pixels+y*bytes_per_line;
324 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
325 if (q == (Quantum *) NULL)
327 for (x=0; x < (ssize_t) image->columns; x++)
331 SetPixelBlue(image,ScaleCharToQuantum(ScaleColor5to8(
332 (1UL*word >> 10) & 0x1f)),q);
333 SetPixelGreen(image,ScaleCharToQuantum(ScaleColor5to8(
334 (1UL*word >> 5) & 0x1f)),q);
335 SetPixelRed(image,ScaleCharToQuantum(ScaleColor5to8(
336 (1UL*word >> 0) & 0x1f)),q);
337 q+=GetPixelChannels(image);
339 if (SyncAuthenticPixels(image,exception) == MagickFalse)
341 if (image->previous == (Image *) NULL)
343 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
345 if (status == MagickFalse)
354 Convert DirectColor scanline.
356 for (y=(ssize_t) image->rows-1; y >= 0; y--)
358 p=tim_pixels+y*bytes_per_line;
359 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
360 if (q == (Quantum *) NULL)
362 for (x=0; x < (ssize_t) image->columns; x++)
364 SetPixelRed(image,ScaleCharToQuantum(*p++),q);
365 SetPixelGreen(image,ScaleCharToQuantum(*p++),q);
366 SetPixelBlue(image,ScaleCharToQuantum(*p++),q);
367 q+=GetPixelChannels(image);
369 if (SyncAuthenticPixels(image,exception) == MagickFalse)
371 if (image->previous == (Image *) NULL)
373 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
375 if (status == MagickFalse)
382 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
384 if (image->storage_class == PseudoClass)
385 (void) SyncImage(image,exception);
386 tim_pixels=(unsigned char *) RelinquishMagickMemory(tim_pixels);
387 if (EOFBlob(image) != MagickFalse)
389 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
394 Proceed to next image.
396 tim_info.id=ReadBlobLSBLong(image);
397 if (tim_info.id == 0x00000010)
400 Allocate next image structure.
402 AcquireNextImage(image_info,image,exception);
403 if (GetNextImageInList(image) == (Image *) NULL)
405 image=DestroyImageList(image);
406 return((Image *) NULL);
408 image=SyncNextImageInList(image);
409 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
411 if (status == MagickFalse)
414 } while (tim_info.id == 0x00000010);
415 (void) CloseBlob(image);
416 return(GetFirstImageInList(image));
420 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
424 % R e g i s t e r T I M I m a g e %
428 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
430 % RegisterTIMImage() adds attributes for the TIM image format to
431 % the list of supported formats. The attributes include the image format
432 % tag, a method to read and/or write the format, whether the format
433 % supports the saving of more than one frame to the same file or blob,
434 % whether the format supports native in-memory I/O, and a brief
435 % description of the format.
437 % The format of the RegisterTIMImage method is:
439 % size_t RegisterTIMImage(void)
442 ModuleExport size_t RegisterTIMImage(void)
447 entry=SetMagickInfo("TIM");
448 entry->decoder=(DecodeImageHandler *) ReadTIMImage;
449 entry->description=ConstantString("PSX TIM");
450 entry->module=ConstantString("TIM");
451 (void) RegisterMagickInfo(entry);
452 return(MagickImageCoderSignature);
456 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
460 % U n r e g i s t e r T I M I m a g e %
464 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
466 % UnregisterTIMImage() removes format registrations made by the
467 % TIM module from the list of supported formats.
469 % The format of the UnregisterTIMImage method is:
471 % UnregisterTIMImage(void)
474 ModuleExport void UnregisterTIMImage(void)
476 (void) UnregisterMagickInfo("TIM");