[FFmpeg-cvslog] Clarify output of av_get_bits_per_pixel

[Kieran Kunhya]

ffmpeg | branch: master | Kieran Kunhya <kierank at ob-encoder.com> | Tue May 14 14:23:40 2013 -0500| [ede75ebc9b9c1a06406e7ae5cf4d38967c033c00] | committer: Anton Khirnov

Clarify output of av_get_bits_per_pixel

Signed-off-by: Anton Khirnov <anton at khirnov.net>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=ede75ebc9b9c1a06406e7ae5cf4d38967c033c00
---

 libavutil/pixdesc.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/libavutil/pixdesc.h b/libavutil/pixdesc.h
index 312e89a..1d73e5d 100644
--- a/libavutil/pixdesc.h
+++ b/libavutil/pixdesc.h
@@ -177,7 +177,8 @@ char *av_get_pix_fmt_string (char *buf, int buf_size, enum AVPixelFormat pix_fmt
 
 /**
  * Return the number of bits per pixel used by the pixel format
- * described by pixdesc.
+ * described by pixdesc. Note that this is not the same as the number
+ * of bits per sample.
  *
  * The returned number of bits refers to the number of bits actually
  * used for storing the pixel information, that is padding bits are