summaryrefslogtreecommitdiff
path: root/libavutil/pixdesc.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michaelni@gmx.at>2012-11-14 11:59:25 +0100
committerMichael Niedermayer <michaelni@gmx.at>2012-11-14 12:04:39 +0100
commitd4e74d5d6d67fbe5999aa48b988b49ffe36ea81c (patch)
treefc3be98913957a665e15b5445a7438dd6e6a040c /libavutil/pixdesc.h
parente13d5e9a4b5b4de065b00b1caea850cd47fd4b18 (diff)
Remove deprecation of avcodec_get_chroma_sub_sample.
Add explanations what the difference between the 2 functions are and when either should be used. Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
Diffstat (limited to 'libavutil/pixdesc.h')
-rw-r--r--libavutil/pixdesc.h5
1 files changed, 5 insertions, 0 deletions
diff --git a/libavutil/pixdesc.h b/libavutil/pixdesc.h
index d4e8766132..dca56a71aa 100644
--- a/libavutil/pixdesc.h
+++ b/libavutil/pixdesc.h
@@ -210,6 +210,11 @@ enum AVPixelFormat av_pix_fmt_desc_get_id(const AVPixFmtDescriptor *desc);
* Utility function to access log2_chroma_w log2_chroma_h from
* the pixel format AVPixFmtDescriptor.
*
+ * See avcodec_get_chroma_sub_sample() for a function that asserts a
+ * valid pixel format instead of returning an error code.
+ * Its recommanded that you use avcodec_get_chroma_sub_sample unless
+ * you do check the return code!
+ *
* @param[in] pix_fmt the pixel format
* @param[out] h_shift store log2_chroma_h
* @param[out] v_shift store log2_chroma_w