encode.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542
  1. // Copyright 2011 Google Inc. All Rights Reserved.
  2. //
  3. // Use of this source code is governed by a BSD-style license
  4. // that can be found in the COPYING file in the root of the source
  5. // tree. An additional intellectual property rights grant can be found
  6. // in the file PATENTS. All contributing project authors may
  7. // be found in the AUTHORS file in the root of the source tree.
  8. // -----------------------------------------------------------------------------
  9. //
  10. // WebP encoder: main interface
  11. //
  12. // Author: Skal (pascal.massimino@gmail.com)
  13. #ifndef WEBP_WEBP_ENCODE_H_
  14. #define WEBP_WEBP_ENCODE_H_
  15. #include "./types.h"
  16. #ifdef __cplusplus
  17. extern "C" {
  18. #endif
  19. #define WEBP_ENCODER_ABI_VERSION 0x020e // MAJOR(8b) + MINOR(8b)
  20. // Note: forward declaring enumerations is not allowed in (strict) C and C++,
  21. // the types are left here for reference.
  22. // typedef enum WebPImageHint WebPImageHint;
  23. // typedef enum WebPEncCSP WebPEncCSP;
  24. // typedef enum WebPPreset WebPPreset;
  25. // typedef enum WebPEncodingError WebPEncodingError;
  26. typedef struct WebPConfig WebPConfig;
  27. typedef struct WebPPicture WebPPicture; // main structure for I/O
  28. typedef struct WebPAuxStats WebPAuxStats;
  29. typedef struct WebPMemoryWriter WebPMemoryWriter;
  30. // Return the encoder's version number, packed in hexadecimal using 8bits for
  31. // each of major/minor/revision. E.g: v2.5.7 is 0x020507.
  32. WEBP_EXTERN(int) WebPGetEncoderVersion(void);
  33. //------------------------------------------------------------------------------
  34. // One-stop-shop call! No questions asked:
  35. // Returns the size of the compressed data (pointed to by *output), or 0 if
  36. // an error occurred. The compressed data must be released by the caller
  37. // using the call 'WebPFree(*output)'.
  38. // These functions compress using the lossy format, and the quality_factor
  39. // can go from 0 (smaller output, lower quality) to 100 (best quality,
  40. // larger output).
  41. WEBP_EXTERN(size_t) WebPEncodeRGB(const uint8_t* rgb,
  42. int width, int height, int stride,
  43. float quality_factor, uint8_t** output);
  44. WEBP_EXTERN(size_t) WebPEncodeBGR(const uint8_t* bgr,
  45. int width, int height, int stride,
  46. float quality_factor, uint8_t** output);
  47. WEBP_EXTERN(size_t) WebPEncodeRGBA(const uint8_t* rgba,
  48. int width, int height, int stride,
  49. float quality_factor, uint8_t** output);
  50. WEBP_EXTERN(size_t) WebPEncodeBGRA(const uint8_t* bgra,
  51. int width, int height, int stride,
  52. float quality_factor, uint8_t** output);
  53. // These functions are the equivalent of the above, but compressing in a
  54. // lossless manner. Files are usually larger than lossy format, but will
  55. // not suffer any compression loss.
  56. WEBP_EXTERN(size_t) WebPEncodeLosslessRGB(const uint8_t* rgb,
  57. int width, int height, int stride,
  58. uint8_t** output);
  59. WEBP_EXTERN(size_t) WebPEncodeLosslessBGR(const uint8_t* bgr,
  60. int width, int height, int stride,
  61. uint8_t** output);
  62. WEBP_EXTERN(size_t) WebPEncodeLosslessRGBA(const uint8_t* rgba,
  63. int width, int height, int stride,
  64. uint8_t** output);
  65. WEBP_EXTERN(size_t) WebPEncodeLosslessBGRA(const uint8_t* bgra,
  66. int width, int height, int stride,
  67. uint8_t** output);
  68. // Releases memory returned by the WebPEncode*() functions above.
  69. WEBP_EXTERN(void) WebPFree(void* ptr);
  70. //------------------------------------------------------------------------------
  71. // Coding parameters
  72. // Image characteristics hint for the underlying encoder.
  73. typedef enum WebPImageHint {
  74. WEBP_HINT_DEFAULT = 0, // default preset.
  75. WEBP_HINT_PICTURE, // digital picture, like portrait, inner shot
  76. WEBP_HINT_PHOTO, // outdoor photograph, with natural lighting
  77. WEBP_HINT_GRAPH, // Discrete tone image (graph, map-tile etc).
  78. WEBP_HINT_LAST
  79. } WebPImageHint;
  80. // Compression parameters.
  81. struct WebPConfig {
  82. int lossless; // Lossless encoding (0=lossy(default), 1=lossless).
  83. float quality; // between 0 (smallest file) and 100 (biggest)
  84. int method; // quality/speed trade-off (0=fast, 6=slower-better)
  85. WebPImageHint image_hint; // Hint for image type (lossless only for now).
  86. // Parameters related to lossy compression only:
  87. int target_size; // if non-zero, set the desired target size in bytes.
  88. // Takes precedence over the 'compression' parameter.
  89. float target_PSNR; // if non-zero, specifies the minimal distortion to
  90. // try to achieve. Takes precedence over target_size.
  91. int segments; // maximum number of segments to use, in [1..4]
  92. int sns_strength; // Spatial Noise Shaping. 0=off, 100=maximum.
  93. int filter_strength; // range: [0 = off .. 100 = strongest]
  94. int filter_sharpness; // range: [0 = off .. 7 = least sharp]
  95. int filter_type; // filtering type: 0 = simple, 1 = strong (only used
  96. // if filter_strength > 0 or autofilter > 0)
  97. int autofilter; // Auto adjust filter's strength [0 = off, 1 = on]
  98. int alpha_compression; // Algorithm for encoding the alpha plane (0 = none,
  99. // 1 = compressed with WebP lossless). Default is 1.
  100. int alpha_filtering; // Predictive filtering method for alpha plane.
  101. // 0: none, 1: fast, 2: best. Default if 1.
  102. int alpha_quality; // Between 0 (smallest size) and 100 (lossless).
  103. // Default is 100.
  104. int pass; // number of entropy-analysis passes (in [1..10]).
  105. int show_compressed; // if true, export the compressed picture back.
  106. // In-loop filtering is not applied.
  107. int preprocessing; // preprocessing filter:
  108. // 0=none, 1=segment-smooth, 2=pseudo-random dithering
  109. int partitions; // log2(number of token partitions) in [0..3]. Default
  110. // is set to 0 for easier progressive decoding.
  111. int partition_limit; // quality degradation allowed to fit the 512k limit
  112. // on prediction modes coding (0: no degradation,
  113. // 100: maximum possible degradation).
  114. int emulate_jpeg_size; // If true, compression parameters will be remapped
  115. // to better match the expected output size from
  116. // JPEG compression. Generally, the output size will
  117. // be similar but the degradation will be lower.
  118. int thread_level; // If non-zero, try and use multi-threaded encoding.
  119. int low_memory; // If set, reduce memory usage (but increase CPU use).
  120. int near_lossless; // Near lossless encoding [0 = max loss .. 100 = off
  121. // (default)].
  122. int exact; // if non-zero, preserve the exact RGB values under
  123. // transparent area. Otherwise, discard this invisible
  124. // RGB information for better compression. The default
  125. // value is 0.
  126. int use_delta_palette; // reserved for future lossless feature
  127. int use_sharp_yuv; // if needed, use sharp (and slow) RGB->YUV conversion
  128. uint32_t pad[2]; // padding for later use
  129. };
  130. // Enumerate some predefined settings for WebPConfig, depending on the type
  131. // of source picture. These presets are used when calling WebPConfigPreset().
  132. typedef enum WebPPreset {
  133. WEBP_PRESET_DEFAULT = 0, // default preset.
  134. WEBP_PRESET_PICTURE, // digital picture, like portrait, inner shot
  135. WEBP_PRESET_PHOTO, // outdoor photograph, with natural lighting
  136. WEBP_PRESET_DRAWING, // hand or line drawing, with high-contrast details
  137. WEBP_PRESET_ICON, // small-sized colorful images
  138. WEBP_PRESET_TEXT // text-like
  139. } WebPPreset;
  140. // Internal, version-checked, entry point
  141. WEBP_EXTERN(int) WebPConfigInitInternal(WebPConfig*, WebPPreset, float, int);
  142. // Should always be called, to initialize a fresh WebPConfig structure before
  143. // modification. Returns false in case of version mismatch. WebPConfigInit()
  144. // must have succeeded before using the 'config' object.
  145. // Note that the default values are lossless=0 and quality=75.
  146. static WEBP_INLINE int WebPConfigInit(WebPConfig* config) {
  147. return WebPConfigInitInternal(config, WEBP_PRESET_DEFAULT, 75.f,
  148. WEBP_ENCODER_ABI_VERSION);
  149. }
  150. // This function will initialize the configuration according to a predefined
  151. // set of parameters (referred to by 'preset') and a given quality factor.
  152. // This function can be called as a replacement to WebPConfigInit(). Will
  153. // return false in case of error.
  154. static WEBP_INLINE int WebPConfigPreset(WebPConfig* config,
  155. WebPPreset preset, float quality) {
  156. return WebPConfigInitInternal(config, preset, quality,
  157. WEBP_ENCODER_ABI_VERSION);
  158. }
  159. // Activate the lossless compression mode with the desired efficiency level
  160. // between 0 (fastest, lowest compression) and 9 (slower, best compression).
  161. // A good default level is '6', providing a fair tradeoff between compression
  162. // speed and final compressed size.
  163. // This function will overwrite several fields from config: 'method', 'quality'
  164. // and 'lossless'. Returns false in case of parameter error.
  165. WEBP_EXTERN(int) WebPConfigLosslessPreset(WebPConfig* config, int level);
  166. // Returns true if 'config' is non-NULL and all configuration parameters are
  167. // within their valid ranges.
  168. WEBP_EXTERN(int) WebPValidateConfig(const WebPConfig* config);
  169. //------------------------------------------------------------------------------
  170. // Input / Output
  171. // Structure for storing auxiliary statistics (mostly for lossy encoding).
  172. struct WebPAuxStats {
  173. int coded_size; // final size
  174. float PSNR[5]; // peak-signal-to-noise ratio for Y/U/V/All/Alpha
  175. int block_count[3]; // number of intra4/intra16/skipped macroblocks
  176. int header_bytes[2]; // approximate number of bytes spent for header
  177. // and mode-partition #0
  178. int residual_bytes[3][4]; // approximate number of bytes spent for
  179. // DC/AC/uv coefficients for each (0..3) segments.
  180. int segment_size[4]; // number of macroblocks in each segments
  181. int segment_quant[4]; // quantizer values for each segments
  182. int segment_level[4]; // filtering strength for each segments [0..63]
  183. int alpha_data_size; // size of the transparency data
  184. int layer_data_size; // size of the enhancement layer data
  185. // lossless encoder statistics
  186. uint32_t lossless_features; // bit0:predictor bit1:cross-color transform
  187. // bit2:subtract-green bit3:color indexing
  188. int histogram_bits; // number of precision bits of histogram
  189. int transform_bits; // precision bits for transform
  190. int cache_bits; // number of bits for color cache lookup
  191. int palette_size; // number of color in palette, if used
  192. int lossless_size; // final lossless size
  193. int lossless_hdr_size; // lossless header (transform, huffman etc) size
  194. int lossless_data_size; // lossless image data size
  195. uint32_t pad[2]; // padding for later use
  196. };
  197. // Signature for output function. Should return true if writing was successful.
  198. // data/data_size is the segment of data to write, and 'picture' is for
  199. // reference (and so one can make use of picture->custom_ptr).
  200. typedef int (*WebPWriterFunction)(const uint8_t* data, size_t data_size,
  201. const WebPPicture* picture);
  202. // WebPMemoryWrite: a special WebPWriterFunction that writes to memory using
  203. // the following WebPMemoryWriter object (to be set as a custom_ptr).
  204. struct WebPMemoryWriter {
  205. uint8_t* mem; // final buffer (of size 'max_size', larger than 'size').
  206. size_t size; // final size
  207. size_t max_size; // total capacity
  208. uint32_t pad[1]; // padding for later use
  209. };
  210. // The following must be called first before any use.
  211. WEBP_EXTERN(void) WebPMemoryWriterInit(WebPMemoryWriter* writer);
  212. // The following must be called to deallocate writer->mem memory. The 'writer'
  213. // object itself is not deallocated.
  214. WEBP_EXTERN(void) WebPMemoryWriterClear(WebPMemoryWriter* writer);
  215. // The custom writer to be used with WebPMemoryWriter as custom_ptr. Upon
  216. // completion, writer.mem and writer.size will hold the coded data.
  217. // writer.mem must be freed by calling WebPMemoryWriterClear.
  218. WEBP_EXTERN(int) WebPMemoryWrite(const uint8_t* data, size_t data_size,
  219. const WebPPicture* picture);
  220. // Progress hook, called from time to time to report progress. It can return
  221. // false to request an abort of the encoding process, or true otherwise if
  222. // everything is OK.
  223. typedef int (*WebPProgressHook)(int percent, const WebPPicture* picture);
  224. // Color spaces.
  225. typedef enum WebPEncCSP {
  226. // chroma sampling
  227. WEBP_YUV420 = 0, // 4:2:0
  228. WEBP_YUV420A = 4, // alpha channel variant
  229. WEBP_CSP_UV_MASK = 3, // bit-mask to get the UV sampling factors
  230. WEBP_CSP_ALPHA_BIT = 4 // bit that is set if alpha is present
  231. } WebPEncCSP;
  232. // Encoding error conditions.
  233. typedef enum WebPEncodingError {
  234. VP8_ENC_OK = 0,
  235. VP8_ENC_ERROR_OUT_OF_MEMORY, // memory error allocating objects
  236. VP8_ENC_ERROR_BITSTREAM_OUT_OF_MEMORY, // memory error while flushing bits
  237. VP8_ENC_ERROR_NULL_PARAMETER, // a pointer parameter is NULL
  238. VP8_ENC_ERROR_INVALID_CONFIGURATION, // configuration is invalid
  239. VP8_ENC_ERROR_BAD_DIMENSION, // picture has invalid width/height
  240. VP8_ENC_ERROR_PARTITION0_OVERFLOW, // partition is bigger than 512k
  241. VP8_ENC_ERROR_PARTITION_OVERFLOW, // partition is bigger than 16M
  242. VP8_ENC_ERROR_BAD_WRITE, // error while flushing bytes
  243. VP8_ENC_ERROR_FILE_TOO_BIG, // file is bigger than 4G
  244. VP8_ENC_ERROR_USER_ABORT, // abort request by user
  245. VP8_ENC_ERROR_LAST // list terminator. always last.
  246. } WebPEncodingError;
  247. // maximum width/height allowed (inclusive), in pixels
  248. #define WEBP_MAX_DIMENSION 16383
  249. // Main exchange structure (input samples, output bytes, statistics)
  250. struct WebPPicture {
  251. // INPUT
  252. //////////////
  253. // Main flag for encoder selecting between ARGB or YUV input.
  254. // It is recommended to use ARGB input (*argb, argb_stride) for lossless
  255. // compression, and YUV input (*y, *u, *v, etc.) for lossy compression
  256. // since these are the respective native colorspace for these formats.
  257. int use_argb;
  258. // YUV input (mostly used for input to lossy compression)
  259. WebPEncCSP colorspace; // colorspace: should be YUV420 for now (=Y'CbCr).
  260. int width, height; // dimensions (less or equal to WEBP_MAX_DIMENSION)
  261. uint8_t *y, *u, *v; // pointers to luma/chroma planes.
  262. int y_stride, uv_stride; // luma/chroma strides.
  263. uint8_t* a; // pointer to the alpha plane
  264. int a_stride; // stride of the alpha plane
  265. uint32_t pad1[2]; // padding for later use
  266. // ARGB input (mostly used for input to lossless compression)
  267. uint32_t* argb; // Pointer to argb (32 bit) plane.
  268. int argb_stride; // This is stride in pixels units, not bytes.
  269. uint32_t pad2[3]; // padding for later use
  270. // OUTPUT
  271. ///////////////
  272. // Byte-emission hook, to store compressed bytes as they are ready.
  273. WebPWriterFunction writer; // can be NULL
  274. void* custom_ptr; // can be used by the writer.
  275. // map for extra information (only for lossy compression mode)
  276. int extra_info_type; // 1: intra type, 2: segment, 3: quant
  277. // 4: intra-16 prediction mode,
  278. // 5: chroma prediction mode,
  279. // 6: bit cost, 7: distortion
  280. uint8_t* extra_info; // if not NULL, points to an array of size
  281. // ((width + 15) / 16) * ((height + 15) / 16) that
  282. // will be filled with a macroblock map, depending
  283. // on extra_info_type.
  284. // STATS AND REPORTS
  285. ///////////////////////////
  286. // Pointer to side statistics (updated only if not NULL)
  287. WebPAuxStats* stats;
  288. // Error code for the latest error encountered during encoding
  289. WebPEncodingError error_code;
  290. // If not NULL, report progress during encoding.
  291. WebPProgressHook progress_hook;
  292. void* user_data; // this field is free to be set to any value and
  293. // used during callbacks (like progress-report e.g.).
  294. uint32_t pad3[3]; // padding for later use
  295. // Unused for now
  296. uint8_t *pad4, *pad5;
  297. uint32_t pad6[8]; // padding for later use
  298. // PRIVATE FIELDS
  299. ////////////////////
  300. void* memory_; // row chunk of memory for yuva planes
  301. void* memory_argb_; // and for argb too.
  302. void* pad7[2]; // padding for later use
  303. };
  304. // Internal, version-checked, entry point
  305. WEBP_EXTERN(int) WebPPictureInitInternal(WebPPicture*, int);
  306. // Should always be called, to initialize the structure. Returns false in case
  307. // of version mismatch. WebPPictureInit() must have succeeded before using the
  308. // 'picture' object.
  309. // Note that, by default, use_argb is false and colorspace is WEBP_YUV420.
  310. static WEBP_INLINE int WebPPictureInit(WebPPicture* picture) {
  311. return WebPPictureInitInternal(picture, WEBP_ENCODER_ABI_VERSION);
  312. }
  313. //------------------------------------------------------------------------------
  314. // WebPPicture utils
  315. // Convenience allocation / deallocation based on picture->width/height:
  316. // Allocate y/u/v buffers as per colorspace/width/height specification.
  317. // Note! This function will free the previous buffer if needed.
  318. // Returns false in case of memory error.
  319. WEBP_EXTERN(int) WebPPictureAlloc(WebPPicture* picture);
  320. // Release the memory allocated by WebPPictureAlloc() or WebPPictureImport*().
  321. // Note that this function does _not_ free the memory used by the 'picture'
  322. // object itself.
  323. // Besides memory (which is reclaimed) all other fields of 'picture' are
  324. // preserved.
  325. WEBP_EXTERN(void) WebPPictureFree(WebPPicture* picture);
  326. // Copy the pixels of *src into *dst, using WebPPictureAlloc. Upon return, *dst
  327. // will fully own the copied pixels (this is not a view). The 'dst' picture need
  328. // not be initialized as its content is overwritten.
  329. // Returns false in case of memory allocation error.
  330. WEBP_EXTERN(int) WebPPictureCopy(const WebPPicture* src, WebPPicture* dst);
  331. // Compute the single distortion for packed planes of samples.
  332. // 'src' will be compared to 'ref', and the raw distortion stored into
  333. // '*distortion'. The refined metric (log(MSE), log(1 - ssim),...' will be
  334. // stored in '*result'.
  335. // 'x_step' is the horizontal stride (in bytes) between samples.
  336. // 'src/ref_stride' is the byte distance between rows.
  337. // Returns false in case of error (bad parameter, memory allocation error, ...).
  338. WEBP_EXTERN(int) WebPPlaneDistortion(const uint8_t* src, size_t src_stride,
  339. const uint8_t* ref, size_t ref_stride,
  340. int width, int height,
  341. size_t x_step,
  342. int type, // 0 = PSNR, 1 = SSIM, 2 = LSIM
  343. float* distortion, float* result);
  344. // Compute PSNR, SSIM or LSIM distortion metric between two pictures. Results
  345. // are in dB, stored in result[] in the B/G/R/A/All order. The distortion is
  346. // always performed using ARGB samples. Hence if the input is YUV(A), the
  347. // picture will be internally converted to ARGB (just for the measurement).
  348. // Warning: this function is rather CPU-intensive.
  349. WEBP_EXTERN(int) WebPPictureDistortion(
  350. const WebPPicture* src, const WebPPicture* ref,
  351. int metric_type, // 0 = PSNR, 1 = SSIM, 2 = LSIM
  352. float result[5]);
  353. // self-crops a picture to the rectangle defined by top/left/width/height.
  354. // Returns false in case of memory allocation error, or if the rectangle is
  355. // outside of the source picture.
  356. // The rectangle for the view is defined by the top-left corner pixel
  357. // coordinates (left, top) as well as its width and height. This rectangle
  358. // must be fully be comprised inside the 'src' source picture. If the source
  359. // picture uses the YUV420 colorspace, the top and left coordinates will be
  360. // snapped to even values.
  361. WEBP_EXTERN(int) WebPPictureCrop(WebPPicture* picture,
  362. int left, int top, int width, int height);
  363. // Extracts a view from 'src' picture into 'dst'. The rectangle for the view
  364. // is defined by the top-left corner pixel coordinates (left, top) as well
  365. // as its width and height. This rectangle must be fully be comprised inside
  366. // the 'src' source picture. If the source picture uses the YUV420 colorspace,
  367. // the top and left coordinates will be snapped to even values.
  368. // Picture 'src' must out-live 'dst' picture. Self-extraction of view is allowed
  369. // ('src' equal to 'dst') as a mean of fast-cropping (but note that doing so,
  370. // the original dimension will be lost). Picture 'dst' need not be initialized
  371. // with WebPPictureInit() if it is different from 'src', since its content will
  372. // be overwritten.
  373. // Returns false in case of memory allocation error or invalid parameters.
  374. WEBP_EXTERN(int) WebPPictureView(const WebPPicture* src,
  375. int left, int top, int width, int height,
  376. WebPPicture* dst);
  377. // Returns true if the 'picture' is actually a view and therefore does
  378. // not own the memory for pixels.
  379. WEBP_EXTERN(int) WebPPictureIsView(const WebPPicture* picture);
  380. // Rescale a picture to new dimension width x height.
  381. // If either 'width' or 'height' (but not both) is 0 the corresponding
  382. // dimension will be calculated preserving the aspect ratio.
  383. // No gamma correction is applied.
  384. // Returns false in case of error (invalid parameter or insufficient memory).
  385. WEBP_EXTERN(int) WebPPictureRescale(WebPPicture* pic, int width, int height);
  386. // Colorspace conversion function to import RGB samples.
  387. // Previous buffer will be free'd, if any.
  388. // *rgb buffer should have a size of at least height * rgb_stride.
  389. // Returns false in case of memory error.
  390. WEBP_EXTERN(int) WebPPictureImportRGB(
  391. WebPPicture* picture, const uint8_t* rgb, int rgb_stride);
  392. // Same, but for RGBA buffer.
  393. WEBP_EXTERN(int) WebPPictureImportRGBA(
  394. WebPPicture* picture, const uint8_t* rgba, int rgba_stride);
  395. // Same, but for RGBA buffer. Imports the RGB direct from the 32-bit format
  396. // input buffer ignoring the alpha channel. Avoids needing to copy the data
  397. // to a temporary 24-bit RGB buffer to import the RGB only.
  398. WEBP_EXTERN(int) WebPPictureImportRGBX(
  399. WebPPicture* picture, const uint8_t* rgbx, int rgbx_stride);
  400. // Variants of the above, but taking BGR(A|X) input.
  401. WEBP_EXTERN(int) WebPPictureImportBGR(
  402. WebPPicture* picture, const uint8_t* bgr, int bgr_stride);
  403. WEBP_EXTERN(int) WebPPictureImportBGRA(
  404. WebPPicture* picture, const uint8_t* bgra, int bgra_stride);
  405. WEBP_EXTERN(int) WebPPictureImportBGRX(
  406. WebPPicture* picture, const uint8_t* bgrx, int bgrx_stride);
  407. // Converts picture->argb data to the YUV420A format. The 'colorspace'
  408. // parameter is deprecated and should be equal to WEBP_YUV420.
  409. // Upon return, picture->use_argb is set to false. The presence of real
  410. // non-opaque transparent values is detected, and 'colorspace' will be
  411. // adjusted accordingly. Note that this method is lossy.
  412. // Returns false in case of error.
  413. WEBP_EXTERN(int) WebPPictureARGBToYUVA(WebPPicture* picture,
  414. WebPEncCSP /*colorspace = WEBP_YUV420*/);
  415. // Same as WebPPictureARGBToYUVA(), but the conversion is done using
  416. // pseudo-random dithering with a strength 'dithering' between
  417. // 0.0 (no dithering) and 1.0 (maximum dithering). This is useful
  418. // for photographic picture.
  419. WEBP_EXTERN(int) WebPPictureARGBToYUVADithered(
  420. WebPPicture* picture, WebPEncCSP colorspace, float dithering);
  421. // Performs 'sharp' RGBA->YUVA420 downsampling and colorspace conversion.
  422. // Downsampling is handled with extra care in case of color clipping. This
  423. // method is roughly 2x slower than WebPPictureARGBToYUVA() but produces better
  424. // and sharper YUV representation.
  425. // Returns false in case of error.
  426. WEBP_EXTERN(int) WebPPictureSharpARGBToYUVA(WebPPicture* picture);
  427. // kept for backward compatibility:
  428. WEBP_EXTERN(int) WebPPictureSmartARGBToYUVA(WebPPicture* picture);
  429. // Converts picture->yuv to picture->argb and sets picture->use_argb to true.
  430. // The input format must be YUV_420 or YUV_420A. The conversion from YUV420 to
  431. // ARGB incurs a small loss too.
  432. // Note that the use of this colorspace is discouraged if one has access to the
  433. // raw ARGB samples, since using YUV420 is comparatively lossy.
  434. // Returns false in case of error.
  435. WEBP_EXTERN(int) WebPPictureYUVAToARGB(WebPPicture* picture);
  436. // Helper function: given a width x height plane of RGBA or YUV(A) samples
  437. // clean-up the YUV or RGB samples under fully transparent area, to help
  438. // compressibility (no guarantee, though).
  439. WEBP_EXTERN(void) WebPCleanupTransparentArea(WebPPicture* picture);
  440. // Scan the picture 'picture' for the presence of non fully opaque alpha values.
  441. // Returns true in such case. Otherwise returns false (indicating that the
  442. // alpha plane can be ignored altogether e.g.).
  443. WEBP_EXTERN(int) WebPPictureHasTransparency(const WebPPicture* picture);
  444. // Remove the transparency information (if present) by blending the color with
  445. // the background color 'background_rgb' (specified as 24bit RGB triplet).
  446. // After this call, all alpha values are reset to 0xff.
  447. WEBP_EXTERN(void) WebPBlendAlpha(WebPPicture* pic, uint32_t background_rgb);
  448. //------------------------------------------------------------------------------
  449. // Main call
  450. // Main encoding call, after config and picture have been initialized.
  451. // 'picture' must be less than 16384x16384 in dimension (cf WEBP_MAX_DIMENSION),
  452. // and the 'config' object must be a valid one.
  453. // Returns false in case of error, true otherwise.
  454. // In case of error, picture->error_code is updated accordingly.
  455. // 'picture' can hold the source samples in both YUV(A) or ARGB input, depending
  456. // on the value of 'picture->use_argb'. It is highly recommended to use
  457. // the former for lossy encoding, and the latter for lossless encoding
  458. // (when config.lossless is true). Automatic conversion from one format to
  459. // another is provided but they both incur some loss.
  460. WEBP_EXTERN(int) WebPEncode(const WebPConfig* config, WebPPicture* picture);
  461. //------------------------------------------------------------------------------
  462. #ifdef __cplusplus
  463. } // extern "C"
  464. #endif
  465. #endif /* WEBP_WEBP_ENCODE_H_ */