2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % L IIIII SSSSS TTTTT %
10 % LLLLL IIIII SSSSS T %
13 % MagickCore Image List Methods %
20 % Copyright 1999-2014 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 "MagickCore/studio.h"
44 #include "MagickCore/blob.h"
45 #include "MagickCore/blob-private.h"
46 #include "MagickCore/exception.h"
47 #include "MagickCore/exception-private.h"
48 #include "MagickCore/list.h"
49 #include "MagickCore/memory_.h"
50 #include "MagickCore/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 *append)
83 assert(images != (Image **) NULL);
84 if (append == (Image *) NULL)
86 assert(append->signature == MagickSignature);
87 if (append->debug != MagickFalse)
88 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",append->filename);
89 if ((*images) == (Image *) NULL)
91 *images=(Image *) append;
94 assert((*images)->signature == MagickSignature);
95 p=GetLastImageInList(*images);
96 q=GetFirstImageInList(append);
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() deletes 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() deletes 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 delete
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 delete_list=(MagickBooleanType *) AcquireQuantumMemory(length,
370 sizeof(*delete_list));
371 if (delete_list == (MagickBooleanType *) NULL)
373 (void) ThrowMagickException(exception,GetMagickModule(),
374 ResourceLimitError,"MemoryAllocationFailed","`%s'",(*images)->filename);
378 for (i=0; i < (ssize_t) length; i++)
379 delete_list[i]=MagickFalse;
381 Note which images will be deleted, avoid duplicate deleted
383 for (p=(char *) scenes; *p != '\0';)
385 while ((isspace((int) ((unsigned char) *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 delete_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 (delete_list[i] != MagickFalse)
414 DeleteImageFromList(images);
417 (void) RelinquishMagickMemory(delete_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 index from the image
566 % list. Starting with 0 as the first image in the list.
568 % A negative offset will return the image from the end of the list, such that
569 % an index of -1 is the last image.
571 % If no such image exists at the specified offset a NULL image pointer is
572 % returned. This will only happen if index is less that the negative of
573 % the list length, or larger than list length -1. EG: ( -N to N-1 )
575 % The format of the GetImageFromList method is:
577 % Image *GetImageFromList(const Image *images,const ssize_t index)
579 % A description of each parameter follows:
581 % o images: the image list.
583 % o index: the position within the list.
586 MagickExport Image *GetImageFromList(const Image *images,const ssize_t index)
594 if (images == (Image *) NULL)
595 return((Image *) NULL);
596 assert(images->signature == MagickSignature);
597 if (images->debug != MagickFalse)
598 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
601 Designed to efficiently find first image (index == 0), or last image
602 (index == -1) as appropriate, without to go through the whole image list.
603 That is it tries to avoid 'counting the whole list' to handle the
604 most common image indexes.
608 p=GetLastImageInList(images);
609 for (i=-1; p != (Image *) NULL; p=p->previous)
615 p=GetFirstImageInList(images);
616 for (i=0; p != (Image *) NULL; p=p->next)
624 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
628 % G e t I m a g e I n d e x I n L i s t %
632 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
634 % GetImageIndexInList() returns the offset in the list of the specified image.
636 % The format of the GetImageIndexInList method is:
638 % ssize_t GetImageIndexInList(const Image *images)
640 % A description of each parameter follows:
642 % o images: the image list.
645 MagickExport ssize_t GetImageIndexInList(const Image *images)
650 if (images == (const Image *) NULL)
652 assert(images->signature == MagickSignature);
653 for (i=0; images->previous != (Image *) NULL; i++)
654 images=images->previous;
659 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
663 % G e t I m a g e L i s t L e n g t h %
667 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
669 % GetImageListLength() returns the length of the list (the number of images in
672 % The format of the GetImageListLength method is:
674 % size_t GetImageListLength(const Image *images)
676 % A description of each parameter follows:
678 % o images: the image list.
681 MagickExport size_t GetImageListLength(const Image *images)
686 if (images == (Image *) NULL)
688 assert(images->signature == MagickSignature);
689 if (images->debug != MagickFalse)
690 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
691 images=GetLastImageInList(images);
692 for (i=0; images != (Image *) NULL; images=images->previous)
698 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
702 % G e t L a s t I m a g e I n L i s t %
706 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
708 % GetLastImageInList() returns a pointer to the last image in the list.
710 % The format of the GetLastImageInList method is:
712 % Image *GetLastImageInList(const Image *images)
714 % A description of each parameter follows:
716 % o images: the image list.
719 MagickExport Image *GetLastImageInList(const Image *images)
724 if (images == (Image *) NULL)
725 return((Image *) NULL);
726 assert(images->signature == MagickSignature);
727 for (p=images; p->next != (Image *) NULL; p=p->next) ;
732 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
736 % G e t N e x t I m a g e I n L i s t %
740 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
742 % GetNextImageInList() returns the next image in the list.
744 % The format of the GetNextImageInList method is:
746 % Image *GetNextImageInList(const Image *images)
748 % A description of each parameter follows:
750 % o images: the image list.
753 MagickExport Image *GetNextImageInList(const Image *images)
755 if (images == (Image *) NULL)
756 return((Image *) NULL);
757 assert(images->signature == MagickSignature);
758 if (images->debug != MagickFalse)
759 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
760 return(images->next);
764 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
768 % G e t P r e v i o u s I m a g e I n L i s t %
772 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
774 % GetPreviousImageInList() returns the previous image in the list.
776 % The format of the GetPreviousImageInList method is:
778 % Image *GetPreviousImageInList(const Image *images)
780 % A description of each parameter follows:
782 % o images: the image list.
785 MagickExport Image *GetPreviousImageInList(const Image *images)
787 if (images == (Image *) NULL)
788 return((Image *) NULL);
789 assert(images->signature == MagickSignature);
790 return(images->previous);
794 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
797 % I m a g e L i s t T o A r r a y %
801 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
803 % ImageListToArray() is a convenience method that converts an image list to
804 % a sequential array, with a NULL image pointer at the end of the array.
806 % The images remain part of the original image list, with the array providing
807 % an alternative means of indexing the image array.
809 % group = ImageListToArray(images, exception);
810 % while (i = 0; group[i] != (Image *) NULL; i++)
811 % printf("%s\n", group[i]->filename);
812 % printf("%d images\n", i);
813 % group = RelinquishMagickMemory(group);
815 % The format of the ImageListToArray method is:
817 % Image **ImageListToArray(const Image *images,ExceptionInfo *exception)
819 % A description of each parameter follows:
821 % o image: the image list.
823 % o exception: return any errors or warnings in this structure.
826 MagickExport Image **ImageListToArray(const Image *images,
827 ExceptionInfo *exception)
835 if (images == (Image *) NULL)
836 return((Image **) NULL);
837 assert(images->signature == MagickSignature);
838 if (images->debug != MagickFalse)
839 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",images->filename);
840 group=(Image **) AcquireQuantumMemory((size_t) GetImageListLength(images)+1UL,
842 if (group == (Image **) NULL)
844 (void) ThrowMagickException(exception,GetMagickModule(),
845 ResourceLimitError,"MemoryAllocationFailed","`%s'",images->filename);
846 return((Image **) NULL);
848 images=GetFirstImageInList(images);
849 for (i=0; images != (Image *) NULL; images=images->next)
850 group[i++]=(Image *) images;
851 group[i]=(Image *) NULL;
856 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
860 % I n s e r t I m a g e I n L i s t %
864 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
866 % InsertImageInList() insert the given image or image list, into the first
867 % image list, immediately AFTER the image pointed to. The given image list
868 % pointer is left unchanged unless previously empty.
870 % The format of the InsertImageInList method is:
872 % InsertImageInList(Image **images,Image *insert)
874 % A description of each parameter follows:
876 % o images: the image list to insert into.
878 % o insert: the image list to insert.
881 MagickExport void InsertImageInList(Image **images,Image *insert)
886 assert(images != (Image **) NULL);
887 assert(insert != (Image *) NULL);
888 assert(insert->signature == MagickSignature);
889 if (insert->debug != MagickFalse)
890 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",insert->filename);
891 if ((*images) == (Image *) NULL)
893 assert((*images)->signature == MagickSignature);
894 split=SplitImageList(*images);
895 AppendImageToList(images,insert);
896 AppendImageToList(images,split);
900 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
904 % N e w I m a g e L i s t %
908 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
910 % NewImageList() creates an empty image list.
912 % The format of the NewImageList method is:
914 % Image *NewImageList(void)
917 MagickExport Image *NewImageList(void)
919 return((Image *) NULL);
923 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
927 % P r e p e n d I m a g e T o L i s t %
931 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
933 % PrependImageToList() prepends the image to the beginning of the list.
935 % The format of the PrependImageToList method is:
937 % PrependImageToList(Image *images,Image *image)
939 % A description of each parameter follows:
941 % o images: the image list.
943 % o image: the image.
946 MagickExport void PrependImageToList(Image **images,Image *prepend)
948 if (*images == (Image *) NULL)
953 AppendImageToList(&prepend,*images);
957 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
961 % R e m o v e I m a g e F r o m L i s t %
965 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
967 % RemoveImageFromList() removes and returns the image pointed to.
969 % The given image list pointer is set to point to the next image in list
970 % if it exists, otherwise it is set to the previous image, or NULL if list
973 % The format of the RemoveImageFromList method is:
975 % Image *RemoveImageFromList(Image **images)
977 % A description of each parameter follows:
979 % o images: the image list.
982 MagickExport Image *RemoveImageFromList(Image **images)
987 assert(images != (Image **) NULL);
988 if ((*images) == (Image *) NULL)
989 return((Image *) NULL);
990 assert((*images)->signature == MagickSignature);
991 if ((*images)->debug != MagickFalse)
992 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
993 (*images)->filename);
995 if ((p->previous == (Image *) NULL) && (p->next == (Image *) NULL))
996 *images=(Image *) NULL;
999 if (p->previous != (Image *) NULL)
1001 p->previous->next=p->next;
1002 *images=p->previous;
1004 if (p->next != (Image *) NULL)
1006 p->next->previous=p->previous;
1009 p->previous=(Image *) NULL;
1010 p->next=(Image *) NULL;
1016 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1020 % R e m o v e F i r s t I m a g e F r o m L i s t %
1024 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1026 % RemoveFirstImageFromList() removes and returns the first image in the list.
1028 % If the given image list pointer pointed to the removed first image, it is
1029 % set to the new first image of list, or NULL if list was emptied, otherwise
1032 % The format of the RemoveFirstImageFromList method is:
1034 % Image *RemoveFirstImageFromList(Image **images)
1036 % A description of each parameter follows:
1038 % o images: the image list.
1041 MagickExport Image *RemoveFirstImageFromList(Image **images)
1046 assert(images != (Image **) NULL);
1047 if ((*images) == (Image *) NULL)
1048 return((Image *) NULL);
1049 assert((*images)->signature == MagickSignature);
1050 if ((*images)->debug != MagickFalse)
1051 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1052 (*images)->filename);
1054 while (image->previous != (Image *) NULL)
1055 image=image->previous;
1056 if (image == *images)
1057 *images=(*images)->next;
1058 if (image->next != (Image *) NULL)
1060 image->next->previous=(Image *) NULL;
1061 image->next=(Image *) NULL;
1067 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1071 % R e m o v e L a s t I m a g e F r o m L i s t %
1075 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1077 % RemoveLastImageFromList() removes and returns the last image from the list.
1079 % If the given image list pointer pointed to the removed last image, it is
1080 % set to the new last image of list, or NULL if list was emptied, otherwise
1083 % The format of the RemoveLastImageFromList method is:
1085 % Image *RemoveLastImageFromList(Image **images)
1087 % A description of each parameter follows:
1089 % o images: the image list.
1092 MagickExport Image *RemoveLastImageFromList(Image **images)
1097 assert(images != (Image **) NULL);
1098 if ((*images) == (Image *) NULL)
1099 return((Image *) NULL);
1100 assert((*images)->signature == MagickSignature);
1101 if ((*images)->debug != MagickFalse)
1102 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1103 (*images)->filename);
1105 while (image->next != (Image *) NULL)
1107 if (image == *images)
1108 *images=(*images)->previous;
1109 if (image->previous != (Image *) NULL)
1111 image->previous->next=(Image *) NULL;
1112 image->previous=(Image *) NULL;
1118 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1122 % R e p l a c e I m a g e I n L i s t %
1126 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1128 % ReplaceImageInList() replaces an image in the list with the given image, or
1129 % list of images. Old image is destroyed.
1131 % The images list pointer is set to point to the first image of the inserted
1134 % The format of the ReplaceImageInList method is:
1136 % ReplaceImageInList(Image **images,Image *replace)
1138 % A description of each parameter follows:
1140 % o images: the list and pointer to image to replace
1142 % o replace: the image or image list replacing the original
1145 MagickExport void ReplaceImageInList(Image **images,Image *replace)
1147 assert(images != (Image **) NULL);
1148 assert(replace != (Image *) NULL);
1149 assert(replace->signature == MagickSignature);
1150 if (replace->debug != MagickFalse)
1151 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",replace->filename);
1152 if ((*images) == (Image *) NULL)
1154 assert((*images)->signature == MagickSignature);
1156 /* link next pointer */
1157 replace=GetLastImageInList(replace);
1158 replace->next=(*images)->next;
1159 if (replace->next != (Image *) NULL)
1160 replace->next->previous=replace;
1162 /* link previous pointer - set images position to first replacement image */
1163 replace=GetFirstImageInList(replace);
1164 replace->previous=(*images)->previous;
1165 if (replace->previous != (Image *) NULL)
1166 replace->previous->next=replace;
1168 /* destroy the replaced image that was in images */
1169 (void) DestroyImage(*images);
1174 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1178 % R e p l a c e I m a g e I n L i s t R e t u r n L a s t %
1182 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1184 % ReplaceImageInListReturnLast() is exactly as ReplaceImageInList() except
1185 % the images pointer is set to the last image in the list of replacemen
1188 % This allows you to simply use GetNextImageInList() to go to the image
1189 % that follows the just replaced image, even if a list of replacement images
1192 % The format of the ReplaceImageInList method is:
1194 % ReplaceImageInListReturnLast(Image **images,Image *replace)
1196 % A description of each parameter follows:
1198 % o images: the list and pointer to image to replace
1200 % o replace: the image or image list replacing the original
1203 MagickExport void ReplaceImageInListReturnLast(Image **images,Image *replace)
1205 assert(images != (Image **) NULL);
1206 assert(replace != (Image *) NULL);
1207 assert(replace->signature == MagickSignature);
1208 if (replace->debug != MagickFalse)
1209 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",replace->filename);
1210 if ((*images) == (Image *) NULL)
1212 assert((*images)->signature == MagickSignature);
1214 /* link previous pointer */
1215 replace=GetFirstImageInList(replace);
1216 replace->previous=(*images)->previous;
1217 if (replace->previous != (Image *) NULL)
1218 replace->previous->next=replace;
1220 /* link next pointer - set images position to last replacement image */
1221 replace=GetLastImageInList(replace);
1222 replace->next=(*images)->next;
1223 if (replace->next != (Image *) NULL)
1224 replace->next->previous=replace;
1226 /* destroy the replaced image that was in images */
1227 (void) DestroyImage(*images);
1232 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1236 % R e v e r s e I m a g e L i s t %
1240 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1242 % ReverseImageList() reverses the order of an image list.
1243 % The list pointer is reset to that start of the re-ordered list.
1245 % The format of the ReverseImageList method is:
1247 % void ReverseImageList(Image **images)
1249 % A description of each parameter follows:
1251 % o images: the image list.
1254 MagickExport void ReverseImageList(Image **images)
1262 assert(images != (Image **) NULL);
1263 if ((*images) == (Image *) NULL)
1265 assert((*images)->signature == MagickSignature);
1266 if ((*images)->debug != MagickFalse)
1267 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1268 (*images)->filename);
1269 for (p=(*images); p->next != (Image *) NULL; p=p->next) ;
1271 for ( ; p != (Image *) NULL; p=p->next)
1274 p->next=p->previous;
1280 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1284 % S p l i c e I m a g e I n t o L i s t %
1288 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1290 % SpliceImageIntoList() removes 'length' images from the list and replaces
1291 % them with the specified splice. Removed images are returned.
1293 % The format of the SpliceImageIntoList method is:
1295 % SpliceImageIntoList(Image **images,const size_t,
1296 % const Image *splice)
1298 % A description of each parameter follows:
1300 % o images: the image list.
1302 % o length: the length of the image list to remove.
1304 % o splice: Replace the removed image list with this list.
1307 MagickExport Image *SpliceImageIntoList(Image **images,
1308 const size_t length,const Image *splice)
1317 assert(images != (Image **) NULL);
1318 assert(splice != (Image *) NULL);
1319 assert(splice->signature == MagickSignature);
1320 if ((*images) == (Image *) NULL)
1321 return((Image *) NULL);
1322 assert((*images)->signature == MagickSignature);
1323 if ((*images)->debug != MagickFalse)
1324 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",
1325 (*images)->filename);
1326 split=SplitImageList(*images);
1327 AppendImageToList(images,splice);
1328 image=(Image *) NULL;
1329 for (i=0; (i < length) && (split != (Image *) NULL); i++)
1330 AppendImageToList(&image,RemoveImageFromList(&split));
1331 AppendImageToList(images,split);
1336 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1340 % S p l i t I m a g e L i s t %
1344 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1346 % SplitImageList() splits an image into two lists, after given image
1347 % The list that was split off is returned, which may be empty.
1349 % The format of the SplitImageList method is:
1351 % Image *SplitImageList(Image *images)
1353 % A description of each parameter follows:
1355 % o images: the image list.
1358 MagickExport Image *SplitImageList(Image *images)
1360 if ((images == (Image *) NULL) || (images->next == (Image *) NULL))
1361 return((Image *) NULL);
1362 images=images->next;
1363 images->previous->next=(Image *) NULL;
1364 images->previous=(Image *) NULL;
1369 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1373 + S y n c I m a g e L i s t %
1377 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1379 % SyncImageList() synchronizes the scene numbers in an image list.
1381 % The format of the SyncImageList method is:
1383 % void SyncImageList(Image *images)
1385 % A description of each parameter follows:
1387 % o images: the image list.
1390 MagickExport void SyncImageList(Image *images)
1396 if (images == (Image *) NULL)
1398 assert(images->signature == MagickSignature);
1399 for (p=images; p != (Image *) NULL; p=p->next)
1401 for (q=p->next; q != (Image *) NULL; q=q->next)
1402 if (p->scene == q->scene)
1404 if (q != (Image *) NULL)
1407 if (p == (Image *) NULL)
1409 for (p=images->next; p != (Image *) NULL; p=p->next)
1410 p->scene=p->previous->scene+1;
1414 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1418 + S y n c N e x t I m a g e I n L i s t %
1422 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
1424 % SyncNextImageInList() returns the next image in the list after the blob
1425 % referenced is synchronized with the current image.
1427 % The format of the SyncNextImageInList method is:
1429 % Image *SyncNextImageInList(const Image *images)
1431 % A description of each parameter follows:
1433 % o images: the image list.
1436 MagickExport Image *SyncNextImageInList(const Image *images)
1438 if (images == (Image *) NULL)
1439 return((Image *) NULL);
1440 assert(images->signature == MagickSignature);
1441 if (images->next == (Image *) NULL)
1442 return((Image *) NULL);
1443 if (images->blob != images->next->blob)
1445 DestroyBlob(images->next);
1446 images->next->blob=ReferenceBlob(images->blob);
1448 images->next->compression=images->compression;
1449 images->next->endian=images->endian;
1450 return(images->next);