Browse code

More detailed documentation patch by Nicolas George: [nicolas george normalesup org]

Originally committed as revision 9305 to svn://svn.ffmpeg.org/ffmpeg/trunk

Nicolas George authored on 2007/06/14 16:28:16
Showing 1 changed files
... ...
@@ -44,6 +44,12 @@
44 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 54
  * If you add a codec ID to this list, add it so that
49 55
  * 1. no value of a existing codec ID changes (that would break ABI),
... ...
@@ -2119,6 +2125,12 @@ typedef struct AVCodecContext {
2119 2119
  * AVCodec.
2120 2120
  */
2121 2121
 typedef struct AVCodec {
2122
+    /**
2123
+     * Name of the codec implementation.
2124
+     * The name is globally unique among encoders and among decoders (but an
2125
+     * encoder and a decoder can share the same name).
2126
+     * This is the primary way to find a codec from the user perspective.
2127
+     */
2122 2128
     const char *name;
2123 2129
     enum CodecType type;
2124 2130
     enum CodecID id;