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

[epirat07 at gmail.com]

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 at ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request at ffmpeg.org with subject "unsubscribe".