libtheora  1.1.1
theora.h
Go to the documentation of this file.
1 /********************************************************************
2  * *
3  * THIS FILE IS PART OF THE OggTheora SOFTWARE CODEC SOURCE CODE. *
4  * USE, DISTRIBUTION AND REPRODUCTION OF THIS LIBRARY SOURCE IS *
5  * GOVERNED BY A BSD-STYLE SOURCE LICENSE INCLUDED WITH THIS SOURCE *
6  * IN 'COPYING'. PLEASE READ THESE TERMS BEFORE DISTRIBUTING. *
7  * *
8  * THE Theora SOURCE CODE IS COPYRIGHT (C) 2002-2009 *
9  * by the Xiph.Org Foundation http://www.xiph.org/ *
10  * *
11  ********************************************************************
12 
13  function:
14  last mod: $Id: theora.h,v 1.17 2003/12/06 18:06:19 arc Exp $
15 
16  ********************************************************************/
17 
18 #ifndef _O_THEORA_H_
19 #define _O_THEORA_H_
20 
21 #ifdef __cplusplus
22 extern "C"
23 {
24 #endif /* __cplusplus */
25 
26 #include <stddef.h> /* for size_t */
27 
28 #include <ogg/ogg.h>
29 
121 /* @{ */
122 
147 typedef struct {
148  int y_width;
149  int y_height;
150  int y_stride;
152  int uv_width;
153  int uv_height;
154  int uv_stride;
155  unsigned char *y;
156  unsigned char *u;
157  unsigned char *v;
159 } yuv_buffer;
160 
164 typedef enum {
170 
178 typedef enum {
184 
206 typedef struct {
207  ogg_uint32_t width;
208  ogg_uint32_t height;
209  ogg_uint32_t frame_width;
210  ogg_uint32_t frame_height;
211  ogg_uint32_t offset_x;
212  ogg_uint32_t offset_y;
213  ogg_uint32_t fps_numerator;
214  ogg_uint32_t fps_denominator;
215  ogg_uint32_t aspect_numerator;
216  ogg_uint32_t aspect_denominator;
219  int quality;
220  int quick_p;
222  /* decode only */
223  unsigned char version_major;
224  unsigned char version_minor;
225  unsigned char version_subminor;
226 
227  void *codec_setup;
228 
229  /* encode only */
232  ogg_uint32_t keyframe_frequency;
233  ogg_uint32_t keyframe_frequency_force; /* also used for decode init to
234  get granpos shift correct */
237  ogg_uint32_t keyframe_mindistance;
238  ogg_int32_t noise_sensitivity;
239  ogg_int32_t sharpness;
240 
243 } theora_info;
244 
247 typedef struct{
249  ogg_int64_t granulepos;
250 
253 
254 } theora_state;
255 
275 typedef struct theora_comment{
276  char **user_comments;
278  int comments;
279  char *vendor;
282 
283 
285 /* \anchor decctlcodes_old
286  * These are the available request codes for theora_control()
287  * when called with a decoder instance.
288  * By convention decoder control codes are odd, to distinguish
289  * them from \ref encctlcodes_old "encoder control codes" which
290  * are even.
291  *
292  * Note that since the 1.0 release, both the legacy and the final
293  * implementation accept all the same control codes, but only the
294  * final API declares the newer codes.
295  *
296  * Keep any experimental or vendor-specific values above \c 0x8000.*/
297 
306 #define TH_DECCTL_GET_PPLEVEL_MAX (1)
307 
313 #define TH_DECCTL_SET_PPLEVEL (3)
314 
327 #define TH_ENCCTL_SET_KEYFRAME_FREQUENCY_FORCE (4)
328 
336 #define TH_DECCTL_SET_GRANPOS (5)
337 
353 #define TH_ENCCTL_SET_QUANT_PARAMS (2)
354 
382 #define TH_ENCCTL_SET_VP3_COMPATIBLE (10)
383 
397 #define TH_ENCCTL_GET_SPLEVEL_MAX (12)
398 
412 #define TH_ENCCTL_SET_SPLEVEL (14)
413 
416 #define OC_FAULT -1
417 #define OC_EINVAL -10
418 #define OC_DISABLED -11
419 #define OC_BADHEADER -20
420 #define OC_NOTFORMAT -21
421 #define OC_VERSION -22
422 #define OC_IMPL -23
423 #define OC_BADPACKET -24
424 #define OC_NEWPACKET -25
425 #define OC_DUPFRAME 1
431 extern const char *theora_version_string(void);
432 
442 extern ogg_uint32_t theora_version_number(void);
443 
451 
463 
476 extern int theora_encode_packetout( theora_state *t, int last_p,
477  ogg_packet *op);
478 
489 extern int theora_encode_header(theora_state *t, ogg_packet *op);
490 
502 extern int theora_encode_comment(theora_comment *tc, ogg_packet *op);
503 
514 extern int theora_encode_tables(theora_state *t, ogg_packet *op);
515 
558  ogg_packet *op);
559 
569 
577 extern int theora_decode_packetin(theora_state *th,ogg_packet *op);
578 
590 
603 extern int theora_packet_isheader(ogg_packet *op);
604 
615 extern int theora_packet_iskeyframe(ogg_packet *op);
616 
643 
660 extern ogg_int64_t theora_granule_frame(theora_state *th,ogg_int64_t granulepos);
661 
677 extern double theora_granule_time(theora_state *th,ogg_int64_t granulepos);
678 
686 
693 
698 extern void theora_clear(theora_state *t);
699 
705 
718 extern void theora_comment_add(theora_comment *tc, char *comment);
719 
733  char *tag, char *value);
734 
749 extern char *theora_comment_query(theora_comment *tc, char *tag, int count);
750 
760 extern int theora_comment_query_count(theora_comment *tc, char *tag);
761 
767 
776 extern int theora_control(theora_state *th,int req,void *buf,size_t buf_sz);
777 
778 /* @} */ /* end oldfuncs doxygen group */
779 
780 #ifdef __cplusplus
781 }
782 #endif /* __cplusplus */
783 
784 #endif /* _O_THEORA_H_ */
Comment header metadata.
Definition: theora.h:275
int comments
The total number of comment string vectors.
Definition: theora.h:278
char ** user_comments
An array of comment string vectors.
Definition: theora.h:276
int * comment_lengths
An array of corresponding string vector lengths in bytes.
Definition: theora.h:277
char * vendor
The vendor string identifying the encoder, null terminated.
Definition: theora.h:279
Theora bitstream info.
Definition: theora.h:206
ogg_uint32_t keyframe_frequency
Definition: theora.h:232
int target_bitrate
nominal bitrate in bits per second
Definition: theora.h:218
ogg_uint32_t width
encoded frame width
Definition: theora.h:207
int keyframe_auto_p
Definition: theora.h:231
ogg_uint32_t frame_height
display frame height
Definition: theora.h:210
int quick_p
Quick encode/decode.
Definition: theora.h:220
ogg_uint32_t fps_numerator
frame rate numerator
Definition: theora.h:213
ogg_int32_t sharpness
Definition: theora.h:239
ogg_uint32_t keyframe_data_target_bitrate
Definition: theora.h:235
ogg_uint32_t aspect_numerator
pixel aspect ratio numerator
Definition: theora.h:215
theora_colorspace colorspace
colorspace
Definition: theora.h:217
theora_pixelformat pixelformat
chroma subsampling mode to expect
Definition: theora.h:241
void * codec_setup
Definition: theora.h:227
int quality
Nominal quality setting, 0-63.
Definition: theora.h:219
unsigned char version_minor
Definition: theora.h:224
unsigned char version_major
Definition: theora.h:223
ogg_uint32_t frame_width
display frame width
Definition: theora.h:209
ogg_uint32_t offset_y
vertical offset of the displayed frame
Definition: theora.h:212
ogg_int32_t keyframe_auto_threshold
Definition: theora.h:236
ogg_uint32_t fps_denominator
frame rate denominator
Definition: theora.h:214
unsigned char version_subminor
Definition: theora.h:225
ogg_uint32_t keyframe_mindistance
Definition: theora.h:237
ogg_int32_t noise_sensitivity
Definition: theora.h:238
ogg_uint32_t keyframe_frequency_force
Definition: theora.h:233
ogg_uint32_t height
encoded frame height
Definition: theora.h:208
int dropframes_p
Definition: theora.h:230
ogg_uint32_t offset_x
horizontal offset of the displayed frame
Definition: theora.h:211
ogg_uint32_t aspect_denominator
pixel aspect ratio denominator
Definition: theora.h:216
Codec internal state and context.
Definition: theora.h:247
theora_info * i
Definition: theora.h:248
void * internal_encode
Definition: theora.h:251
ogg_int64_t granulepos
Definition: theora.h:249
void * internal_decode
Definition: theora.h:252
A YUV buffer for passing uncompressed frames to and from the codec.
Definition: theora.h:147
int y_height
Height of the luminance plane.
Definition: theora.h:149
int uv_height
Height of the chroma planes.
Definition: theora.h:153
unsigned char * y
Pointer to start of luminance data.
Definition: theora.h:155
unsigned char * u
Pointer to start of Cb data.
Definition: theora.h:156
int uv_width
Width of the Cb and Cr chroma planes.
Definition: theora.h:152
int y_stride
Offset in bytes between successive rows.
Definition: theora.h:150
unsigned char * v
Pointer to start of Cr data.
Definition: theora.h:157
int y_width
Width of the Y' luminance plane.
Definition: theora.h:148
int uv_stride
Offset between successive chroma rows.
Definition: theora.h:154
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,...
void theora_comment_clear(theora_comment *tc)
Clear an allocated theora_comment struct so that it can be freed.
int theora_decode_YUVout(theora_state *th, yuv_buffer *yuv)
Output the next available frame of decoded YUV data.
int theora_encode_init(theora_state *th, theora_info *ti)
Initialize the theora encoder.
int theora_comment_query_count(theora_comment *tc, char *tag)
Look up the number of instances of a tag.
int theora_control(theora_state *th, int req, void *buf, size_t buf_sz)
Encoder control function.
int theora_decode_init(theora_state *th, theora_info *c)
Initialize a theora_state handle for decoding.
void theora_info_init(theora_info *c)
Initialize a theora_info structure.
void theora_comment_add_tag(theora_comment *tc, char *tag, char *value)
Add a comment to an initialized theora_comment structure.
int theora_packet_iskeyframe(ogg_packet *op)
Report whether a theora packet is a keyframe or not.
char * theora_comment_query(theora_comment *tc, char *tag, int count)
Look up a comment value by tag.
double theora_granule_time(theora_state *th, ogg_int64_t granulepos)
Convert a granulepos to absolute time in seconds.
int theora_encode_header(theora_state *t, ogg_packet *op)
Request a packet containing the initial header.
int theora_encode_comment(theora_comment *tc, ogg_packet *op)
Request a comment header packet from provided metadata.
int theora_encode_tables(theora_state *t, ogg_packet *op)
Request a packet containing the codebook tables for the stream.
const char * theora_version_string(void)
Retrieve a human-readable string to identify the encoder vendor and version.
int theora_encode_packetout(theora_state *t, int last_p, ogg_packet *op)
Request the next packet of encoded video.
void theora_comment_add(theora_comment *tc, char *comment)
Add a comment to an initialized theora_comment structure.
ogg_int64_t theora_granule_frame(theora_state *th, ogg_int64_t granulepos)
Convert a granulepos to an absolute frame index, starting at 0.
void theora_comment_init(theora_comment *tc)
Initialize an allocated theora_comment structure.
theora_colorspace
A Colorspace.
Definition: theora.h:164
@ OC_CS_ITU_REC_470BG
This is the best option for 'PAL' content.
Definition: theora.h:167
@ OC_CS_NSPACES
This marks the end of the defined colorspaces.
Definition: theora.h:168
@ OC_CS_ITU_REC_470M
This is the best option for 'NTSC' content.
Definition: theora.h:166
@ OC_CS_UNSPECIFIED
The colorspace is unknown or unspecified.
Definition: theora.h:165
int theora_decode_packetin(theora_state *th, ogg_packet *op)
Input a packet containing encoded data into the theora decoder.
void theora_clear(theora_state *t)
Free all internal data associated with a theora_state handle.
int theora_packet_isheader(ogg_packet *op)
Report whether a theora packet is a header or not This function does no verification beyond checking ...
void theora_info_clear(theora_info *c)
Clear a theora_info structure.
int theora_encode_YUVin(theora_state *t, yuv_buffer *yuv)
Submit a YUV buffer to the theora encoder.
struct theora_comment theora_comment
Comment header metadata.
int theora_granule_shift(theora_info *ti)
Report the granulepos shift radix.
ogg_uint32_t theora_version_number(void)
Retrieve a 32-bit version number.
theora_pixelformat
A Chroma subsampling.
Definition: theora.h:178
@ OC_PF_444
No chroma subsampling at all (4:4:4)
Definition: theora.h:182
@ OC_PF_422
Horizonatal chroma subsampling by 2 (4:2:2)
Definition: theora.h:181
@ OC_PF_420
Chroma subsampling by 2 in each direction (4:2:0)
Definition: theora.h:179
@ OC_PF_RSVD
Reserved value.
Definition: theora.h:180