jassub 1.7.13 → 1.7.14

package/dist/libraries/include/ass/ass_types.h

@@ -1,292 +0,0 @@
-/*
- * Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
- * Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
- *
- * This file is part of libass.
- *
- * Permission to use, copy, modify, and distribute this software for any
- * purpose with or without fee is hereby granted, provided that the above
- * copyright notice and this permission notice appear in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
- * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
- * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
- * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
- * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
- * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- */
-
-#ifndef LIBASS_TYPES_H
-#define LIBASS_TYPES_H
-
-#include <stdint.h>
-
-/**
- * GENERAL NOTE regarding the definitions exposed by this header
- *
- * The main use case for this is _reading_ the track fields, especially
- * track->YCbCrMatrix, to correctly display the rendering results.
- *
- * Furthermore, the exposed definitions also open up the possibility to _modify_
- * the exposed structs, working closer to library internals and bypassing
- * e.g. creation of intermediate ASS-text buffers when creating dynamic events.
- * This is an advanced use case and should only be done when well-versed in ASS
- * and aware of the effects and legal values of _all_ fields of the structs.
- * The burden of sanitising and correctly initialising fields is then also
- * placed on the API user.
- * By nature of direct struct modifications working closer to library internals,
- * workflows that make use of this possibility are also more likely to be
- * affected by future API breaks than those which do not.
- *
- * To avoid desynchronisation with internal states, there are some restrictions
- * on when and how direct struct modification can be performed.
- * Ignoring them may lead to undefined behaviour. See the following listing:
- *
- *  - Manual struct edits and track-modifying (including modification to the
- *    event and style elements of the track) API calls cannot be freely mixed:
- *    - Before manual changes are performed, it is allowed to call any such API,
- *      unless the documentation of the funtion says otherwise.
- *    - After manual changes have been performed, no track-modifying API may be
- *      invoked, except for ass_track_set_feature and ass_flush_events.
- *  - After the first call to ass_render_frame, existing array members
- *    (e.g. members of events) and non-array track fields (e.g. PlayResX
- *    or event_format) must not be modified. Adding new members to arrays
- *    and updating the corresponding counter remains allowed.
- *  - Adding and removing members to array fields, like events or styles,
- *    must be done through the corresponding API function, e.g. ass_alloc_event.
- *    See the documentation of these functions.
- *  - The memory pointed to by string fields (char *) must be
- *    free'able by the implementation of free used by libass.
- *
- * A non-exhaustive list of examples of track-modifying API functions:
- *   ass_process_data, ass_process_codec_private,
- *   ass_process_chunk, ass_read_styles, ...
- *
- * Direct struct modification can be done safely, but it is also easy to
- * miss an initialisation or violate these restrictions, thus introducing bugs
- * that may not manifest immediately. It should be carefully considered
- * whether this is worthwhile for the desired use-case.
- */
-
-#define VALIGN_SUB 0
-#define VALIGN_CENTER 8
-#define VALIGN_TOP 4
-#define HALIGN_LEFT 1
-#define HALIGN_CENTER 2
-#define HALIGN_RIGHT 3
-#define ASS_JUSTIFY_AUTO 0
-#define ASS_JUSTIFY_LEFT 1
-#define ASS_JUSTIFY_CENTER 2
-#define ASS_JUSTIFY_RIGHT 3
-
-#define FONT_WEIGHT_LIGHT  300
-#define FONT_WEIGHT_MEDIUM 400
-#define FONT_WEIGHT_BOLD   700
-#define FONT_SLANT_NONE    0
-#define FONT_SLANT_ITALIC  100
-#define FONT_SLANT_OBLIQUE 110
-#define FONT_WIDTH_CONDENSED 75
-#define FONT_WIDTH_NORMAL    100
-#define FONT_WIDTH_EXPANDED  125
-
-
-/* Opaque objects internally used by libass.  Contents are private. */
-typedef struct ass_renderer ASS_Renderer;
-typedef struct render_priv ASS_RenderPriv;
-typedef struct parser_priv ASS_ParserPriv;
-typedef struct ass_library ASS_Library;
-
-/* ASS Style: line */
-typedef struct ass_style {
-    char *Name;     //must be a valid non-NULL string pointer; may be an empty string
-    char *FontName; //must be a valid non-NULL string pointer; may be an empty string
-    double FontSize;
-    uint32_t PrimaryColour;
-    uint32_t SecondaryColour;
-    uint32_t OutlineColour;
-    uint32_t BackColour;
-    int Bold;      // 0 or 1 (boolean)
-    int Italic;    // 0 or 1 (boolean)
-    int Underline; // 0 or 1 (boolean)
-    int StrikeOut; // 0 or 1 (boolean)
-    double ScaleX; // positive with 1.0 representing 100%
-    double ScaleY; // positive with 1.0 representing 100%
-    double Spacing;
-    double Angle;
-    int BorderStyle;
-    double Outline;
-    double Shadow;
-    int Alignment; // use `VALIGN_* | HALIGN_*` as value
-    int MarginL;
-    int MarginR;
-    int MarginV;
-    int Encoding;
-    int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
-    double Blur; // sets a default \blur for the event; same values as \blur
-    int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
-} ASS_Style;
-
-
-/*
- * ASS_Event corresponds to a single Dialogue line;
- * text is stored as-is, style overrides will be parsed later.
- */
-typedef struct ass_event {
-    long long Start;            // ms
-    long long Duration;         // ms
-
-    int ReadOrder;
-    int Layer;
-    int Style;
-    char *Name;
-    int MarginL;
-    int MarginR;
-    int MarginV;
-    char *Effect;
-    char *Text;
-
-    ASS_RenderPriv *render_priv;
-} ASS_Event;
-
-/**
- * Support for (xy-)VSFilter mangled colors
- *
- * Generally, xy-VSFilter emulates the classic VSFilter behavior of
- * rendering directly into the (usually YCbCr) video. Classic
- * guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
- * when converting the subtitle RGB color to the video colorspace.
- * This led to odd results when other colorspaces were used, particular
- * once those became more common with the rise of HDTV video:
- * HDTV typically uses BT.709(TV), but VSFilter continued assuming
- * BT.601(TV) for conversion.
- *
- * This means classic vsfilter will mangle colors as follows:
- *
- *    screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
- *
- * where video_csp is the colorspace of the video with which the
- * subtitle was muxed.
- *
- * Subtitle authors worked around this issue by adjusting the color
- * to look as intended *after* going through the mangling process. Still,
- * this behaviour isn't great and also limits the color range. Yet,
- * for backwards compatibility with existing files, the classic mangling
- * must be preserved for existing files to not break the display of
- * color-matched typesets created with older VSFilter versions. Thus,
- * on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
- * header was introduced to allow new files to avoid this color mangling.
- * However due to a limitation of VSFilter API, VSFilters don't actually
- * know the real colorspace of the video they're rendering to, so the
- * header wasn't created as a simple "Use ColourMangling: yes/no", but instead
- * specifies exactly which colorspace to use for the initial conversion
- * from the subtitle's RGB values to the video's YCbCr. So we now got
- *
- *    screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
- *
- * with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
- *
- * XySubFilter, whose API was planned during introduction of this header,
- * is not affected by this VSFilter-API limitation, so for it and other
- * renderers like libass an additional special value "None" was also added.
- * "None" tells the renderer to directly use untouched RGB values without
- * any conversion.
- *
- * If the video itself is already in RGB natively, then no color mangling
- * happens regardless of the presence or value of a "YCbCr Matrix" header.
- *
- * The above mangling process with special value "None" to opt out
- * of any color mangling is the recommended default behaviour.
- *
- * Keep in mind though, that xy-VSFilter cannot accurately implement this and
- * will instead resort to a guessing the video colorspace based on resolution
- * and then convert RGB to the guessed space.
- * Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
- * "None" and use TV.601 for unknown, but the video colorspace for no or an
- * empty header (which can break old subtitles).
- *
- * Aegisub's (the main application to produce ASS subtitle scripts) behaviour
- * regarding colorspaces is unfortunately a bit confusing.
- * As of time of writing there still is a config option to force BT.601(TV)
- * in some active forks (which should not be used to author subs and serves
- * at most as a tool to check how now ancient VSFilters would have rendered the
- * subs), the automatically chosen colorspace may depend on the fork and the
- * videoprovider used and furthermore Aegisub likes to override
- * "YCbCr Matrix: None" with the autodetected space of a loaded video.
- * Supposedly some Aegisub versions had an option that "tries not to mangle the
- * colors". It was said that if the header is not set to BT.601(TV), the colors
- * were supposed not to be mangled, even if the header was not set to "None".
- *
- * In general, misinterpreting this header or not using it will lead to
- * slightly different subtitle colors, which can matter if the subtitle
- * attempts to match solid colored areas in the video.
- * It is recommended to stick to XySubFilter-like behaviour described above.
- * A highly motivated application may also expose options to users to  emulate
- * xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
- * Completly ignoring the color mangling is likely to give bad results.
- *
- * Note that libass doesn't change colors based on this header. It
- * absolutely can't do that, because the video colorspace is required
- * in order to handle this as intended. API users must use the exposed
- * information to perform color mangling as described above.
- */
-typedef enum ASS_YCbCrMatrix {
-    YCBCR_DEFAULT = 0,  // Header missing
-    YCBCR_UNKNOWN,      // Header could not be parsed correctly
-    YCBCR_NONE,         // "None" special value
-    YCBCR_BT601_TV,
-    YCBCR_BT601_PC,
-    YCBCR_BT709_TV,
-    YCBCR_BT709_PC,
-    YCBCR_SMPTE240M_TV,
-    YCBCR_SMPTE240M_PC,
-    YCBCR_FCC_TV,
-    YCBCR_FCC_PC
-    // New enum values can be added here in new ABI-compatible library releases.
-} ASS_YCbCrMatrix;
-
-/*
- * ass track represent either an external script or a matroska subtitle stream
- * (no real difference between them); it can be used in rendering after the
- * headers are parsed (i.e. events format line read).
- */
-typedef struct ass_track {
-    int n_styles;           // amount used
-    int max_styles;         // amount allocated
-    int n_events;
-    int max_events;
-    ASS_Style *styles;    // array of styles, max_styles length, n_styles used
-    ASS_Event *events;    // the same as styles
-
-    char *style_format;     // style format line (everything after "Format: ")
-    char *event_format;     // event format line
-
-    enum {
-        TRACK_TYPE_UNKNOWN = 0,
-        TRACK_TYPE_ASS,
-        TRACK_TYPE_SSA
-    } track_type;
-
-    // Script header fields
-    int PlayResX;
-    int PlayResY;
-    double Timer;
-    int WrapStyle;
-    int ScaledBorderAndShadow; // 0 or 1 (boolean)
-    int Kerning; // 0 or 1 (boolean)
-    char *Language; // zero-terminated ISO-639-1 code
-    ASS_YCbCrMatrix YCbCrMatrix;
-
-    int default_style;      // index of default style
-    char *name;             // file name in case of external subs, 0 for streams
-
-    ASS_Library *library;
-    ASS_ParserPriv *parser_priv;
-
-    int LayoutResX;  // overrides values from ass_set_storage_size and
-    int LayoutResY;  // also takes precendence over ass_set_pixel_aspect
-
-    // New fields can be added here in new ABI-compatible library releases.
-} ASS_Track;
-
-#endif /* LIBASS_TYPES_H */

