[FFmpeg-devel] [PATCH] avutil/frame.h: improve documentation for AV_FRAME_FLAG_LOSSLESS

[Marton Balint]

On Tue, 7 Jan 2025, Leo Izen wrote:

> It should be more clear what this flag is indicating with a more
> verbose comment documenting it.

I guess we could bikeshed this till the end :)

Below are my suggestions, heavily based on yours of course. Feel free to 
take what you like, and omit what you don't.

>
> Signed-off-by: Leo Izen <leo.izen at gmail.com>
> ---
> libavutil/frame.h | 8 +++++++-
> 1 file changed, 7 insertions(+), 1 deletion(-)
>
> diff --git a/libavutil/frame.h b/libavutil/frame.h
> index 993fa6b65a..e3657f193f 100644
> --- a/libavutil/frame.h
> +++ b/libavutil/frame.h
> @@ -666,7 +666,13 @@ typedef struct AVFrame {
>  */
> #define AV_FRAME_FLAG_TOP_FIELD_FIRST (1 << 4)
> /**
> - * A flag to mark frames which were encoded losslessly from the input.
> + * A flag to mark frames that a decoder has determined were originally encoded
> + * losslessly.

A decoder can use this flag to mark frames which were originally encoded 
losslessly.

> + *
> + * For coding bitstream formats which support both lossless and lossy
> + * encoding, it is sometimes possible for a decoder to determine which method
> + * was used when the bitsream was encoded.

For codecs which support both lossless and lossy encoding it might be 
possible to determine which was used based on bitstream flags or coding 
methods.

> Frames marked with this flag
> + * have been identified by a decoder as having been losslessly encoded, originally.

Yeah, as others already mentioned this adds no further info, so just 
remove.

Thanks,
Marton

>  */
> #define AV_FRAME_FLAG_LOSSLESS        (1 << 5)
> /**
> -- 
> 2.47.1
>
> _______________________________________________
> 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".
>