Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
 help / color / mirror / Atom feed
* [FFmpeg-devel] Rename examples, apply consistency fixes
@ 2023-01-15 16:10 Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 01/15] examples: rename avio_reading to avio_read_callback Stefano Sabatini
                   ` (14 more replies)
  0 siblings, 15 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches

Apply consistent VERB_OBJECT scheme for examples, apply consistency
fixes to doxy content.


_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 01/15] examples: rename avio_reading to avio_read_callback
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-25  0:28   ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 02/15] examples: rename demuxing_decoding to demux_decode Stefano Sabatini
                   ` (13 subsequent siblings)
  14 siblings, 1 reply; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

Adopt general scheme VERB_OBJECT.
---
 configure                                             | 4 ++--
 doc/examples/Makefile                                 | 2 +-
 doc/examples/Makefile.example                         | 2 +-
 doc/examples/{avio_reading.c => avio_read_callback.c} | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename doc/examples/{avio_reading.c => avio_read_callback.c} (99%)

diff --git a/configure b/configure
index df69d39669..81acf17e08 100755
--- a/configure
+++ b/configure
@@ -1711,7 +1711,7 @@ COMPONENT_LIST="
 
 EXAMPLE_LIST="
     avio_list_dir_example
-    avio_reading_example
+    avio_read_callback_example
     decode_audio_example
     decode_video_example
     demuxing_decoding_example
@@ -3768,7 +3768,7 @@ yadif_videotoolbox_filter_deps="metal corevideo videotoolbox"
 
 # examples
 avio_list_dir_deps="avformat avutil"
-avio_reading_deps="avformat avcodec avutil"
+avio_read_callback_deps="avformat avcodec avutil"
 decode_audio_example_deps="avcodec avutil"
 decode_video_example_deps="avcodec avutil"
 demuxing_decoding_example_deps="avcodec avformat avutil"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index f937fbefda..a651f5877a 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -1,5 +1,5 @@
 EXAMPLES-$(CONFIG_AVIO_LIST_DIR_EXAMPLE)     += avio_list_dir
-EXAMPLES-$(CONFIG_AVIO_READING_EXAMPLE)      += avio_reading
+EXAMPLES-$(CONFIG_AVIO_READ_CALLBACK_EXAMPLE) += avio_read_callback
 EXAMPLES-$(CONFIG_DECODE_AUDIO_EXAMPLE)      += decode_audio
 EXAMPLES-$(CONFIG_DECODE_VIDEO_EXAMPLE)      += decode_video
 EXAMPLES-$(CONFIG_DEMUXING_DECODING_EXAMPLE) += demuxing_decoding
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index a232d97f98..bcb485e306 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -12,7 +12,7 @@ CFLAGS := $(shell pkg-config --cflags $(FFMPEG_LIBS)) $(CFLAGS)
 LDLIBS := $(shell pkg-config --libs $(FFMPEG_LIBS)) $(LDLIBS)
 
 EXAMPLES=       avio_list_dir                      \
-                avio_reading                       \
+                avio_read_callback                 \
                 decode_audio                       \
                 decode_video                       \
                 demuxing_decoding                  \
diff --git a/doc/examples/avio_reading.c b/doc/examples/avio_read_callback.c
similarity index 99%
rename from doc/examples/avio_reading.c
rename to doc/examples/avio_read_callback.c
index 36ee02afa5..e57a66bdec 100644
--- a/doc/examples/avio_reading.c
+++ b/doc/examples/avio_read_callback.c
@@ -26,7 +26,7 @@
  *
  * Make libavformat demuxer access media content through a custom
  * AVIOContext read callback.
