FFmpeg
api-dump-stream-meta-test.c
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2025 Romain Beauxis
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a copy
5  * of this software and associated documentation files (the "Software"), to deal
6  * in the Software without restriction, including without limitation the rights
7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8  * copies of the Software, and to permit persons to whom the Software is
9  * furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 
23 /**
24  * Dump stream metadata
25  */
26 
27 #include "libavcodec/avcodec.h"
28 #include "libavformat/avformat.h"
29 #include "libavutil/timestamp.h"
30 
31 static int dump_stream_meta(const char *input_filename) {
32  const AVCodec *codec = NULL;
33  AVPacket *pkt = NULL;
34  AVFrame *fr = NULL;
37  AVCodecParameters *origin_par = NULL;
38  AVStream *st;
39  int stream_idx = 0;
40  int result;
41  char *metadata;
42 
44  if (result < 0) {
45  av_log(NULL, AV_LOG_ERROR, "Can't open file\n");
46  return result;
47  }
48 
50  if (result < 0) {
51  av_log(NULL, AV_LOG_ERROR, "Can't get stream info\n");
52  goto end;
53  }
54 
55  if (fmt_ctx->nb_streams > 1) {
56  av_log(NULL, AV_LOG_ERROR, "More than one stream found in input!\n");
57  goto end;
58  }
59 
60  origin_par = fmt_ctx->streams[stream_idx]->codecpar;
61  st = fmt_ctx->streams[stream_idx];
62 
63  result = av_dict_get_string(st->metadata, &metadata, '=', ':');
64  if (result < 0)
65  goto end;
66 
67  printf("Stream ID: %d, codec name: %s, metadata: %s\n", stream_idx,
68  avcodec_get_name(origin_par->codec_id),
69  strlen(metadata) ? metadata : "N/A");
70 
71  codec = avcodec_find_decoder(origin_par->codec_id);
72  if (!codec) {
73  av_log(NULL, AV_LOG_ERROR, "Can't find decoder\n");
75  goto end;
76  }
77 
78  ctx = avcodec_alloc_context3(codec);
79  if (!ctx) {
80  av_log(NULL, AV_LOG_ERROR, "Can't allocate decoder context\n");
81  result = AVERROR(ENOMEM);
82  goto end;
83  }
84 
86  if (result) {
87  av_log(NULL, AV_LOG_ERROR, "Can't copy decoder context\n");
88  goto end;
89  }
90 
91  result = avcodec_open2(ctx, codec, NULL);
92  if (result < 0) {
93  av_log(ctx, AV_LOG_ERROR, "Can't open decoder\n");
94  goto end;
95  }
96 
97  pkt = av_packet_alloc();
98  if (!pkt) {
99  av_log(NULL, AV_LOG_ERROR, "Cannot allocate packet\n");
100  result = AVERROR(ENOMEM);
101  goto end;
102  }
103 
104  fr = av_frame_alloc();
105  if (!fr) {
106  av_log(NULL, AV_LOG_ERROR, "Can't allocate frame\n");
107  result = AVERROR(ENOMEM);
108  goto end;
109  }
110 
111  for (;;) {
113  if (result)
114  goto end;
115 
116  if (pkt->stream_index != stream_idx) {
118  continue;
119  }
120 
121  printf("Stream ID: %d, packet PTS: %s, packet DTS: %s\n",
123 
125  result = av_dict_get_string(st->metadata, &metadata, '=', ':');
126  if (result < 0)
127  goto end;
128 
129  printf("Stream ID: %d, new metadata: %s\n", pkt->stream_index,
130  strlen(metadata) ? metadata : "N/A");
131 
133  }
134 
137 
138  if (result < 0)
139  goto end;
140 
141  do {
143  if (result == AVERROR_EOF) {
144  result = 0;
145  goto end;
146  }
147 
148  if (result == AVERROR(EAGAIN))
149  break;
150 
151  if (result < 0)
152  goto end;
153 
154  result = av_dict_get_string(fr->metadata, &metadata, '=', ':');
155  if (result < 0)
156  goto end;
157 
158  printf("Stream ID: %d, frame PTS: %s, metadata: %s\n",
159  pkt->stream_index, av_ts2str(fr->pts),
160  strlen(metadata) ? metadata : "N/A");
161  } while (1);
162  }
163 
164 end:
166  av_frame_free(&fr);
169  return result;
170 }
171 
172 int main(int argc, char **argv) {
173  if (argc < 2) {
174  av_log(NULL, AV_LOG_ERROR, "Incorrect input\n");
175  return 1;
176  }
177 
178  if (dump_stream_meta(argv[1]) != AVERROR_EOF)
179  return 1;
180 
181  return 0;
182 }
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: packet.c:430
AVCodec
AVCodec.
Definition: codec.h:172
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
AVCodecParameters
This struct describes the properties of an encoded stream.
Definition: codec_par.h:47
AVERROR_EOF
#define AVERROR_EOF
End of file.
Definition: error.h:57
metadata
Stream codec metadata
Definition: ogg-flac-chained-meta.txt:2
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:63
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:410
AVFormatContext::streams
AVStream ** streams
A list of all streams in the file.
Definition: avformat.h:1333
AVFrame::pts
int64_t pts
Presentation timestamp in time_base units (time when frame should be shown to user).
Definition: frame.h:512
av_read_frame
int av_read_frame(AVFormatContext *s, AVPacket *pkt)
Return the next frame of a stream.
Definition: demux.c:1529
av_packet_free
void av_packet_free(AVPacket **pkt)
Free the packet, if the packet is reference counted, it will be unreferenced first.
Definition: packet.c:75
avformat_close_input
void avformat_close_input(AVFormatContext **s)
Close an opened input AVFormatContext.
Definition: demux.c:367
main
int main(int argc, char **argv)
Definition: api-dump-stream-meta-test.c:172
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:51
pkt
AVPacket * pkt
Definition: movenc.c:60
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:210
dump_stream_meta
static int dump_stream_meta(const char *input_filename)
Dump stream metadata.
Definition: api-dump-stream-meta-test.c:31
avformat_open_input
int avformat_open_input(AVFormatContext **ps, const char *url, const AVInputFormat *fmt, AVDictionary **options)
Open an input stream and read the header.
Definition: demux.c:217
avcodec_alloc_context3
AVCodecContext * avcodec_alloc_context3(const AVCodec *codec)
Allocate an AVCodecContext and set its fields to default values.
Definition: options.c:149
avcodec_receive_frame
int attribute_align_arg avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame)
Return decoded output data from a decoder or encoder (when the AV_CODEC_FLAG_RECON_FRAME flag is used...
Definition: avcodec.c:702
ctx
AVFormatContext * ctx
Definition: movenc.c:49
AVFormatContext
Format I/O context.
Definition: avformat.h:1265
AVStream::codecpar
AVCodecParameters * codecpar
Codec parameters associated with this stream.
Definition: avformat.h:768
avcodec_parameters_to_context
int avcodec_parameters_to_context(AVCodecContext *codec, const struct AVCodecParameters *par)
Fill the codec context based on the values from the supplied codec parameters.
result
and forward the result(frame or status change) to the corresponding input. If nothing is possible
NULL
#define NULL
Definition: coverity.c:32
avcodec_free_context
void avcodec_free_context(AVCodecContext **avctx)
Free the codec context and everything associated with it and write NULL to the provided pointer.
Definition: options.c:164
AVStream::metadata
AVDictionary * metadata
Definition: avformat.h:825
avcodec_open2
int attribute_align_arg avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options)
Initialize the AVCodecContext to use the given AVCodec.
Definition: avcodec.c:143
AVSTREAM_EVENT_FLAG_METADATA_UPDATED
#define AVSTREAM_EVENT_FLAG_METADATA_UPDATED
Definition: avformat.h:863
avcodec_find_decoder
const AVCodec * avcodec_find_decoder(enum AVCodecID id)
Find a registered decoder with a matching codec ID.
Definition: allcodecs.c:1017
AVFormatContext::nb_streams
unsigned int nb_streams
Number of elements in AVFormatContext.streams.
Definition: avformat.h:1321
avformat_find_stream_info
int avformat_find_stream_info(AVFormatContext *ic, AVDictionary **options)
Read packets of a media file to get stream information.
Definition: demux.c:2507
fmt_ctx
static AVFormatContext * fmt_ctx
Definition: decode_filter_audio.c:46
AVStream::event_flags
int event_flags
Flags indicating events happening on the stream, a combination of AVSTREAM_EVENT_FLAG_*.
Definition: avformat.h:856
printf
printf("static const uint8_t my_array[100] = {\n")
AVPacket::dts
int64_t dts
Decompression timestamp in AVStream->time_base units; the time at which the packet is decompressed.
Definition: packet.h:534
av_packet_alloc
AVPacket * av_packet_alloc(void)
Allocate an AVPacket and set its fields to default values.
Definition: packet.c:64
avcodec_get_name
const char * avcodec_get_name(enum AVCodecID id)
Get the name of a codec.
Definition: utils.c:406
avcodec_send_packet
int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt)
Supply raw packet data as input to a decoder.
Definition: decode.c:704
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:528
avcodec.h
AVStream
Stream structure.
Definition: avformat.h:745
avformat.h
AVCodecContext
main external API structure.
Definition: avcodec.h:431
AVFrame::metadata
AVDictionary * metadata
metadata.
Definition: frame.h:688
AVPacket::stream_index
int stream_index
Definition: packet.h:537
input_filename
static const char * input_filename
Definition: ffplay.c:306
AVERROR_DECODER_NOT_FOUND
#define AVERROR_DECODER_NOT_FOUND
Decoder not found.
Definition: error.h:54
AVCodecParameters::codec_id
enum AVCodecID codec_id
Specific type of the encoded data (the codec used).
Definition: codec_par.h:55
AVPacket
This structure stores compressed data.
Definition: packet.h:512
av_dict_get_string
int av_dict_get_string(const AVDictionary *m, char **buffer, const char key_val_sep, const char pairs_sep)
Get dictionary entries as a string.
Definition: dict.c:260
timestamp.h
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
av_ts2str
#define av_ts2str(ts)
Convenience macro, the return value should be used only directly in function arguments but never stan...
Definition: timestamp.h:54