package/dist/libraries/include/brotli/decode.h

@@ -1,344 +0,0 @@
-/* Copyright 2013 Google Inc. All Rights Reserved.
-
-   Distributed under MIT license.
-   See file LICENSE for detail or copy at https://opensource.org/licenses/MIT
-*/
-
-/**
- * @file
- * API for Brotli decompression.
- */
-
-#ifndef BROTLI_DEC_DECODE_H_
-#define BROTLI_DEC_DECODE_H_
-
-#include <brotli/port.h>
-#include <brotli/types.h>
-
-#if defined(__cplusplus) || defined(c_plusplus)
-extern "C" {
-#endif
-
-/**
- * Opaque structure that holds decoder state.
- *
- * Allocated and initialized with ::BrotliDecoderCreateInstance.
- * Cleaned up and deallocated with ::BrotliDecoderDestroyInstance.
- */
-typedef struct BrotliDecoderStateStruct BrotliDecoderState;
-
-/**
- * Result type for ::BrotliDecoderDecompress and
- * ::BrotliDecoderDecompressStream functions.
- */
-typedef enum {
-  /** Decoding error, e.g. corrupted input or memory allocation problem. */
-  BROTLI_DECODER_RESULT_ERROR = 0,
-  /** Decoding successfully completed. */
-  BROTLI_DECODER_RESULT_SUCCESS = 1,
-  /** Partially done; should be called again with more input. */
-  BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT = 2,
-  /** Partially done; should be called again with more output. */
-  BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT = 3
-} BrotliDecoderResult;
-
-/**
- * Template that evaluates items of ::BrotliDecoderErrorCode.
- *
- * Example: @code {.cpp}
- * // Log Brotli error code.
- * switch (brotliDecoderErrorCode) {
- * #define CASE_(PREFIX, NAME, CODE) \
- *   case BROTLI_DECODER ## PREFIX ## NAME: \
- *     LOG(INFO) << "error code:" << #NAME; \
- *     break;
- * #define NEWLINE_
- * BROTLI_DECODER_ERROR_CODES_LIST(CASE_, NEWLINE_)
- * #undef CASE_
- * #undef NEWLINE_
- *   default: LOG(FATAL) << "unknown brotli error code";
- * }
- * @endcode
- */
-#define BROTLI_DECODER_ERROR_CODES_LIST(BROTLI_ERROR_CODE, SEPARATOR)      \
-  BROTLI_ERROR_CODE(_, NO_ERROR, 0) SEPARATOR                              \
-  /* Same as BrotliDecoderResult values */                                 \
-  BROTLI_ERROR_CODE(_, SUCCESS, 1) SEPARATOR                               \
-  BROTLI_ERROR_CODE(_, NEEDS_MORE_INPUT, 2) SEPARATOR                      \
-  BROTLI_ERROR_CODE(_, NEEDS_MORE_OUTPUT, 3) SEPARATOR                     \
-                                                                           \
-  /* Errors caused by invalid input */                                     \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, EXUBERANT_NIBBLE, -1) SEPARATOR        \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, RESERVED, -2) SEPARATOR                \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, EXUBERANT_META_NIBBLE, -3) SEPARATOR   \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, SIMPLE_HUFFMAN_ALPHABET, -4) SEPARATOR \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, SIMPLE_HUFFMAN_SAME, -5) SEPARATOR     \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, CL_SPACE, -6) SEPARATOR                \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, HUFFMAN_SPACE, -7) SEPARATOR           \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, CONTEXT_MAP_REPEAT, -8) SEPARATOR      \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, BLOCK_LENGTH_1, -9) SEPARATOR          \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, BLOCK_LENGTH_2, -10) SEPARATOR         \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, TRANSFORM, -11) SEPARATOR              \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, DICTIONARY, -12) SEPARATOR             \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, WINDOW_BITS, -13) SEPARATOR            \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, PADDING_1, -14) SEPARATOR              \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, PADDING_2, -15) SEPARATOR              \
-  BROTLI_ERROR_CODE(_ERROR_FORMAT_, DISTANCE, -16) SEPARATOR               \
-                                                                           \
-  /* -17..-18 codes are reserved */                                        \
-                                                                           \
-  BROTLI_ERROR_CODE(_ERROR_, DICTIONARY_NOT_SET, -19) SEPARATOR            \
-  BROTLI_ERROR_CODE(_ERROR_, INVALID_ARGUMENTS, -20) SEPARATOR             \
-                                                                           \
-  /* Memory allocation problems */                                         \
-  BROTLI_ERROR_CODE(_ERROR_ALLOC_, CONTEXT_MODES, -21) SEPARATOR           \
-  /* Literal, insert and distance trees together */                        \
-  BROTLI_ERROR_CODE(_ERROR_ALLOC_, TREE_GROUPS, -22) SEPARATOR             \
-  /* -23..-24 codes are reserved for distinct tree groups */               \
-  BROTLI_ERROR_CODE(_ERROR_ALLOC_, CONTEXT_MAP, -25) SEPARATOR             \
-  BROTLI_ERROR_CODE(_ERROR_ALLOC_, RING_BUFFER_1, -26) SEPARATOR           \
-  BROTLI_ERROR_CODE(_ERROR_ALLOC_, RING_BUFFER_2, -27) SEPARATOR           \
-  /* -28..-29 codes are reserved for dynamic ring-buffer allocation */     \
-  BROTLI_ERROR_CODE(_ERROR_ALLOC_, BLOCK_TYPE_TREES, -30) SEPARATOR        \
-                                                                           \
-  /* "Impossible" states */                                                \
-  BROTLI_ERROR_CODE(_ERROR_, UNREACHABLE, -31)
-
-/**
- * Error code for detailed logging / production debugging.
- *
- * See ::BrotliDecoderGetErrorCode and ::BROTLI_LAST_ERROR_CODE.
- */
-typedef enum {
-#define BROTLI_COMMA_ ,
-#define BROTLI_ERROR_CODE_ENUM_ITEM_(PREFIX, NAME, CODE) \
-    BROTLI_DECODER ## PREFIX ## NAME = CODE
-  BROTLI_DECODER_ERROR_CODES_LIST(BROTLI_ERROR_CODE_ENUM_ITEM_, BROTLI_COMMA_)
-} BrotliDecoderErrorCode;
-#undef BROTLI_ERROR_CODE_ENUM_ITEM_
-#undef BROTLI_COMMA_
-
-/**
- * The value of the last error code, negative integer.
- *
- * All other error code values are in the range from ::BROTLI_LAST_ERROR_CODE
- * to @c -1. There are also 4 other possible non-error codes @c 0 .. @c 3 in
- * ::BrotliDecoderErrorCode enumeration.
- */
-#define BROTLI_LAST_ERROR_CODE BROTLI_DECODER_ERROR_UNREACHABLE
-
-/** Options to be used with ::BrotliDecoderSetParameter. */
-typedef enum BrotliDecoderParameter {
-  /**
-   * Disable "canny" ring buffer allocation strategy.
-   *
-   * Ring buffer is allocated according to window size, despite the real size of
-   * the content.
-   */
-  BROTLI_DECODER_PARAM_DISABLE_RING_BUFFER_REALLOCATION = 0,
-  /**
-   * Flag that determines if "Large Window Brotli" is used.
-   */
-  BROTLI_DECODER_PARAM_LARGE_WINDOW = 1
-} BrotliDecoderParameter;
-
-/**
- * Sets the specified parameter to the given decoder instance.
- *
- * @param state decoder instance
- * @param param parameter to set
- * @param value new parameter value
- * @returns ::BROTLI_FALSE if parameter is unrecognized, or value is invalid
- * @returns ::BROTLI_TRUE if value is accepted
- */
-BROTLI_DEC_API BROTLI_BOOL BrotliDecoderSetParameter(
-    BrotliDecoderState* state, BrotliDecoderParameter param, uint32_t value);
-
-/**
- * Creates an instance of ::BrotliDecoderState and initializes it.
- *
- * The instance can be used once for decoding and should then be destroyed with
- * ::BrotliDecoderDestroyInstance, it cannot be reused for a new decoding
- * session.
- *
- * @p alloc_func and @p free_func @b MUST be both zero or both non-zero. In the
- * case they are both zero, default memory allocators are used. @p opaque is
- * passed to @p alloc_func and @p free_func when they are called. @p free_func
- * has to return without doing anything when asked to free a NULL pointer.
- *
- * @param alloc_func custom memory allocation function
- * @param free_func custom memory free function
- * @param opaque custom memory manager handle
- * @returns @c 0 if instance can not be allocated or initialized
- * @returns pointer to initialized ::BrotliDecoderState otherwise
- */
-BROTLI_DEC_API BrotliDecoderState* BrotliDecoderCreateInstance(
-    brotli_alloc_func alloc_func, brotli_free_func free_func, void* opaque);
-
-/**
- * Deinitializes and frees ::BrotliDecoderState instance.
- *
- * @param state decoder instance to be cleaned up and deallocated
- */
-BROTLI_DEC_API void BrotliDecoderDestroyInstance(BrotliDecoderState* state);
-
-/**
- * Performs one-shot memory-to-memory decompression.
- *
- * Decompresses the data in @p encoded_buffer into @p decoded_buffer, and sets
- * @p *decoded_size to the decompressed length.
- *
- * @param encoded_size size of @p encoded_buffer
- * @param encoded_buffer compressed data buffer with at least @p encoded_size
- *        addressable bytes
- * @param[in, out] decoded_size @b in: size of @p decoded_buffer; \n
- *                 @b out: length of decompressed data written to
- *                 @p decoded_buffer
- * @param decoded_buffer decompressed data destination buffer
- * @returns ::BROTLI_DECODER_RESULT_ERROR if input is corrupted, memory
- *          allocation failed, or @p decoded_buffer is not large enough;
- * @returns ::BROTLI_DECODER_RESULT_SUCCESS otherwise
- */
-BROTLI_DEC_API BrotliDecoderResult BrotliDecoderDecompress(
-    size_t encoded_size,
-    const uint8_t encoded_buffer[BROTLI_ARRAY_PARAM(encoded_size)],
-    size_t* decoded_size,
-    uint8_t decoded_buffer[BROTLI_ARRAY_PARAM(*decoded_size)]);
-
-/**
- * Decompresses the input stream to the output stream.
- *
- * The values @p *available_in and @p *available_out must specify the number of
- * bytes addressable at @p *next_in and @p *next_out respectively.
- * When @p *available_out is @c 0, @p next_out is allowed to be @c NULL.
- *
- * After each call, @p *available_in will be decremented by the amount of input
- * bytes consumed, and the @p *next_in pointer will be incremented by that
- * amount. Similarly, @p *available_out will be decremented by the amount of
- * output bytes written, and the @p *next_out pointer will be incremented by
- * that amount.
- *
- * @p total_out, if it is not a null-pointer, will be set to the number
- * of bytes decompressed since the last @p state initialization.
- *
- * @note Input is never overconsumed, so @p next_in and @p available_in could be
- * passed to the next consumer after decoding is complete.
- *
- * @param state decoder instance
- * @param[in, out] available_in @b in: amount of available input; \n
- *                 @b out: amount of unused input
- * @param[in, out] next_in pointer to the next compressed byte
- * @param[in, out] available_out @b in: length of output buffer; \n
- *                 @b out: remaining size of output buffer
- * @param[in, out] next_out output buffer cursor;
- *                 can be @c NULL if @p available_out is @c 0
- * @param[out] total_out number of bytes decompressed so far; can be @c NULL
- * @returns ::BROTLI_DECODER_RESULT_ERROR if input is corrupted, memory
- *          allocation failed, arguments were invalid, etc.;
- *          use ::BrotliDecoderGetErrorCode to get detailed error code
- * @returns ::BROTLI_DECODER_RESULT_NEEDS_MORE_INPUT decoding is blocked until
- *          more input data is provided
- * @returns ::BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT decoding is blocked until
- *          more output space is provided
- * @returns ::BROTLI_DECODER_RESULT_SUCCESS decoding is finished, no more
- *          input might be consumed and no more output will be produced
- */
-BROTLI_DEC_API BrotliDecoderResult BrotliDecoderDecompressStream(
-  BrotliDecoderState* state, size_t* available_in, const uint8_t** next_in,
-  size_t* available_out, uint8_t** next_out, size_t* total_out);
-
-/**
- * Checks if decoder has more output.
- *
- * @param state decoder instance
- * @returns ::BROTLI_TRUE, if decoder has some unconsumed output
- * @returns ::BROTLI_FALSE otherwise
- */
-BROTLI_DEC_API BROTLI_BOOL BrotliDecoderHasMoreOutput(
-    const BrotliDecoderState* state);
-
-/**
- * Acquires pointer to internal output buffer.
- *
- * This method is used to make language bindings easier and more efficient:
- *  -# push data to ::BrotliDecoderDecompressStream,
- *     until ::BROTLI_DECODER_RESULT_NEEDS_MORE_OUTPUT is reported
- *  -# use ::BrotliDecoderTakeOutput to peek bytes and copy to language-specific
- *     entity
- *
- * Also this could be useful if there is an output stream that is able to
- * consume all the provided data (e.g. when data is saved to file system).
- *
- * @attention After every call to ::BrotliDecoderTakeOutput @p *size bytes of
- *            output are considered consumed for all consecutive calls to the
- *            instance methods; returned pointer becomes invalidated as well.
- *
- * @note Decoder output is not guaranteed to be contiguous. This means that
- *       after the size-unrestricted call to ::BrotliDecoderTakeOutput,
- *       immediate next call to ::BrotliDecoderTakeOutput may return more data.
- *
- * @param state decoder instance
- * @param[in, out] size @b in: number of bytes caller is ready to take, @c 0 if
- *                 any amount could be handled; \n
- *                 @b out: amount of data pointed by returned pointer and
- *                 considered consumed; \n
- *                 out value is never greater than in value, unless it is @c 0
- * @returns pointer to output data
- */
-BROTLI_DEC_API const uint8_t* BrotliDecoderTakeOutput(
-    BrotliDecoderState* state, size_t* size);
-
-/**
- * Checks if instance has already consumed input.
- *
- * Instance that returns ::BROTLI_FALSE is considered "fresh" and could be
- * reused.
- *
- * @param state decoder instance
- * @returns ::BROTLI_TRUE if decoder has already used some input bytes
- * @returns ::BROTLI_FALSE otherwise
- */
-BROTLI_DEC_API BROTLI_BOOL BrotliDecoderIsUsed(const BrotliDecoderState* state);
-
-/**
- * Checks if decoder instance reached the final state.
- *
- * @param state decoder instance
- * @returns ::BROTLI_TRUE if decoder is in a state where it reached the end of
- *          the input and produced all of the output
- * @returns ::BROTLI_FALSE otherwise
- */
-BROTLI_DEC_API BROTLI_BOOL BrotliDecoderIsFinished(
-    const BrotliDecoderState* state);
-
-/**
- * Acquires a detailed error code.
- *
- * Should be used only after ::BrotliDecoderDecompressStream returns
- * ::BROTLI_DECODER_RESULT_ERROR.
- *
- * See also ::BrotliDecoderErrorString
- *
- * @param state decoder instance
- * @returns last saved error code
- */
-BROTLI_DEC_API BrotliDecoderErrorCode BrotliDecoderGetErrorCode(
-    const BrotliDecoderState* state);
-
-/**
- * Converts error code to a c-string.
- */
-BROTLI_DEC_API const char* BrotliDecoderErrorString(BrotliDecoderErrorCode c);
-
-/**
- * Gets a decoder library version.
- *
- * Look at BROTLI_VERSION for more information.
- */
-BROTLI_DEC_API uint32_t BrotliDecoderVersion(void);
-
-#if defined(__cplusplus) || defined(c_plusplus)
-} /* extern "C" */
-#endif
-
-#endif  /* BROTLI_DEC_DECODE_H_ */