- * @example avio_reading.c
+ * @example avio_read_callback.c
  */
 
 #include <libavcodec/avcodec.h>
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 02/15] examples: rename demuxing_decoding to demux_decode
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 01/15] examples: rename avio_reading to avio_read_callback Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 03/15] examples: rename filtering_audio to decode_filter_audio Stefano Sabatini
                   ` (12 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

Follow general scheme VERB_OBJECT.
---
 configure                                            | 4 ++--
 doc/examples/Makefile                                | 2 +-
 doc/examples/Makefile.example                        | 2 +-
 doc/examples/{demuxing_decoding.c => demux_decode.c} | 4 ++--
 4 files changed, 6 insertions(+), 6 deletions(-)
 rename doc/examples/{demuxing_decoding.c => demux_decode.c} (99%)

diff --git a/configure b/configure
index 81acf17e08..a1488c442a 100755
--- a/configure
+++ b/configure
@@ -1714,7 +1714,7 @@ EXAMPLE_LIST="
     avio_read_callback_example
     decode_audio_example
     decode_video_example
-    demuxing_decoding_example
+    demux_decode_example
     encode_audio_example
     encode_video_example
     extract_mvs_example
@@ -3771,7 +3771,7 @@ avio_list_dir_deps="avformat avutil"
 avio_read_callback_deps="avformat avcodec avutil"
 decode_audio_example_deps="avcodec avutil"
 decode_video_example_deps="avcodec avutil"
-demuxing_decoding_example_deps="avcodec avformat avutil"
+demux_decode_example_deps="avcodec avformat avutil"
 encode_audio_example_deps="avcodec avutil"
 encode_video_example_deps="avcodec avutil"
 extract_mvs_example_deps="avcodec avformat avutil"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index a651f5877a..adfcdb6aa3 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -2,7 +2,7 @@ EXAMPLES-$(CONFIG_AVIO_LIST_DIR_EXAMPLE)     += avio_list_dir
 EXAMPLES-$(CONFIG_AVIO_READ_CALLBACK_EXAMPLE) += avio_read_callback
 EXAMPLES-$(CONFIG_DECODE_AUDIO_EXAMPLE)      += decode_audio
 EXAMPLES-$(CONFIG_DECODE_VIDEO_EXAMPLE)      += decode_video
-EXAMPLES-$(CONFIG_DEMUXING_DECODING_EXAMPLE) += demuxing_decoding
+EXAMPLES-$(CONFIG_DEMUX_DECODE_EXAMPLE)      += demux_decode
 EXAMPLES-$(CONFIG_ENCODE_AUDIO_EXAMPLE)      += encode_audio
 EXAMPLES-$(CONFIG_ENCODE_VIDEO_EXAMPLE)      += encode_video
 EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index bcb485e306..33af323c6f 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -15,7 +15,7 @@ EXAMPLES=       avio_list_dir                      \
                 avio_read_callback                 \
                 decode_audio                       \
                 decode_video                       \
-                demuxing_decoding                  \
+                demux_decode                       \
                 encode_audio                       \
                 encode_video                       \
                 extract_mvs                        \
diff --git a/doc/examples/demuxing_decoding.c b/doc/examples/demux_decode.c
similarity index 99%
rename from doc/examples/demuxing_decoding.c
rename to doc/examples/demux_decode.c
index 999a78db0d..a2ca53b26b 100644
--- a/doc/examples/demuxing_decoding.c
+++ b/doc/examples/demux_decode.c
@@ -22,11 +22,11 @@
 
 /**
  * @file
- * Demuxing and decoding example.
+ * libavformat and libavcodec API example to demux and decode.
  *
  * Show how to use the libavformat and libavcodec API to demux and
  * decode audio and video data.
- * @example demuxing_decoding.c
+ * @example demux_decode.c
  */
 
 #include <libavutil/imgutils.h>
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 03/15] examples: rename filtering_audio to decode_filter_audio
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 01/15] examples: rename avio_reading to avio_read_callback Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 02/15] examples: rename demuxing_decoding to demux_decode Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 04/15] examples: rename filtering_video to decode_filter_video Stefano Sabatini
                   ` (11 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                                                 | 4 ++--
 doc/examples/Makefile                                     | 2 +-
 doc/examples/Makefile.example                             | 2 +-
 doc/examples/{filtering_audio.c => decode_filter_audio.c} | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename doc/examples/{filtering_audio.c => decode_filter_audio.c} (99%)

diff --git a/configure b/configure
index a1488c442a..69137e929a 100755
--- a/configure
+++ b/configure
@@ -1713,13 +1713,13 @@ EXAMPLE_LIST="
     avio_list_dir_example
     avio_read_callback_example
     decode_audio_example
+    decode_filter_audio_example
     decode_video_example
     demux_decode_example
     encode_audio_example
     encode_video_example
     extract_mvs_example
     filter_audio_example
-    filtering_audio_example
     filtering_video_example
     http_multiclient_example
     hw_decode_example
@@ -3770,13 +3770,13 @@ yadif_videotoolbox_filter_deps="metal corevideo videotoolbox"
 avio_list_dir_deps="avformat avutil"
 avio_read_callback_deps="avformat avcodec avutil"
 decode_audio_example_deps="avcodec avutil"
+decode_filter_audio_example_deps="avfilter avcodec avformat avutil"
 decode_video_example_deps="avcodec avutil"
 demux_decode_example_deps="avcodec avformat avutil"
 encode_audio_example_deps="avcodec avutil"
 encode_video_example_deps="avcodec avutil"
 extract_mvs_example_deps="avcodec avformat avutil"
 filter_audio_example_deps="avfilter avutil"
-filtering_audio_example_deps="avfilter avcodec avformat avutil"
 filtering_video_example_deps="avfilter avcodec avformat avutil"
 http_multiclient_example_deps="avformat avutil fork"
 hw_decode_example_deps="avcodec avformat avutil"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index adfcdb6aa3..2e97605d5e 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -1,13 +1,13 @@
 EXAMPLES-$(CONFIG_AVIO_LIST_DIR_EXAMPLE)     += avio_list_dir
 EXAMPLES-$(CONFIG_AVIO_READ_CALLBACK_EXAMPLE) += avio_read_callback
 EXAMPLES-$(CONFIG_DECODE_AUDIO_EXAMPLE)      += decode_audio
+EXAMPLES-$(CONFIG_DECODE_FILTER_AUDIO_EXAMPLE) += decode_filter_audio
 EXAMPLES-$(CONFIG_DECODE_VIDEO_EXAMPLE)      += decode_video
 EXAMPLES-$(CONFIG_DEMUX_DECODE_EXAMPLE)      += demux_decode
 EXAMPLES-$(CONFIG_ENCODE_AUDIO_EXAMPLE)      += encode_audio
 EXAMPLES-$(CONFIG_ENCODE_VIDEO_EXAMPLE)      += encode_video
 EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
 EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
-EXAMPLES-$(CONFIG_FILTERING_AUDIO_EXAMPLE)   += filtering_audio
 EXAMPLES-$(CONFIG_FILTERING_VIDEO_EXAMPLE)   += filtering_video
 EXAMPLES-$(CONFIG_HTTP_MULTICLIENT_EXAMPLE)  += http_multiclient
 EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index 33af323c6f..e720dc2008 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -14,13 +14,13 @@ LDLIBS := $(shell pkg-config --libs $(FFMPEG_LIBS)) $(LDLIBS)
 EXAMPLES=       avio_list_dir                      \
                 avio_read_callback                 \
                 decode_audio                       \
+                decode_filter_audio                \
                 decode_video                       \
                 demux_decode                       \
                 encode_audio                       \
                 encode_video                       \
                 extract_mvs                        \
                 filtering_video                    \
-                filtering_audio                    \
                 http_multiclient                   \
                 hw_decode                          \
                 metadata                           \
diff --git a/doc/examples/filtering_audio.c b/doc/examples/decode_filter_audio.c
similarity index 99%
rename from doc/examples/filtering_audio.c
rename to doc/examples/decode_filter_audio.c
index 51fc47be2a..607237bf11 100644
--- a/doc/examples/filtering_audio.c
+++ b/doc/examples/decode_filter_audio.c
@@ -25,7 +25,7 @@
 /**
  * @file
  * API example for audio decoding and filtering
- * @example filtering_audio.c
+ * @example decode_filter_audio.c
  */
 
 #include <unistd.h>
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 04/15] examples: rename filtering_video to decode_filter_video
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (2 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 03/15] examples: rename filtering_audio to decode_filter_audio Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 05/15] examples: rename http_multiclient to avio_http_serve_files Stefano Sabatini
                   ` (10 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                                                 | 4 ++--
 doc/examples/Makefile                                     | 2 +-
 doc/examples/Makefile.example                             | 2 +-
 doc/examples/{filtering_video.c => decode_filter_video.c} | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename doc/examples/{filtering_video.c => decode_filter_video.c} (99%)

diff --git a/configure b/configure
index 69137e929a..a79bc785f3 100755
--- a/configure
+++ b/configure
@@ -1714,13 +1714,13 @@ EXAMPLE_LIST="
     avio_read_callback_example
     decode_audio_example
     decode_filter_audio_example
+    decode_filter_video_example
     decode_video_example
     demux_decode_example
     encode_audio_example
     encode_video_example
     extract_mvs_example
     filter_audio_example
-    filtering_video_example
     http_multiclient_example
     hw_decode_example
     metadata_example
@@ -3771,13 +3771,13 @@ avio_list_dir_deps="avformat avutil"
 avio_read_callback_deps="avformat avcodec avutil"
 decode_audio_example_deps="avcodec avutil"
 decode_filter_audio_example_deps="avfilter avcodec avformat avutil"
+decode_filter_video_example_deps="avfilter avcodec avformat avutil"
 decode_video_example_deps="avcodec avutil"
 demux_decode_example_deps="avcodec avformat avutil"
 encode_audio_example_deps="avcodec avutil"
 encode_video_example_deps="avcodec avutil"
 extract_mvs_example_deps="avcodec avformat avutil"
 filter_audio_example_deps="avfilter avutil"
-filtering_video_example_deps="avfilter avcodec avformat avutil"
 http_multiclient_example_deps="avformat avutil fork"
 hw_decode_example_deps="avcodec avformat avutil"
 metadata_example_deps="avformat avutil"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index 2e97605d5e..ba3a3b712a 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -2,13 +2,13 @@ EXAMPLES-$(CONFIG_AVIO_LIST_DIR_EXAMPLE)     += avio_list_dir
 EXAMPLES-$(CONFIG_AVIO_READ_CALLBACK_EXAMPLE) += avio_read_callback
 EXAMPLES-$(CONFIG_DECODE_AUDIO_EXAMPLE)      += decode_audio
 EXAMPLES-$(CONFIG_DECODE_FILTER_AUDIO_EXAMPLE) += decode_filter_audio
+EXAMPLES-$(CONFIG_DECODE_FILTER_VIDEO_EXAMPLE) += decode_filter_video
 EXAMPLES-$(CONFIG_DECODE_VIDEO_EXAMPLE)      += decode_video
 EXAMPLES-$(CONFIG_DEMUX_DECODE_EXAMPLE)      += demux_decode
 EXAMPLES-$(CONFIG_ENCODE_AUDIO_EXAMPLE)      += encode_audio
 EXAMPLES-$(CONFIG_ENCODE_VIDEO_EXAMPLE)      += encode_video
 EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
 EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
-EXAMPLES-$(CONFIG_FILTERING_VIDEO_EXAMPLE)   += filtering_video
 EXAMPLES-$(CONFIG_HTTP_MULTICLIENT_EXAMPLE)  += http_multiclient
 EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
 EXAMPLES-$(CONFIG_METADATA_EXAMPLE)          += metadata
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index e720dc2008..3383bb61fe 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -15,12 +15,12 @@ EXAMPLES=       avio_list_dir                      \
                 avio_read_callback                 \
                 decode_audio                       \
                 decode_filter_audio                \
+                decode_filter_video                \
                 decode_video                       \
                 demux_decode                       \
                 encode_audio                       \
                 encode_video                       \
                 extract_mvs                        \
-                filtering_video                    \
                 http_multiclient                   \
                 hw_decode                          \
                 metadata                           \
diff --git a/doc/examples/filtering_video.c b/doc/examples/decode_filter_video.c
similarity index 99%
rename from doc/examples/filtering_video.c
rename to doc/examples/decode_filter_video.c
index 7b3e16c40c..454c19222f 100644
--- a/doc/examples/filtering_video.c
+++ b/doc/examples/decode_filter_video.c
@@ -24,7 +24,7 @@
 /**
  * @file
  * API example for decoding and filtering
- * @example filtering_video.c
+ * @example decode_filter_video.c
  */
 
 #define _XOPEN_SOURCE 600 /* for usleep */
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 05/15] examples: rename http_multiclient to avio_http_serve_files
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (3 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 04/15] examples: rename filtering_video to decode_filter_video Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 06/15] examples: rename metadata to show_metadata Stefano Sabatini
                   ` (9 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                                                    | 4 ++--
 doc/examples/Makefile                                        | 2 +-
 doc/examples/Makefile.example                                | 5 +++--
 doc/examples/{http_multiclient.c => avio_http_serve_files.c} | 2 +-
 4 files changed, 7 insertions(+), 6 deletions(-)
 rename doc/examples/{http_multiclient.c => avio_http_serve_files.c} (99%)

diff --git a/configure b/configure
index a79bc785f3..8c2bb6fab5 100755
--- a/configure
+++ b/configure
@@ -1710,6 +1710,7 @@ COMPONENT_LIST="
 "
 
 EXAMPLE_LIST="
+    avio_http_serve_files_example
     avio_list_dir_example
     avio_read_callback_example
     decode_audio_example
@@ -1721,7 +1722,6 @@ EXAMPLE_LIST="
     encode_video_example
     extract_mvs_example
     filter_audio_example
-    http_multiclient_example
     hw_decode_example
     metadata_example
     muxing_example
@@ -3767,6 +3767,7 @@ yadif_cuda_filter_deps_any="cuda_nvcc cuda_llvm"
 yadif_videotoolbox_filter_deps="metal corevideo videotoolbox"
 
 # examples
+avio_http_serve_files_deps="avformat avutil fork"
 avio_list_dir_deps="avformat avutil"
 avio_read_callback_deps="avformat avcodec avutil"
 decode_audio_example_deps="avcodec avutil"
@@ -3778,7 +3779,6 @@ encode_audio_example_deps="avcodec avutil"
 encode_video_example_deps="avcodec avutil"
 extract_mvs_example_deps="avcodec avformat avutil"
 filter_audio_example_deps="avfilter avutil"
-http_multiclient_example_deps="avformat avutil fork"
 hw_decode_example_deps="avcodec avformat avutil"
 metadata_example_deps="avformat avutil"
 muxing_example_deps="avcodec avformat avutil swscale"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index ba3a3b712a..f640a5e636 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -1,3 +1,4 @@
+EXAMPLES-$(CONFIG_AVIO_HTTP_SERVE_FILES)     += avio_http_serve_files
 EXAMPLES-$(CONFIG_AVIO_LIST_DIR_EXAMPLE)     += avio_list_dir
 EXAMPLES-$(CONFIG_AVIO_READ_CALLBACK_EXAMPLE) += avio_read_callback
 EXAMPLES-$(CONFIG_DECODE_AUDIO_EXAMPLE)      += decode_audio
@@ -9,7 +10,6 @@ EXAMPLES-$(CONFIG_ENCODE_AUDIO_EXAMPLE)      += encode_audio
 EXAMPLES-$(CONFIG_ENCODE_VIDEO_EXAMPLE)      += encode_video
 EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
 EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
-EXAMPLES-$(CONFIG_HTTP_MULTICLIENT_EXAMPLE)  += http_multiclient
 EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
 EXAMPLES-$(CONFIG_METADATA_EXAMPLE)          += metadata
 EXAMPLES-$(CONFIG_MUXING_EXAMPLE)            += muxing
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index 3383bb61fe..9e725715a5 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -11,7 +11,9 @@ CFLAGS += -Wall -g
 CFLAGS := $(shell pkg-config --cflags $(FFMPEG_LIBS)) $(CFLAGS)
 LDLIBS := $(shell pkg-config --libs $(FFMPEG_LIBS)) $(LDLIBS)
 
-EXAMPLES=       avio_list_dir                      \
+EXAMPLES=\
+                avio_http_serve_files              \
+                avio_list_dir                      \
                 avio_read_callback                 \
                 decode_audio                       \
                 decode_filter_audio                \
@@ -21,7 +23,6 @@ EXAMPLES=       avio_list_dir                      \
                 encode_audio                       \
                 encode_video                       \
                 extract_mvs                        \
-                http_multiclient                   \
                 hw_decode                          \
                 metadata                           \
                 muxing                             \
diff --git a/doc/examples/http_multiclient.c b/doc/examples/avio_http_serve_files.c
similarity index 99%
rename from doc/examples/http_multiclient.c
rename to doc/examples/avio_http_serve_files.c
index 831e89c60a..d6a1d146f3 100644
--- a/doc/examples/http_multiclient.c
+++ b/doc/examples/avio_http_serve_files.c
@@ -24,7 +24,7 @@
  * @file
  * libavformat multi-client network API usage example.
  *
- * @example http_multiclient.c
+ * @example avio_http_serve_files.c
  * This example will serve a file without decoding or demuxing it over http.
  * Multiple clients can connect and will receive the same file.
  */
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 06/15] examples: rename metadata to show_metadata
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (4 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 05/15] examples: rename http_multiclient to avio_http_serve_files Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 07/15] examples: rename muxing to mux Stefano Sabatini
                   ` (8 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                                    | 4 ++--
 doc/examples/Makefile                        | 2 +-
 doc/examples/Makefile.example                | 2 +-
 doc/examples/{metadata.c => show_metadata.c} | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename doc/examples/{metadata.c => show_metadata.c} (98%)

diff --git a/configure b/configure
index 8c2bb6fab5..419bd03221 100755
--- a/configure
+++ b/configure
@@ -1723,12 +1723,12 @@ EXAMPLE_LIST="
     extract_mvs_example
     filter_audio_example
     hw_decode_example
-    metadata_example
     muxing_example
     qsvdec_example
     remuxing_example
     resampling_audio_example
     scaling_video_example
+    show_metadata_example
     transcode_aac_example
     transcoding_example
     vaapi_encode_example
@@ -3780,12 +3780,12 @@ encode_video_example_deps="avcodec avutil"
 extract_mvs_example_deps="avcodec avformat avutil"
 filter_audio_example_deps="avfilter avutil"
 hw_decode_example_deps="avcodec avformat avutil"
-metadata_example_deps="avformat avutil"
 muxing_example_deps="avcodec avformat avutil swscale"
 qsvdec_example_deps="avcodec avutil libmfx h264_qsv_decoder"
 remuxing_example_deps="avcodec avformat avutil"
 resampling_audio_example_deps="avutil swresample"
 scaling_video_example_deps="avutil swscale"
+show_metadata_example_deps="avformat avutil"
 transcode_aac_example_deps="avcodec avformat swresample"
 transcoding_example_deps="avfilter avcodec avformat avutil"
 vaapi_encode_example_deps="avcodec avutil h264_vaapi_encoder"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index f640a5e636..44a56dd84d 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -11,12 +11,12 @@ EXAMPLES-$(CONFIG_ENCODE_VIDEO_EXAMPLE)      += encode_video
 EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
 EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
 EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
-EXAMPLES-$(CONFIG_METADATA_EXAMPLE)          += metadata
 EXAMPLES-$(CONFIG_MUXING_EXAMPLE)            += muxing
 EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE)            += qsvdec
 EXAMPLES-$(CONFIG_REMUXING_EXAMPLE)          += remuxing
 EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
 EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
+EXAMPLES-$(CONFIG_SHOW_METADATA_EXAMPLE)     += show_metadata
 EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)     += transcode_aac
 EXAMPLES-$(CONFIG_TRANSCODING_EXAMPLE)       += transcoding
 EXAMPLES-$(CONFIG_VAAPI_ENCODE_EXAMPLE)      += vaapi_encode
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index 9e725715a5..db09ceddd1 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -24,11 +24,11 @@ EXAMPLES=\
                 encode_video                       \
                 extract_mvs                        \
                 hw_decode                          \
-                metadata                           \
                 muxing                             \
                 remuxing                           \
                 resampling_audio                   \
                 scaling_video                      \
+                show_metadata                      \
                 transcode_aac                      \
                 transcoding                        \
 
diff --git a/doc/examples/metadata.c b/doc/examples/show_metadata.c
similarity index 98%
rename from doc/examples/metadata.c
rename to doc/examples/show_metadata.c
index 734b12df16..f7f07bf598 100644
--- a/doc/examples/metadata.c
+++ b/doc/examples/show_metadata.c
@@ -23,7 +23,7 @@
 /**
  * @file
  * Shows how the metadata API can be used in application programs.
- * @example metadata.c
+ * @example show_metadata.c
  */
 
 #include <stdio.h>
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 07/15] examples: rename muxing to mux
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (5 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 06/15] examples: rename metadata to show_metadata Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 08/15] examples: rename qsvdec to qsv_decode Stefano Sabatini
                   ` (7 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                        | 4 ++--
 doc/examples/Makefile            | 2 +-
 doc/examples/Makefile.example    | 2 +-
 doc/examples/encode_video.c      | 2 +-
 doc/examples/{muxing.c => mux.c} | 2 +-
 5 files changed, 6 insertions(+), 6 deletions(-)
 rename doc/examples/{muxing.c => mux.c} (99%)

diff --git a/configure b/configure
index 419bd03221..b65fdc6187 100755
--- a/configure
+++ b/configure
@@ -1723,7 +1723,7 @@ EXAMPLE_LIST="
     extract_mvs_example
     filter_audio_example
     hw_decode_example
-    muxing_example
+    mux_example
     qsvdec_example
     remuxing_example
     resampling_audio_example
@@ -3780,7 +3780,7 @@ encode_video_example_deps="avcodec avutil"
 extract_mvs_example_deps="avcodec avformat avutil"
 filter_audio_example_deps="avfilter avutil"
 hw_decode_example_deps="avcodec avformat avutil"
-muxing_example_deps="avcodec avformat avutil swscale"
+mux_example_deps="avcodec avformat avutil swscale"
 qsvdec_example_deps="avcodec avutil libmfx h264_qsv_decoder"
 remuxing_example_deps="avcodec avformat avutil"
 resampling_audio_example_deps="avutil swresample"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index 44a56dd84d..c91d26e4a0 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -11,7 +11,7 @@ EXAMPLES-$(CONFIG_ENCODE_VIDEO_EXAMPLE)      += encode_video
 EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
 EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
 EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
-EXAMPLES-$(CONFIG_MUXING_EXAMPLE)            += muxing
+EXAMPLES-$(CONFIG_MUX_EXAMPLE)               += mux
 EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE)            += qsvdec
 EXAMPLES-$(CONFIG_REMUXING_EXAMPLE)          += remuxing
 EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index db09ceddd1..920c7a2362 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -24,7 +24,7 @@ EXAMPLES=\
                 encode_video                       \
                 extract_mvs                        \
                 hw_decode                          \
