pnglibconf.dfa 36 KB

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