lavc: extend frame_size doxy.
authorAnton Khirnov <anton@khirnov.net>
Wed, 17 Oct 2012 05:17:24 +0000 (07:17 +0200)
committerAnton Khirnov <anton@khirnov.net>
Mon, 22 Oct 2012 06:49:58 +0000 (08:49 +0200)
libavcodec/avcodec.h

index cda6703..64d45db 100644 (file)
@@ -2081,7 +2081,13 @@ typedef struct AVCodecContext {
 
     /* The following data should not be initialized. */
     /**
-     * Samples per packet, initialized when calling 'init'.
+     * Number of samples per channel in an audio frame.
+     *
+     * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
+     *   except the last must contain exactly frame_size samples per channel.
+     *   May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
+     *   frame size is not restricted.
+     * - decoding: may be set by some decoders to indicate constant frame size
      */
     int frame_size;