-                muxing                             \
+                mux                                \
                 remuxing                           \
                 resampling_audio                   \
                 scaling_video                      \
diff --git a/doc/examples/encode_video.c b/doc/examples/encode_video.c
index 939ed68324..6c3a3f5684 100644
--- a/doc/examples/encode_video.c
+++ b/doc/examples/encode_video.c
@@ -202,7 +202,7 @@ int main(int argc, char **argv)
        It makes only sense because this tiny examples writes packets
        directly. This is called "elementary stream" and only works for some
        codecs. To create a valid file, you usually need to write packets
-       into a proper file format or protocol; see muxing.c.
+       into a proper file format or protocol; see mux.c.
      */
     if (codec->id == AV_CODEC_ID_MPEG1VIDEO || codec->id == AV_CODEC_ID_MPEG2VIDEO)
         fwrite(endcode, 1, sizeof(endcode), f);
diff --git a/doc/examples/muxing.c b/doc/examples/mux.c
similarity index 99%
rename from doc/examples/muxing.c
rename to doc/examples/mux.c
index cd997d5431..e3062c5003 100644
--- a/doc/examples/muxing.c
+++ b/doc/examples/mux.c
@@ -26,7 +26,7 @@
  *
  * Output a media file in any supported libavformat format. The default
  * codecs are used.
