Commit cb70a93c authored by Vittorio Giovara's avatar Vittorio Giovara

lavc: Document interaction between avcodec_open2() and decoding routines

parent 733f4b05
...@@ -3285,6 +3285,9 @@ void avcodec_free_frame(AVFrame **frame); ...@@ -3285,6 +3285,9 @@ void avcodec_free_frame(AVFrame **frame);
* *
* @warning This function is not thread safe! * @warning This function is not thread safe!
* *
* @note Always call this function before using decoding routines (such as
* @ref avcodec_decode_video2()).
*
* @code * @code
* avcodec_register_all(); * avcodec_register_all();
* av_dict_set(&opts, "b", "2.5M", 0); * av_dict_set(&opts, "b", "2.5M", 0);
...@@ -3614,6 +3617,9 @@ void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height, ...@@ -3614,6 +3617,9 @@ void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
* larger than the actual read bytes because some optimized bitstream * larger than the actual read bytes because some optimized bitstream
* readers read 32 or 64 bits at once and could read over the end. * readers read 32 or 64 bits at once and could read over the end.
* *
* @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
* before packets may be fed to the decoder.
*
* @param avctx the codec context * @param avctx the codec context
* @param[out] frame The AVFrame in which to store decoded audio samples. * @param[out] frame The AVFrame in which to store decoded audio samples.
* The decoder will allocate a buffer for the decoded frame by * The decoder will allocate a buffer for the decoded frame by
...@@ -3658,6 +3664,9 @@ int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame, ...@@ -3658,6 +3664,9 @@ int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
* between input and output, these need to be fed with avpkt->data=NULL, * between input and output, these need to be fed with avpkt->data=NULL,
* avpkt->size=0 at the end to return the remaining frames. * avpkt->size=0 at the end to return the remaining frames.
* *
* @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
* before packets may be fed to the decoder.
*
* @param avctx the codec context * @param avctx the codec context
* @param[out] picture The AVFrame in which the decoded video frame will be stored. * @param[out] picture The AVFrame in which the decoded video frame will be stored.
* Use av_frame_alloc() to get an AVFrame. The codec will * Use av_frame_alloc() to get an AVFrame. The codec will
...@@ -3696,6 +3705,9 @@ int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture, ...@@ -3696,6 +3705,9 @@ int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
* and reusing a get_buffer written for video codecs would probably perform badly * and reusing a get_buffer written for video codecs would probably perform badly
* due to a potentially very different allocation pattern. * due to a potentially very different allocation pattern.
* *
* @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
* before packets may be fed to the decoder.
*
* @param avctx the codec context * @param avctx the codec context
* @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
freed with avsubtitle_free if *got_sub_ptr is set. freed with avsubtitle_free if *got_sub_ptr is set.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment