diff mbox series

[FFmpeg-devel,4/7] lavfi/avfilter: document AVFilterContext.is_disabled as private

Message ID 20241003193127.15818-4-anton@khirnov.net
State New
Headers show
Series [FFmpeg-devel,1/7] lavfi/avfilter: move AVFilterContext.ready to FFFilterContext | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Anton Khirnov Oct. 3, 2024, 7:31 p.m. UTC
Ideally there should be three parts to the filter context - public,
private to the filter, and private to generic code, but only the first
and the last of these exist currently. Until the second is implemented,
this is better than nothing.
---
 libavfilter/avfilter.h | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

Comments

Marvin Scholz Oct. 3, 2024, 7:47 p.m. UTC | #1
On 3 Oct 2024, at 21:31, Anton Khirnov wrote:

> Ideally there should be three parts to the filter context - public,
> private to the filter, and private to generic code, but only the first
> and the last of these exist currently. Until the second is implemented,
> this is better than nothing.
> ---
>  libavfilter/avfilter.h | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
>
> diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
> index a255d71700..d13a2df732 100644
> --- a/libavfilter/avfilter.h
> +++ b/libavfilter/avfilter.h
> @@ -512,7 +512,12 @@ struct AVFilterContext {
>      ///< @deprecated unused
>      double *var_values;
>  #endif
> -    int is_disabled;                ///< the enabled state from the last expression evaluation
> +    /**
> +     * MUST NOT be accessed from outside avfilter.
> +     *
> +     * the enabled state from the last expression evaluation
> +     */

The first part should be the brief description for which
„MUST NOT be accessed from outside avfilter.“ is not quite helpful.

You probably want this to be „Enabled state from the last expression evaluation“
and add a @warning for the „MUST NOT be accessed from outside avfilter.“

Also what do you mean by that? The libavfilter internals? Or is it fine to access it
in a filter, for example? Thats not clear at all from this, at least to me.

> +    int is_disabled;
>
>      /**
>       * For filters which will create hardware frames, sets the device the
> -- 
> 2.43.0
>
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
Anton Khirnov Oct. 4, 2024, 6:48 a.m. UTC | #2
Quoting epirat07@gmail.com (2024-10-03 21:47:59)
> 
> 
> On 3 Oct 2024, at 21:31, Anton Khirnov wrote:
> 
> > Ideally there should be three parts to the filter context - public,
> > private to the filter, and private to generic code, but only the first
> > and the last of these exist currently. Until the second is implemented,
> > this is better than nothing.
> > ---
> >  libavfilter/avfilter.h | 7 ++++++-
> >  1 file changed, 6 insertions(+), 1 deletion(-)
> >
> > diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
> > index a255d71700..d13a2df732 100644
> > --- a/libavfilter/avfilter.h
> > +++ b/libavfilter/avfilter.h
> > @@ -512,7 +512,12 @@ struct AVFilterContext {
> >      ///< @deprecated unused
> >      double *var_values;
> >  #endif
> > -    int is_disabled;                ///< the enabled state from the last expression evaluation
> > +    /**
> > +     * MUST NOT be accessed from outside avfilter.
> > +     *
> > +     * the enabled state from the last expression evaluation
> > +     */
> 
> The first part should be the brief description for which
> „MUST NOT be accessed from outside avfilter.“ is not quite helpful.

It's all the information a public API user needs.

> Also what do you mean by that? The libavfilter internals? Or is it fine to access it
> in a filter, for example? Thats not clear at all from this, at least to me.

It is accessed from filters, which is why I'm merely changing
documentation. If it was not, I'd move it to FFFilterContext (which is
not accessible to filters).
diff mbox series

Patch

diff --git a/libavfilter/avfilter.h b/libavfilter/avfilter.h
index a255d71700..d13a2df732 100644
--- a/libavfilter/avfilter.h
+++ b/libavfilter/avfilter.h
@@ -512,7 +512,12 @@  struct AVFilterContext {
     ///< @deprecated unused
     double *var_values;
 #endif
-    int is_disabled;                ///< the enabled state from the last expression evaluation
+    /**
+     * MUST NOT be accessed from outside avfilter.
+     *
+     * the enabled state from the last expression evaluation
+     */
+    int is_disabled;
 
     /**
      * For filters which will create hardware frames, sets the device the