- * @example muxing.c
+ * @example mux.c
  */
 
 #include <stdlib.h>
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 08/15] examples: rename qsvdec to qsv_decode
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (6 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 07/15] examples: rename muxing to mux Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 09/15] examples: rename remuxing to remux Stefano Sabatini
                   ` (6 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                               | 4 ++--
 doc/examples/Makefile                   | 2 +-
 doc/examples/{qsvdec.c => qsv_decode.c} | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)
 rename doc/examples/{qsvdec.c => qsv_decode.c} (99%)

diff --git a/configure b/configure
index b65fdc6187..e277014e26 100755
--- a/configure
+++ b/configure
@@ -1724,7 +1724,7 @@ EXAMPLE_LIST="
     filter_audio_example
     hw_decode_example
     mux_example
-    qsvdec_example
+    qsv_decode_example
     remuxing_example
     resampling_audio_example
     scaling_video_example
@@ -3781,7 +3781,7 @@ extract_mvs_example_deps="avcodec avformat avutil"
 filter_audio_example_deps="avfilter avutil"
 hw_decode_example_deps="avcodec avformat avutil"
 mux_example_deps="avcodec avformat avutil swscale"
-qsvdec_example_deps="avcodec avutil libmfx h264_qsv_decoder"
+qsv_decode_example_deps="avcodec avutil libmfx h264_qsv_decoder"
 remuxing_example_deps="avcodec avformat avutil"
 resampling_audio_example_deps="avutil swresample"
 scaling_video_example_deps="avutil swscale"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index c91d26e4a0..9342fae744 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -12,7 +12,7 @@ EXAMPLES-$(CONFIG_EXTRACT_MVS_EXAMPLE)       += extract_mvs
 EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
 EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
 EXAMPLES-$(CONFIG_MUX_EXAMPLE)               += mux
-EXAMPLES-$(CONFIG_QSVDEC_EXAMPLE)            += qsvdec
+EXAMPLES-$(CONFIG_QSV_DECODE_EXAMPLE)        += qsv_decode
 EXAMPLES-$(CONFIG_REMUXING_EXAMPLE)          += remuxing
 EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
 EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
diff --git a/doc/examples/qsvdec.c b/doc/examples/qsv_decode.c
similarity index 99%
rename from doc/examples/qsvdec.c
rename to doc/examples/qsv_decode.c
index b662ae91c3..0cdef4466c 100644
--- a/doc/examples/qsvdec.c
+++ b/doc/examples/qsv_decode.c
@@ -24,7 +24,7 @@
  * @file
  * Intel QSV-accelerated H.264 decoding example.
  *
- * @example qsvdec.c
+ * @example qsv_decode.c
  * This example shows how to do QSV-accelerated H.264 decoding with output
  * frames in the GPU video surfaces.
  */
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 09/15] examples: rename remuxing to remux
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (7 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 08/15] examples: rename qsvdec to qsv_decode Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 10/15] examples: rename resampling audio to resample_audio Stefano Sabatini
                   ` (5 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                            | 4 ++--
 doc/examples/Makefile                | 2 +-
 doc/examples/Makefile.example        | 2 +-
 doc/examples/{remuxing.c => remux.c} | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename doc/examples/{remuxing.c => remux.c} (99%)

diff --git a/configure b/configure
index e277014e26..f8059d2a68 100755
--- a/configure
+++ b/configure
@@ -1725,7 +1725,7 @@ EXAMPLE_LIST="
     hw_decode_example
     mux_example
     qsv_decode_example
-    remuxing_example
+    remux_example
     resampling_audio_example
     scaling_video_example
     show_metadata_example
@@ -3782,7 +3782,7 @@ filter_audio_example_deps="avfilter avutil"
 hw_decode_example_deps="avcodec avformat avutil"
 mux_example_deps="avcodec avformat avutil swscale"
 qsv_decode_example_deps="avcodec avutil libmfx h264_qsv_decoder"
-remuxing_example_deps="avcodec avformat avutil"
+remux_example_deps="avcodec avformat avutil"
 resampling_audio_example_deps="avutil swresample"
 scaling_video_example_deps="avutil swscale"
 show_metadata_example_deps="avformat avutil"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index 9342fae744..8cc9d4e80e 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -13,7 +13,7 @@ EXAMPLES-$(CONFIG_FILTER_AUDIO_EXAMPLE)      += filter_audio
 EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
 EXAMPLES-$(CONFIG_MUX_EXAMPLE)               += mux
 EXAMPLES-$(CONFIG_QSV_DECODE_EXAMPLE)        += qsv_decode
-EXAMPLES-$(CONFIG_REMUXING_EXAMPLE)          += remuxing
+EXAMPLES-$(CONFIG_REMUX_EXAMPLE)             += remux
 EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
 EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
 EXAMPLES-$(CONFIG_SHOW_METADATA_EXAMPLE)     += show_metadata
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index 920c7a2362..ff30f9a3da 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -25,7 +25,7 @@ EXAMPLES=\
                 extract_mvs                        \
                 hw_decode                          \
                 mux                                \
-                remuxing                           \
+                remux                              \
                 resampling_audio                   \
                 scaling_video                      \
                 show_metadata                      \
diff --git a/doc/examples/remuxing.c b/doc/examples/remux.c
similarity index 99%
rename from doc/examples/remuxing.c
rename to doc/examples/remux.c
index 2657f9dc66..8855199c60 100644
--- a/doc/examples/remuxing.c
+++ b/doc/examples/remux.c
@@ -25,7 +25,7 @@
  * libavformat/libavcodec demuxing and muxing API example.
  *
  * Remux streams from one container format to another.
- * @example remuxing.c
+ * @example remux.c
  */
 
 #include <libavutil/timestamp.h>
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 10/15] examples: rename resampling audio to resample_audio
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (8 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 09/15] examples: rename remuxing to remux Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 11/15] examples: rename scaling_video to scale_video Stefano Sabatini
                   ` (4 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                                             | 4 ++--
 doc/examples/Makefile                                 | 2 +-
 doc/examples/Makefile.example                         | 2 +-
 doc/examples/{resampling_audio.c => resample_audio.c} | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename doc/examples/{resampling_audio.c => resample_audio.c} (99%)

diff --git a/configure b/configure
index f8059d2a68..e767f9da79 100755
--- a/configure
+++ b/configure
@@ -1726,7 +1726,7 @@ EXAMPLE_LIST="
     mux_example
     qsv_decode_example
     remux_example
-    resampling_audio_example
+    resample_audio_example
     scaling_video_example
     show_metadata_example
     transcode_aac_example
@@ -3783,7 +3783,7 @@ hw_decode_example_deps="avcodec avformat avutil"
 mux_example_deps="avcodec avformat avutil swscale"
 qsv_decode_example_deps="avcodec avutil libmfx h264_qsv_decoder"
 remux_example_deps="avcodec avformat avutil"
-resampling_audio_example_deps="avutil swresample"
+resample_audio_example_deps="avutil swresample"
 scaling_video_example_deps="avutil swscale"
 show_metadata_example_deps="avformat avutil"
 transcode_aac_example_deps="avcodec avformat swresample"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index 8cc9d4e80e..4ea0d95ca1 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -14,7 +14,7 @@ EXAMPLES-$(CONFIG_HW_DECODE_EXAMPLE)         += hw_decode
 EXAMPLES-$(CONFIG_MUX_EXAMPLE)               += mux
 EXAMPLES-$(CONFIG_QSV_DECODE_EXAMPLE)        += qsv_decode
 EXAMPLES-$(CONFIG_REMUX_EXAMPLE)             += remux
-EXAMPLES-$(CONFIG_RESAMPLING_AUDIO_EXAMPLE)  += resampling_audio
+EXAMPLES-$(CONFIG_RESAMPLE_AUDIO_EXAMPLE)    += resample_audio
 EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
 EXAMPLES-$(CONFIG_SHOW_METADATA_EXAMPLE)     += show_metadata
 EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)     += transcode_aac
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index ff30f9a3da..f632c0e490 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -26,7 +26,7 @@ EXAMPLES=\
                 hw_decode                          \
                 mux                                \
                 remux                              \
-                resampling_audio                   \
+                resample_audio                     \
                 scaling_video                      \
                 show_metadata                      \
                 transcode_aac                      \
diff --git a/doc/examples/resampling_audio.c b/doc/examples/resample_audio.c
similarity index 99%
rename from doc/examples/resampling_audio.c
rename to doc/examples/resample_audio.c
index 9f1521a5a5..890d30c934 100644
--- a/doc/examples/resampling_audio.c
+++ b/doc/examples/resample_audio.c
@@ -21,7 +21,7 @@
  */
 
 /**
- * @example resampling_audio.c
+ * @example resample_audio.c
  * libswresample API use example.
  */
 
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 11/15] examples: rename scaling_video to scale_video
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (9 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 10/15] examples: rename resampling audio to resample_audio Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 12/15] examples: rename transcoding to transcode Stefano Sabatini
                   ` (3 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                                       | 4 ++--
 doc/examples/Makefile                           | 2 +-
 doc/examples/Makefile.example                   | 2 +-
 doc/examples/{scaling_video.c => scale_video.c} | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename doc/examples/{scaling_video.c => scale_video.c} (99%)

diff --git a/configure b/configure
index e767f9da79..117c9c2f7b 100755
--- a/configure
+++ b/configure
@@ -1727,7 +1727,7 @@ EXAMPLE_LIST="
     qsv_decode_example
     remux_example
     resample_audio_example
-    scaling_video_example
+    scale_video_example
     show_metadata_example
     transcode_aac_example
     transcoding_example
@@ -3784,7 +3784,7 @@ mux_example_deps="avcodec avformat avutil swscale"
 qsv_decode_example_deps="avcodec avutil libmfx h264_qsv_decoder"
 remux_example_deps="avcodec avformat avutil"
 resample_audio_example_deps="avutil swresample"
-scaling_video_example_deps="avutil swscale"
+scale_video_example_deps="avutil swscale"
 show_metadata_example_deps="avformat avutil"
 transcode_aac_example_deps="avcodec avformat swresample"
 transcoding_example_deps="avfilter avcodec avformat avutil"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index 4ea0d95ca1..a42bcd4465 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -15,7 +15,7 @@ EXAMPLES-$(CONFIG_MUX_EXAMPLE)               += mux
 EXAMPLES-$(CONFIG_QSV_DECODE_EXAMPLE)        += qsv_decode
 EXAMPLES-$(CONFIG_REMUX_EXAMPLE)             += remux
 EXAMPLES-$(CONFIG_RESAMPLE_AUDIO_EXAMPLE)    += resample_audio
-EXAMPLES-$(CONFIG_SCALING_VIDEO_EXAMPLE)     += scaling_video
+EXAMPLES-$(CONFIG_SCALE_VIDEO_EXAMPLE)       += scale_video
 EXAMPLES-$(CONFIG_SHOW_METADATA_EXAMPLE)     += show_metadata
 EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)     += transcode_aac
 EXAMPLES-$(CONFIG_TRANSCODING_EXAMPLE)       += transcoding
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index f632c0e490..da7a947830 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -27,7 +27,7 @@ EXAMPLES=\
                 mux                                \
                 remux                              \
                 resample_audio                     \
