avframe: note that linesize is not the usable data size

diff --git a/libavutil/frame.h b/libavutil/frame.h
index d71948db09d58fb880d907d9e0d4e3ca7a43136b..b0676e7f58c602d514af4ba5b912a504ff92a99f 100644 (file)
--- a/libavutil/frame.h
+++ b/libavutil/frame.h
@@ -84,6 +84,9 @@ typedef struct AVFrame {
      *
      * For audio, only linesize[0] may be set. For planar audio, each channel
      * plane must be the same size.
+     *
+     * @note The linesize may be larger than the size of usable data -- there
+     * may be extra padding present for performance reasons.
      */
     int linesize[AV_NUM_DATA_POINTERS];