theora.h
Go to the documentation of this file.
/********************************************************************
* *
* THIS FILE IS PART OF THE OggTheora SOFTWARE CODEC SOURCE CODE. *
* USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
* GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
* IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
* *
* THE Theora SOURCE CODE IS COPYRIGHT (C) 2002-2009 *
* by the Xiph.Org Foundation http://www.xiph.org/ *
* *
********************************************************************
function:
last mod: $Id: theora.h,v 1.17 2003/12/06 18:06:19 arc Exp $
********************************************************************/
#ifndef _O_THEORA_H_
#define _O_THEORA_H_
#ifdef __cplusplus
extern "C"
{
#endif /* __cplusplus */
#include <stddef.h> /* for size_t */
#include <ogg/ogg.h>
/* @{ */
typedef struct {
int y_width;
int y_height;
int y_stride;
int uv_width;
int uv_height;
int uv_stride;
unsigned char *y;
unsigned char *u;
unsigned char *v;
} yuv_buffer;
typedef enum {
OC_CS_UNSPECIFIED,
OC_CS_ITU_REC_470M,
OC_CS_ITU_REC_470BG,
OC_CS_NSPACES
} theora_colorspace;
typedef enum {
OC_PF_420,
OC_PF_RSVD,
OC_PF_422,
OC_PF_444,
} theora_pixelformat;
typedef struct {
ogg_uint32_t width;
ogg_uint32_t height;
ogg_uint32_t frame_width;
ogg_uint32_t frame_height;
ogg_uint32_t offset_x;
ogg_uint32_t offset_y;
ogg_uint32_t fps_numerator;
ogg_uint32_t fps_denominator;
ogg_uint32_t aspect_numerator;
ogg_uint32_t aspect_denominator;
theora_colorspace colorspace;
int target_bitrate;
int quality;
int quick_p;
/* decode only */
unsigned char version_major;
unsigned char version_minor;
unsigned char version_subminor;
void *codec_setup;
/* encode only */
int dropframes_p;
int keyframe_auto_p;
ogg_uint32_t keyframe_frequency;
ogg_uint32_t keyframe_frequency_force; /* also used for decode init to
get granpos shift correct */
ogg_uint32_t keyframe_data_target_bitrate;
ogg_int32_t keyframe_auto_threshold;
ogg_uint32_t keyframe_mindistance;
ogg_int32_t noise_sensitivity;
ogg_int32_t sharpness;
theora_pixelformat pixelformat;
} theora_info;
typedef struct{
theora_info *i;
ogg_int64_t granulepos;
void *internal_encode;
void *internal_decode;
} theora_state;
typedef struct theora_comment{
char **user_comments;
int *comment_lengths;
int comments;
char *vendor;
} theora_comment;
/* \anchor decctlcodes_old
* These are the available request codes for theora_control()
* when called with a decoder instance.
* By convention decoder control codes are odd, to distinguish
* them from \ref encctlcodes_old "encoder control codes" which
* are even.
*
* Note that since the 1.0 release, both the legacy and the final
* implementation accept all the same control codes, but only the
* final API declares the newer codes.
*
* Keep any experimental or vendor-specific values above \c 0x8000.*/
#define TH_DECCTL_GET_PPLEVEL_MAX (1)
#define TH_DECCTL_SET_PPLEVEL (3)
#define TH_ENCCTL_SET_KEYFRAME_FREQUENCY_FORCE (4)
#define TH_DECCTL_SET_GRANPOS (5)
#define TH_ENCCTL_SET_QUANT_PARAMS (2)
#define TH_ENCCTL_SET_VP3_COMPATIBLE (10)
#define TH_ENCCTL_GET_SPLEVEL_MAX (12)
#define TH_ENCCTL_SET_SPLEVEL (14)
#define OC_FAULT -1
#define OC_EINVAL -10
#define OC_DISABLED -11
#define OC_BADHEADER -20
#define OC_NOTFORMAT -21
#define OC_VERSION -22
#define OC_IMPL -23
#define OC_BADPACKET -24
#define OC_NEWPACKET -25
#define OC_DUPFRAME 1
extern const char *theora_version_string(void);
extern ogg_uint32_t theora_version_number(void);
extern int theora_encode_init(theora_state *th, theora_info *ti);
extern int theora_encode_YUVin(theora_state *t, yuv_buffer *yuv);
extern int theora_encode_packetout( theora_state *t, int last_p,
ogg_packet *op);
extern int theora_encode_header(theora_state *t, ogg_packet *op);
extern int theora_encode_comment(theora_comment *tc, ogg_packet *op);
extern int theora_encode_tables(theora_state *t, ogg_packet *op);
extern int theora_decode_header(theora_info *ci, theora_comment *cc,
ogg_packet *op);
extern int theora_decode_init(theora_state *th, theora_info *c);
extern int theora_decode_packetin(theora_state *th,ogg_packet *op);
extern int theora_decode_YUVout(theora_state *th,yuv_buffer *yuv);
extern int theora_packet_isheader(ogg_packet *op);
extern int theora_packet_iskeyframe(ogg_packet *op);
int theora_granule_shift(theora_info *ti);
extern ogg_int64_t theora_granule_frame(theora_state *th,ogg_int64_t granulepos);
extern double theora_granule_time(theora_state *th,ogg_int64_t granulepos);
extern void theora_info_init(theora_info *c);
extern void theora_info_clear(theora_info *c);
extern void theora_clear(theora_state *t);
extern void theora_comment_init(theora_comment *tc);
extern void theora_comment_add(theora_comment *tc, char *comment);
extern void theora_comment_add_tag(theora_comment *tc,
char *tag, char *value);
extern char *theora_comment_query(theora_comment *tc, char *tag, int count);
extern int theora_comment_query_count(theora_comment *tc, char *tag);
extern void theora_comment_clear(theora_comment *tc);
extern int theora_control(theora_state *th,int req,void *buf,size_t buf_sz);
/* @} */ /* end oldfuncs doxygen group */
#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* _O_THEORA_H_ */
theora_packet_iskeyframe
int theora_packet_iskeyframe(ogg_packet *op)
Report whether a theora packet is a keyframe or not.
theora_control
int theora_control(theora_state *th, int req, void *buf, size_t buf_sz)
Encoder control function.
theora_info::fps_numerator
ogg_uint32_t fps_numerator
frame rate numerator
Definition: theora.h:213
theora_info::quality
int quality
Nominal quality setting, 0-63.
Definition: theora.h:219
theora_comment_add_tag
void theora_comment_add_tag(theora_comment *tc, char *tag, char *value)
Add a comment to an initialized theora_comment structure.
theora_granule_time
double theora_granule_time(theora_state *th, ogg_int64_t granulepos)
Convert a granulepos to absolute time in seconds.
OC_CS_UNSPECIFIED
The colorspace is unknown or unspecified.
Definition: theora.h:165
theora_encode_YUVin
int theora_encode_YUVin(theora_state *t, yuv_buffer *yuv)
Submit a YUV buffer to the theora encoder.
theora_clear
void theora_clear(theora_state *t)
Free all internal data associated with a theora_state handle.
theora_comment
Comment header metadata.
Definition: theora.h:275
theora_encode_header
int theora_encode_header(theora_state *t, ogg_packet *op)
Request a packet containing the initial header.
theora_comment_query
char * theora_comment_query(theora_comment *tc, char *tag, int count)
Look up a comment value by tag.
theora_comment_clear
void theora_comment_clear(theora_comment *tc)
Clear an allocated theora_comment struct so that it can be freed.
theora_info::colorspace
theora_colorspace colorspace
colorspace
Definition: theora.h:217
theora_state::i
theora_info * i
Definition: theora.h:248
theora_state::internal_decode
void * internal_decode
Definition: theora.h:252
theora_state
Codec internal state and context.
Definition: theora.h:247
yuv_buffer::y
unsigned char * y
Pointer to start of luminance data.
Definition: theora.h:155
yuv_buffer::uv_width
int uv_width
Width of the Cb and Cr chroma planes.
Definition: theora.h:152
theora_info::quick_p
int quick_p
Quick encode/decode.
Definition: theora.h:220
theora_granule_frame
ogg_int64_t theora_granule_frame(theora_state *th, ogg_int64_t granulepos)
Convert a granulepos to an absolute frame index, starting at 0.
theora_state::internal_encode
void * internal_encode
Definition: theora.h:251
theora_info::fps_denominator
ogg_uint32_t fps_denominator
frame rate denominator
Definition: theora.h:214
OC_CS_ITU_REC_470M
This is the best option for &#39;NTSC&#39; content.
Definition: theora.h:166
theora_decode_YUVout
int theora_decode_YUVout(theora_state *th, yuv_buffer *yuv)
Output the next available frame of decoded YUV data.
yuv_buffer::u
unsigned char * u
Pointer to start of Cb data.
Definition: theora.h:156
theora_info::noise_sensitivity
ogg_int32_t noise_sensitivity
Definition: theora.h:238
theora_info::width
ogg_uint32_t width
encoded frame width
Definition: theora.h:207
OC_PF_420
Chroma subsampling by 2 in each direction (4:2:0)
Definition: theora.h:179
theora_decode_header
int theora_decode_header(theora_info *ci, theora_comment *cc, ogg_packet *op)
Decode an Ogg packet, with the expectation that the packet contains an initial header, comment data or codebook tables.
theora_info::frame_height
ogg_uint32_t frame_height
display frame height
Definition: theora.h:210
theora_comment::user_comments
char ** user_comments
An array of comment string vectors.
Definition: theora.h:276
theora_packet_isheader
int theora_packet_isheader(ogg_packet *op)
Report whether a theora packet is a header or not This function does no verification beyond checking ...
theora_info::aspect_denominator
ogg_uint32_t aspect_denominator
pixel aspect ratio denominator
Definition: theora.h:216
theora_info::aspect_numerator
ogg_uint32_t aspect_numerator
pixel aspect ratio numerator
Definition: theora.h:215
theora_comment_add
void theora_comment_add(theora_comment *tc, char *comment)
Add a comment to an initialized theora_comment structure.
theora_encode_packetout
int theora_encode_packetout(theora_state *t, int last_p, ogg_packet *op)
Request the next packet of encoded video.
theora_info
Theora bitstream info.
Definition: theora.h:206
theora_colorspace
theora_colorspace
A Colorspace.
Definition: theora.h:164
theora_info::frame_width
ogg_uint32_t frame_width
display frame width
Definition: theora.h:209
yuv_buffer::uv_height
int uv_height
Height of the chroma planes.
Definition: theora.h:153
theora_info::keyframe_auto_p
int keyframe_auto_p
Definition: theora.h:231
theora_encode_init
int theora_encode_init(theora_state *th, theora_info *ti)
Initialize the theora encoder.
theora_comment::comments
int comments
The total number of comment string vectors.
Definition: theora.h:278
theora_decode_init
int theora_decode_init(theora_state *th, theora_info *c)
Initialize a theora_state handle for decoding.
theora_info::offset_y
ogg_uint32_t offset_y
vertical offset of the displayed frame
Definition: theora.h:212
theora_pixelformat
theora_pixelformat
A Chroma subsampling.
Definition: theora.h:178
theora_info::keyframe_auto_threshold
ogg_int32_t keyframe_auto_threshold
Definition: theora.h:236
OC_PF_444
No chroma subsampling at all (4:4:4)
Definition: theora.h:182
theora_decode_packetin
int theora_decode_packetin(theora_state *th, ogg_packet *op)
Input a packet containing encoded data into the theora decoder.
OC_PF_RSVD
Reserved value.
Definition: theora.h:180
theora_comment::vendor
char * vendor
The vendor string identifying the encoder, null terminated.
Definition: theora.h:279
yuv_buffer::v
unsigned char * v
Pointer to start of Cr data.
Definition: theora.h:157
yuv_buffer::y_height
int y_height
Height of the luminance plane.
Definition: theora.h:149
theora_info::target_bitrate
int target_bitrate
nominal bitrate in bits per second
Definition: theora.h:218
theora_info::dropframes_p
int dropframes_p
Definition: theora.h:230
theora_comment_query_count
int theora_comment_query_count(theora_comment *tc, char *tag)
Look up the number of instances of a tag.
theora_state::granulepos
ogg_int64_t granulepos
Definition: theora.h:249
theora_comment::comment_lengths
int * comment_lengths
An array of corresponding string vector lengths in bytes.
Definition: theora.h:277
theora_info::sharpness
ogg_int32_t sharpness
Definition: theora.h:239
yuv_buffer::y_width
int y_width
Width of the Y&#39; luminance plane.
Definition: theora.h:148
theora_info_clear
void theora_info_clear(theora_info *c)
Clear a theora_info structure.
theora_info_init
void theora_info_init(theora_info *c)
Initialize a theora_info structure.
theora_info::version_subminor
unsigned char version_subminor
Definition: theora.h:225
yuv_buffer::uv_stride
int uv_stride
Offset between successive chroma rows.
Definition: theora.h:154
theora_info::version_major
unsigned char version_major
Definition: theora.h:223
theora_comment
struct theora_comment theora_comment
Comment header metadata.
theora_info::codec_setup
void * codec_setup
Definition: theora.h:227
theora_granule_shift
int theora_granule_shift(theora_info *ti)
Report the granulepos shift radix.
theora_version_number
ogg_uint32_t theora_version_number(void)
Retrieve a 32-bit version number.
theora_comment_init
void theora_comment_init(theora_comment *tc)
Initialize an allocated theora_comment structure.
theora_info::keyframe_data_target_bitrate
ogg_uint32_t keyframe_data_target_bitrate
Definition: theora.h:235
theora_info::offset_x
ogg_uint32_t offset_x
horizontal offset of the displayed frame
Definition: theora.h:211
theora_info::keyframe_mindistance
ogg_uint32_t keyframe_mindistance
Definition: theora.h:237
theora_encode_comment
int theora_encode_comment(theora_comment *tc, ogg_packet *op)
Request a comment header packet from provided metadata.
OC_CS_NSPACES
This marks the end of the defined colorspaces.
Definition: theora.h:168
theora_info::keyframe_frequency_force
ogg_uint32_t keyframe_frequency_force
Definition: theora.h:233
theora_encode_tables
int theora_encode_tables(theora_state *t, ogg_packet *op)
Request a packet containing the codebook tables for the stream.
theora_info::height
ogg_uint32_t height
encoded frame height
Definition: theora.h:208
theora_info::pixelformat
theora_pixelformat pixelformat
chroma subsampling mode to expect
Definition: theora.h:241
theora_info::version_minor
unsigned char version_minor
Definition: theora.h:224
OC_CS_ITU_REC_470BG
This is the best option for &#39;PAL&#39; content.
Definition: theora.h:167
OC_PF_422
Horizonatal chroma subsampling by 2 (4:2:2)
Definition: theora.h:181
yuv_buffer::y_stride
int y_stride
Offset in bytes between successive rows.
Definition: theora.h:150
theora_info::keyframe_frequency
ogg_uint32_t keyframe_frequency
Definition: theora.h:232
yuv_buffer
A YUV buffer for passing uncompressed frames to and from the codec.
Definition: theora.h:147