PR #24498 opened by ambitiuswisdom
URL: https://code.ffmpeg.org/FFmpeg/FFmpeg/pulls/24498
Patch URL: https://code.ffmpeg.org/FFmpeg/FFmpeg/pulls/24498.patch

Summary:
- Move the existing libastcenc decoder documentation into the Video Decoders 
section.
- Keep the documented decoder behavior and options unchanged.

Reason:
libastcenc is a video decoder, but its documentation was located in the
audio decoder section, causing incorrect categorization in generated docs.

This is a documentation-only change. 



>From 7797fb3ee3620ed4f466d6db3825e12243053055 Mon Sep 17 00:00:00 2001
From: Ruonan <[email protected]>
Date: Tue, 15 Sep 2026 13:49:04 +0800
Subject: [PATCH] doc/decoders: move libastcenc into video section

The libastcenc wrapper decodes AVMEDIA_TYPE_VIDEO ASTC frames, but its
documentation was placed after the audio decoder chapter started. Move
the existing section next to the other video decoders so generated
documentation classifies it correctly.
---
 doc/decoders.texi | 70 +++++++++++++++++++++++------------------------
 1 file changed, 35 insertions(+), 35 deletions(-)

diff --git a/doc/decoders.texi b/doc/decoders.texi
index 73348f8ee1..5652252233 100644
--- a/doc/decoders.texi
+++ b/doc/decoders.texi
@@ -105,6 +105,41 @@ top-field-first is assumed
 
 @end table
 
+@section libastcenc
+
+ARM ASTC Encoder wrapper for decoding ASTC textures.
+
+This decoder requires the Arm ASTC Encoder (astc-encoder) library version
+5.4 or newer, installed as @code{astcenc/astcenc.h} next to a library that
+@code{-lastcenc} finds. Pass @code{--enable-version3} together with
+@code{--enable-libastcenc} to configure.
+
+The @file{.astc} header does not record the intended decoding profile.
+Individual blocks identify their endpoint encodings, but this does not
+establish the sRGB versus linear interpretation. The decoder therefore uses
+the container metadata or @option{dec_profile}: a KTX sRGB texture is decoded
+as @code{ldr-srgb}, while a KTX texture in the linear format is sampled with
+HDR precision (@code{hdr-ldr-a}, half-float output) because the linear GL
+internal format says nothing about LDR. A raw @code{.astc} file carries no
+profile at all, so it falls back to @code{ldr-srgb}; use @option{dec_profile}
+for a raw HDR image:
+
+@example
+ffmpeg -dec_profile hdr-ldr-a -i input.astc output.png
+@end example
+
+@subsection Options
+@table @option
+@item dec_profile @var{int}
+Color profile to decode with, overriding the container metadata. It must
+match the profile the texture was encoded with: @code{astcenc} substitutes
+a fixed magenta error color for blocks whose endpoints do not fit the
+selected profile. The values are @code{ldr}, @code{ldr-srgb},
+@code{hdr-ldr-a} and @code{hdr}. Without this option the profile published
+by the container is used; a raw @file{.astc} stream, which publishes none,
+falls back to @code{ldr-srgb}.
+@end table
+
 @section libdav1d
 
 dav1d AV1 decoder.
@@ -299,41 +334,6 @@ correctly by using lavc's old buggy lpc logic for decoding.
 
 @end table
 
-@section libastcenc
-
-ARM ASTC Encoder wrapper for decoding ASTC textures.
-
-This decoder requires the Arm ASTC Encoder (astc-encoder) library version
-5.4 or newer, installed as @code{astcenc/astcenc.h} next to a library that
-@code{-lastcenc} finds. Pass @code{--enable-version3} together with
-@code{--enable-libastcenc} to configure.
-
-The @file{.astc} header does not record the intended decoding profile.
-Individual blocks identify their endpoint encodings, but this does not
-establish the sRGB versus linear interpretation. The decoder therefore uses
-the container metadata or @option{dec_profile}: a KTX sRGB texture is decoded
-as @code{ldr-srgb}, while a KTX texture in the linear format is sampled with
-HDR precision (@code{hdr-ldr-a}, half-float output) because the linear GL
-internal format says nothing about LDR. A raw @code{.astc} file carries no
-profile at all, so it falls back to @code{ldr-srgb}; use @option{dec_profile}
-for a raw HDR image:
-
-@example
-ffmpeg -dec_profile hdr-ldr-a -i input.astc output.png
-@end example
-
-@subsection Options
-@table @option
-@item dec_profile @var{int}
-Color profile to decode with, overriding the container metadata. It must
-match the profile the texture was encoded with: @code{astcenc} substitutes
-a fixed magenta error color for blocks whose endpoints do not fit the
-selected profile. The values are @code{ldr}, @code{ldr-srgb},
-@code{hdr-ldr-a} and @code{hdr}. Without this option the profile published
-by the container is used; a raw @file{.astc} stream, which publishes none,
-falls back to @code{ldr-srgb}.
-@end table
-
 @section ffwavesynth
 
 Internal wave synthesizer.
-- 
2.52.0

_______________________________________________
ffmpeg-devel mailing list -- [email protected]
To unsubscribe send an email to [email protected]

Reply via email to