webpi.h 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  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. // Internal header: WebP decoding parameters and custom IO on buffer
  11. //
  12. // Author: somnath@google.com (Somnath Banerjee)
  13. #ifndef WEBP_DEC_WEBPI_H_
  14. #define WEBP_DEC_WEBPI_H_
  15. #ifdef __cplusplus
  16. extern "C" {
  17. #endif
  18. #include "../utils/rescaler.h"
  19. #include "./decode_vp8.h"
  20. //------------------------------------------------------------------------------
  21. // WebPDecParams: Decoding output parameters. Transient internal object.
  22. typedef struct WebPDecParams WebPDecParams;
  23. typedef int (*OutputFunc)(const VP8Io* const io, WebPDecParams* const p);
  24. typedef int (*OutputRowFunc)(WebPDecParams* const p, int y_pos);
  25. struct WebPDecParams {
  26. WebPDecBuffer* output; // output buffer.
  27. uint8_t* tmp_y, *tmp_u, *tmp_v; // cache for the fancy upsampler
  28. // or used for tmp rescaling
  29. int last_y; // coordinate of the line that was last output
  30. const WebPDecoderOptions* options; // if not NULL, use alt decoding features
  31. // rescalers
  32. WebPRescaler scaler_y, scaler_u, scaler_v, scaler_a;
  33. void* memory; // overall scratch memory for the output work.
  34. OutputFunc emit; // output RGB or YUV samples
  35. OutputFunc emit_alpha; // output alpha channel
  36. OutputRowFunc emit_alpha_row; // output one line of rescaled alpha values
  37. };
  38. // Should be called first, before any use of the WebPDecParams object.
  39. void WebPResetDecParams(WebPDecParams* const params);
  40. //------------------------------------------------------------------------------
  41. // Header parsing helpers
  42. // Structure storing a description of the RIFF headers.
  43. typedef struct {
  44. const uint8_t* data; // input buffer
  45. size_t data_size; // input buffer size
  46. int have_all_data; // true if all data is known to be available
  47. size_t offset; // offset to main data chunk (VP8 or VP8L)
  48. const uint8_t* alpha_data; // points to alpha chunk (if present)
  49. size_t alpha_data_size; // alpha chunk size
  50. size_t compressed_size; // VP8/VP8L compressed data size
  51. size_t riff_size; // size of the riff payload (or 0 if absent)
  52. int is_lossless; // true if a VP8L chunk is present
  53. } WebPHeaderStructure;
  54. // Skips over all valid chunks prior to the first VP8/VP8L frame header.
  55. // Returns: VP8_STATUS_OK, VP8_STATUS_BITSTREAM_ERROR (invalid header/chunk),
  56. // VP8_STATUS_NOT_ENOUGH_DATA (partial input) or VP8_STATUS_UNSUPPORTED_FEATURE
  57. // in the case of non-decodable features (animation for instance).
  58. // In 'headers', compressed_size, offset, alpha_data, alpha_size, and lossless
  59. // fields are updated appropriately upon success.
  60. VP8StatusCode WebPParseHeaders(WebPHeaderStructure* const headers);
  61. //------------------------------------------------------------------------------
  62. // Misc utils
  63. // Initializes VP8Io with custom setup, io and teardown functions. The default
  64. // hooks will use the supplied 'params' as io->opaque handle.
  65. void WebPInitCustomIo(WebPDecParams* const params, VP8Io* const io);
  66. // Setup crop_xxx fields, mb_w and mb_h in io. 'src_colorspace' refers
  67. // to the *compressed* format, not the output one.
  68. int WebPIoInitFromOptions(const WebPDecoderOptions* const options,
  69. VP8Io* const io, WEBP_CSP_MODE src_colorspace);
  70. //------------------------------------------------------------------------------
  71. // Internal functions regarding WebPDecBuffer memory (in buffer.c).
  72. // Don't really need to be externally visible for now.
  73. // Prepare 'buffer' with the requested initial dimensions width/height.
  74. // If no external storage is supplied, initializes buffer by allocating output
  75. // memory and setting up the stride information. Validate the parameters. Return
  76. // an error code in case of problem (no memory, or invalid stride / size /
  77. // dimension / etc.). If *options is not NULL, also verify that the options'
  78. // parameters are valid and apply them to the width/height dimensions of the
  79. // output buffer. This takes cropping / scaling / rotation into account.
  80. // Also incorporates the options->flip flag to flip the buffer parameters if
  81. // needed.
  82. VP8StatusCode WebPAllocateDecBuffer(int width, int height,
  83. const WebPDecoderOptions* const options,
  84. WebPDecBuffer* const buffer);
  85. // Flip buffer vertically by negating the various strides.
  86. VP8StatusCode WebPFlipBuffer(WebPDecBuffer* const buffer);
  87. // Copy 'src' into 'dst' buffer, making sure 'dst' is not marked as owner of the
  88. // memory (still held by 'src').
  89. void WebPCopyDecBuffer(const WebPDecBuffer* const src,
  90. WebPDecBuffer* const dst);
  91. // Copy and transfer ownership from src to dst (beware of parameter order!)
  92. void WebPGrabDecBuffer(WebPDecBuffer* const src, WebPDecBuffer* const dst);
  93. //------------------------------------------------------------------------------
  94. #ifdef __cplusplus
  95. } // extern "C"
  96. #endif
  97. #endif /* WEBP_DEC_WEBPI_H_ */