2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % IIIIIIIIII PPPPPPPP LL %
13 % IIIIIIIIII PP LLLLLLLL %
17 % Read/Write Scanalytics IPLab Image Format %
22 % Copyright 1999-2018 ImageMagick Studio LLC, a non-profit organization %
23 % dedicated to making software imaging solutions freely available. %
25 % You may not use this file except in compliance with the License. You may %
26 % obtain a copy of the License at %
28 % https://www.imagemagick.org/script/license.php %
30 % Unless required by applicable law or agreed to in writing, software %
31 % distributed under the License is distributed on an "AS IS" BASIS, %
32 % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
33 % See the License for the specific language governing permissions and %
34 % limitations under the License. %
36 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
44 #include "MagickCore/studio.h"
45 #include "MagickCore/blob.h"
46 #include "MagickCore/blob-private.h"
47 #include "MagickCore/cache.h"
48 #include "MagickCore/colorspace.h"
49 #include "MagickCore/colorspace-private.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/monitor.h"
58 #include "MagickCore/monitor-private.h"
59 #include "MagickCore/option.h"
60 #include "MagickCore/property.h"
61 #include "MagickCore/quantum-private.h"
62 #include "MagickCore/static.h"
63 #include "MagickCore/string_.h"
64 #include "MagickCore/module.h"
70 typedef struct _IPLInfo
84 static MagickBooleanType
85 WriteIPLImage(const ImageInfo *,Image *,ExceptionInfo *);
88 static void increase (void *pixel, int byteType){
90 case 0:(*((unsigned char *) pixel))++; break;
91 case 1:(*((signed int *) pixel))++; break;
92 case 2:(*((unsigned int *) pixel))++; break;
93 case 3:(*((signed long *) pixel))++; break;
94 default:(*((unsigned int *) pixel))++; break;
100 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
108 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
110 % IsIPL() returns MagickTrue if the image format type, identified by the
111 % magick string, is IPL.
113 % The format of the IsIPL method is:
115 % MagickBooleanType IsIPL(const unsigned char *magick,const size_t length)
117 % A description of each parameter follows:
119 % o magick: compare image format pattern against these bytes.
121 % o length: Specifies the length of the magick string.
124 static MagickBooleanType IsIPL(const unsigned char *magick,const size_t length)
128 if (LocaleNCompare((const char *) magick,"data",4) == 0)
134 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
138 % R e a d I P L I m a g e %
142 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
144 % ReadIPLImage() reads a Scanalytics IPLab image file and returns it. It
145 % allocates the memory necessary for the new Image structure and returns a
146 % pointer to the new image.
148 % According to the IPLab spec, the data is blocked out in five dimensions:
149 % { t, z, c, y, x }. When we return the image, the latter three are folded
150 % into the standard "Image" structure. The "scenes" (image_info->scene)
151 % correspond to the order: { {t0,z0}, {t0, z1}, ..., {t1,z0}, {t1,z1}... }
152 % The number of scenes is t*z.
154 % The format of the ReadIPLImage method is:
156 % Image *ReadIPLImage(const ImageInfo *image_info,ExceptionInfo *exception)
158 % A description of each parameter follows:
160 % o image_info: The image info.
162 % o exception: return any errors or warnings in this structure.
166 static void SetHeaderFromIPL(Image *image, IPLInfo *ipl){
167 image->columns = ipl->width;
168 image->rows = ipl->height;
169 image->depth = ipl->depth;
170 image->resolution.x = 1;
171 image->resolution.y = 1;
175 static Image *ReadIPLImage(const ImageInfo *image_info,ExceptionInfo *exception)
183 MagickBooleanType status;
185 unsigned char magick[12], *pixels;
206 assert(image_info != (const ImageInfo *) NULL);
207 assert(image_info->signature == MagickCoreSignature);
208 if ( image_info->debug != MagickFalse)
209 (void) LogMagickEvent(TraceEvent, GetMagickModule(), "%s",
210 image_info->filename);
211 assert(exception != (ExceptionInfo *) NULL);
212 assert(exception->signature == MagickCoreSignature);
213 image=AcquireImage(image_info,exception);
214 status=OpenBlob(image_info,image,ReadBinaryBlobMode,exception);
215 if (status == MagickFalse)
217 image=DestroyImageList(image);
218 return((Image *) NULL);
227 If we get back "iiii", we have LSB,"mmmm", MSB
229 count=ReadBlob(image,4,magick);
231 ThrowReaderException(CorruptImageError, "ImproperImageHeader");
232 if((LocaleNCompare((char *) magick,"iiii",4) == 0))
233 image->endian=LSBEndian;
235 if((LocaleNCompare((char *) magick,"mmmm",4) == 0))
236 image->endian=MSBEndian;
238 ThrowReaderException(CorruptImageError, "ImproperImageHeader");
241 /* Skip o'er the next 8 bytes (garbage) */
242 count=ReadBlob(image, 8, magick);
244 Excellent, now we read the header unimpeded.
246 count=ReadBlob(image,4,magick);
247 if((count != 4) || (LocaleNCompare((char *) magick,"data",4) != 0))
248 ThrowReaderException(CorruptImageError, "ImproperImageHeader");
249 ipl_info.size=ReadBlobLong(image);
250 ipl_info.width=ReadBlobLong(image);
251 ipl_info.height=ReadBlobLong(image);
252 if((ipl_info.width == 0UL) || (ipl_info.height == 0UL))
253 ThrowReaderException(CorruptImageError,"ImproperImageHeader");
254 ipl_info.colors=ReadBlobLong(image);
255 if(ipl_info.colors == 3){ SetImageColorspace(image,sRGBColorspace,exception);}
256 else { image->colorspace = GRAYColorspace; }
257 ipl_info.z=ReadBlobLong(image);
258 ipl_info.time=ReadBlobLong(image);
260 ipl_info.byteType=ReadBlobLong(image);
263 /* Initialize Quantum Info */
265 switch (ipl_info.byteType) {
268 quantum_format = UnsignedQuantumFormat;
272 quantum_format = SignedQuantumFormat;
276 quantum_format = UnsignedQuantumFormat;
280 quantum_format = SignedQuantumFormat;
282 case 4: ipl_info.depth=32;
283 quantum_format = FloatingPointQuantumFormat;
287 quantum_format = UnsignedQuantumFormat;
291 quantum_format = UnsignedQuantumFormat;
295 quantum_format = FloatingPointQuantumFormat;
299 quantum_format = UnsignedQuantumFormat;
302 extent=ipl_info.width*ipl_info.height*ipl_info.z*ipl_info.depth/8;
303 if (extent > GetBlobSize(image))
304 ThrowReaderException(CorruptImageError,"InsufficientImageDataInFile");
307 Set number of scenes of image
309 SetHeaderFromIPL(image, &ipl_info);
311 /* Thats all we need if we are pinging. */
312 if (image_info->ping != MagickFalse)
314 (void) CloseBlob(image);
315 return(GetFirstImageInList(image));
317 length=image->columns;
318 quantum_type=GetQuantumType(image,exception);
321 SetHeaderFromIPL(image, &ipl_info);
323 if ((image_info->ping != MagickFalse) && (image_info->number_scenes != 0))
324 if (image->scene >= (image_info->scene+image_info->number_scenes-1))
326 status=SetImageExtent(image,image->columns,image->rows,exception);
327 if (status == MagickFalse)
328 return(DestroyImageList(image));
330 printf("Length: %.20g, Memory size: %.20g\n", (double) length,(double)
333 quantum_info=AcquireQuantumInfo(image_info,image);
334 if (quantum_info == (QuantumInfo *) NULL)
335 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
336 status=SetQuantumFormat(image,quantum_info,quantum_format);
337 if (status == MagickFalse)
338 ThrowReaderException(ResourceLimitError,"MemoryAllocationFailed");
339 pixels=(unsigned char *) GetQuantumPixels(quantum_info);
340 if(image->columns != ipl_info.width){
342 printf("Columns not set correctly! Wanted: %.20g, got: %.20g\n",
343 (double) ipl_info.width, (double) image->columns);
348 Covert IPL binary to pixel packets
351 if(ipl_info.colors == 1){
352 for(y = 0; y < (ssize_t) image->rows; y++){
353 (void) ReadBlob(image, length*image->depth/8, pixels);
354 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
355 if (q == (Quantum *) NULL)
357 (void) ImportQuantumPixels(image,(CacheView *) NULL,quantum_info,
358 GrayQuantum,pixels,exception);
359 if (SyncAuthenticPixels(image,exception) == MagickFalse)
364 for(y = 0; y < (ssize_t) image->rows; y++){
365 (void) ReadBlob(image, length*image->depth/8, pixels);
366 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
367 if (q == (Quantum *) NULL)
369 (void) ImportQuantumPixels(image,(CacheView *) NULL,quantum_info,
370 RedQuantum,pixels,exception);
371 if (SyncAuthenticPixels(image,exception) == MagickFalse)
374 for(y = 0; y < (ssize_t) image->rows; y++){
375 (void) ReadBlob(image, length*image->depth/8, pixels);
376 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
377 if (q == (Quantum *) NULL)
379 (void) ImportQuantumPixels(image,(CacheView *) NULL,quantum_info,
380 GreenQuantum,pixels,exception);
381 if (SyncAuthenticPixels(image,exception) == MagickFalse)
384 for(y = 0; y < (ssize_t) image->rows; y++){
385 (void) ReadBlob(image, length*image->depth/8, pixels);
386 q=QueueAuthenticPixels(image,0,y,image->columns,1,exception);
387 if (q == (Quantum *) NULL)
389 (void) ImportQuantumPixels(image,(CacheView *) NULL,quantum_info,
390 BlueQuantum,pixels,exception);
391 if (SyncAuthenticPixels(image,exception) == MagickFalse)
395 SetQuantumImageType(image,quantum_type);
398 quantum_info = DestroyQuantumInfo(quantum_info);
400 if (EOFBlob(image) != MagickFalse)
402 ThrowFileException(exception,CorruptImageError,"UnexpectedEndOfFile",
406 if (t_count < ipl_info.z * ipl_info.time)
409 Proceed to next image.
411 AcquireNextImage(image_info,image,exception);
412 if (GetNextImageInList(image) == (Image *) NULL)
417 image=SyncNextImageInList(image);
418 status=SetImageProgress(image,LoadImagesTag,TellBlob(image),
420 if (status == MagickFalse)
423 } while (t_count < ipl_info.z*ipl_info.time);
425 if (status == MagickFalse)
426 return(DestroyImageList(image));
427 return(GetFirstImageInList(image));
431 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
435 % R e g i s t e r I P L I m a g e %
439 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
441 % RegisterIPLImage() add attributes for the Scanalytics IPL image format to the
442 % list of supported formats.
446 ModuleExport size_t RegisterIPLImage(void)
451 entry=AcquireMagickInfo("IPL","IPL","IPL Image Sequence");
452 entry->decoder=(DecodeImageHandler *) ReadIPLImage;
453 entry->encoder=(EncodeImageHandler *) WriteIPLImage;
454 entry->magick=(IsImageFormatHandler *) IsIPL;
455 entry->flags|=CoderDecoderSeekableStreamFlag;
456 entry->flags|=CoderEndianSupportFlag;
457 (void) RegisterMagickInfo(entry);
458 return(MagickImageCoderSignature);
462 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
466 % U n r e g i s t e r I P L I m a g e %
470 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
472 % UnregisterIPLImage() removes format registrations made by the
473 % IPL module from the list of supported formats.
475 % The format of the UnregisterIPLImage method is:
477 % UnregisterIPLImage(void)
480 ModuleExport void UnregisterIPLImage(void)
482 (void) UnregisterMagickInfo("IPL");
486 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
490 % W r i t e I P L I m a g e %
494 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
496 % WriteIPLImage() writes an image to a file in Scanalytics IPLabimage format.
498 % The format of the WriteIPLImage method is:
500 % MagickBooleanType WriteIPLImage(const ImageInfo *image_info,Image *image)
501 % Image *image,ExceptionInfo *exception)
503 % A description of each parameter follows.
505 % o image_info: The image info.
507 % o image: The image.
509 % o exception: return any errors or warnings in this structure.
512 static MagickBooleanType WriteIPLImage(const ImageInfo *image_info,Image *image,
513 ExceptionInfo *exception)
524 register const Quantum
540 Open output image file.
542 assert(image_info != (const ImageInfo *) NULL);
543 assert(image_info->signature == MagickCoreSignature);
544 assert(image != (Image *) NULL);
545 assert(image->signature == MagickCoreSignature);
546 if (image->debug != MagickFalse)
547 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
548 assert(exception != (ExceptionInfo *) NULL);
549 assert(exception->signature == MagickCoreSignature);
550 status=OpenBlob(image_info,image,WriteBinaryBlobMode,exception);
551 if (status == MagickFalse)
555 quantum_info=AcquireQuantumInfo(image_info,image);
556 if (quantum_info == (QuantumInfo *) NULL)
557 ThrowWriterException(ResourceLimitError,"MemoryAllocationFailed");
558 if ((quantum_info->format == UndefinedQuantumFormat) &&
559 (IsHighDynamicRangeImage(image,exception) != MagickFalse))
560 SetQuantumFormat(image,quantum_info,FloatingPointQuantumFormat);
561 switch(quantum_info->depth){
563 ipl_info.byteType = 0;
566 if(quantum_info->format == SignedQuantumFormat){
567 ipl_info.byteType = 2;
570 ipl_info.byteType = 1;
574 if(quantum_info->format == FloatingPointQuantumFormat){
575 ipl_info.byteType = 3;
578 ipl_info.byteType = 4;
582 ipl_info.byteType = 10;
585 ipl_info.byteType = 2;
589 imageListLength=GetImageListLength(image);
590 ipl_info.z = (unsigned int) imageListLength;
591 /* There is no current method for detecting whether we have T or Z stacks */
593 ipl_info.width = (unsigned int) image->columns;
594 ipl_info.height = (unsigned int) image->rows;
595 (void) TransformImageColorspace(image,sRGBColorspace,exception);
596 if(IssRGBCompatibleColorspace(image->colorspace) != MagickFalse) { ipl_info.colors = 3; }
597 else{ ipl_info.colors = 1; }
599 ipl_info.size = (unsigned int) (28 +
600 ((image->depth)/8)*ipl_info.height*ipl_info.width*ipl_info.colors*ipl_info.z);
602 /* Ok! Calculations are done. Lets write this puppy down! */
607 /* Shockingly (maybe not if you have used IPLab), IPLab itself CANNOT read MSBEndian
608 files! The reader above can, but they cannot. For compatability reasons, I will leave
609 the code in here, but it is all but useless if you want to use IPLab. */
611 if(image_info->endian == MSBEndian)
612 (void) WriteBlob(image, 4, (const unsigned char *) "mmmm");
614 image->endian = LSBEndian;
615 (void) WriteBlob(image, 4, (const unsigned char *) "iiii");
617 (void) WriteBlobLong(image, 4);
618 (void) WriteBlob(image, 4, (const unsigned char *) "100f");
619 (void) WriteBlob(image, 4, (const unsigned char *) "data");
620 (void) WriteBlobLong(image, ipl_info.size);
621 (void) WriteBlobLong(image, ipl_info.width);
622 (void) WriteBlobLong(image, ipl_info.height);
623 (void) WriteBlobLong(image, ipl_info.colors);
624 if(image_info->adjoin == MagickFalse)
625 (void) WriteBlobLong(image, 1);
627 (void) WriteBlobLong(image, ipl_info.z);
628 (void) WriteBlobLong(image, ipl_info.time);
629 (void) WriteBlobLong(image, ipl_info.byteType);
634 Convert MIFF to IPL raster pixels.
636 pixels=(unsigned char *) GetQuantumPixels(quantum_info);
637 if(ipl_info.colors == 1){
639 for(y = 0; y < (ssize_t) ipl_info.height; y++){
640 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
641 if (p == (const Quantum *) NULL)
643 (void) ExportQuantumPixels(image,(CacheView *) NULL, quantum_info,
644 GrayQuantum, pixels,exception);
645 (void) WriteBlob(image, image->columns*image->depth/8, pixels);
649 if(ipl_info.colors == 3){
651 for(y = 0; y < (ssize_t) ipl_info.height; y++){
652 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
653 if (p == (const Quantum *) NULL)
655 (void) ExportQuantumPixels(image,(CacheView *) NULL, quantum_info,
656 RedQuantum, pixels,exception);
657 (void) WriteBlob(image, image->columns*image->depth/8, pixels);
661 for(y = 0; y < (ssize_t) ipl_info.height; y++){
662 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
663 if (p == (const Quantum *) NULL)
665 (void) ExportQuantumPixels(image,(CacheView *) NULL, quantum_info,
666 GreenQuantum, pixels,exception);
667 (void) WriteBlob(image, image->columns*image->depth/8, pixels);
670 for(y = 0; y < (ssize_t) ipl_info.height; y++){
671 p=GetVirtualPixels(image,0,y,image->columns,1,exception);
672 if (p == (const Quantum *) NULL)
674 (void) ExportQuantumPixels(image,(CacheView *) NULL, quantum_info,
675 BlueQuantum, pixels,exception);
676 (void) WriteBlob(image, image->columns*image->depth/8, pixels);
677 if (image->previous == (Image *) NULL)
679 status=SetImageProgress(image,SaveImageTag,(MagickOffsetType) y,
681 if (status == MagickFalse)
686 quantum_info=DestroyQuantumInfo(quantum_info);
687 if (GetNextImageInList(image) == (Image *) NULL)
689 image=SyncNextImageInList(image);
690 status=SetImageProgress(image,SaveImagesTag,scene++,imageListLength);
691 if (status == MagickFalse)
693 }while (image_info->adjoin != MagickFalse);
695 (void) WriteBlob(image, 4, (const unsigned char *) "fini");
696 (void) WriteBlobLong(image, 0);