diff avio.h @ 2849:0182bdddc45e libavformat

Document ByteIOContext and URLContext change rules.
author michael
date Thu, 20 Dec 2007 22:33:53 +0000
parents f51675f78402
children 082a99e44795
line wrap: on
line diff
--- a/avio.h	Thu Dec 20 11:22:39 2007 +0000
+++ b/avio.h	Thu Dec 20 22:33:53 2007 +0000
@@ -29,6 +29,13 @@
 
 /* unbuffered I/O */
 
+/**
+ * URL 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(URLContext) must not be used outside libav*
+ */
 struct URLContext {
     struct URLProtocol *prot;
     int flags;
@@ -135,6 +142,13 @@
 
 int register_protocol(URLProtocol *protocol);
 
+/**
+ * Bytestream IO 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(ByteIOContext) must not be used outside libav*
+ */
 typedef struct {
     unsigned char *buffer;
     int buffer_size;