2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % L IIIII SSSSS TTTTT %
10 % LLLLL IIIII SSSSS T %
13 % MagickCore Image List Methods %
20 % Copyright 1999-2011 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 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
43 #include "magick/studio.h"
44 #include "magick/blob.h"
45 #include "magick/blob-private.h"
46 #include "magick/exception.h"
47 #include "magick/exception-private.h"
48 #include "magick/list.h"
49 #include "magick/memory_.h"
50 #include "magick/string_.h"
53 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
57 % A p p e n d I m a g e T o L i s t %
61 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
63 % AppendImageToList() appends the second image list to the end of the first
64 % list. The given image list pointer is left unchanged, unless it was empty.
66 % The format of the AppendImageToList method is:
68 % AppendImageToList(Image *images,const Image *image)
70 % A description of each parameter follows:
72 % o images: the image list to be appended to.
74 % o image: the appended image or image list.
77 MagickExport void AppendImageToList(Image **images,const Image *image)
83 assert(images != (Image **) NULL);
84 if (image == (Image *) NULL)
86 assert(image->signature == MagickSignature);
87 if (image->debug != MagickFalse)
88 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
89 if ((*images) == (Image *) NULL)
91 *images=(Image *) image;
94 assert((*images)->signature == MagickSignature);
95 p=GetLastImageInList(*images);
96 q=GetFirstImageInList(image);
102 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
106 % C l o n e I m a g e L i s t %
110 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
112 % CloneImageList() returns a duplicate of the image list.
114 % The format of the CloneImageList method is:
116 % Image *CloneImageList(const Image *images,ExceptionInfo *exception)
118 % A description of each parameter follows:
120 % o images: the image list.
122 % o exception: return any errors or warnings in this structure.
125 MagickExport Image *CloneImageList(const Image *images,ExceptionInfo *exception)
134 if (images == (Image *) NULL)
135 return((Image *) NULL);
136 assert(images->signature == MagickSignature);
137 while (images->previous != (Image *) NULL)
138 images=images->previous;
139 image=(Image *) NULL;
140 for (p=(Image *) NULL; images != (Image *) NULL; images=images->next)
142 clone=CloneImage(images,0,0,MagickTrue,exception);
143 if (clone == (Image *) NULL)
145 if (image != (Image *) NULL)
146 image=DestroyImageList(image);
147 return((Image *) NULL);
149 if (image == (Image *) NULL)
163 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
167 % C l o n e I m a g e s %
171 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
173 % CloneImages() clones one or more images from an image sequence, using a
174 % comma separated list of image numbers or ranges.
176 % The numbers start at 0 for the first image in the list, while negative
177 % numbers refer to images starting counting from the end of the range. Images
178 % may be refered to multiple times to clone them multiple times. Images
179 % refered beyond the available number of images in list are ignored.
181 % Images referenced may be reversed, and results in a clone of those images
182 % also being made with a reversed order.
184 % The format of the CloneImages method is:
186 % Image *CloneImages(const Image *images,const char *scenes,
187 % ExceptionInfo *exception)
189 % A description of each parameter follows:
191 % o images: the image sequence.
193 % o scenes: This character string specifies which scenes to clone
194 % (e.g. 1,3-5,7-3,2).
196 % o exception: return any errors or warnings in this structure.
199 MagickExport Image *CloneImages(const Image *images,const char *scenes,
200 ExceptionInfo *exception)
223 assert(images != (const Image *) NULL);
224 assert(images->signature == MagickSignature);
225 assert(scenes != (char *) NULL);
226 if (images->debug != MagickFalse)
227 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
228 assert(exception != (ExceptionInfo *) NULL);
229 assert(exception->signature == MagickSignature);
230 clone_images=NewImageList();
231 images=GetFirstImageInList(images);
232 length=GetImageListLength(images);
233 for (p=(char *) scenes; *p != '\0';)
235 while ((isspace((int) ((unsigned char) *p)) != 0) || (*p == ','))
237 first=strtol(p,&p,10);
239 first+=(long) length;
241 while (isspace((int) ((unsigned char) *p)) != 0)
245 last=strtol(p+1,&p,10);
249 for (step=first > last ? -1 : 1; first != (last+step); first+=step)
252 for (next=images; next != (Image *) NULL; next=GetNextImageInList(next))
254 if (i == (ssize_t) first)
256 image=CloneImage(next,0,0,MagickTrue,exception);
257 if (image == (Image *) NULL)
259 AppendImageToList(&clone_images,image);
265 return(GetFirstImageInList(clone_images));
269 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
273 % D e l e t e I m a g e F r o m L i s t %
277 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
279 % DeleteImageFromList() duplicates an image from the list. List pointer
280 % is moved to the next image, if one is present. See RemoveImageFromList().
282 % The format of the DeleteImageFromList method is:
284 % DeleteImageFromList(Image **images)
286 % A description of each parameter follows:
288 % o images: the image list.
291 MagickExport void DeleteImageFromList(Image **images)
296 image=RemoveImageFromList(images);
297 if (image != (Image *) NULL)
298 (void) DestroyImage(image);
302 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
306 % D e l e t e I m a g e s %
310 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
312 % DeleteImages() duplicates one or more images from an image sequence, using a
313 % comma separated list of image numbers or ranges.
315 % The numbers start at 0 for the first image, while negative numbers refer to
316 % images starting counting from the end of the range. Images may be refered to
317 % multiple times without problems. Image refered beyond the available number
318 % of images in list are ignored.
320 % If the referenced images are in the reverse order, that range will be
321 % completely ignored, unlike CloneImages().
323 % The format of the DeleteImages method is:
325 % DeleteImages(Image **images,const char *scenes,ExceptionInfo *exception)
327 % A description of each parameter follows:
329 % o images: the image sequence.
331 % o scenes: This character string specifies which scenes to duplicate
332 % (e.g. 1,3-5,-2-6,2).
334 % o exception: return any errors or warnings in this structure.
337 MagickExport void DeleteImages(Image **images,const char *scenes,
338 ExceptionInfo *exception)
359 assert(images != (Image **) NULL);
360 assert((*images)->signature == MagickSignature);
361 assert(scenes != (char *) NULL);
362 if ((*images)->debug != MagickFalse)
363 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
364 (*images)->filename);
365 assert(exception != (ExceptionInfo *) NULL);
366 assert(exception->signature == MagickSignature);
367 *images=GetFirstImageInList(*images);
368 length=GetImageListLength(*images);
369 duplicate_list=(MagickBooleanType *) AcquireQuantumMemory(length,
370 sizeof(*duplicate_list));
371 if (duplicate_list == (MagickBooleanType *) NULL)
373 (void) ThrowMagickException(exception,GetMagickModule(),
374 ResourceLimitError,"MemoryAllocationFailed","`%s'",(*images)->filename);
378 for (i=0; i < (ssize_t) length; i++)
379 duplicate_list[i]=MagickFalse;
381 Note which images will be duplicated, avoid duplicate duplicated
383 for (p=(char *) scenes; *p != '\0';)
385 while ((isspace((int) *p) != 0) || (*p == ','))
387 first=strtol(p,&p,10);
389 first+=(long) length;
391 while (isspace((int) ((unsigned char) *p)) != 0)
395 last=strtol(p+1,&p,10);
401 for (i=(ssize_t) first; i <= (ssize_t) last; i++)
402 if ((i >= 0) && (i < (ssize_t) length))
403 duplicate_list[i]=MagickTrue;
406 Delete images marked for deletion, once only
409 for (i=0; i < (ssize_t) length; i++)
412 image=GetNextImageInList(image);
413 if (duplicate_list[i] != MagickFalse)
414 DeleteImageFromList(images);
417 (void) RelinquishMagickMemory(duplicate_list);
418 *images=GetFirstImageInList(*images);
422 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
426 % D e s t r o y I m a g e L i s t %
430 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
432 % DestroyImageList() destroys an image list.
434 % The format of the DestroyImageList method is:
436 % Image *DestroyImageList(Image *image)
438 % A description of each parameter follows:
440 % o image: the image sequence.
443 MagickExport Image *DestroyImageList(Image *images)
445 if (images == (Image *) NULL)
446 return((Image *) NULL);
447 assert(images->signature == MagickSignature);
448 if (images->debug != MagickFalse)
449 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
450 while (images != (Image *) NULL)
451 DeleteImageFromList(&images);
452 return((Image *) NULL);
456 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
460 % D u p l i c a t e I m a g e s %
464 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
466 % DuplicateImages() duplicates one or more images from an image sequence,
467 % using a count and a comma separated list of image numbers or ranges.
469 % The numbers start at 0 for the first image, while negative numbers refer to
470 % images starting counting from the end of the range. Images may be refered to
471 % multiple times without problems. Image refered beyond the available number
472 % of images in list are ignored.
474 % The format of the DuplicateImages method is:
476 % Image *DuplicateImages(Image *images,const size_t number_duplicates,
477 % const char *scenes,ExceptionInfo *exception)
479 % A description of each parameter follows:
481 % o images: the image sequence.
483 % o number_duplicates: duplicate the image sequence this number of times.
485 % o scenes: This character string specifies which scenes to duplicate (e.g.
488 % o exception: return any errors or warnings in this structure.
491 MagickExport Image *DuplicateImages(Image *images,
492 const size_t number_duplicates,const char *scenes,ExceptionInfo *exception)
504 assert(images != (Image *) NULL);
505 assert(images->signature == MagickSignature);
506 assert(scenes != (char *) NULL);
507 if (images->debug != MagickFalse)
508 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
509 assert(exception != (ExceptionInfo *) NULL);
510 assert(exception->signature == MagickSignature);
511 duplicate_images=NewImageList();
512 for (i=0; i < (ssize_t) number_duplicates; i++)
514 clone_images=CloneImages(images,scenes,exception);
515 AppendImageToList(&duplicate_images,clone_images);
517 return(duplicate_images);
521 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
525 % G e t F i r s t I m a g e I n L i s t %
529 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
531 % GetFirstImageInList() returns a pointer to the first image in the list.
533 % The format of the GetFirstImageInList method is:
535 % Image *GetFirstImageInList(const Image *images)
537 % A description of each parameter follows:
539 % o images: the image list.
542 MagickExport Image *GetFirstImageInList(const Image *images)
547 if (images == (Image *) NULL)
548 return((Image *) NULL);
549 assert(images->signature == MagickSignature);
550 for (p=images; p->previous != (Image *) NULL; p=p->previous) ;
555 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
559 % G e t I m a g e F r o m L i s t %
563 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
565 % GetImageFromList() returns an image at the specified offset from the list.
567 % The format of the GetImageFromList method is:
569 % Image *GetImageFromList(const Image *images,const ssize_t index)
571 % A description of each parameter follows:
573 % o images: the image list.
575 % o index: the position within the list.
578 MagickExport Image *GetImageFromList(const Image *images,const ssize_t index)
592 if (images == (Image *) NULL)
593 return((Image *) NULL);
594 assert(images->signature == MagickSignature);
595 if (images->debug != MagickFalse)
596 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
597 for (p=images; p->previous != (Image *) NULL; p=p->previous) ;
598 length=GetImageListLength(images);
599 for (offset=index; offset < 0; offset+=(ssize_t) length) ;
600 for (i=0; p != (Image *) NULL; p=p->next)
601 if (i++ == (ssize_t) (offset % length))
603 if (p == (Image *) NULL)
604 return((Image *) NULL);
609 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
613 % G e t I m a g e I n d e x I n L i s t %
617 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
619 % GetImageIndexInList() returns the offset in the list of the specified image.
621 % The format of the GetImageIndexInList method is:
623 % ssize_t GetImageIndexInList(const Image *images)
625 % A description of each parameter follows:
627 % o images: the image list.
630 MagickExport ssize_t GetImageIndexInList(const Image *images)
635 if (images == (const Image *) NULL)
637 assert(images->signature == MagickSignature);
638 for (i=0; images->previous != (Image *) NULL; i++)
639 images=images->previous;
644 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
648 % G e t I m a g e L i s t L e n g t h %
652 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
654 % GetImageListLength() returns the length of the list (the number of images in
657 % The format of the GetImageListLength method is:
659 % size_t GetImageListLength(const Image *images)
661 % A description of each parameter follows:
663 % o images: the image list.
666 MagickExport size_t GetImageListLength(const Image *images)
671 if (images == (Image *) NULL)
673 assert(images->signature == MagickSignature);
674 if (images->debug != MagickFalse)
675 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
676 while (images->previous != (Image *) NULL)
677 images=images->previous;
678 for (i=0; images != (Image *) NULL; images=images->next)
684 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
688 % G e t L a s t I m a g e I n L i s t %
692 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
694 % GetLastImageInList() returns a pointer to the last image in the list.
696 % The format of the GetLastImageInList method is:
698 % Image *GetLastImageInList(const Image *images)
700 % A description of each parameter follows:
702 % o images: the image list.
705 MagickExport Image *GetLastImageInList(const Image *images)
710 if (images == (Image *) NULL)
711 return((Image *) NULL);
712 assert(images->signature == MagickSignature);
713 for (p=images; p->next != (Image *) NULL; p=p->next) ;
718 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
722 % G e t N e x t I m a g e I n L i s t %
726 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
728 % GetNextImageInList() returns the next image in the list.
730 % The format of the GetNextImageInList method is:
732 % Image *GetNextImageInList(const Image *images)
734 % A description of each parameter follows:
736 % o images: the image list.
739 MagickExport Image *GetNextImageInList(const Image *images)
741 if (images == (Image *) NULL)
742 return((Image *) NULL);
743 assert(images->signature == MagickSignature);
744 if (images->debug != MagickFalse)
745 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
746 return(images->next);
750 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
754 % G e t P r e v i o u s I m a g e I n L i s t %
758 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
760 % GetPreviousImageInList() returns the previous image in the list.
762 % The format of the GetPreviousImageInList method is:
764 % Image *GetPreviousImageInList(const Image *images)
766 % A description of each parameter follows:
768 % o images: the image list.
771 MagickExport Image *GetPreviousImageInList(const Image *images)
773 if (images == (Image *) NULL)
774 return((Image *) NULL);
775 assert(images->signature == MagickSignature);
776 return(images->previous);
780 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
783 % I m a g e L i s t T o A r r a y %
787 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
789 % ImageListToArray() is a convenience method that converts an image list to
790 % a sequential array. For example,
792 % group = ImageListToArray(images, exception);
793 % while (i = 0; group[i] != (Image *) NULL; i++)
794 % printf("%s\n", group[i]->filename);
795 % printf("%d images\n", i);
796 % group = RelinquishMagickMemory(group);
798 % The format of the ImageListToArray method is:
800 % Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
802 % A description of each parameter follows:
804 % o image: the image list.
806 % o exception: return any errors or warnings in this structure.
809 MagickExport Image **ImageListToArray(const Image *images,
810 ExceptionInfo *exception)
818 if (images == (Image *) NULL)
819 return((Image **) NULL);
820 assert(images->signature == MagickSignature);
821 if (images->debug != MagickFalse)
822 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
823 group=(Image **) AcquireQuantumMemory((size_t) GetImageListLength(images)+1UL,
825 if (group == (Image **) NULL)
827 (void) ThrowMagickException(exception,GetMagickModule(),
828 ResourceLimitError,"MemoryAllocationFailed","`%s'",images->filename);
829 return((Image **) NULL);
831 images=GetFirstImageInList(images);
832 for (i=0; images != (Image *) NULL; images=images->next)
833 group[i++]=(Image *) images;
834 group[i]=(Image *) NULL;
839 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
843 % I n s e r t I m a g e I n L i s t %
847 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
849 % InsertImageInList() inserts the second image or image list into the first
850 % image list immediately after the image pointed to. The given image list
851 % pointer is unchanged unless previously empty.
853 % The format of the InsertImageInList method is:
855 % InsertImageInList(Image **images,Image *image)
857 % A description of each parameter follows:
859 % o images: the image list to insert into.
861 % o image: the image list to insert.
864 MagickExport void InsertImageInList(Image **images,Image *image)
869 assert(images != (Image **) NULL);
870 assert(image != (Image *) NULL);
871 assert(image->signature == MagickSignature);
872 if (image->debug != MagickFalse)
873 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
874 if ((*images) == (Image *) NULL)
876 assert((*images)->signature == MagickSignature);
877 split=SplitImageList(*images);
878 AppendImageToList(images,image);
879 AppendImageToList(images,split);
883 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
887 % N e w I m a g e L i s t %
891 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
893 % NewImageList() creates an empty image list.
895 % The format of the NewImageList method is:
897 % Image *NewImageList(void)
900 MagickExport Image *NewImageList(void)
902 return((Image *) NULL);
906 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
910 + P a g e I n d e x I m a g e L i s t %
914 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
916 % PageIndexImageList() synchronizes the page_index and page_total values
919 % These values are used by InterpretImageProperties() to set %p and %n
920 % percent escapes. The value is preserved, even if the image is later removed
921 % from the list using RemoveFirstImageFromList() for individual image
924 % The format of the PageIndexImageList method is:
926 % void PageIndexImageList(Image *images)
928 % A description of each parameter follows:
930 % o images: the image list.
933 MagickExport void PageIndexImageList(Image *images)
938 if (images == (Image *) NULL)
940 assert(images->signature == MagickSignature);
941 if (images->debug != MagickFalse)
942 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
944 /* find start for image counting */
945 while (images->previous != (Image *) NULL)
946 images=images->previous;
948 /* count up images - find end */
950 while (images->next != (Image *) NULL)
951 images=images->next, n++;
953 /* set page_index and page_total attributes */
955 for (; images != (Image *) NULL; images=images->previous)
956 images->page_index=p--, images->page_total=(size_t) n;
960 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
964 % P r e p e n d I m a g e T o L i s t %
968 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
970 % PrependImageToList() prepends the image to the beginning of the list.
972 % The format of the PrependImageToList method is:
974 % PrependImageToList(Image *images,Image *image)
976 % A description of each parameter follows:
978 % o images: the image list.
980 % o image: the image.
983 MagickExport void PrependImageToList(Image **images,Image *image)
985 AppendImageToList(&image,*images);
989 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
993 % R e m o v e I m a g e F r o m L i s t %
997 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
999 % RemoveImageFromList() removes and returns the image pointed to.
1001 % The given image list pointer is set to point to the next image in list
1002 % if it exists, otherwise it is set to the previous image, or NULL if list
1005 % The format of the RemoveImageFromList method is:
1007 % Image *RemoveImageFromList(Image **images)
1009 % A description of each parameter follows:
1011 % o images: the image list.
1014 MagickExport Image *RemoveImageFromList(Image **images)
1019 assert(images != (Image **) NULL);
1020 if ((*images) == (Image *) NULL)
1021 return((Image *) NULL);
1022 assert((*images)->signature == MagickSignature);
1023 if ((*images)->debug != MagickFalse)
1024 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1025 (*images)->filename);
1027 if ((p->previous == (Image *) NULL) && (p->next == (Image *) NULL))
1028 *images=(Image *) NULL;
1031 if (p->previous != (Image *) NULL)
1033 p->previous->next=p->next;
1034 *images=p->previous;
1036 if (p->next != (Image *) NULL)
1038 p->next->previous=p->previous;
1041 p->previous=(Image *) NULL;
1042 p->next=(Image *) NULL;
1048 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1052 % R e m o v e F i r s t I m a g e F r o m L i s t %
1056 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1058 % RemoveFirstImageFromList() removes and returns the first image in the list.
1060 % If the given image list pointer pointed to the removed first image, it is
1061 % set to the new first image of list, or NULL if list was emptied, otherwise
1064 % The format of the RemoveFirstImageFromList method is:
1066 % Image *RemoveFirstImageFromList(Image **images)
1068 % A description of each parameter follows:
1070 % o images: the image list.
1073 MagickExport Image *RemoveFirstImageFromList(Image **images)
1078 assert(images != (Image **) NULL);
1079 if ((*images) == (Image *) NULL)
1080 return((Image *) NULL);
1081 assert((*images)->signature == MagickSignature);
1082 if ((*images)->debug != MagickFalse)
1083 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1084 (*images)->filename);
1086 while (image->previous != (Image *) NULL)
1087 image=image->previous;
1088 if (image == *images)
1089 *images=(*images)->next;
1090 if (image->next != (Image *) NULL)
1092 image->next->previous=(Image *) NULL;
1093 image->next=(Image *) NULL;
1099 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1103 % R e m o v e L a s t I m a g e F r o m L i s t %
1107 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1109 % RemoveLastImageFromList() removes and returns the last image from the list.
1111 % If the given image list pointer pointed to the removed last image, it is
1112 % set to the new last image of list, or NULL if list was emptied, otherwise
1115 % The format of the RemoveLastImageFromList method is:
1117 % Image *RemoveLastImageFromList(Image **images)
1119 % A description of each parameter follows:
1121 % o images: the image list.
1124 MagickExport Image *RemoveLastImageFromList(Image **images)
1129 assert(images != (Image **) NULL);
1130 if ((*images) == (Image *) NULL)
1131 return((Image *) NULL);
1132 assert((*images)->signature == MagickSignature);
1133 if ((*images)->debug != MagickFalse)
1134 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1135 (*images)->filename);
1137 while (image->next != (Image *) NULL)
1139 if (image == *images)
1140 *images=(*images)->previous;
1141 if (image->previous != (Image *) NULL)
1143 image->previous->next=(Image *) NULL;
1144 image->previous=(Image *) NULL;
1150 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1154 % R e p l a c e I m a g e I n L i s t %
1158 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1160 % ReplaceImageInList() replaces an image in the list. Old image is destroyed.
1161 % The given image list pointer is set to point to the just inserted image.
1163 % The format of the ReplaceImageInList method is:
1165 % ReplaceImageInList(Image **images,Image *image)
1167 % A description of each parameter follows:
1169 % o images: the image list.
1171 % o image: the image.
1174 MagickExport void ReplaceImageInList(Image **images,Image *image)
1176 assert(images != (Image **) NULL);
1177 assert(image != (Image *) NULL);
1178 assert(image->signature == MagickSignature);
1179 if (image->debug != MagickFalse)
1180 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",image->filename);
1181 if ((*images) == (Image *) NULL)
1183 assert((*images)->signature == MagickSignature);
1184 for ( ; image->next != (Image *) NULL; image=image->next) ;
1185 image->next=(*images)->next;
1186 if (image->next != (Image *) NULL)
1187 image->next->previous=image;
1188 for ( ; image->previous != (Image *) NULL; image=image->previous) ;
1189 image->previous=(*images)->previous;
1190 if (image->previous != (Image *) NULL)
1191 image->previous->next=image;
1192 (void) DestroyImage(*images);
1197 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1201 % R e v e r s e I m a g e L i s t %
1205 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1207 % ReverseImageList() reverses the order of an image list.
1208 % The list pointer is reset to that start of the re-ordered list.
1210 % The format of the ReverseImageList method is:
1212 % void ReverseImageList(Image **images)
1214 % A description of each parameter follows:
1216 % o images: the image list.
1219 MagickExport void ReverseImageList(Image **images)
1227 assert(images != (Image **) NULL);
1228 if ((*images) == (Image *) NULL)
1230 assert((*images)->signature == MagickSignature);
1231 if ((*images)->debug != MagickFalse)
1232 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1233 (*images)->filename);
1234 for (p=(*images); p->next != (Image *) NULL; p=p->next) ;
1236 for ( ; p != (Image *) NULL; p=p->next)
1239 p->next=p->previous;
1245 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1249 % S p l i c e I m a g e I n t o L i s t %
1253 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1255 % SpliceImageIntoList() removes 'length' images from the list and replaces
1256 % them with the specified splice. Removed images are returned.
1258 % The format of the SpliceImageIntoList method is:
1260 % SpliceImageIntoList(Image **images,const size_t,
1261 % const Image *splice)
1263 % A description of each parameter follows:
1265 % o images: the image list.
1267 % o length: the length of the image list to remove.
1269 % o splice: Replace the removed image list with this list.
1272 MagickExport Image *SpliceImageIntoList(Image **images,
1273 const size_t length,const Image *splice)
1282 assert(images != (Image **) NULL);
1283 assert(splice != (Image *) NULL);
1284 assert(splice->signature == MagickSignature);
1285 if ((*images) == (Image *) NULL)
1286 return((Image *) NULL);
1287 assert((*images)->signature == MagickSignature);
1288 if ((*images)->debug != MagickFalse)
1289 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1290 (*images)->filename);
1291 split=SplitImageList(*images);
1292 AppendImageToList(images,splice);
1293 image=(Image *) NULL;
1294 for (i=0; (i < length) && (split != (Image *) NULL); i++)
1295 AppendImageToList(&image,RemoveImageFromList(&split));
1296 AppendImageToList(images,split);
1301 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1305 % S p l i t I m a g e L i s t %
1309 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1311 % SplitImageList() splits an image into two lists, after given image
1312 % The list that was split off is returned, which may be empty.
1314 % The format of the SplitImageList method is:
1316 % Image *SplitImageList(Image *images)
1318 % A description of each parameter follows:
1320 % o images: the image list.
1323 MagickExport Image *SplitImageList(Image *images)
1325 if ((images == (Image *) NULL) || (images->next == (Image *) NULL))
1326 return((Image *) NULL);
1327 images=images->next;
1328 images->previous->next=(Image *) NULL;
1329 images->previous=(Image *) NULL;
1334 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1338 + S y n c I m a g e L i s t %
1342 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1344 % SyncImageList() synchronizes the scene numbers in an image list.
1346 % The format of the SyncImageList method is:
1348 % void SyncImageList(Image *images)
1350 % A description of each parameter follows:
1352 % o images: the image list.
1355 MagickExport void SyncImageList(Image *images)
1361 if (images == (Image *) NULL)
1363 assert(images->signature == MagickSignature);
1364 for (p=images; p != (Image *) NULL; p=p->next)
1366 for (q=p->next; q != (Image *) NULL; q=q->next)
1367 if (p->scene == q->scene)
1369 if (q != (Image *) NULL)
1372 if (p == (Image *) NULL)
1374 for (p=images->next; p != (Image *) NULL; p=p->next)
1375 p->scene=p->previous->scene+1;
1379 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1383 + S y n c N e x t I m a g e I n L i s t %
1387 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1389 % SyncNextImageInList() returns the next image in the list after the blob
1390 % referenced is synchronized with the current image.
1392 % The format of the SyncNextImageInList method is:
1394 % Image *SyncNextImageInList(const Image *images)
1396 % A description of each parameter follows:
1398 % o images: the image list.
1401 MagickExport Image *SyncNextImageInList(const Image *images)
1403 if (images == (Image *) NULL)
1404 return((Image *) NULL);
1405 assert(images->signature == MagickSignature);
1406 if (images->next == (Image *) NULL)
1407 return((Image *) NULL);
1408 if (images->blob != images->next->blob)
1410 DestroyBlob(images->next);
1411 images->next->blob=ReferenceBlob(images->blob);
1413 images->next->compression=images->compression;
1414 images->next->endian=images->endian;
1415 return(images->next);