-                scaling_video                      \
+                scale_video                        \
                 show_metadata                      \
                 transcode_aac                      \
                 transcoding                        \
diff --git a/doc/examples/scaling_video.c b/doc/examples/scale_video.c
similarity index 99%
rename from doc/examples/scaling_video.c
rename to doc/examples/scale_video.c
index 587f3abe4f..27cd00996d 100644
--- a/doc/examples/scaling_video.c
+++ b/doc/examples/scale_video.c
@@ -23,7 +23,7 @@
 /**
  * @file
  * libswscale API use example.
- * @example scaling_video.c
+ * @example scale_video.c
  */
 
 #include <libavutil/imgutils.h>
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 12/15] examples: rename transcoding to transcode
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (10 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 11/15] examples: rename scaling_video to scale_video Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 13/15] examples: apply doxy entries consistency fixes Stefano Sabatini
                   ` (2 subsequent siblings)
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 configure                                   | 4 ++--
 doc/examples/Makefile                       | 2 +-
 doc/examples/Makefile.example               | 2 +-
 doc/examples/{transcoding.c => transcode.c} | 2 +-
 4 files changed, 5 insertions(+), 5 deletions(-)
 rename doc/examples/{transcoding.c => transcode.c} (99%)

diff --git a/configure b/configure
index 117c9c2f7b..81894fbc4d 100755
--- a/configure
+++ b/configure
@@ -1730,7 +1730,7 @@ EXAMPLE_LIST="
     scale_video_example
     show_metadata_example
     transcode_aac_example
-    transcoding_example
+    transcode_example
     vaapi_encode_example
     vaapi_transcode_example
     qsv_transcode_example
@@ -3787,7 +3787,7 @@ resample_audio_example_deps="avutil swresample"
 scale_video_example_deps="avutil swscale"
 show_metadata_example_deps="avformat avutil"
 transcode_aac_example_deps="avcodec avformat swresample"
-transcoding_example_deps="avfilter avcodec avformat avutil"
+transcode_example_deps="avfilter avcodec avformat avutil"
 vaapi_encode_example_deps="avcodec avutil h264_vaapi_encoder"
 vaapi_transcode_example_deps="avcodec avformat avutil h264_vaapi_encoder"
 qsv_transcode_example_deps="avcodec avformat avutil h264_qsv_encoder"
diff --git a/doc/examples/Makefile b/doc/examples/Makefile
index a42bcd4465..4efed6b11d 100644
--- a/doc/examples/Makefile
+++ b/doc/examples/Makefile
@@ -18,7 +18,7 @@ EXAMPLES-$(CONFIG_RESAMPLE_AUDIO_EXAMPLE)    += resample_audio
 EXAMPLES-$(CONFIG_SCALE_VIDEO_EXAMPLE)       += scale_video
 EXAMPLES-$(CONFIG_SHOW_METADATA_EXAMPLE)     += show_metadata
 EXAMPLES-$(CONFIG_TRANSCODE_AAC_EXAMPLE)     += transcode_aac
-EXAMPLES-$(CONFIG_TRANSCODING_EXAMPLE)       += transcoding
+EXAMPLES-$(CONFIG_TRANSCODE_EXAMPLE)         += transcode
 EXAMPLES-$(CONFIG_VAAPI_ENCODE_EXAMPLE)      += vaapi_encode
 EXAMPLES-$(CONFIG_VAAPI_TRANSCODE_EXAMPLE)   += vaapi_transcode
 EXAMPLES-$(CONFIG_QSV_TRANSCODE_EXAMPLE)     += qsv_transcode
diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index da7a947830..730d7e1a9a 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -30,7 +30,7 @@ EXAMPLES=\
                 scale_video                        \
                 show_metadata                      \
                 transcode_aac                      \
-                transcoding                        \
+                transcode                          \
 
 OBJS=$(addsuffix .o,$(EXAMPLES))
 
diff --git a/doc/examples/transcoding.c b/doc/examples/transcode.c
similarity index 99%
rename from doc/examples/transcoding.c
rename to doc/examples/transcode.c
index 013f89fc7d..b0f4fb0399 100644
--- a/doc/examples/transcoding.c
+++ b/doc/examples/transcode.c
@@ -25,7 +25,7 @@
 /**
  * @file
  * API example for demuxing, decoding, filtering, encoding and muxing
- * @example transcoding.c
+ * @example transcode.c
  */
 
 #include <libavcodec/avcodec.h>
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 13/15] examples: apply doxy entries consistency fixes
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (11 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 12/15] examples: rename transcoding to transcode Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 14/15] examples: apply consistency fixes to doxy entries Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 15/15] examples/Makefile.example: add missing entries Stefano Sabatini
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 doc/examples/avio_list_dir.c | 8 ++++++++
 doc/examples/encode_audio.c  | 2 +-
 doc/examples/encode_video.c  | 2 +-
 3 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/doc/examples/avio_list_dir.c b/doc/examples/avio_list_dir.c
index 3073baaefa..13b46e1718 100644
--- a/doc/examples/avio_list_dir.c
+++ b/doc/examples/avio_list_dir.c
@@ -20,6 +20,14 @@
  * THE SOFTWARE.
  */
 
+/**
+ * @file
+ * libavformat AVIOContext API example to list directory.
+ *
+ * Show how to list directories through the libavformat AVIOContext API.
+ * @example avio_list_dir.c
+ */
+
 #include <libavcodec/avcodec.h>
 #include <libavformat/avformat.h>
 #include <libavformat/avio.h>
diff --git a/doc/examples/encode_audio.c b/doc/examples/encode_audio.c
index 9a1792b725..4688084e29 100644
--- a/doc/examples/encode_audio.c
+++ b/doc/examples/encode_audio.c
@@ -22,7 +22,7 @@
 
 /**
  * @file
- * audio encoding with libavcodec API example.
+ * libavcodec API example to encode audio.
  *
  * @example encode_audio.c
  */
diff --git a/doc/examples/encode_video.c b/doc/examples/encode_video.c
index 6c3a3f5684..e9365e4bbd 100644
--- a/doc/examples/encode_video.c
+++ b/doc/examples/encode_video.c
@@ -22,7 +22,7 @@
 
 /**
  * @file
- * video encoding with libavcodec API example
+ * libavcodec API example to encode video
  *
  * @example encode_video.c
  */
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 14/15] examples: apply consistency fixes to doxy entries
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (12 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 13/15] examples: apply doxy entries consistency fixes Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 15/15] examples/Makefile.example: add missing entries Stefano Sabatini
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

Use consistent format for the @file field and file description.
---
 doc/examples/avio_http_serve_files.c |  9 ++++-----
 doc/examples/avio_list_dir.c         |  5 ++---
 doc/examples/avio_read_callback.c    |  5 ++---
 doc/examples/decode_audio.c          |  7 ++++---
 doc/examples/decode_filter_audio.c   |  6 ++++--
 doc/examples/decode_video.c          |  7 ++++---
 doc/examples/demux_decode.c          | 10 +++++-----
 doc/examples/encode_audio.c          |  6 +++---
 doc/examples/encode_video.c          |  6 +++---
 doc/examples/extract_mvs.c           |  8 ++++++++
 doc/examples/filter_audio.c          | 10 ++++------
 doc/examples/hw_decode.c             |  9 ++++-----
 doc/examples/mux.c                   |  9 ++++-----
 doc/examples/qsv_decode.c            |  9 ++++-----
 doc/examples/qsv_transcode.c         | 12 +++++-------
 doc/examples/remux.c                 |  8 ++++----
 doc/examples/resample_audio.c        |  6 +++++-
 doc/examples/scale_video.c           |  5 +++--
 doc/examples/show_metadata.c         |  5 +++--
 doc/examples/transcode.c             |  6 ++++--
 doc/examples/transcode_aac.c         |  9 ++++-----
 doc/examples/vaapi_encode.c          | 11 ++++-------
 doc/examples/vaapi_transcode.c       |  9 +++------
 23 files changed, 90 insertions(+), 87 deletions(-)

diff --git a/doc/examples/avio_http_serve_files.c b/doc/examples/avio_http_serve_files.c
index d6a1d146f3..2aae3870c2 100644
--- a/doc/examples/avio_http_serve_files.c
+++ b/doc/examples/avio_http_serve_files.c
@@ -21,12 +21,11 @@
  */
 
 /**
- * @file
- * libavformat multi-client network API usage example.
- *
+ * @file libavformat multi-client network API usage example
  * @example avio_http_serve_files.c
- * This example will serve a file without decoding or demuxing it over http.
- * Multiple clients can connect and will receive the same file.
+ *
+ * Serve a file without decoding or demuxing it over the HTTP protocol. Multiple
+ * clients can connect and will receive the same file.
  */
 
 #include <libavformat/avformat.h>
diff --git a/doc/examples/avio_list_dir.c b/doc/examples/avio_list_dir.c
index 13b46e1718..bb19debad3 100644
--- a/doc/examples/avio_list_dir.c
+++ b/doc/examples/avio_list_dir.c
@@ -21,11 +21,10 @@
  */
 
 /**
- * @file
- * libavformat AVIOContext API example to list directory.
+ * @file libavformat AVIOContext list directory API usage example
+ * @example avio_list_dir.c
  *
  * Show how to list directories through the libavformat AVIOContext API.
- * @example avio_list_dir.c
  */
 
 #include <libavcodec/avcodec.h>
diff --git a/doc/examples/avio_read_callback.c b/doc/examples/avio_read_callback.c
index e57a66bdec..4cf81ad72e 100644
--- a/doc/examples/avio_read_callback.c
+++ b/doc/examples/avio_read_callback.c
@@ -21,12 +21,11 @@
  */
 
 /**
- * @file
- * libavformat AVIOContext API example.
+ * @file libavformat AVIOContext read callback API usage example
+ * @example avio_read_callback.c
  *
  * Make libavformat demuxer access media content through a custom
  * AVIOContext read callback.
- * @example avio_read_callback.c
  */
 
 #include <libavcodec/avcodec.h>
diff --git a/doc/examples/decode_audio.c b/doc/examples/decode_audio.c
index 49ad22cba6..bcb3d87a69 100644
--- a/doc/examples/decode_audio.c
+++ b/doc/examples/decode_audio.c
@@ -21,10 +21,11 @@
  */
 
 /**
- * @file
- * audio decoding with libavcodec API example
- *
+ * @file libavcodec audio decoding API usage example
  * @example decode_audio.c
+ *
+ * Decode data from an MP2 input file and generate a raw audio file to
+ * be played with ffplay.
  */
 
 #include <stdio.h>
diff --git a/doc/examples/decode_filter_audio.c b/doc/examples/decode_filter_audio.c
index 607237bf11..2046419819 100644
--- a/doc/examples/decode_filter_audio.c
+++ b/doc/examples/decode_filter_audio.c
@@ -23,9 +23,11 @@
  */
 
 /**
- * @file
- * API example for audio decoding and filtering
+ * @file audio decoding and filtering usage example
  * @example decode_filter_audio.c
+ *
+ * Demux, decode and filter audio input file, generate a raw audio
+ * file to be played with ffplay.
  */
 
 #include <unistd.h>
diff --git a/doc/examples/decode_video.c b/doc/examples/decode_video.c
index 7238e38103..81ec4b50e2 100644
--- a/doc/examples/decode_video.c
+++ b/doc/examples/decode_video.c
@@ -21,10 +21,11 @@
  */
 
 /**
- * @file
- * video decoding with libavcodec API example
+ * @file libavcodec video decoding API usage example
+ * @example decode_video.c *
  *
- * @example decode_video.c
+ * Read from an MPEG1 video file, decode frames, and generate PGM images as
+ * output.
  */
 
 #include <stdio.h>
diff --git a/doc/examples/demux_decode.c b/doc/examples/demux_decode.c
index a2ca53b26b..ebef7a6114 100644
--- a/doc/examples/demux_decode.c
+++ b/doc/examples/demux_decode.c
@@ -21,12 +21,12 @@
  */
 
 /**
- * @file
- * libavformat and libavcodec API example to demux and decode.
- *
- * Show how to use the libavformat and libavcodec API to demux and
- * decode audio and video data.
+ * @file libavformat and libavcodec demuxing and decoding API usage example
  * @example demux_decode.c
+ *
+ * Show how to use the libavformat and libavcodec API to demux and decode audio
+ * and video data. Write the output as raw audio and input files to be played by
+ * ffplay.
  */
 
 #include <libavutil/imgutils.h>
diff --git a/doc/examples/encode_audio.c b/doc/examples/encode_audio.c
index 4688084e29..bb16683d94 100644
--- a/doc/examples/encode_audio.c
+++ b/doc/examples/encode_audio.c
@@ -21,10 +21,10 @@
  */
 
 /**
- * @file
- * libavcodec API example to encode audio.
- *
+ * @file libavcodec encoding audio API usage examples
  * @example encode_audio.c
+ *
+ * Generate a synthetic audio signal and encode it to an output MP2 file.
  */
 
 #include <stdint.h>
diff --git a/doc/examples/encode_video.c b/doc/examples/encode_video.c
index e9365e4bbd..4fae146f2e 100644
--- a/doc/examples/encode_video.c
+++ b/doc/examples/encode_video.c
@@ -21,10 +21,10 @@
  */
 
 /**
- * @file
- * libavcodec API example to encode video
- *
+ * @file libavcodec encoding video API usage example
  * @example encode_video.c
+ *
+ * Generate synthetic video data and encode it to an output file.
  */
 
 #include <stdio.h>
diff --git a/doc/examples/extract_mvs.c b/doc/examples/extract_mvs.c
index b80ba26bb7..5603064d72 100644
--- a/doc/examples/extract_mvs.c
+++ b/doc/examples/extract_mvs.c
@@ -21,6 +21,14 @@
  * THE SOFTWARE.
  */
 
+/**
+ * @file libavcodec motion vectors extraction API usage example
+ * @example extract_mvs.c
+ *
+ * Read from input file, decode video stream and print a motion vectors
+ * representation to stdout.
+ */
+
 #include <libavutil/motion_vector.h>
 #include <libavcodec/avcodec.h>
 #include <libavformat/avformat.h>
diff --git a/doc/examples/filter_audio.c b/doc/examples/filter_audio.c
index f53e52562b..9e4039b900 100644
--- a/doc/examples/filter_audio.c
+++ b/doc/examples/filter_audio.c
@@ -19,13 +19,11 @@
  */
 
 /**
- * @file
- * libavfilter API usage example.
- *
+ * @file libavfilter audio filtering API usage example
  * @example filter_audio.c
- * This example will generate a sine wave audio,
- * pass it through a simple filter chain, and then compute the MD5 checksum of
- * the output data.
+ *
+ * This example will generate a sine wave audio, pass it through a simple filter
+ * chain, and then compute the MD5 checksum of the output data.
  *
  * The filter chain it uses is:
  * (input) -> abuffer -> volume -> aformat -> abuffersink -> (output)
diff --git a/doc/examples/hw_decode.c b/doc/examples/hw_decode.c
index 0d23f451e6..6a4a4fb83d 100644
--- a/doc/examples/hw_decode.c
+++ b/doc/examples/hw_decode.c
@@ -24,12 +24,11 @@
  */
 
 /**
- * @file
- * HW-Accelerated decoding example.
- *
+ * @file HW-accelerated decoding API usage.example
  * @example hw_decode.c
- * This example shows how to do HW-accelerated decoding with output
- * frames from the HW video surfaces.
+ *
+ * Perform HW-accelerated decoding with output frames from HW video
+ * surfaces.
  */
 
 #include <stdio.h>
diff --git a/doc/examples/mux.c b/doc/examples/mux.c
index e3062c5003..d1f682e196 100644
--- a/doc/examples/mux.c
+++ b/doc/examples/mux.c
@@ -21,12 +21,11 @@
  */
 
 /**
- * @file
- * libavformat API example.
- *
- * Output a media file in any supported libavformat format. The default
- * codecs are used.
+ * @file libavformat muxing API usage example
  * @example mux.c
+ *
+ * Generate a synthetic audio and video signal and mux them to a media file in
+ * any supported libavformat format. The default codecs are used.
  */
 
 #include <stdlib.h>
diff --git a/doc/examples/qsv_decode.c b/doc/examples/qsv_decode.c
index 0cdef4466c..cc2662d5bd 100644
--- a/doc/examples/qsv_decode.c
+++ b/doc/examples/qsv_decode.c
@@ -21,12 +21,11 @@
  */
 
 /**
- * @file
- * Intel QSV-accelerated H.264 decoding example.
- *
+ * @file Intel QSV-accelerated H.264 decoding API usage example
  * @example qsv_decode.c
- * This example shows how to do QSV-accelerated H.264 decoding with output
- * frames in the GPU video surfaces.
+ *
+ * Perform QSV-accelerated H.264 decoding with output frames in the
+ * GPU video surfaces, write the decoded frames to an output file.
  */
 
 #include "config.h"
diff --git a/doc/examples/qsv_transcode.c b/doc/examples/qsv_transcode.c
index 9b37bbea9f..7ea3ef5674 100644
--- a/doc/examples/qsv_transcode.c
+++ b/doc/examples/qsv_transcode.c
@@ -1,6 +1,4 @@
 /*
- * Quick Sync Video (video transcoding) transcode sample
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
@@ -21,12 +19,12 @@
  */
 
 /**
- * @file
- * Intel QSV-accelerated transcoding example.
- *
+ * @file Intel QSV-accelerated video transcoding API usage example
  * @example qsv_transcode.c
- * This example shows how to do QSV-accelerated transcoding and how to
- * dynamically change encoder's option.
+ *
+ * Perform QSV-accelerated transcoding and show to dynamically change
+ * encoder's options.
+ *
  * Usage: qsv_transcode input_stream codec output_stream initial option
  *                      { frame_number new_option }
  * e.g: - qsv_transcode input.mp4 h264_qsv output_h264.mp4 "g 60"
diff --git a/doc/examples/remux.c b/doc/examples/remux.c
index 8855199c60..ecf30489f1 100644
--- a/doc/examples/remux.c
+++ b/doc/examples/remux.c
@@ -21,11 +21,11 @@
  */
 
 /**
- * @file
- * libavformat/libavcodec demuxing and muxing API example.
- *
- * Remux streams from one container format to another.
+ * @file libavformat/libavcodec demuxing and muxing API usage example
  * @example remux.c
+ *
+ * Remux streams from one container format to another. Data is copied from the
+ * input to the output without transcoding.
  */
 
 #include <libavutil/timestamp.h>
diff --git a/doc/examples/resample_audio.c b/doc/examples/resample_audio.c
index 890d30c934..db9b4e5e08 100644
--- a/doc/examples/resample_audio.c
+++ b/doc/examples/resample_audio.c
@@ -21,8 +21,12 @@
  */
 
 /**
+ * @file audio resampling API usage example
  * @example resample_audio.c
- * libswresample API use example.
+ *
+ * Generate a synthetic audio signal, and Use libswresample API to perform audio
+ * resampling. The output is written to a raw audio file to be played with
+ * ffplay.
  */
 
 #include <libavutil/opt.h>
diff --git a/doc/examples/scale_video.c b/doc/examples/scale_video.c
index 27cd00996d..cb4da4a576 100644
--- a/doc/examples/scale_video.c
+++ b/doc/examples/scale_video.c
@@ -21,9 +21,10 @@
  */
 
 /**
- * @file
- * libswscale API use example.
+ * @file libswscale API usage example
  * @example scale_video.c
+ *
+ * Generate a synthetic video signal and use libswscale to perform rescaling.
  */
 
 #include <libavutil/imgutils.h>
diff --git a/doc/examples/show_metadata.c b/doc/examples/show_metadata.c
index f7f07bf598..abe3cc0cae 100644
--- a/doc/examples/show_metadata.c
+++ b/doc/examples/show_metadata.c
@@ -21,9 +21,10 @@
  */
 
 /**
- * @file
- * Shows how the metadata API can be used in application programs.
+ * @file libavformat metadata extraction API usage example
  * @example show_metadata.c
+ *
+ * Show metadata from an input file.
  */
 
 #include <stdio.h>
diff --git a/doc/examples/transcode.c b/doc/examples/transcode.c
index b0f4fb0399..805a028ed7 100644
--- a/doc/examples/transcode.c
+++ b/doc/examples/transcode.c
@@ -23,9 +23,11 @@
  */
 
 /**
- * @file
- * API example for demuxing, decoding, filtering, encoding and muxing
+ * @file demuxing, decoding, filtering, encoding and muxing API usage example
  * @example transcode.c
+ *
+ * Convert input to output file, applying some hard-coded filter-graph on both
+ * audio and video streams.
  */
 
 #include <libavcodec/avcodec.h>
diff --git a/doc/examples/transcode_aac.c b/doc/examples/transcode_aac.c
index 2d4f9a59d3..bb5681a7c0 100644
--- a/doc/examples/transcode_aac.c
+++ b/doc/examples/transcode_aac.c
@@ -19,12 +19,11 @@
  */
 
 /**
- * @file
- * Simple audio converter
- *
+ * @file audio transcoding to MPEG/AAC API usage example
  * @example transcode_aac.c
- * Convert an input audio file to AAC in an MP4 container using FFmpeg.
- * Formats other than MP4 are supported based on the output file extension.
+ *
+ * Convert an input audio file to AAC in an MP4 container. Formats other than
+ * MP4 are supported based on the output file extension.
  * @author Andreas Unterweger (dustsigns@gmail.com)
  */
 
diff --git a/doc/examples/vaapi_encode.c b/doc/examples/vaapi_encode.c
index e232fa579a..d5f472f6dd 100644
--- a/doc/examples/vaapi_encode.c
+++ b/doc/examples/vaapi_encode.c
@@ -1,6 +1,4 @@
 /*
- * Video Acceleration API (video encoding) encode sample
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
@@ -21,13 +19,12 @@
  */
 
 /**
- * @file
- * Intel VAAPI-accelerated encoding example.
- *
+ * @file Intel VAAPI-accelerated encoding API usage example
  * @example vaapi_encode.c
- * This example shows how to do VAAPI-accelerated encoding. now only support NV12
- * raw file, usage like: vaapi_encode 1920 1080 input.yuv output.h264
  *
+ * Perform VAAPI-accelerated encoding. Read input from an NV12 raw
+ * file, and write the H.264 encoded data to an output raw file.
+ * Usage: vaapi_encode 1920 1080 input.yuv output.h264
  */
 
 #include <stdio.h>
diff --git a/doc/examples/vaapi_transcode.c b/doc/examples/vaapi_transcode.c
index a174bb643a..8367cb3040 100644
--- a/doc/examples/vaapi_transcode.c
+++ b/doc/examples/vaapi_transcode.c
@@ -1,6 +1,4 @@
 /*
- * Video Acceleration API (video transcoding) transcode sample
- *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
@@ -21,11 +19,10 @@
  */
 
 /**
- * @file
- * Intel VAAPI-accelerated transcoding example.
- *
+ * @file Intel VAAPI-accelerated transcoding API usage example
  * @example vaapi_transcode.c
- * This example shows how to do VAAPI-accelerated transcoding.
+ *
+ * Perform VAAPI-accelerated transcoding.
  * Usage: vaapi_transcode input_stream codec output_stream
  * e.g: - vaapi_transcode input.mp4 h264_vaapi output_h264.mp4
  *      - vaapi_transcode input.mp4 vp9_vaapi output_vp9.ivf
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* [FFmpeg-devel] [PATCH 15/15] examples/Makefile.example: add missing entries
  2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
                   ` (13 preceding siblings ...)
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 14/15] examples: apply consistency fixes to doxy entries Stefano Sabatini
@ 2023-01-15 16:10 ` Stefano Sabatini
  14 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-15 16:10 UTC (permalink / raw)
  To: FFmpeg development discussions and patches; +Cc: Stefano Sabatini

---
 doc/examples/Makefile.example | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/examples/Makefile.example b/doc/examples/Makefile.example
index 730d7e1a9a..79c7fbd24c 100644
--- a/doc/examples/Makefile.example
+++ b/doc/examples/Makefile.example
@@ -25,12 +25,16 @@ EXAMPLES=\
                 extract_mvs                        \
                 hw_decode                          \
                 mux                                \
+                qsv_decode                         \
+                qsv_transcode                      \
                 remux                              \
                 resample_audio                     \
                 scale_video                        \
                 show_metadata                      \
                 transcode_aac                      \
                 transcode                          \
+                vaapi_encode                       \
+                vaapi_transcode                    \
 
 OBJS=$(addsuffix .o,$(EXAMPLES))
 
-- 
2.25.1

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [FFmpeg-devel] [PATCH 01/15] examples: rename avio_reading to avio_read_callback
  2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 01/15] examples: rename avio_reading to avio_read_callback Stefano Sabatini
@ 2023-01-25  0:28   ` Stefano Sabatini
  2023-02-11 17:12     ` Stefano Sabatini
  0 siblings, 1 reply; 18+ messages in thread
From: Stefano Sabatini @ 2023-01-25  0:28 UTC (permalink / raw)
  To: FFmpeg development discussions and patches

On date Sunday 2023-01-15 17:10:21 +0100, Stefano Sabatini wrote:
> Adopt general scheme VERB_OBJECT.
> ---
>  configure                                             | 4 ++--
>  doc/examples/Makefile                                 | 2 +-
>  doc/examples/Makefile.example                         | 2 +-
>  doc/examples/{avio_reading.c => avio_read_callback.c} | 2 +-
>  4 files changed, 5 insertions(+), 5 deletions(-)
>  rename doc/examples/{avio_reading.c => avio_read_callback.c} (99%)

Will apply the patchset in a few days if I see no comments.

_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

* Re: [FFmpeg-devel] [PATCH 01/15] examples: rename avio_reading to avio_read_callback
  2023-01-25  0:28   ` Stefano Sabatini
