diff avformat.h @ 2846:625c2c60f585 libavformat

Document a few more structure change rules with relation to ABI/API.
author michael
date Thu, 20 Dec 2007 09:59:07 +0000
parents 440267faee3c
children 082a99e44795
line wrap: on
line diff
--- a/avformat.h	Thu Dec 20 09:51:11 2007 +0000
+++ b/avformat.h	Thu Dec 20 09:59:07 2007 +0000
@@ -269,6 +269,13 @@
     int min_distance;         /**< min distance between this and the previous keyframe, used to avoid unneeded searching */
 } AVIndexEntry;
 
+/**
+ * Stream 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(AVStream) must not be used outside libav*
+ */
 typedef struct AVStream {
     int index;    /**< stream index in AVFormatContext */
     int id;       /**< format specific stream id */
@@ -343,6 +350,13 @@
 
 #define AV_PROGRAM_RUNNING 1
 
+/**
+ *
+ * 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(AVProgram) must not be used outside libav*
+ */
 typedef struct AVProgram {
     int            id;
     char           *provider_name; ///< Network name for DVB streams