tests: Add stream dump test API util, use it to dump stream data for chained ogg/{vorbis, opus, flac} streams.

Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>

tests/Makefile

@@ -220,6 +220,9 @@ include $(SRC_PATH)/tests/fate/mpeg4.mak
 include $(SRC_PATH)/tests/fate/mpegps.mak
 include $(SRC_PATH)/tests/fate/mpegts.mak
 include $(SRC_PATH)/tests/fate/mxf.mak
+include $(SRC_PATH)/tests/fate/ogg-vorbis.mak
+include $(SRC_PATH)/tests/fate/ogg-flac.mak
+include $(SRC_PATH)/tests/fate/ogg-opus.mak
 include $(SRC_PATH)/tests/fate/oma.mak
 include $(SRC_PATH)/tests/fate/opus.mak
 include $(SRC_PATH)/tests/fate/pcm.mak
@@ -278,6 +281,7 @@ $(FATE_FFPROBE) $(FATE_FFMPEG_FFPROBE) $(FATE_SAMPLES_FFPROBE) $(FATE_SAMPLES_FF
 $(FATE_SAMPLES_FASTSTART): tools/qt-faststart$(EXESUF)
 $(FATE_SAMPLES_DUMP_DATA) $(FATE_SAMPLES_DUMP_DATA-yes): tools/venc_data_dump$(EXESUF)
 $(FATE_SAMPLES_SCALE_SLICE): tools/scale_slice_test$(EXESUF)
+$(FATE_SAMPLES_DUMP_STREAM_META): tests/api/api-dump-stream-meta-test$(EXESUF)
 
 ifdef SAMPLES
 FATE += $(FATE_EXTERN)

tests/api/Makefile

@@ -1,7 +1,7 @@
 APITESTPROGS-$(call ENCDEC, FLAC, FLAC) += api-flac
 APITESTPROGS-$(call DEMDEC, H264, H264) += api-h264
 APITESTPROGS-$(call DEMDEC, H264, H264) += api-h264-slice
-APITESTPROGS-yes += api-seek
+APITESTPROGS-yes += api-seek api-dump-stream-meta
 APITESTPROGS-$(call DEMDEC, H263, H263) += api-band
 APITESTPROGS-$(HAVE_THREADS) += api-threadmessage
 APITESTPROGS += $(APITESTPROGS-yes)

tests/api/api-dump-stream-meta-test.c

@@ -0,0 +1,182 @@
+/*
+ * Copyright (c) 2025 Romain Beauxis
+ *
+ * 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
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+ * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+/**
+ * Dump stream metadata
+ */
+
+#include "libavcodec/avcodec.h"
+#include "libavformat/avformat.h"
+#include "libavutil/timestamp.h"
+
+static int dump_stream_meta(const char *input_filename) {
+    const AVCodec *codec = NULL;
+    AVPacket *pkt = NULL;
+    AVFrame *fr = NULL;
+    AVFormatContext *fmt_ctx = NULL;
+    AVCodecContext *ctx = NULL;
+    AVCodecParameters *origin_par = NULL;
+    AVStream *st;
+    int stream_idx = 0;
+    int result;
+    char *metadata;
+
+    result = avformat_open_input(&fmt_ctx, input_filename, NULL, NULL);
+    if (result < 0) {
+        av_log(NULL, AV_LOG_ERROR, "Can't open file\n");
+        return result;
+    }
+
+    result = avformat_find_stream_info(fmt_ctx, NULL);
+    if (result < 0) {
+        av_log(NULL, AV_LOG_ERROR, "Can't get stream info\n");
+        goto end;
+    }
+
+    if (fmt_ctx->nb_streams > 1) {
+        av_log(NULL, AV_LOG_ERROR, "More than one stream found in input!\n");
+        goto end;
+    }
+
+    origin_par = fmt_ctx->streams[stream_idx]->codecpar;
+    st = fmt_ctx->streams[stream_idx];
+
+    result = av_dict_get_string(st->metadata, &metadata, '=', ':');
+    if (result < 0)
+        goto end;
+
+    printf("Stream ID: %d, codec name: %s, metadata: %s\n", stream_idx,
+           avcodec_get_name(origin_par->codec_id),
+           strlen(metadata) ? metadata : "N/A");
+
+    codec = avcodec_find_decoder(origin_par->codec_id);
+    if (!codec) {
+        av_log(NULL, AV_LOG_ERROR, "Can't find decoder\n");
+        result = AVERROR_DECODER_NOT_FOUND;
+        goto end;
+    }
+
+    ctx = avcodec_alloc_context3(codec);
+    if (!ctx) {
+        av_log(NULL, AV_LOG_ERROR, "Can't allocate decoder context\n");
+        result = AVERROR(ENOMEM);
+        goto end;
+    }
+
+    result = avcodec_parameters_to_context(ctx, origin_par);
+    if (result) {
+        av_log(NULL, AV_LOG_ERROR, "Can't copy decoder context\n");
+        goto end;
+    }
+
+    result = avcodec_open2(ctx, codec, NULL);
+    if (result < 0) {
+        av_log(ctx, AV_LOG_ERROR, "Can't open decoder\n");
+        goto end;
+    }
+
+    pkt = av_packet_alloc();
+    if (!pkt) {
+        av_log(NULL, AV_LOG_ERROR, "Cannot allocate packet\n");
+        result = AVERROR(ENOMEM);
+        goto end;
+    }
+
+    fr = av_frame_alloc();
+    if (!fr) {
+        av_log(NULL, AV_LOG_ERROR, "Can't allocate frame\n");
+        result = AVERROR(ENOMEM);
+        goto end;
+    }
+
+    for (;;) {
+        result = av_read_frame(fmt_ctx, pkt);
+        if (result)
+            goto end;
+
+        if (pkt->stream_index != stream_idx) {
+            av_packet_unref(pkt);
+            continue;
+        }
+
+        printf("Stream ID: %d, packet PTS: %s, packet DTS: %s\n",
+               pkt->stream_index, av_ts2str(pkt->pts), av_ts2str(pkt->dts));
+
+        if (st->event_flags & AVSTREAM_EVENT_FLAG_METADATA_UPDATED) {
+            result = av_dict_get_string(st->metadata, &metadata, '=', ':');
+            if (result < 0)
+                goto end;
+
+            printf("Stream ID: %d, new metadata: %s\n", pkt->stream_index,
+                   strlen(metadata) ? metadata : "N/A");
+
+            st->event_flags &= ~AVSTREAM_EVENT_FLAG_METADATA_UPDATED;
+        }
+
+        result = avcodec_send_packet(ctx, pkt);
+        av_packet_unref(pkt);
+
+        if (result < 0)
+            goto end;
+
+        do {
+            result = avcodec_receive_frame(ctx, fr);
+            if (result == AVERROR_EOF) {
+                result = 0;
+                goto end;
+            }
+
+            if (result == AVERROR(EAGAIN))
+                break;
+
+            if (result < 0)
+                goto end;
+
+            result = av_dict_get_string(fr->metadata, &metadata, '=', ':');
+            if (result < 0)
+                goto end;
+
+            printf("Stream ID: %d, frame PTS: %s, metadata: %s\n",
+                   pkt->stream_index, av_ts2str(fr->pts),
+                   strlen(metadata) ? metadata : "N/A");
+        } while (1);
+    }
+
+end:
+    av_packet_free(&pkt);
+    av_frame_free(&fr);
+    avformat_close_input(&fmt_ctx);
+    avcodec_free_context(&ctx);
+    return result;
+}
+
+int main(int argc, char **argv) {
+    if (argc < 2) {
+        av_log(NULL, AV_LOG_ERROR, "Incorrect input\n");
+        return 1;
+    }
+
+    if (dump_stream_meta(argv[1]) != AVERROR_EOF)
+        return 1;
+
+    return 0;
+}

tests/fate/ogg-flac.mak

@@ -0,0 +1,11 @@
+FATE_OGG_FLAC += fate-ogg-flac-chained-meta
+fate-ogg-flac-chained-meta: REF = $(SRC_PATH)/tests/ref/fate/ogg-flac-chained-meta.txt
+fate-ogg-flac-chained-meta: CMD = run $(APITESTSDIR)/api-dump-stream-meta-test$(EXESUF) $(TARGET_SAMPLES)/ogg-flac/chained-meta.ogg
+
+FATE_OGG_FLAC-$(call DEMDEC, OGG, FLAC) += $(FATE_OGG_FLAC)
+
+FATE_SAMPLES_DUMP_STREAM_META += $(FATE_OGG_FLAC-yes)
+
+FATE_EXTERN += $(FATE_OGG_FLAC-yes)
+
+fate-ogg-flac: $(FATE_OGG_FLAC-yes)

tests/fate/ogg-opus.mak

@@ -0,0 +1,11 @@
+FATE_OGG_OPUS += fate-ogg-opus-chained-meta
+fate-ogg-opus-chained-meta: REF = $(SRC_PATH)/tests/ref/fate/ogg-opus-chained-meta.txt
+fate-ogg-opus-chained-meta: CMD = run $(APITESTSDIR)/api-dump-stream-meta-test$(EXESUF) $(TARGET_SAMPLES)/ogg-opus/chained-meta.ogg
+
+FATE_OGG_OPUS-$(call DEMDEC, OGG, OPUS) += $(FATE_OGG_OPUS)
+
+FATE_SAMPLES_DUMP_STREAM_META += $(FATE_OGG_OPUS-yes)
+
+FATE_EXTERN += $(FATE_OGG_OPUS-yes)
+
+fate-ogg-opus: $(FATE_OGG_OPUS-yes)

tests/fate/ogg-vorbis.mak

@@ -0,0 +1,11 @@
+FATE_OGG_VORBIS += fate-ogg-vorbis-chained-meta
+fate-ogg-vorbis-chained-meta: REF = $(SRC_PATH)/tests/ref/fate/ogg-vorbis-chained-meta.txt
+fate-ogg-vorbis-chained-meta: CMD = run $(APITESTSDIR)/api-dump-stream-meta-test$(EXESUF) $(TARGET_SAMPLES)/ogg-vorbis/chained-meta.ogg
+
+FATE_OGG_VORBIS-$(call DEMDEC, OGG, VORBIS) += $(FATE_OGG_VORBIS)
+
+FATE_SAMPLES_DUMP_STREAM_META += $(FATE_OGG_VORBIS-yes)
+
+FATE_EXTERN += $(FATE_OGG_VORBIS-yes)
+
+fate-ogg-vorbis: $(FATE_OGG_VORBIS-yes)

tests/ref/fate/ogg-flac-chained-meta.txt

@@ -0,0 +1,12 @@
+Stream ID: 0, codec name: flac, metadata: encoder=Lavc61.19.100 flac:title=First Stream
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, new metadata: encoder=Lavc61.19.100 flac:title=First Stream
+Stream ID: 0, frame PTS: 0, metadata: N/A
+Stream ID: 0, packet PTS: 4608, packet DTS: 4608
+Stream ID: 0, frame PTS: 4608, metadata: N/A
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, frame PTS: 0, metadata: N/A
+Stream ID: 0, packet PTS: 4608, packet DTS: 4608
+Stream ID: 0, frame PTS: 4608, metadata: N/A

tests/ref/fate/ogg-opus-chained-meta.txt

@@ -0,0 +1,27 @@
+Stream ID: 0, codec name: opus, metadata: encoder=Lavc61.19.100 libopus:title=First Stream
+Stream ID: 0, packet PTS: -312, packet DTS: -312
+Stream ID: 0, new metadata: encoder=Lavc61.19.100 libopus:title=First Stream
+Stream ID: 0, frame PTS: -312, metadata: N/A
+Stream ID: 0, packet PTS: 648, packet DTS: 648
+Stream ID: 0, frame PTS: 648, metadata: N/A
+Stream ID: 0, packet PTS: 1608, packet DTS: 1608
+Stream ID: 0, frame PTS: 1608, metadata: N/A
+Stream ID: 0, packet PTS: 2568, packet DTS: 2568
+Stream ID: 0, frame PTS: 2568, metadata: N/A
+Stream ID: 0, packet PTS: 3528, packet DTS: 3528
+Stream ID: 0, frame PTS: 3528, metadata: N/A
+Stream ID: 0, packet PTS: 4488, packet DTS: 4488
+Stream ID: 0, frame PTS: 4488, metadata: N/A
+Stream ID: 0, packet PTS: -312, packet DTS: -312
+Stream ID: 0, new metadata: encoder=Lavc61.19.100 libopus;Lavc61.19.100 libopus:title=First Stream;Second Stream
+Stream ID: 0, frame PTS: -312, metadata: N/A
+Stream ID: 0, packet PTS: 648, packet DTS: 648
+Stream ID: 0, frame PTS: 648, metadata: N/A
+Stream ID: 0, packet PTS: 1608, packet DTS: 1608
+Stream ID: 0, frame PTS: 1608, metadata: N/A
+Stream ID: 0, packet PTS: 2568, packet DTS: 2568
+Stream ID: 0, frame PTS: 2568, metadata: N/A
+Stream ID: 0, packet PTS: 3528, packet DTS: 3528
+Stream ID: 0, frame PTS: 3528, metadata: N/A
+Stream ID: 0, packet PTS: 4488, packet DTS: 4488
+Stream ID: 0, frame PTS: 4488, metadata: N/A

tests/ref/fate/ogg-vorbis-chained-meta.txt

@@ -0,0 +1,17 @@
+Stream ID: 0, codec name: vorbis, metadata: encoder=Lavc61.19.100 libvorbis:title=First Stream
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, new metadata: encoder=Lavc61.19.100 libvorbis:title=First Stream
+Stream ID: 0, packet PTS: 128, packet DTS: 128
+Stream ID: 0, frame PTS: 128, metadata: N/A
+Stream ID: 0, packet PTS: 704, packet DTS: 704
+Stream ID: 0, frame PTS: 704, metadata: N/A
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, new metadata: encoder=Lavc61.19.100 libvorbis:title=Second Stream
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, packet PTS: 0, packet DTS: 0
+Stream ID: 0, frame PTS: 0, metadata: N/A
+Stream ID: 0, packet PTS: 128, packet DTS: 128
+Stream ID: 0, frame PTS: 128, metadata: N/A
+Stream ID: 0, packet PTS: 704, packet DTS: 704
+Stream ID: 0, frame PTS: 704, metadata: N/A