summaryrefslogtreecommitdiff
path: root/libavcodec/internal.h
diff options
context:
space:
mode:
Diffstat (limited to 'libavcodec/internal.h')
-rw-r--r--libavcodec/internal.h6
1 files changed, 6 insertions, 0 deletions
diff --git a/libavcodec/internal.h b/libavcodec/internal.h
index 868e3dfc54..a619e977f6 100644
--- a/libavcodec/internal.h
+++ b/libavcodec/internal.h
@@ -272,6 +272,12 @@ int ff_side_data_update_matrix_encoding(AVFrame *frame,
* Select the (possibly hardware accelerated) pixel format.
* This is a wrapper around AVCodecContext.get_format() and should be used
* instead of calling get_format() directly.
+ *
+ * The list of pixel formats must contain at least one valid entry, and is
+ * terminated with AV_PIX_FMT_NONE. If it is possible to decode to software,
+ * the last entry in the list must be the most accurate software format.
+ * If it is not possible to decode to software, AVCodecContext.sw_pix_fmt
+ * must be set before calling this function.
*/
int ff_get_format(AVCodecContext *avctx, const enum AVPixelFormat *fmt);