pnglibconf.dfa 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920
  1. # scripts/pnglibconf.dfa - library build configuration control
  2. #
  3. @/*- pnglibconf.dfn intermediate file
  4. @ * generated from scripts/pnglibconf.dfa
  5. @ */
  6. #
  7. com pnglibconf.h - library build configuration
  8. com
  9. version
  10. com
  11. com Copyright (c) 2018-2019 Cosmin Truta
  12. com Copyright (c) 1998-2002,2004,2006-2018 Glenn Randers-Pehrson
  13. com
  14. com This code is released under the libpng license.
  15. com For conditions of distribution and use, see the disclaimer
  16. com and license in png.h
  17. com
  18. file pnglibconf.h scripts/pnglibconf.dfa PNGLCONF_H
  19. # This file is preprocessed by scripts/options.awk and the
  20. # C compiler to generate 'pnglibconf.h' - a list of all the
  21. # configuration options. The file lists the various options
  22. # that can *only* be specified during the libpng build;
  23. # pnglibconf.h freezes the definitions selected for the specific
  24. # build.
  25. #
  26. # The syntax is detailed in scripts/options.awk; this is a summary
  27. # only:
  28. #
  29. # setting <name> [requires ...] [default]
  30. # #define PNG_<name> <value> /* value comes from current setting */
  31. # option <name> [requires ...] [if ...] [enables ...] [disabled]
  32. # #define PNG_<name>_SUPPORTED if the requirements are met and
  33. # enable the other options listed
  34. # chunk <name> [requires ...] [enables ...] [disabled]
  35. # Enable chunk processing for the given ancillary chunk; any
  36. # 'requires something' expands to READ_something for read and
  37. # WRITE_something for write, but the enables list members are
  38. # used as given (e.g. enables GAMMA just expands to that on the
  39. # correspond READ_name and WRITE_name lines.)
  40. #
  41. # "," may be used to separate options on an 'option' line and is ignored; it
  42. # doesn't change the meaning of the line. (NOT setting, where "," becomes
  43. # part of the setting!) A comma at the end of an option line causes a
  44. # continuation (the next line is included in the option too.)
  45. #
  46. # Note that the 'on' and 'off' keywords, while valid on both option
  47. # and chunk, should not be used in this file because they force the
  48. # relevant options on or off.
  49. #----------------------------------------------------------------------
  50. # The following setting, option and chunk values can all be changed
  51. # while building libpng:
  52. #
  53. # setting: change 'setting' lines to fine tune library performance;
  54. # changes to the settings don't affect the libpng API functionally
  55. #
  56. # option: change 'option' lines to remove or add capabilities from
  57. # or to the library; options change the library API
  58. #
  59. # chunk: change 'chunk' lines to remove capabilities to process
  60. # optional ('ancillary') chunks. This does not prevent PNG
  61. # decoding but does change the libpng API because some chunks
  62. # will be ignored.
  63. #
  64. # There are three ways of disabling features, in no particular order:
  65. #
  66. # 1) Create 'pngusr.h', enter the required private build information
  67. # detailed below and #define PNG_NO_<option> for each option you
  68. # don't want in that file in that file. You can also turn on options
  69. # using PNG_<option>_SUPPORTED. When you have finished rerun
  70. # configure and rebuild pnglibconf.h file with -DPNG_USER_CONFIG:
  71. #
  72. # make clean
  73. # CPPFLAGS='-DPNG_USER_CONFIG' ./configure
  74. # make pnglibconf.h
  75. #
  76. # pngusr.h is only used during the creation of pnglibconf.h, but it
  77. # is safer to ensure that -DPNG_USER_CONFIG is specified throughout
  78. # the build by changing the CPPFLAGS passed to the initial ./configure
  79. #
  80. # 2) Add definitions of the settings you want to change to
  81. # CPPFLAGS; for example:
  82. #
  83. # -DPNG_DEFAULT_READ_MACROS=0
  84. #
  85. # (This would change the default to *not* use read macros.) Be
  86. # very careful to change only settings that don't alter the API
  87. # because this approach bypasses the private build checking. You
  88. # can also change settings from pngpriv.h (read pngpriv.h) safely
  89. # without API changes. Do that in the same way.
  90. #
  91. # 3) Write a new '.dfa' file (say 'pngusr.dfa') and in this file
  92. # provide override values for setting entries and turn option or
  93. # chunk values explicitly 'on' or 'off':
  94. #
  95. # setting FOO default VALUE
  96. # option BAR [on|off]
  97. #
  98. # Then add this file to the options.awk command line (the *first*
  99. # one) after this file. The make macro DFA_XTRA is provided to make
  100. # this easier (set it like CPPFLAGS prior to running ./configure).
  101. # Look at the builds below contrib/pngminim for some extreme examples
  102. # of how this can be used.
  103. #
  104. # Don't edit this file unless you are contributing a patch to
  105. # libpng and need new or modified options/settings.
  106. #----------------------------------------------------------------------
  107. # The following causes commented out #undef lines to be written to
  108. # pnglibconf.h; this can be stopped by logunsupported=0 in a later
  109. # file or on the command line (after pnglibconf.dfa)
  110. logunsupported = 1
  111. # The following allows the output from configure to modify the contents of
  112. # pnglibconf.h
  113. @#ifdef HAVE_CONFIG_H
  114. @# include "config.h"
  115. @#endif
  116. # PNG_USER_CONFIG has to be defined on the compiler command line
  117. # to cause pngusr.h to be read while constructing pnglibconf.h
  118. #
  119. # If you create a private DLL you need to define the following
  120. # macros in the file 'pngusr.h' and set -DPNG_USER_CONFIG for
  121. # compilation (i.e. in CPPFLAGS.)
  122. # #define PNG_USER_PRIVATEBUILD \
  123. # <Describes by whom and why this version of the DLL was built>
  124. # e.g. #define PNG_USER_PRIVATEBUILD "Build by MyCompany for xyz reasons."
  125. # #define PNG_USER_DLLFNAME_POSTFIX <two-letter postfix that serve to
  126. # distinguish your DLL from those of the official release. These
  127. # correspond to the trailing letters that come after the version
  128. # number and must match your private DLL name>
  129. # e.g. // private DLL "libpng13gx.dll"
  130. # #define PNG_USER_DLLFNAME_POSTFIX "gx"
  131. #
  132. # The following macros are also at your disposal if you want to complete the
  133. # DLL VERSIONINFO structure.
  134. # - PNG_USER_VERSIONINFO_COMMENTS
  135. # - PNG_USER_VERSIONINFO_COMPANYNAME
  136. # - PNG_USER_VERSIONINFO_LEGALTRADEMARKS
  137. # It is necessary to include configures definitions here so that AC_DEFINE
  138. # in configure.ac works in a comprehensible way
  139. @#if defined(HAVE_CONFIG_H) && !defined(PNG_NO_CONFIG_H)
  140. @# include "config.h"
  141. @#endif
  142. @#ifdef PNG_USER_CONFIG
  143. @# include "pngusr.h"
  144. @#endif
  145. # This is a special fixup for the Watcom C compiler on Windows, which has
  146. # multiple procedure call standards. Unless PNG_API_RULE is set explicitly
  147. # (i.e. if it is not defined at this point) it will be forced to '2' here when
  148. # using Watcom. This indicates to the other header files that Watcom behaviour
  149. # is required where appropriate.
  150. @#ifdef __WATCOMC__
  151. @# ifndef PNG_API_RULE
  152. @# define PNG_API_RULE 2 /* Use Watcom calling conventions */
  153. @# endif
  154. @#endif
  155. # IN DEVELOPMENT
  156. # These are currently experimental features; define them if you want (NOTE:
  157. # experimental options must be disabled before they are defined in this file!)
  158. # NONE
  159. # Note that PNG_USER_CONFIG only has an effect when building
  160. # pnglibconf.h
  161. setting USER_CONFIG
  162. setting USER_PRIVATEBUILD
  163. setting USER_DLLFNAME_POSTFIX
  164. setting USER_VERSIONINFO_COMMENTS
  165. setting USER_VERSIONINFO_COMPANYNAME
  166. setting USER_VERSIONINFO_LEGALTRADEMARKS
  167. # Record the 'API rule' used to select calling conventions on
  168. # those systems that support such things (see all the comments in
  169. # pngconf.h)
  170. # Changing this setting has a fundamental affect on the PNG ABI,
  171. # do not release shared libraries with this changed.
  172. setting API_RULE default 0
  173. # This allows a prefix to be added to the front of every API function name (and
  174. # therefore every symbol) by redefining all the function names with the prefix
  175. # at the end of pnglibconf.h. It also turns on similar internal symbol renaming
  176. # by causing a similar build-time only file, pngprefix.h, to be generated.
  177. setting PREFIX
  178. # Implementation specific control of the optimizations, enabled by those
  179. # hardware or software options that need it (typically when run-time choices
  180. # must be made by the user)
  181. option SET_OPTION disabled
  182. # These options are specific to the ARM NEON hardware optimizations. At present
  183. # these optimizations depend on GCC specific pre-processing of an assembler (.S)
  184. # file so they probably won't work with other compilers.
  185. #
  186. # ARM_NEON_OPT: unset: check at compile time (__ARM_NEON__ must be defined by
  187. # the compiler, typically as a result of specifying
  188. # CC="gcc -mfpu=neon".)
  189. # 0: disable (even if the CPU has a NEON FPU.)
  190. # 1: check at run time (via ARM_NEON_{API,CHECK})
  191. # 2: switch on unconditionally (inadvisable - instead pass
  192. # -mfpu=neon to GCC in CC)
  193. # When building libpng avoid using any setting other than '0'; '1' is
  194. # set automatically when either 'API' or 'CHECK' are configured in,
  195. # '2' should not be necessary as -mfpu=neon will achieve the same
  196. # effect as well as applying NEON optimizations to the rest of the
  197. # libpng code.
  198. # NOTE: any setting other than '0' requires ALIGNED_MEMORY
  199. # ARM_NEON_API: (PNG_ARM_NEON == 1) allow the optimization to be switched on
  200. # with png_set_option
  201. # ARM_NEON_CHECK: (PNG_ARM_NEON == 1) compile a run-time check to see if Neon
  202. # extensions are supported. This is poorly supported and
  203. # deprecated - use the png_set_option API.
  204. setting ARM_NEON_OPT
  205. option ARM_NEON_API disabled requires ALIGNED_MEMORY enables SET_OPTION,
  206. sets ARM_NEON_OPT 1
  207. option ARM_NEON_CHECK disabled requires ALIGNED_MEMORY,
  208. sets ARM_NEON_OPT 1
  209. # These options are specific to the PowerPC VSX hardware optimizations.
  210. #
  211. # POWERPC_VSX_OPT: unset: check at compile time (__PPC64__,__ALTIVEC__,__VSX__
  212. # must be defined by the compiler, typically as a result
  213. # of specifying
  214. # "-mvsx -maltivec" compiler flags)
  215. # 0: disable (even if the CPU supports VSX.)
  216. # 1: check at run time (via POWERPC_VSX_{API,CHECK})
  217. # 2: switch on unconditionally (inadvisable - instead pass
  218. # -mvsx -maltivec to compiler options)
  219. # When building libpng avoid using any setting other than '0'; '1' is
  220. # set automatically when either 'API' or 'CHECK' are configured in,
  221. # '2' should not be necessary as "-mvsx -maltivec" will achieve the same
  222. # effect as well as applying VSX optimizations to the rest of the
  223. # libpng code.
  224. # POWERPC_VSX_API: (PNG_POWERPC_VSX == 1) allow the optimization to be switched on
  225. # with png_set_option
  226. # POWERPC_VSX_CHECK: (PNG_POWERPC_VSX == 1) compile a run-time check to see if VSX
  227. # extensions are supported. This is supported not for all OSes
  228. # (see contrib/powerpc/README)
  229. setting POWERPC_VSX_OPT
  230. option POWERPC_VSX_API disabled enables SET_OPTION,
  231. sets POWERPC_VSX_OPT 1
  232. option POWERPC_VSX_CHECK disabled,
  233. sets POWERPC_VSX_OPT 1
  234. # These settings configure the default compression level (0-9) and 'strategy';
  235. # strategy is as defined by the implementors of zlib. It describes the input
  236. # data and modifies the zlib parameters in an attempt to optimize the balance
  237. # between search and huffman encoding in the zlib algorithms. The defaults are
  238. # the zlib.h defaults - the apparently recursive definition does not arise
  239. # because the name of the setting is prefixed by PNG_
  240. #
  241. # The TEXT values are the defaults when writing compressed text (all forms)
  242. # Include the zlib header so that the defaults below are known
  243. @# include <zlib.h>
  244. # The '@' here means to substitute the value when pnglibconf.h is built
  245. setting Z_DEFAULT_COMPRESSION default @Z_DEFAULT_COMPRESSION
  246. # TODO: why aren't these Z_RLE; zlib.h says that Z_RLE, specifically, is
  247. # appropriate for PNG images, maybe it doesn't exist in all versions?
  248. setting Z_DEFAULT_STRATEGY default @Z_FILTERED
  249. setting Z_DEFAULT_NOFILTER_STRATEGY default @Z_DEFAULT_STRATEGY
  250. setting ZLIB_VERNUM default @ZLIB_VERNUM
  251. # Linkage of:
  252. #
  253. # API: libpng API functions
  254. # CALLBACK: internal non-file-local callbacks
  255. # FUNCTION: internal non-file-local functions
  256. # DATA: internal non-file-local (const) data
  257. setting LINKAGE_API default extern
  258. setting LINKAGE_CALLBACK default extern
  259. setting LINKAGE_FUNCTION default extern
  260. setting LINKAGE_DATA default extern
  261. setting TEXT_Z_DEFAULT_COMPRESSION default @Z_DEFAULT_COMPRESSION
  262. setting TEXT_Z_DEFAULT_STRATEGY default @Z_DEFAULT_STRATEGY
  263. # Default to using the read macros
  264. setting DEFAULT_READ_MACROS default 1
  265. # The alternative is to call functions to read PNG values, if
  266. # the functions are turned *off* the read macros must always
  267. # be enabled, so turning this off will actually force the
  268. # USE_READ_MACROS option on (see pngconf.h)
  269. option READ_INT_FUNCTIONS requires READ
  270. # The same for write but these can only be switched off if no writing
  271. # is required at all - hence the use of a 'disabled', not a 'requires'.
  272. # If these are needed, they are enabled in the 'WRITE options' section
  273. # below.
  274. option WRITE_INT_FUNCTIONS disabled
  275. # Error controls
  276. #
  277. # WARNINGS: normally on, if off no warnings are generated
  278. # ERROR_TEXT: normally on, if off errors happen but there is no message
  279. # ERROR_NUMBERS: unimplemented feature, therefore disabled
  280. # BENIGN_ERRORS: support for just issuing warnings for recoverable errors
  281. #
  282. # BENIGN_READ_ERRORS:
  283. # By default recoverable errors on read should just generate warnings,
  284. # generally safe but PNG files that don't conform to the specification will
  285. # be accepted if a meaningful result can be produced.
  286. #
  287. # BENIGN_WRITE_ERRORS:
  288. # By default recoverable errors on write should just generate warnings,
  289. # not generally safe because this allows the application to write invalid
  290. # PNG files. Applications should enable this themselves; it's useful
  291. # because it means that a failure to write an ancillary chunk can often be
  292. # ignored.
  293. option WARNINGS
  294. option ERROR_TEXT
  295. option ERROR_NUMBERS disabled
  296. option BENIGN_ERRORS
  297. option BENIGN_WRITE_ERRORS requires BENIGN_ERRORS disabled
  298. option BENIGN_READ_ERRORS requires BENIGN_ERRORS
  299. # Generic options - affect both read and write.
  300. option MNG_FEATURES
  301. # Arithmetic options, the first is the big switch that chooses between internal
  302. # floating and fixed point arithmetic implementations - it does not affect any
  303. # APIs. The second two (the _POINT settings) switch off individual APIs.
  304. #
  305. # Prior to libpng 1.6.8 one of the API (_POINT) variants had to be selected. At
  306. # 1.6.8 this restriction has been removed; the simplified API can be used
  307. # without enabling any of the low level fixed/floating APIs.
  308. option FLOATING_ARITHMETIC
  309. option FLOATING_POINT
  310. option FIXED_POINT
  311. # This protects us against compilers that run on a windowing system
  312. # and thus don't have or would rather us not use the stdio types:
  313. # stdin, stdout, and stderr. The only one currently used is stderr
  314. # in png_error() and png_warning(). #defining PNG_NO_CONSOLE_IO will
  315. # prevent these from being compiled and used. #defining PNG_NO_STDIO
  316. # will also prevent these, plus will prevent the entire set of stdio
  317. # macros and functions (FILE *, printf, etc.) from being compiled and used,
  318. # unless (PNG_DEBUG > 0) has been #defined.
  319. option STDIO
  320. option CONSOLE_IO requires STDIO
  321. # Note: prior to 1.5.0 this option could not be disabled if STDIO
  322. # was enabled. Prior to 1.5.3 this option required STDIO
  323. option TIME_RFC1123
  324. # PNG_SETJMP_NOT_SUPPORTED is an old equivalent for NO_SETJMP
  325. option SETJMP
  326. = NO_SETJMP SETJMP_NOT_SUPPORTED
  327. # If this is disabled it is not possible for apps to get the
  328. # values from the 'info' structure, this effectively removes
  329. # quite a lot of the READ API.
  330. option EASY_ACCESS
  331. # Added at libpng-1.2.0
  332. option USER_MEM
  333. # Added at libpng-1.4.0
  334. option IO_STATE
  335. # Libpng limits: limit the size of images and data on read.
  336. #
  337. # If this option is disabled all the limit checking code will be disabled:
  338. option USER_LIMITS requires READ
  339. # The default settings given below for the limits mean that libpng will
  340. # limit the size of images or the size of data in ancillary chunks to less
  341. # than the specification or implementation limits. Settings have the
  342. # following interpretations:
  343. #
  344. # USER_WIDTH_MAX: maximum width of an image that will be read
  345. # USER_HEIGHT_MAX: maximum height
  346. # USER_CHUNK_MALLOC_MAX: maximum in-memory (decompressed) size of a single chunk
  347. # USER_CHUNK_CACHE_MAX: maximum number of chunks to be cached
  348. #
  349. # Only chunks that are variable in number are counted towards the
  350. # Use 0x7fffffff for unlimited
  351. setting USER_WIDTH_MAX default 1000000
  352. setting USER_HEIGHT_MAX default 1000000
  353. # Use 0 for unlimited
  354. setting USER_CHUNK_CACHE_MAX default 1000
  355. setting USER_CHUNK_MALLOC_MAX default 8000000
  356. # If this option is enabled APIs to set the above limits at run time are added;
  357. # without this the hardwired (compile time) limits will be used.
  358. option SET_USER_LIMITS requires USER_LIMITS
  359. # All of the following options relate to code capabilities for
  360. # processing image data before creating a PNG or after reading one.
  361. # You can remove these capabilities safely and still be PNG
  362. # conformant, however the library that results is still non-standard.
  363. # See the comments above about how to change options and settings.
  364. # READ options
  365. #
  366. # WARNING: in libpng 1.5 maintained configuration compatibility with earlier
  367. # versions. In some cases turning off an option turned off other options, in
  368. # others it was ineffective unless dependent options were also turned off.
  369. # Libpng 1.6 changes this: in general if you turn off an option that affects
  370. # APIs it stays off and simply disables APIs that depend on it.
  371. #
  372. # As a result if you simply port the libpng 1.5 configuration to libpng 1.6 you
  373. # will probably see build failures due to missing APIs. Fixing these failures
  374. # requires some, perhaps considerable, knowledge of what your libpng using
  375. # applications are doing, fortunately there is no great reason for you to move
  376. # to libpng 1.6; the new interfaces in 1.6 will take several years to become
  377. # popular.
  378. option READ enables READ_INTERLACING SET_OPTION
  379. # Disabling READ_16BIT does not disable reading 16-bit PNG files, but it
  380. # forces them to be chopped down to 8-bit, and disables any 16-bit
  381. # processing after that has happened. You need to be sure to enable
  382. # READ_SCALE_16_TO_8 or READ_STRIP_16_TO_8 when you disable READ_16BIT for
  383. # this to work properly. You should disable the other option if you need to
  384. # ensure a particular conversion (otherwise the app can chose.)
  385. option READ_16BIT requires READ enables 16BIT
  386. option READ_QUANTIZE requires READ
  387. option READ_TRANSFORMS requires READ
  388. = NO_READ_TRANSFORMS READ_TRANSFORMS_NOT_SUPPORTED
  389. # Read gamma handling. Gamma processing is a core part of libpng and many of
  390. # the capabilities are dependent on libpng performing gamma correction.
  391. #
  392. # In libpng 1.6 disabling gamma processing (setting PNG_NO_READ_GAMMA)
  393. # consistently disables those parts of the API that depend on it. Prior to
  394. # 1.6.0 this was not true; the results were unpredictable and varied between
  395. # releases.
  396. #
  397. # If you disable gamma processing and your program no longer compiles you need
  398. # to ask whether you really need the APIs that are missing. If you do then you
  399. # almost certainly need the gamma processing.
  400. #
  401. # If you handle gamma issues outside libpng then you do not need the libpng
  402. # gamma processing; and it is an enormous waste of space. You just need to
  403. # remove the use of libpng APIs that depend on it.
  404. option READ_GAMMA requires READ_TRANSFORMS, READ_gAMA, READ_sRGB
  405. option READ_ALPHA_MODE requires READ_TRANSFORMS, READ_GAMMA
  406. option READ_BACKGROUND requires READ_TRANSFORMS, READ_STRIP_ALPHA, READ_GAMMA
  407. option READ_BGR requires READ_TRANSFORMS
  408. option READ_EXPAND_16 requires READ_TRANSFORMS, READ_16BIT, READ_EXPAND
  409. option READ_EXPAND requires READ_TRANSFORMS
  410. option READ_FILLER requires READ_TRANSFORMS
  411. option READ_GRAY_TO_RGB requires READ_TRANSFORMS
  412. option READ_INVERT_ALPHA requires READ_TRANSFORMS
  413. option READ_INVERT requires READ_TRANSFORMS
  414. option READ_PACK requires READ_TRANSFORMS
  415. option READ_PACKSWAP requires READ_TRANSFORMS
  416. option READ_RGB_TO_GRAY requires READ_TRANSFORMS, READ_GAMMA enables COLORSPACE
  417. option READ_SCALE_16_TO_8 requires READ_TRANSFORMS
  418. option READ_SHIFT requires READ_TRANSFORMS
  419. option READ_STRIP_16_TO_8 requires READ_TRANSFORMS
  420. option READ_STRIP_ALPHA requires READ_TRANSFORMS
  421. option READ_SWAP_ALPHA requires READ_TRANSFORMS
  422. option READ_SWAP requires READ_TRANSFORMS, READ_16BIT
  423. option READ_USER_TRANSFORM requires READ_TRANSFORMS
  424. option PROGRESSIVE_READ requires READ
  425. option SEQUENTIAL_READ requires READ
  426. # You can define PNG_NO_PROGRESSIVE_READ if you don't do progressive reading.
  427. # This is not talking about interlacing capability! You'll still have
  428. # interlacing unless you turn off the following which is required
  429. # for PNG-compliant decoders. (In other words, do not do this - in
  430. # fact it can't be disabled from the command line!)
  431. #option READ_INTERLACING requires READ
  432. option READ_COMPOSITE_NODIV requires READ
  433. = NO_READ_COMPOSITE_NODIV NO_READ_COMPOSITED_NODIV
  434. # Inch conversions
  435. option INCH_CONVERSIONS
  436. = INCH_CONVERSIONS INCH_CONVERSIONS
  437. # API to build a grayscale palette
  438. # NOTE: this is not used internally by libpng at present.
  439. option BUILD_GRAYSCALE_PALETTE
  440. # WRITE options
  441. option WRITE enables WRITE_INT_FUNCTIONS
  442. # Disabling WRITE_16BIT prevents 16-bit PNG files from being
  443. # generated.
  444. option WRITE_16BIT requires WRITE enables 16BIT
  445. option WRITE_TRANSFORMS requires WRITE
  446. = NO_WRITE_TRANSFORMS WRITE_TRANSFORMS_NOT_SUPPORTED
  447. option WRITE_SHIFT requires WRITE_TRANSFORMS
  448. option WRITE_PACK requires WRITE_TRANSFORMS
  449. option WRITE_BGR requires WRITE_TRANSFORMS
  450. option WRITE_SWAP requires WRITE_TRANSFORMS, WRITE_16BIT
  451. option WRITE_PACKSWAP requires WRITE_TRANSFORMS
  452. option WRITE_INVERT requires WRITE_TRANSFORMS
  453. option WRITE_FILLER requires WRITE_TRANSFORMS
  454. option WRITE_SWAP_ALPHA requires WRITE_TRANSFORMS
  455. option WRITE_INVERT_ALPHA requires WRITE_TRANSFORMS
  456. option WRITE_USER_TRANSFORM requires WRITE_TRANSFORMS
  457. # This is not required for PNG-compliant encoders, but can cause
  458. # trouble if left undefined
  459. option WRITE_INTERLACING requires WRITE
  460. # Deprecated, will be removed.
  461. option WRITE_WEIGHTED_FILTER requires WRITE
  462. option WRITE_FLUSH requires WRITE
  463. # Note: these can be turned off explicitly if not required by the
  464. # apps implementing the user transforms
  465. option USER_TRANSFORM_PTR if READ_USER_TRANSFORM, WRITE_USER_TRANSFORM
  466. option USER_TRANSFORM_INFO if READ_USER_TRANSFORM, WRITE_USER_TRANSFORM
  467. # This enables API to set compression parameters for compressing
  468. # non-IDAT chunks (zTXt, iTXt, iCCP, and unknown chunks). This feature
  469. # was added at libpng-1.5.3.
  470. option WRITE_CUSTOMIZE_ZTXT_COMPRESSION requires WRITE
  471. option WRITE_CUSTOMIZE_COMPRESSION requires WRITE
  472. # Any chunks you are not interested in, you can undef here. The
  473. # ones that allocate memory may be especially important (hIST,
  474. # tEXt, zTXt, tRNS, pCAL). Others will just save time and make png_info
  475. # a bit smaller.
  476. # The size of the png_text structure changed in libpng-1.0.6 when
  477. # iTXt support was added. iTXt support was turned off by default through
  478. # libpng-1.2.x, to support old apps that malloc the png_text structure
  479. # instead of calling png_set_text() and letting libpng malloc it. It
  480. # was turned on by default in libpng-1.4.0.
  481. option READ_ANCILLARY_CHUNKS requires READ
  482. # PNG_READ_ANCILLARY_CHUNKS_NOT_SUPPORTED is deprecated.
  483. = NO_READ_ANCILLARY_CHUNKS READ_ANCILLARY_CHUNKS_NOT_SUPPORTED
  484. option WRITE_ANCILLARY_CHUNKS requires WRITE
  485. # PNG_WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED is deprecated.
  486. = NO_WRITE_ANCILLARY_CHUNKS WRITE_ANCILLARY_CHUNKS_NOT_SUPPORTED
  487. # These options disable *all* the text chunks if turned off
  488. option TEXT disabled
  489. option READ_TEXT requires READ_ANCILLARY_CHUNKS enables TEXT
  490. option WRITE_TEXT requires WRITE_ANCILLARY_CHUNKS enables TEXT
  491. # Moved to pnglibconf.h at libpng-1.5.0
  492. # Feature support: in 1.4 this was in pngconf.h, but the following
  493. # features have no affect on the libpng API. Add library
  494. # only features to the end of this list. Add features that
  495. # affect the API above. (Note: the list of chunks follows
  496. # the library-only settings.)
  497. #
  498. # BUILD TIME ONLY OPTIONS
  499. # These options do not affect the API but rather alter how the
  500. # API is implemented, they get recorded in pnglibconf.h, but
  501. # can't be changed by the application.
  502. # Colorspace support (enabled as required); just the support for colorant
  503. # information. Gamma support, likewise, is just support for the gamma
  504. # information, READ_GAMMA is required for gamma transformations (so it
  505. # is possible to read PNG gamma without enabling all the libpng transform
  506. # code - do this for applications that do their own gamma processing)
  507. #
  508. # As of 1.6.0 COLORSPACE is only useful if the application processes the
  509. # information; this is because the library does not do any colorspace
  510. # processing, it just validates the data in the PNG file.
  511. option GAMMA disabled
  512. option COLORSPACE enables GAMMA disabled
  513. # When an ICC profile is read, or png_set, it will be checked for a match
  514. # against known sRGB profiles if the sRGB handling is enabled. The
  515. # PNG_sRGB_PROFILE_CHECKS setting controls how much work is done during the
  516. # check:
  517. #
  518. # -1: Don't do any sRGB profile checking.
  519. #
  520. # 0: Just validate the profile MD5 signature if present, otherwise use
  521. # the checks in option 1.
  522. #
  523. # 1: Additionally check the length, intent and adler32 checksum of the
  524. # actual data. If enabled this will reject known profiles that have
  525. # had the rendering intent in the header changed as well as other edits
  526. # done without updating the checksum. See the discussion below.
  527. #
  528. # 2: Additionally checksum all the data using the ethernet CRC32 algorithm.
  529. # This makes it more difficult to fake profiles and makes it less likely
  530. # to get a false positive on profiles with no signature, but is probably
  531. # just a waste of time since all currently approved ICC sRGB profiles have
  532. # a secure MD5 signature.
  533. #
  534. # The rendering intent. An ICC profile stores an intended rendering intent,
  535. # but does not include the value in the signature. The intent is documented
  536. # as the intent that should be used when combining two profiles. The sRGB
  537. # profile is intended, however, to be used with any of the four defined intents.
  538. # For this reason the sRGB chunk includes an 'intent' to be used when displaying
  539. # the image (intent is really a property of the image not the profile.)
  540. #
  541. # Unfortunately the iCCP chunk does not. It may therefore be that some
  542. # applications modify the intent in profiles (including sRGB profiles) to work
  543. # round this problem. Selecting an option other than option '0' will cause such
  544. # modified profiles to be rejected.
  545. #
  546. # Security. The use of Adler32 and CRC32 checksums does not help significantly
  547. # with any security issues. It is relatively easy to produce arbitrary profiles
  548. # with the required checksums on current computer systems. Nevertheless
  549. # security does not seem to be an issue because the only consequence of a false
  550. # positive is a false assertion that the profile is an sRGB profile. This might
  551. # be used to hide data from libpng using applications, but it doesn't seem
  552. # possible to damage them.
  553. setting sRGB_PROFILE_CHECKS default 2
  554. # Artificially align memory - the code typically aligns to 8 byte
  555. # boundaries if this is switched on, it's a small waste of space
  556. # but can help (in theory) on some architectures. Only affects
  557. # internal structures. Added at libpng 1.4.0
  558. option ALIGNED_MEMORY
  559. # Buggy compilers (e.g., gcc 2.7.2.2) need PNG_NO_POINTER_INDEXING
  560. # See png[wr]util.c, normally this should always be *on*
  561. option POINTER_INDEXING
  562. # Other defines for things like memory and the like can go here.
  563. # BUILD TIME SETTINGS
  564. # Like build time options these do not affect the API, but they
  565. # may be useful to applications because they record details of
  566. # how the API will behave particularly with regard to overall
  567. # accuracy.
  568. # This controls how fine the quantizing gets. As this allocates
  569. # a largish chunk of memory (32K), those who are not as concerned
  570. # with quantizing quality can decrease some or all of these.
  571. setting QUANTIZE_RED_BITS default 5
  572. setting QUANTIZE_GREEN_BITS default 5
  573. setting QUANTIZE_BLUE_BITS default 5
  574. # This controls how fine the gamma correction becomes when you
  575. # are only interested in 8 bits anyway. Increasing this value
  576. # results in more memory being used, and more pow() functions
  577. # being called to fill in the gamma tables. Don't set this value
  578. # less than 8, and even that may not work (I haven't tested it).
  579. setting MAX_GAMMA_8 default 11
  580. # This controls how much a difference in gamma we can tolerate before
  581. # we actually start doing gamma conversion, it's a fixed point value,
  582. # so the default below is 0.05, meaning libpng ignores corrections in
  583. # the range 0.95 to 1.05
  584. setting GAMMA_THRESHOLD_FIXED default 5000
  585. # Precision to use when converting a floating point value to a PNG
  586. # extension format string in an sCAL chunk (only relevant if the
  587. # floating point API is enabled)
  588. setting sCAL_PRECISION default 5
  589. # This is the size of the compression buffer, and thus the size of
  590. # an IDAT chunk. Make this whatever size you feel is best for your
  591. # machine. One of these will be allocated per png_struct. When this
  592. # is full, it writes the data to the disk, and does some other
  593. # calculations. Making this an extremely small size may slow
  594. # the library down, but you may want to experiment to determine
  595. # where it becomes significant, if you are concerned with memory
  596. # usage. Note that zlib allocates at least 32Kb also. For readers,
  597. # this describes the size of the buffer available to read the data in.
  598. # Unless this gets smaller than the size of a row (compressed),
  599. # it should not make much difference how big this is.
  600. setting ZBUF_SIZE default 8192
  601. # This is the size of the decompression buffer used when counting or checking
  602. # the decompressed size of an LZ stream from a compressed ancillary chunk; the
  603. # decompressed data is never used so a different size may be optimal. This size
  604. # was determined using contrib/libtests/timepng.c with compressed zTXt data
  605. # around 11MByte in size. Slight speed improvements (up to about 14% in
  606. # timepng) can be achieved by very large increases (to 32kbyte) on regular data,
  607. # but highly compressible data shows only around 2% improvement. The size is
  608. # chosen to minimize the effects of DoS attacks based on using very large
  609. # amounts of highly compressible data.
  610. setting INFLATE_BUF_SIZE default 1024
  611. # This is the maximum amount of IDAT data that the sequential reader will
  612. # process at one time. The setting does not affect the size of IDAT chunks
  613. # read, just the amount read at once. Neither does it affect the progressive
  614. # reader, which processes just the amount of data the application gives it.
  615. # The sequential reader is currently unable to process more than one IDAT at
  616. # once - it has to read and process each one in turn. There is no point setting
  617. # this to a value larger than the IDAT chunks typically encountered (it would
  618. # just waste memory) but there may be some point in reducing it below the value
  619. # of ZBUF_SIZE (the size of IDAT chunks written by libpng.)
  620. setting IDAT_READ_SIZE default PNG_ZBUF_SIZE
  621. # Ancillary chunks
  622. chunk bKGD
  623. chunk cHRM enables COLORSPACE
  624. chunk eXIf
  625. chunk gAMA enables GAMMA
  626. chunk hIST
  627. chunk iCCP enables COLORSPACE, GAMMA
  628. chunk iTXt enables TEXT
  629. chunk oFFs
  630. chunk pCAL
  631. chunk pHYs
  632. chunk sBIT
  633. chunk sCAL
  634. chunk sPLT
  635. chunk sRGB enables COLORSPACE, GAMMA, SET_OPTION
  636. chunk tEXt requires TEXT
  637. chunk tIME
  638. chunk tRNS
  639. chunk zTXt enables TEXT
  640. # This only affects support of the optional PLTE chunk in RGB and RGBA
  641. # images. Notice that READ_ANCILLARY_CHUNKS therefore disables part
  642. # of the regular chunk reading too.
  643. option READ_OPT_PLTE requires READ_ANCILLARY_CHUNKS
  644. # Unknown chunk handling
  645. #
  646. # 'UNKNOWN_CHUNKS' is a global option to disable all unknown chunk handling on
  647. # read or write; everything else below requires it (directly or indirectly).
  648. option UNKNOWN_CHUNKS
  649. # There are three main options to control the ability to read and write unknown
  650. # chunks. If either read option is turned on then unknown chunks will be read,
  651. # otherwise they are skipped. If the write option is turned on unknown chunks
  652. # set by png_set_unknown_chunks will be written otherwise it is an error to call
  653. # that API on a write struct.
  654. option WRITE_UNKNOWN_CHUNKS requires WRITE requires UNKNOWN_CHUNKS
  655. option WRITE_UNKNOWN_CHUNKS enables STORE_UNKNOWN_CHUNKS
  656. # The first way to read user chunks is to have libpng save them for a later call
  657. # to png_get_unknown_chunks, the application must call
  658. # png_set_keep_unknown_chunks to cause this to actually happen (see png.h)
  659. option SAVE_UNKNOWN_CHUNKS requires READ requires SET_UNKNOWN_CHUNKS
  660. option SAVE_UNKNOWN_CHUNKS enables READ_UNKNOWN_CHUNKS, STORE_UNKNOWN_CHUNKS
  661. # The second approach is to use an application provided callback to process the
  662. # chunks, the callback can either handle the chunk entirely itself or request
  663. # that libpng store the chunk for later retrieval via png_get_unknown_chunks.
  664. #
  665. # NOTE: If STORE_UNKNOWN_CHUNKS is not enabled (which is the default if
  666. # both SAVE_UNKNOWN_CHUNKS and WRITE_UNKNOWN_CHUNKS are disabled) then a
  667. # 0 result from the callback will be ignored because no support for saving
  668. # unknown chunks has been compiled in. The normal symptom is that your app
  669. # fails to compile because png_get_unknown_chunks is no longer defined in png.h.
  670. # If you encounter this issue simply enable STORE_UNKNOWN_CHUNKS in your build.
  671. #
  672. # Note that there is no 'WRITE_USER_CHUNKS' so the USER_CHUNKS option is always
  673. # the same as READ_USER_CHUNKS at present
  674. option READ_USER_CHUNKS requires READ, UNKNOWN_CHUNKS
  675. option READ_USER_CHUNKS enables READ_UNKNOWN_CHUNKS, USER_CHUNKS
  676. # Two further options are provided to allow detailed control of the handling.
  677. # The first enables png_set_keep_unknown_chunks; this allows the default to be
  678. # changed from discarding unknown chunks and allows per-chunk control. This is
  679. # required to use the SAVE_UNKNOWN_CHUNKS option. If enabled this option also
  680. # applies to write (see png.h), otherwise the write API simply writes all the
  681. # chunks it is given.
  682. #
  683. # The second option extends the unknown handling to allow known chunks to be
  684. # handled as though they were unknown. This option doesn't change any APIs, it
  685. # merely turns on the code to check known as well as unknown chunks.
  686. #
  687. # This option no longer affects the write code. It can be safely disabled and
  688. # will prevent applications stopping libpng reading known chunks.
  689. option SET_UNKNOWN_CHUNKS requires UNKNOWN_CHUNKS
  690. option HANDLE_AS_UNKNOWN requires SET_UNKNOWN_CHUNKS
  691. # The following options are derived from the above and should not be turned on
  692. # explicitly.
  693. option READ_UNKNOWN_CHUNKS requires UNKNOWN_CHUNKS disabled
  694. option STORE_UNKNOWN_CHUNKS requires UNKNOWN_CHUNKS disabled
  695. option CONVERT_tIME requires WRITE_ANCILLARY_CHUNKS
  696. # The "tm" structure is not supported on WindowsCE
  697. @#ifdef _WIN32_WCE
  698. @# define PNG_NO_CONVERT_tIME
  699. @#endif
  700. option WRITE_FILTER requires WRITE
  701. option SAVE_INT_32 disabled
  702. # png_save_int_32 is required internally for writing the ancillary chunks oFFs
  703. # and pCAL and for both reading and writing iCCP (for the generation/checking of
  704. # the corresponding cHRM/gAMA chunks) if full ICC is supported.
  705. # added at libpng-1.5.4
  706. option WRITE_OPTIMIZE_CMF requires WRITE
  707. option READ_COMPRESSED_TEXT disabled
  708. option READ_iCCP enables READ_COMPRESSED_TEXT
  709. option READ_iTXt enables READ_COMPRESSED_TEXT
  710. option READ_zTXt enables READ_COMPRESSED_TEXT
  711. option WRITE_oFFs enables SAVE_INT_32
  712. option WRITE_pCAL enables SAVE_INT_32
  713. option WRITE_cHRM enables SAVE_INT_32
  714. option WRITE_COMPRESSED_TEXT disabled
  715. option WRITE_iCCP enables WRITE_COMPRESSED_TEXT
  716. option WRITE_iTXt enables WRITE_COMPRESSED_TEXT
  717. option WRITE_zTXt enables WRITE_COMPRESSED_TEXT
  718. # Turn this off to disable png_read_png() and png_write_png() and
  719. # leave the row_pointers member out of the info structure.
  720. option INFO_IMAGE
  721. # added at libpng-1.5.10
  722. # Turn this off to disable warning about invalid palette index and
  723. # leave the num_palette_max member out of the png structure.
  724. option CHECK_FOR_INVALID_INDEX enables READ_CHECK_FOR_INVALID_INDEX
  725. option CHECK_FOR_INVALID_INDEX enables WRITE_CHECK_FOR_INVALID_INDEX
  726. option READ_CHECK_FOR_INVALID_INDEX requires READ, CHECK_FOR_INVALID_INDEX
  727. option WRITE_CHECK_FOR_INVALID_INDEX requires WRITE, CHECK_FOR_INVALID_INDEX
  728. # added at libpng-1.5.15
  729. option GET_PALETTE_MAX enables READ_GET_PALETTE_MAX WRITE_GET_PALETTE_MAX
  730. option READ_GET_PALETTE_MAX requires READ_CHECK_FOR_INVALID_INDEX disabled
  731. option WRITE_GET_PALETTE_MAX requires WRITE_CHECK_FOR_INVALID_INDEX disabled
  732. # Simplified API options (added at libpng-1.6.0)
  733. # In libpng 1.6.8 the handling of these options was changed to used 'requires'
  734. # throughout, so that disabling some of the low level support always disables
  735. # the base simplified read/write API. This much simplifies the handling and
  736. # makes 'everything = off' work in a more intuitive way. It eliminates a
  737. # previously reported feature that APIs previously enabled by the simplified
  738. # API couldn't be turned off without explicitly turning off the simplified
  739. # APIs.
  740. #
  741. # Read:
  742. option SIMPLIFIED_READ,
  743. requires SEQUENTIAL_READ, READ_TRANSFORMS, SETJMP, BENIGN_ERRORS,
  744. READ_EXPAND, READ_16BIT, READ_EXPAND_16, READ_SCALE_16_TO_8,
  745. READ_RGB_TO_GRAY, READ_ALPHA_MODE, READ_BACKGROUND, READ_STRIP_ALPHA,
  746. READ_FILLER, READ_SWAP, READ_PACK, READ_GRAY_TO_RGB, READ_GAMMA,
  747. READ_tRNS, READ_bKGD, READ_gAMA, READ_cHRM, READ_sRGB, READ_sBIT
  748. # AFIRST and BGR read options:
  749. # Prior to libpng 1.6.8 these were disabled but switched on if the low level
  750. # libpng routines that do the swaps were enabled. This worked but was
  751. # confusing. In libpng 1.6.8 the options were changed to simple 'requires'
  752. # and are enabled by default. This should work the same way in practice.
  753. option SIMPLIFIED_READ_AFIRST enables FORMAT_AFIRST,
  754. requires SIMPLIFIED_READ READ_SWAP_ALPHA
  755. option SIMPLIFIED_READ_BGR enables FORMAT_BGR,
  756. requires SIMPLIFIED_READ READ_BGR
  757. # Write:
  758. option SIMPLIFIED_WRITE,
  759. requires WRITE, SETJMP, WRITE_SWAP, WRITE_PACK,
  760. WRITE_tRNS, WRITE_gAMA, WRITE_sRGB, WRITE_cHRM
  761. # 1.6.22: allow simplified write without stdio support:
  762. option SIMPLIFIED_WRITE_STDIO requires SIMPLIFIED_WRITE STDIO
  763. option SIMPLIFIED_WRITE_AFIRST enables FORMAT_AFIRST,
  764. requires SIMPLIFIED_WRITE WRITE_SWAP_ALPHA
  765. option SIMPLIFIED_WRITE_BGR enables FORMAT_BGR,
  766. requires SIMPLIFIED_WRITE WRITE_BGR
  767. # Formats:
  768. option FORMAT_AFIRST disabled
  769. option FORMAT_BGR disabled