diff options
author | wm4 <nfxjfg@googlemail.com> | 2016-04-01 13:52:12 +0300 |
---|---|---|
committer | wm4 <nfxjfg@googlemail.com> | 2016-04-01 13:52:12 +0300 |
commit | f099cb2f8a51dbe01b0e5bac16f244d534709ca3 (patch) | |
tree | e36092be92d6c051d3791897b77d47b1a32875ce /libavutil | |
parent | 54ccaaeb2b93e19d2a19267db1781bc9d5d36f27 (diff) |
lavu: improve documentation of some AVFrame functions
Diffstat (limited to 'libavutil')
-rw-r--r-- | libavutil/frame.h | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/libavutil/frame.h b/libavutil/frame.h index 76a8123dcb..89f41fc7be 100644 --- a/libavutil/frame.h +++ b/libavutil/frame.h @@ -591,6 +591,10 @@ void av_frame_free(AVFrame **frame); * If src is not reference counted, new buffers are allocated and the data is * copied. * + * @warning: dst MUST have been either unreferenced with av_frame_unref(dst), + * or newly allocated with av_frame_alloc() before calling this + * function, or undefined behavior will occur. + * * @return 0 on success, a negative AVERROR on error */ int av_frame_ref(AVFrame *dst, const AVFrame *src); @@ -611,6 +615,10 @@ void av_frame_unref(AVFrame *frame); /** * Move everything contained in src to dst and reset src. + * + * @warning: dst is not unreferenced, but directly overwritten without reading + * or deallocating its contents. Call av_frame_unref(dst) manually + * before calling this function to ensure that no memory is leaked. */ void av_frame_move_ref(AVFrame *dst, AVFrame *src); @@ -626,6 +634,9 @@ void av_frame_move_ref(AVFrame *dst, AVFrame *src); * necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf. * For planar formats, one buffer will be allocated for each plane. * + * @warning: if frame already has been allocated, undefined behaviour, including + * memory leaks, can occur. + * * @param frame frame in which to store the new buffers. * @param align required buffer size alignment * |