comparison avcodec.h @ 5139:f3d9859953c1 libavcodec

More detailed documentation patch by Nicolas George: [nicolas george normalesup org]
author benoit
date Thu, 14 Jun 2007 07:28:16 +0000
parents 0134da1737d0
children 2b72f9bc4f06
comparison
equal deleted inserted replaced
5138:189a1229a7a6 5139:f3d9859953c1
42 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000) 42 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
43 #define AV_TIME_BASE 1000000 43 #define AV_TIME_BASE 1000000
44 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE} 44 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
45 45
46 /** 46 /**
47 * Identifies the syntax and semantics of the bitstream.
48 * The principle is roughly:
49 * Two decoders with the same ID can decode the same streams.
50 * Two encoders with the same ID can encode compatible streams.
51 * There may be slight deviations from the principle due to implementation
52 * details.
47 * 53 *
48 * If you add a codec ID to this list, add it so that 54 * If you add a codec ID to this list, add it so that
49 * 1. no value of a existing codec ID changes (that would break ABI), 55 * 1. no value of a existing codec ID changes (that would break ABI),
50 * 2. it is as close as possible to similar codecs. 56 * 2. it is as close as possible to similar codecs.
51 */ 57 */
2117 2123
2118 /** 2124 /**
2119 * AVCodec. 2125 * AVCodec.
2120 */ 2126 */
2121 typedef struct AVCodec { 2127 typedef struct AVCodec {
2128 /**
2129 * Name of the codec implementation.
2130 * The name is globally unique among encoders and among decoders (but an
2131 * encoder and a decoder can share the same name).
2132 * This is the primary way to find a codec from the user perspective.
2133 */
2122 const char *name; 2134 const char *name;
2123 enum CodecType type; 2135 enum CodecType type;
2124 enum CodecID id; 2136 enum CodecID id;
2125 int priv_data_size; 2137 int priv_data_size;
2126 int (*init)(AVCodecContext *); 2138 int (*init)(AVCodecContext *);