@ 2023-02-11 17:12     ` Stefano Sabatini
  0 siblings, 0 replies; 18+ messages in thread
From: Stefano Sabatini @ 2023-02-11 17:12 UTC (permalink / raw)
  To: FFmpeg development discussions and patches

On date Wednesday 2023-01-25 01:28:47 +0100, Stefano Sabatini wrote:
> On date Sunday 2023-01-15 17:10:21 +0100, Stefano Sabatini wrote:
> > Adopt general scheme VERB_OBJECT.
> > ---
> >  configure                                             | 4 ++--
> >  doc/examples/Makefile                                 | 2 +-
> >  doc/examples/Makefile.example                         | 2 +-
> >  doc/examples/{avio_reading.c => avio_read_callback.c} | 2 +-
> >  4 files changed, 5 insertions(+), 5 deletions(-)
> >  rename doc/examples/{avio_reading.c => avio_read_callback.c} (99%)
> 
> Will apply the patchset in a few days if I see no comments.

Applied.
_______________________________________________
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".

^ permalink raw reply	[flat|nested] 18+ messages in thread

end of thread, other threads:[~2023-02-11 17:12 UTC | newest]

Thread overview: 18+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-15 16:10 [FFmpeg-devel] Rename examples, apply consistency fixes Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 01/15] examples: rename avio_reading to avio_read_callback Stefano Sabatini
2023-01-25  0:28   ` Stefano Sabatini
2023-02-11 17:12     ` Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 02/15] examples: rename demuxing_decoding to demux_decode Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 03/15] examples: rename filtering_audio to decode_filter_audio Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 04/15] examples: rename filtering_video to decode_filter_video Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 05/15] examples: rename http_multiclient to avio_http_serve_files Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 06/15] examples: rename metadata to show_metadata Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 07/15] examples: rename muxing to mux Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 08/15] examples: rename qsvdec to qsv_decode Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 09/15] examples: rename remuxing to remux Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 10/15] examples: rename resampling audio to resample_audio Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 11/15] examples: rename scaling_video to scale_video Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 12/15] examples: rename transcoding to transcode Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 13/15] examples: apply doxy entries consistency fixes Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 14/15] examples: apply consistency fixes to doxy entries Stefano Sabatini
2023-01-15 16:10 ` [FFmpeg-devel] [PATCH 15/15] examples/Makefile.example: add missing entries Stefano Sabatini

Git Inbox Mirror of the ffmpeg-devel mailing list - see https://ffmpeg.org/mailman/listinfo/ffmpeg-devel

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://master.gitmailbox.com/ffmpegdev/0 ffmpegdev/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 ffmpegdev ffmpegdev/ https://master.gitmailbox.com/ffmpegdev \
		ffmpegdev@gitmailbox.com
	public-inbox-index ffmpegdev

Example config snippet for mirrors.


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git