daaladec.h man page

daala/daaladec.h — The libdaala C decoding API.  

Synopsis

#include 'codec.h'

Data Structures

struct od_acct_symbol
struct od_accounting_dict
Dictionary for translating strings into id.
struct od_accounting

Macros

#define _daala_daaladec_H   (1)
#define OD_DECCTL_SET_BSIZE_BUFFER   (7001)
#define OD_DECCTL_SET_FLAGS_BUFFER   (7003)
#define OD_DECCTL_SET_MV_BUFFER   (7005)
#define OD_DECCTL_SET_MC_IMG   (7007)
Copy the motion compensated reference into a user supplied daala_image.
#define OD_DECCTL_GET_ACCOUNTING   (7009)
#define OD_DECCTL_SET_ACCOUNTING_ENABLED   (7011)
#define OD_DECCTL_SET_DERING_BUFFER   (7013)
#define OD_ACCT_FRAME   (10)
#define OD_ACCT_MV   (11)
#define MAX_SYMBOL_TYPES   (256)

Typedefs

Decoder state
The following data structures are opaque, and their contents are not publicly defined by this API.

Referring to their internals directly is unsupported, and may break without warning.

typedef struct daala_dec_ctx daala_dec_ctx
The decoder context.
typedef struct daala_setup_info daala_setup_info
Setup information.

Functions

Functions for decoding
You must link to libdaalaadec if you use any of the functions in this section.

int daala_decode_header_in (daala_info *info, daala_comment *dc, daala_setup_info **ds, const daala_packet *dp)
Parses the header packets from an Ogg Daala stream.
daala_dec_ctx * daala_decode_create (const daala_info *info, const daala_setup_info *setup)
Allocates a decoder instance.
void daala_setup_free (daala_setup_info *setup)
Releases all storage used for the decoder setup information.
int daala_decode_ctl (daala_dec_ctx *dec, int req, void *buf, size_t buf_sz)
Decoder control function.
void daala_decode_free (daala_dec_ctx *dec)
Frees an allocated decoder instance.
int daala_decode_packet_in (daala_dec_ctx *dec, const daala_packet *dp)
Retrieves decoded video data frames.
int daala_decode_img_out (daala_dec_ctx *dec, daala_image *img)
Outputs the next available decoded image frame.

Detailed Description

The libdaala C decoding API.

Macro Definition Documentation

#define OD_DECCTL_SET_MC_IMG   (7007)

Copy the motion compensated reference into a user supplied daala_image.

Parameters:

<tt>daala_image*</tt> Pointer to the user supplied daala_image. Image must be allocated by the caller, and must be the same format as the decoder output images.

Typedef Documentation

typedef struct daala_dec_ctx daala_dec_ctx

The decoder context.

typedef struct daala_setup_info daala_setup_info

Setup information. This contains auxiliary information decoded from the setup header by daala_decode_header_in() to be passed to daala_decode_create(). It can be re-used to initialize any number of decoders, and can be freed via daala_setup_free() at any time.

Author

Generated automatically by Doxygen for daala from the source code.

Info

Mon Sep 11 2017 Version unknown daala