2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13 % Read PSX TIM Image Format %
20 % Copyright 1999-2017 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 == MagickCoreSignature);
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 == MagickCoreSignature);
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;
188 Read TIM raster colormap.
190 (void)ReadBlobLSBLong(image);
191 (void)ReadBlobLSBShort(image);
192 (void)ReadBlobLSBShort(image);
193 width=ReadBlobLSBShort(image);
194 height=ReadBlobLSBShort(image);
195 image->columns=width;
197 if (AcquireImageColormap(image,pixel_mode == 1 ? 256UL : 16UL,exception) == MagickFalse)
198 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
199 tim_colormap=(unsigned char *) AcquireQuantumMemory(image->colors,
200 2UL*sizeof(*tim_colormap));
201 if (tim_colormap == (unsigned char *) NULL)
202 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
203 count=ReadBlob(image,2*image->colors,tim_colormap);
204 if (count != (ssize_t) (2*image->colors))
205 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
207 for (i=0; i < (ssize_t) image->colors; i++)
210 word|=(unsigned short) (*p++ << 8);
211 image->colormap[i].blue=ScaleCharToQuantum(
212 ScaleColor5to8(1UL*(word >> 10) & 0x1f));
213 image->colormap[i].green=ScaleCharToQuantum(
214 ScaleColor5to8(1UL*(word >> 5) & 0x1f));
215 image->colormap[i].red=ScaleCharToQuantum(
216 ScaleColor5to8(1UL*word & 0x1f));
218 tim_colormap=(unsigned char *) RelinquishMagickMemory(tim_colormap);
220 if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))
221 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
223 status=SetImageExtent(image,image->columns,image->rows,exception);
224 if (status == MagickFalse)
225 return(DestroyImageList(image));
229 (void) ReadBlobLSBLong(image);
230 (void) ReadBlobLSBShort(image);
231 (void) ReadBlobLSBShort(image);
232 width=ReadBlobLSBShort(image);
233 height=ReadBlobLSBShort(image);
234 image_size=2*width*height;
235 bytes_per_line=width*2;
236 width=(width*16)/bits_per_pixel;
237 tim_data=(unsigned char *) AcquireQuantumMemory(image_size,
239 if (tim_data == (unsigned char *) NULL)
240 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
241 count=ReadBlob(image,image_size,tim_data);
242 if (count != (ssize_t) (image_size))
243 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
246 Initialize image structure.
248 image->columns=width;
251 Convert TIM raster image to pixel packets.
253 switch (bits_per_pixel)
258 Convert PseudoColor scanline.
260 for (y=(ssize_t) image->rows-1; y >= 0; y--)
262 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
263 if (q == (Quantum *) NULL)
265 p=tim_pixels+y*bytes_per_line;
266 for (x=0; x < ((ssize_t) image->columns-1); x+=2)
268 SetPixelIndex(image,(*p) & 0x0f,q);
269 q+=GetPixelChannels(image);
270 SetPixelIndex(image,(*p >> 4) & 0x0f,q);
272 q+=GetPixelChannels(image);
274 if ((image->columns % 2) != 0)
276 SetPixelIndex(image,(*p >> 4) & 0x0f,q);
278 q+=GetPixelChannels(image);
280 if (SyncAuthenticPixels(image,exception) == MagickFalse)
282 if (image->previous == (Image *) NULL)
284 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
286 if (status == MagickFalse)
295 Convert PseudoColor scanline.
297 for (y=(ssize_t) image->rows-1; y >= 0; y--)
299 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
300 if (q == (Quantum *) NULL)
302 p=tim_pixels+y*bytes_per_line;
303 for (x=0; x < (ssize_t) image->columns; x++)
305 SetPixelIndex(image,*p++,q);
306 q+=GetPixelChannels(image);
308 if (SyncAuthenticPixels(image,exception) == MagickFalse)
310 if (image->previous == (Image *) NULL)
312 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
314 if (status == MagickFalse)
323 Convert DirectColor scanline.
325 for (y=(ssize_t) image->rows-1; y >= 0; y--)
327 p=tim_pixels+y*bytes_per_line;
328 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
329 if (q == (Quantum *) NULL)
331 for (x=0; x < (ssize_t) image->columns; x++)
335 SetPixelBlue(image,ScaleCharToQuantum(ScaleColor5to8(
336 (1UL*word >> 10) & 0x1f)),q);
337 SetPixelGreen(image,ScaleCharToQuantum(ScaleColor5to8(
338 (1UL*word >> 5) & 0x1f)),q);
339 SetPixelRed(image,ScaleCharToQuantum(ScaleColor5to8(
340 (1UL*word >> 0) & 0x1f)),q);
341 q+=GetPixelChannels(image);
343 if (SyncAuthenticPixels(image,exception) == MagickFalse)
345 if (image->previous == (Image *) NULL)
347 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
349 if (status == MagickFalse)
358 Convert DirectColor scanline.
360 for (y=(ssize_t) image->rows-1; y >= 0; y--)
362 p=tim_pixels+y*bytes_per_line;
363 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
364 if (q == (Quantum *) NULL)
366 for (x=0; x < (ssize_t) image->columns; x++)
368 SetPixelRed(image,ScaleCharToQuantum(*p++),q);
369 SetPixelGreen(image,ScaleCharToQuantum(*p++),q);
370 SetPixelBlue(image,ScaleCharToQuantum(*p++),q);
371 q+=GetPixelChannels(image);
373 if (SyncAuthenticPixels(image,exception) == MagickFalse)
375 if (image->previous == (Image *) NULL)
377 status=SetImageProgress(image,LoadImageTag,(MagickOffsetType) y,
379 if (status == MagickFalse)
386 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
388 if (image->storage_class == PseudoClass)
389 (void) SyncImage(image,exception);
390 tim_pixels=(unsigned char *) RelinquishMagickMemory(tim_pixels);
391 if (EOFBlob(image) != MagickFalse)
393 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
398 Proceed to next image.
400 tim_info.id=ReadBlobLSBLong(image);
401 if (tim_info.id == 0x00000010)
404 Allocate next image structure.
406 AcquireNextImage(image_info,image,exception);
407 if (GetNextImageInList(image) == (Image *) NULL)
409 image=DestroyImageList(image);
410 return((Image *) NULL);
412 image=SyncNextImageInList(image);
413 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
415 if (status == MagickFalse)
418 } while (tim_info.id == 0x00000010);
419 (void) CloseBlob(image);
420 return(GetFirstImageInList(image));
424 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
428 % R e g i s t e r T I M I m a g e %
432 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
434 % RegisterTIMImage() adds attributes for the TIM image format to
435 % the list of supported formats. The attributes include the image format
436 % tag, a method to read and/or write the format, whether the format
437 % supports the saving of more than one frame to the same file or blob,
438 % whether the format supports native in-memory I/O, and a brief
439 % description of the format.
441 % The format of the RegisterTIMImage method is:
443 % size_t RegisterTIMImage(void)
446 ModuleExport size_t RegisterTIMImage(void)
451 entry=AcquireMagickInfo("TIM","TIM","PSX TIM");
452 entry->decoder=(DecodeImageHandler *) ReadTIMImage;
453 (void) RegisterMagickInfo(entry);
454 return(MagickImageCoderSignature);
458 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
462 % U n r e g i s t e r T I M I m a g e %
466 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
468 % UnregisterTIMImage() removes format registrations made by the
469 % TIM module from the list of supported formats.
471 % The format of the UnregisterTIMImage method is:
473 % UnregisterTIMImage(void)
476 ModuleExport void UnregisterTIMImage(void)
478 (void) UnregisterMagickInfo("TIM");