2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
6 % CCCC OOO DDDD EEEEE RRRR %
10 % CCCC OOO DDDD EEEEE R R %
13 % MagickCore Image Coder Methods %
20 % Copyright 1999-2012 ImageMagick Studio LLC, a non-profit organization %
21 % dedicated to making software imaging solutions freely available. %
23 % You may not use this file except in compliance with the License. You may %
24 % obtain a copy of the License at %
26 % http://www.imagemagick.org/script/license.php %
28 % Unless required by applicable law or agreed to in writing, software %
29 % distributed under the License is distributed on an "AS IS" BASIS, %
30 % WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. %
31 % See the License for the specific language governing permissions and %
32 % limitations under the License. %
34 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
42 #include "MagickCore/studio.h"
43 #include "MagickCore/blob.h"
44 #include "MagickCore/client.h"
45 #include "MagickCore/coder.h"
46 #include "MagickCore/coder-private.h"
47 #include "MagickCore/configure.h"
48 #include "MagickCore/draw.h"
49 #include "MagickCore/exception.h"
50 #include "MagickCore/exception-private.h"
51 #include "MagickCore/hashmap.h"
52 #include "MagickCore/log.h"
53 #include "MagickCore/memory_.h"
54 #include "MagickCore/option.h"
55 #include "MagickCore/semaphore.h"
56 #include "MagickCore/string_.h"
57 #include "MagickCore/splay-tree.h"
58 #include "MagickCore/token.h"
59 #include "MagickCore/utility.h"
60 #include "MagickCore/utility-private.h"
61 #include "MagickCore/xml-tree.h"
66 #define MagickCoderFilename "coder.xml"
71 typedef struct _CoderMapInfo
81 static const CoderMapInfo
86 { "8BIMTEXT", "META" },
87 { "8BIMWTEXT", "META" },
91 { "APP1JPEG", "META" },
123 { "FRACTAL", "PLASMA" },
129 { "GRANITE", "MAGICK" },
130 { "GROUP4", "TIFF" },
140 { "IMPLICIT", "***" },
142 { "IPTCTEXT", "META" },
143 { "IPTCWTEXT", "META" },
144 { "ISOBRL", "BRAILLE" },
152 { "LOGO", "MAGICK" },
165 { "NETSCAPE", "MAGICK" },
191 { "RADIAL-GRADIENT", "GRADIENT" },
197 { "ROSE", "MAGICK" },
203 { "TIFF64", "TIFF" },
206 { "UBRL", "BRAILLE" },
209 { "WIZARD", "MAGICK" },
211 { "WMFWIN32", "EMF" },
215 { "XTRNARRAY", "XTRN" },
216 { "XTRNBLOB", "XTRN" },
217 { "XTRNFILE", "XTRN" },
218 { "XTRNIMAGE", "XTRN" },
221 { "YCbCrA", "YCbCr" }
225 *coder_semaphore = (SemaphoreInfo *) NULL;
228 *coder_list = (SplayTreeInfo *) NULL;
230 static volatile MagickBooleanType
231 instantiate_coder = MagickFalse;
234 Forward declarations.
236 static MagickBooleanType
237 InitializeCoderList(ExceptionInfo *),
238 LoadCoderLists(const char *,ExceptionInfo *);
241 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
245 + C o d e r C o m p o n e n t G e n e s i s %
249 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
251 % CoderComponentGenesis() instantiates the coder component.
253 % The format of the CoderComponentGenesis method is:
255 % MagickBooleanType CoderComponentGenesis(void)
258 MagickPrivate MagickBooleanType CoderComponentGenesis(void)
260 AcquireSemaphoreInfo(&coder_semaphore);
265 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
269 + C o d e r C o m p o n e n t T e r m i n u s %
273 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
275 % CoderComponentTerminus() destroys the coder component.
277 % The format of the CoderComponentTerminus method is:
279 % CoderComponentTerminus(void)
282 MagickPrivate void CoderComponentTerminus(void)
284 if (coder_semaphore == (SemaphoreInfo *) NULL)
285 AcquireSemaphoreInfo(&coder_semaphore);
286 LockSemaphoreInfo(coder_semaphore);
287 if (coder_list != (SplayTreeInfo *) NULL)
288 coder_list=DestroySplayTree(coder_list);
289 instantiate_coder=MagickFalse;
290 UnlockSemaphoreInfo(coder_semaphore);
291 DestroySemaphoreInfo(&coder_semaphore);
295 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
299 + G e t C o d e r I n f o %
303 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
305 % GetCoderInfo searches the coder list for the specified name and if found
306 % returns attributes for that coder.
308 % The format of the GetCoderInfo method is:
310 % const CoderInfo *GetCoderInfo(const char *name,ExceptionInfo *exception)
312 % A description of each parameter follows:
314 % o name: the coder name.
316 % o exception: return any errors or warnings in this structure.
319 MagickExport const CoderInfo *GetCoderInfo(const char *name,
320 ExceptionInfo *exception)
322 assert(exception != (ExceptionInfo *) NULL);
323 if ((coder_list == (SplayTreeInfo *) NULL) ||
324 (instantiate_coder == MagickFalse))
325 if (InitializeCoderList(exception) == MagickFalse)
326 return((const CoderInfo *) NULL);
327 if ((coder_list == (SplayTreeInfo *) NULL) ||
328 (GetNumberOfNodesInSplayTree(coder_list) == 0))
329 return((const CoderInfo *) NULL);
330 if ((name == (const char *) NULL) || (LocaleCompare(name,"*") == 0))
332 ResetSplayTreeIterator(coder_list);
333 return((const CoderInfo *) GetNextValueInSplayTree(coder_list));
335 return((const CoderInfo *) GetValueFromSplayTree(coder_list,name));
339 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
343 % G e t C o d e r I n f o L i s t %
347 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
349 % GetCoderInfoList() returns any coder_map that match the specified pattern.
350 % The format of the GetCoderInfoList function is:
352 % const CoderInfo **GetCoderInfoList(const char *pattern,
353 % size_t *number_coders,ExceptionInfo *exception)
355 % A description of each parameter follows:
357 % o pattern: Specifies a pointer to a text string containing a pattern.
359 % o number_coders: This integer returns the number of coders in the list.
361 % o exception: return any errors or warnings in this structure.
365 static int CoderInfoCompare(const void *x,const void *y)
371 p=(const CoderInfo **) x,
372 q=(const CoderInfo **) y;
373 if (LocaleCompare((*p)->path,(*q)->path) == 0)
374 return(LocaleCompare((*p)->name,(*q)->name));
375 return(LocaleCompare((*p)->path,(*q)->path));
378 MagickExport const CoderInfo **GetCoderInfoList(const char *pattern,
379 size_t *number_coders,ExceptionInfo *exception)
384 register const CoderInfo
393 assert(pattern != (char *) NULL);
394 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",pattern);
395 assert(number_coders != (size_t *) NULL);
397 p=GetCoderInfo("*",exception);
398 if (p == (const CoderInfo *) NULL)
399 return((const CoderInfo **) NULL);
400 coder_map=(const CoderInfo **) AcquireQuantumMemory((size_t)
401 GetNumberOfNodesInSplayTree(coder_list)+1UL,sizeof(*coder_map));
402 if (coder_map == (const CoderInfo **) NULL)
403 return((const CoderInfo **) NULL);
407 LockSemaphoreInfo(coder_semaphore);
408 ResetSplayTreeIterator(coder_list);
409 p=(const CoderInfo *) GetNextValueInSplayTree(coder_list);
410 for (i=0; p != (const CoderInfo *) NULL; )
412 if ((p->stealth == MagickFalse) &&
413 (GlobExpression(p->name,pattern,MagickFalse) != MagickFalse))
415 p=(const CoderInfo *) GetNextValueInSplayTree(coder_list);
417 UnlockSemaphoreInfo(coder_semaphore);
418 qsort((void *) coder_map,(size_t) i,sizeof(*coder_map),CoderInfoCompare);
419 coder_map[i]=(CoderInfo *) NULL;
420 *number_coders=(size_t) i;
425 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
429 % G e t C o d e r L i s t %
433 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
435 % GetCoderList() returns any coder_map that match the specified pattern.
437 % The format of the GetCoderList function is:
439 % char **GetCoderList(const char *pattern,size_t *number_coders,
440 % ExceptionInfo *exception)
442 % A description of each parameter follows:
444 % o pattern: Specifies a pointer to a text string containing a pattern.
446 % o number_coders: This integer returns the number of coders in the list.
448 % o exception: return any errors or warnings in this structure.
452 static int CoderCompare(const void *x,const void *y)
460 return(LocaleCompare(*p,*q));
463 MagickExport char **GetCoderList(const char *pattern,
464 size_t *number_coders,ExceptionInfo *exception)
469 register const CoderInfo
478 assert(pattern != (char *) NULL);
479 (void) LogMagickEvent(TraceEvent,GetMagickModule(),"%s",pattern);
480 assert(number_coders != (size_t *) NULL);
482 p=GetCoderInfo("*",exception);
483 if (p == (const CoderInfo *) NULL)
484 return((char **) NULL);
485 coder_map=(char **) AcquireQuantumMemory((size_t)
486 GetNumberOfNodesInSplayTree(coder_list)+1UL,sizeof(*coder_map));
487 if (coder_map == (char **) NULL)
488 return((char **) NULL);
492 LockSemaphoreInfo(coder_semaphore);
493 ResetSplayTreeIterator(coder_list);
494 p=(const CoderInfo *) GetNextValueInSplayTree(coder_list);
495 for (i=0; p != (const CoderInfo *) NULL; )
497 if ((p->stealth == MagickFalse) &&
498 (GlobExpression(p->name,pattern,MagickFalse) != MagickFalse))
499 coder_map[i++]=ConstantString(p->name);
500 p=(const CoderInfo *) GetNextValueInSplayTree(coder_list);
502 UnlockSemaphoreInfo(coder_semaphore);
503 qsort((void *) coder_map,(size_t) i,sizeof(*coder_map),CoderCompare);
504 coder_map[i]=(char *) NULL;
505 *number_coders=(size_t) i;
510 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
514 + I n i t i a l i z e C o d e r L i s t %
518 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
520 % InitializeCoderList() initializes the coder list.
522 % The format of the InitializeCoderList method is:
524 % MagickBooleanType InitializeCoderList(ExceptionInfo *exception)
526 % A description of each parameter follows.
528 % o exception: return any errors or warnings in this structure.
531 static MagickBooleanType InitializeCoderList(ExceptionInfo *exception)
533 if ((coder_list == (SplayTreeInfo *) NULL) &&
534 (instantiate_coder == MagickFalse))
536 if (coder_semaphore == (SemaphoreInfo *) NULL)
537 AcquireSemaphoreInfo(&coder_semaphore);
538 LockSemaphoreInfo(coder_semaphore);
539 if ((coder_list == (SplayTreeInfo *) NULL) &&
540 (instantiate_coder == MagickFalse))
542 (void) LoadCoderLists(MagickCoderFilename,exception);
543 instantiate_coder=MagickTrue;
545 UnlockSemaphoreInfo(coder_semaphore);
547 return(coder_list != (SplayTreeInfo *) NULL ? MagickTrue : MagickFalse);
551 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
555 % L i s t C o d e r I n f o %
559 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
561 % ListCoderInfo() lists the coder info to a file.
563 % The format of the ListCoderInfo coder is:
565 % MagickBooleanType ListCoderInfo(FILE *file,ExceptionInfo *exception)
567 % A description of each parameter follows.
569 % o file: An pointer to a FILE.
571 % o exception: return any errors or warnings in this structure.
574 MagickExport MagickBooleanType ListCoderInfo(FILE *file,
575 ExceptionInfo *exception)
592 if (file == (const FILE *) NULL)
594 coder_info=GetCoderInfoList("*",&number_coders,exception);
595 if (coder_info == (const CoderInfo **) NULL)
597 path=(const char *) NULL;
598 for (i=0; i < (ssize_t) number_coders; i++)
600 if (coder_info[i]->stealth != MagickFalse)
602 if ((path == (const char *) NULL) ||
603 (LocaleCompare(path,coder_info[i]->path) != 0))
605 if (coder_info[i]->path != (char *) NULL)
606 (void) FormatLocaleFile(file,"\nPath: %s\n\n",coder_info[i]->path);
607 (void) FormatLocaleFile(file,"Magick Coder\n");
608 (void) FormatLocaleFile(file,
609 "-------------------------------------------------"
610 "------------------------------\n");
612 path=coder_info[i]->path;
613 (void) FormatLocaleFile(file,"%s",coder_info[i]->magick);
614 for (j=(ssize_t) strlen(coder_info[i]->magick); j <= 11; j++)
615 (void) FormatLocaleFile(file," ");
616 if (coder_info[i]->name != (char *) NULL)
617 (void) FormatLocaleFile(file,"%s",coder_info[i]->name);
618 (void) FormatLocaleFile(file,"\n");
620 coder_info=(const CoderInfo **) RelinquishMagickMemory((void *) coder_info);
626 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
630 + L o a d C o d e r L i s t %
634 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
636 % LoadCoderList() loads the coder configuration file which provides a
637 % mapping between coder attributes and a coder name.
639 % The format of the LoadCoderList coder is:
641 % MagickBooleanType LoadCoderList(const char *xml,const char *filename,
642 % const size_t depth,ExceptionInfo *exception)
644 % A description of each parameter follows:
646 % o xml: The coder list in XML format.
648 % o filename: The coder list filename.
650 % o depth: depth of <include /> statements.
652 % o exception: return any errors or warnings in this structure.
656 static void *DestroyCoderNode(void *coder_info)
661 p=(CoderInfo *) coder_info;
662 if (p->exempt == MagickFalse)
664 if (p->path != (char *) NULL)
665 p->path=DestroyString(p->path);
666 if (p->name != (char *) NULL)
667 p->name=DestroyString(p->name);
668 if (p->magick != (char *) NULL)
669 p->magick=DestroyString(p->magick);
671 return(RelinquishMagickMemory(p));
674 static MagickBooleanType LoadCoderList(const char *xml,const char *filename,
675 const size_t depth,ExceptionInfo *exception)
678 keyword[MaxTextExtent],
691 Load the coder map file.
693 (void) LogMagickEvent(ConfigureEvent,GetMagickModule(),
694 "Loading coder configuration file \"%s\" ...",filename);
695 if (xml == (const char *) NULL)
697 if (coder_list == (SplayTreeInfo *) NULL)
699 coder_list=NewSplayTree(CompareSplayTreeString,RelinquishMagickMemory,
701 if (coder_list == (SplayTreeInfo *) NULL)
703 ThrowFileException(exception,ResourceLimitError,
704 "MemoryAllocationFailed",filename);
709 coder_info=(CoderInfo *) NULL;
710 token=AcquireString(xml);
711 for (q=(char *) xml; *q != '\0'; )
716 GetMagickToken(q,&q,token);
719 (void) CopyMagickString(keyword,token,MaxTextExtent);
720 if (LocaleNCompare(keyword,"<!DOCTYPE",9) == 0)
725 while ((LocaleNCompare(q,"]>",2) != 0) && (*q != '\0'))
726 GetMagickToken(q,&q,token);
729 if (LocaleNCompare(keyword,"<!--",4) == 0)
734 while ((LocaleNCompare(q,"->",2) != 0) && (*q != '\0'))
735 GetMagickToken(q,&q,token);
738 if (LocaleCompare(keyword,"<include") == 0)
743 while (((*token != '/') && (*(token+1) != '>')) && (*q != '\0'))
745 (void) CopyMagickString(keyword,token,MaxTextExtent);
746 GetMagickToken(q,&q,token);
749 GetMagickToken(q,&q,token);
750 if (LocaleCompare(keyword,"file") == 0)
753 (void) ThrowMagickException(exception,GetMagickModule(),
754 ConfigureError,"IncludeNodeNestedTooDeeply","`%s'",token);
761 GetPathComponent(filename,HeadPath,path);
763 (void) ConcatenateMagickString(path,DirectorySeparator,
765 if (*token == *DirectorySeparator)
766 (void) CopyMagickString(path,token,MaxTextExtent);
768 (void) ConcatenateMagickString(path,token,MaxTextExtent);
769 xml=FileToString(path,~0,exception);
770 if (xml != (char *) NULL)
772 status=LoadCoderList(xml,path,depth+1,exception);
773 xml=(char *) RelinquishMagickMemory(xml);
780 if (LocaleCompare(keyword,"<coder") == 0)
785 coder_info=(CoderInfo *) AcquireMagickMemory(sizeof(*coder_info));
786 if (coder_info == (CoderInfo *) NULL)
787 ThrowFatalException(ResourceLimitFatalError,"MemoryAllocationFailed");
788 (void) ResetMagickMemory(coder_info,0,sizeof(*coder_info));
789 coder_info->path=ConstantString(filename);
790 coder_info->exempt=MagickFalse;
791 coder_info->signature=MagickSignature;
794 if (coder_info == (CoderInfo *) NULL)
796 if (LocaleCompare(keyword,"/>") == 0)
798 status=AddValueToSplayTree(coder_list,ConstantString(
799 coder_info->magick),coder_info);
800 if (status == MagickFalse)
801 (void) ThrowMagickException(exception,GetMagickModule(),
802 ResourceLimitError,"MemoryAllocationFailed","`%s'",
804 coder_info=(CoderInfo *) NULL;
806 GetMagickToken(q,(const char **) NULL,token);
809 GetMagickToken(q,&q,token);
810 GetMagickToken(q,&q,token);
816 if (LocaleCompare((char *) keyword,"magick") == 0)
818 coder_info->magick=ConstantString(token);
826 if (LocaleCompare((char *) keyword,"name") == 0)
828 coder_info->name=ConstantString(token);
836 if (LocaleCompare((char *) keyword,"stealth") == 0)
838 coder_info->stealth=IsMagickTrue(token);
847 token=(char *) RelinquishMagickMemory(token);
852 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
856 % L o a d C o d e r L i s t s %
860 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
862 % LoadCoderLists() loads one or more coder configuration file which
863 % provides a mapping between coder attributes and a coder name.
865 % The format of the LoadCoderLists coder is:
867 % MagickBooleanType LoadCoderLists(const char *filename,
868 % ExceptionInfo *exception)
870 % A description of each parameter follows:
872 % o filename: the font file name.
874 % o exception: return any errors or warnings in this structure.
877 static MagickBooleanType LoadCoderLists(const char *filename,
878 ExceptionInfo *exception)
893 Load built-in coder map.
896 if (coder_list == (SplayTreeInfo *) NULL)
898 coder_list=NewSplayTree(CompareSplayTreeString,RelinquishMagickMemory,
900 if (coder_list == (SplayTreeInfo *) NULL)
902 ThrowFileException(exception,ResourceLimitError,
903 "MemoryAllocationFailed",filename);
907 for (i=0; i < (ssize_t) (sizeof(CoderMap)/sizeof(*CoderMap)); i++)
912 register const CoderMapInfo
916 coder_info=(CoderInfo *) AcquireMagickMemory(sizeof(*coder_info));
917 if (coder_info == (CoderInfo *) NULL)
919 (void) ThrowMagickException(exception,GetMagickModule(),
920 ResourceLimitError,"MemoryAllocationFailed","`%s'",coder_info->name);
923 (void) ResetMagickMemory(coder_info,0,sizeof(*coder_info));
924 coder_info->path=(char *) "[built-in]";
925 coder_info->magick=(char *) p->magick;
926 coder_info->name=(char *) p->name;
927 coder_info->exempt=MagickTrue;
928 coder_info->signature=MagickSignature;
929 status=AddValueToSplayTree(coder_list,ConstantString(coder_info->magick),
931 if (status == MagickFalse)
932 (void) ThrowMagickException(exception,GetMagickModule(),
933 ResourceLimitError,"MemoryAllocationFailed","`%s'",coder_info->name);
936 Load external coder map.
938 options=GetConfigureOptions(filename,exception);
939 option=(const StringInfo *) GetNextValueInLinkedList(options);
940 while (option != (const StringInfo *) NULL)
942 status|=LoadCoderList((const char *) GetStringInfoDatum(option),
943 GetStringInfoPath(option),0,exception);
944 option=(const StringInfo *) GetNextValueInLinkedList(options);
946 options=DestroyConfigureOptions(options);
947 return(status != 0 ? MagickTrue : MagickFalse);