diff mbox

[FFmpeg-devel,1/2] lavfi/framesync: document frame ownership for dualinput.

Message ID 20180102135814.13657-1-george@nsup.org
State Accepted
Commit 9ace76697ac1e43aa4da4c7333ec4a296907c336
Headers show

Commit Message

Nicolas George Jan. 2, 2018, 1:58 p.m. UTC 
Signed-off-by: Nicolas George <george@nsup.org>
---
 libavfilter/framesync.h | 3 +++
 1 file changed, 3 insertions(+)

Comments

Paul B Mahol Jan. 3, 2018, 3:41 p.m. UTC | #1 
On 1/2/18, Nicolas George <george@nsup.org> wrote:
> Signed-off-by: Nicolas George <george@nsup.org>
> ---
>  libavfilter/framesync.h | 3 +++
>  1 file changed, 3 insertions(+)
>
> diff --git a/libavfilter/framesync.h b/libavfilter/framesync.h
> index 9fdc4d1ae2..abf3bf552b 100644
> --- a/libavfilter/framesync.h
> +++ b/libavfilter/framesync.h
> @@ -286,6 +286,9 @@ int ff_framesync_init_dualinput(FFFrameSync *fs,
> AVFilterContext *parent);
>   * @param f0  used to return the main frame
>   * @param f1  used to return the second frame, or NULL if disabled
>   * @return  >=0 for success or AVERROR code
> + * @note  The frame returned in f0 belongs to the caller (get = 1 in
> + * ff_framesync_get_frame()) while the frame returned in f1 is still owned
> + * by the framesync structure.
>   */
>  int ff_framesync_dualinput_get(FFFrameSync *fs, AVFrame **f0, AVFrame
> **f1);

LGTM
Nicolas George Jan. 3, 2018, 7:03 p.m. UTC | #2 
Paul B Mahol (2018-01-03):
> LGTM

Thanks, both patches pushed.

Regards,
diff mbox

Patch

diff --git a/libavfilter/framesync.h b/libavfilter/framesync.h
index 9fdc4d1ae2..abf3bf552b 100644
--- a/libavfilter/framesync.h
+++ b/libavfilter/framesync.h
@@ -286,6 +286,9 @@  int ff_framesync_init_dualinput(FFFrameSync *fs, AVFilterContext *parent);
  * @param f0  used to return the main frame
  * @param f1  used to return the second frame, or NULL if disabled
  * @return  >=0 for success or AVERROR code
+ * @note  The frame returned in f0 belongs to the caller (get = 1 in
+ * ff_framesync_get_frame()) while the frame returned in f1 is still owned
+ * by the framesync structure.
  */
 int ff_framesync_dualinput_get(FFFrameSync *fs, AVFrame **f0, AVFrame **f1);