Main Page | Modules | Data Structures | Directories | File List | Data Fields | Globals

Legacy pre-1.0 C API


Files

file  theora.h
 The libtheora pre-1.0 legacy C API.

Data Structures

struct  yuv_buffer
 A YUV buffer for passing uncompressed frames to and from the codec. More...
struct  theora_info
 Theora bitstream info. More...
struct  theora_state
 Codec internal state and context. More...
struct  theora_comment
 Comment header metadata. More...

Typedefs

typedef theora_comment theora_comment
 Comment header metadata.

Enumerations

enum  theora_colorspace { OC_CS_UNSPECIFIED, OC_CS_ITU_REC_470M, OC_CS_ITU_REC_470BG, OC_CS_NSPACES }
 A Colorspace. More...
enum  theora_pixelformat { OC_PF_420, OC_PF_RSVD, OC_PF_422, OC_PF_444 }
 A Chroma subsampling. More...

Typedef Documentation

typedef struct theora_comment theora_comment
 

Comment header metadata.

This structure holds the in-stream metadata corresponding to the 'comment' header packet.

Meta data is stored as a series of (tag, value) pairs, in length-encoded string vectors. The first occurence of the '=' character delimits the tag and value. A particular tag may occur more than once. The character set encoding for the strings is always UTF-8, but the tag names are limited to case-insensitive ASCII. See the spec for details.

In filling in this structure, theora_decode_header() will null-terminate the user_comment strings for safety. However, the bitstream format itself treats them as 8-bit clean, and so the length array should be treated as authoritative for their length.


Enumeration Type Documentation

enum theora_colorspace
 

A Colorspace.

Enumerator:
OC_CS_UNSPECIFIED  The colorspace is unknown or unspecified.
OC_CS_ITU_REC_470M  This is the best option for 'NTSC' content.
OC_CS_ITU_REC_470BG  This is the best option for 'PAL' content.
OC_CS_NSPACES  This marks the end of the defined colorspaces.

enum theora_pixelformat
 

A Chroma subsampling.

These enumerate the available chroma subsampling options supported by the theora format. See Section 4.4 of the specification for exact definitions.

Enumerator:
OC_PF_420  Chroma subsampling by 2 in each direction (4:2:0).
OC_PF_RSVD  Reserved value.
OC_PF_422  Horizonatal chroma subsampling by 2 (4:2:2).
OC_PF_444  No chroma subsampling at all (4:4:4).


Generated on Tue Aug 24 20:45:54 2010 for libtheora by  doxygen 1.4.4