Document structure change rules with relation to ABI/API.
authorMichael Niedermayer <michaelni@gmx.at>
Thu, 20 Dec 2007 09:43:01 +0000 (09:43 +0000)
committerMichael Niedermayer <michaelni@gmx.at>
Thu, 20 Dec 2007 09:43:01 +0000 (09:43 +0000)
Originally committed as revision 11281 to svn://svn.ffmpeg.org/ffmpeg/trunk

libavcodec/avcodec.h
libavformat/avformat.h

index a32f961..98d1489 100644 (file)
@@ -753,7 +753,11 @@ typedef struct AVFrame {
 #define DEFAULT_FRAME_RATE_BASE 1001000
 
 /**
- * main external API structure
+ * main external API structure.
+ * New fields can be added to the end with minor version bumps.
+ * Removial, reordering and changes to existing fields require a Major
+ * version bump.
+ * sizeof(AVCodecContext) must not be used outside libav*
  */
 typedef struct AVCodecContext {
     /**
index c0ad4a6..bbe818f 100644 (file)
@@ -358,7 +358,13 @@ typedef struct AVProgram {
 
 #define MAX_STREAMS 20
 
-/* format I/O context */
+/**
+ * format I/O context.
+ * New fields can be added to the end with minor version bumps.
+ * Removial, reordering and changes to existing fields require a Major
+ * version bump.
+ * sizeof(AVFormatContext) must not be used outside libav*
+ */
 typedef struct AVFormatContext {
     const AVClass *av_class; /**< set by av_alloc_format_context */
     /* can only be iformat or oformat, not both at the same time */