Coverage Report

Created: 2026-10-28 07:09

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/ffmpeg/libavformat/demux.h
Line
Count
Source
1
/*
2
 * copyright (c) 2001 Fabrice Bellard
3
 *
4
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg is free software; you can redistribute it and/or
7
 * modify it under the terms of the GNU Lesser General Public
8
 * License as published by the Free Software Foundation; either
9
 * version 2.1 of the License, or (at your option) any later version.
10
 *
11
 * FFmpeg is distributed in the hope that it will be useful,
12
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14
 * Lesser General Public License for more details.
15
 *
16
 * You should have received a copy of the GNU Lesser General Public
17
 * License along with FFmpeg; if not, write to the Free Software
18
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19
 */
20
21
#ifndef AVFORMAT_DEMUX_H
22
#define AVFORMAT_DEMUX_H
23
24
#include <stdint.h>
25
#include "libavutil/rational.h"
26
#include "libavcodec/packet.h"
27
#include "avformat.h"
28
29
struct AVDeviceInfoList;
30
31
/**
32
 * For an FFInputFormat with this flag set read_close() needs to be called
33
 * by the caller upon read_header() failure.
34
 */
35
0
#define FF_INFMT_FLAG_INIT_CLEANUP                             (1 << 0)
36
37
/*
38
 * Prefer the codec framerate for avg_frame_rate computation.
39
 */
40
0
#define FF_INFMT_FLAG_PREFER_CODEC_FRAMERATE                   (1 << 1)
41
42
/**
43
 * Automatically parse ID3v2 metadata
44
 */
45
0
#define FF_INFMT_FLAG_ID3V2_AUTO                               (1 << 2)
46
47
/**
48
 * Input format stream state
49
 * The stream states to be used for FFInputFormat::read_set_state
50
 */
51
enum FFInputFormatStreamState {
52
     FF_INFMT_STATE_PLAY,
53
     FF_INFMT_STATE_PAUSE,
54
 };
55
56
/**
57
 * Command handling options
58
 * Different options influencing the behaviour of
59
 * the FFInputFormat::handle_command callback.
60
 */
61
enum FFInputFormatCommandOption {
62
    FF_INFMT_COMMAND_SUBMIT,
63
    FF_INFMT_COMMAND_GET_REPLY,
64
};
65
66
typedef struct FFInputFormat {
67
    /**
68
     * The public AVInputFormat. See avformat.h for it.
69
     */
70
    AVInputFormat p;
71
72
    /**
73
     * Raw demuxers store their codec ID here.
74
     */
75
    enum AVCodecID raw_codec_id;
76
77
    /**
78
     * Size of private data so that it can be allocated in the wrapper.
79
     */
80
    int priv_data_size;
81
82
    /**
83
     * Internal flags. See FF_INFMT_FLAG_* above and FF_FMT_FLAG_* in internal.h.
84
     */
85
    int flags_internal;
86
87
    /**
88
     * Tell if a given file has a chance of being parsed as this format.
89
     * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
90
     * big so you do not have to check for that unless you need more.
91
     *
92
     * If the final score is not yet resolvable, the special return value
93
     * AVERROR(EAGAIN) can be used to signal to the caller that probing must
94
     * be tried again with more bytes.
95
     *
96
     * This is distinct from AVPROBE_SCORE_RETRY, which means "possibly mine,
97
     * but if another format is more confident, let it have the file", whereas
98
     * AVERROR(EAGAIN) means "possibly mine, don't let another format claim
99
     * it until I've seen enough data to make a decision".
100
     */
101
    int (*read_probe)(const AVProbeData *);
102
103
    /**
104
     * Read the format header and initialize the AVFormatContext
105
     * structure. Return 0 if OK. 'avformat_new_stream' should be
106
     * called to create new streams.
107
     */
108
    int (*read_header)(struct AVFormatContext *);
109
110
    /**
111
     * Read one packet and put it in 'pkt'. pts and flags are also
112
     * set. 'avformat_new_stream' can be called only if the flag
113
     * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
114
     * background thread).
115
     * @return 0 on success, < 0 on error.
116
     *         Upon returning an error, pkt must be unreferenced by the caller.
117
     */
118
    int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
119
120
    /**
121
     * Close the stream. The AVFormatContext and AVStreams are not
122
     * freed by this function
123
     */
124
    int (*read_close)(struct AVFormatContext *);
125
126
    /**
127
     * Seek to a given timestamp relative to the frames in
128
     * stream component stream_index.
129
     * @param stream_index Must not be -1.
130
     * @param flags Selects which direction should be preferred if no exact
131
     *              match is available.
132
     * @return >= 0 on success (but not necessarily the new offset)
133
     */
134
    int (*read_seek)(struct AVFormatContext *,
135
                     int stream_index, int64_t timestamp, int flags);
136
137
    /**
138
     * Get the next timestamp in stream[stream_index].time_base units.
139
     * @return the timestamp or AV_NOPTS_VALUE if an error occurred
140
     */
141
    int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
142
                              int64_t *pos, int64_t pos_limit);
143
144
    /**
145
     * Change the stream state - only meaningful if using a network-based format
146
     * (RTSP).
147
     */
148
    int (*read_set_state)(struct AVFormatContext *,
149
                          enum FFInputFormatStreamState state);
150
151
    /**
152
     * Handle demuxer commands
153
     * This callback is used to either send a command to a demuxer
154
     * (FF_INFMT_COMMAND_SUBMIT), or to retrieve the reply for
155
     * a previously sent command (FF_INFMT_COMMAND_GET_REPLY).
156
     *
157
     * Demuxers implementing this must return AVERROR(ENOTSUP)
158
     * if the provided \p id is not handled by the demuxer.
159
     * Demuxers should return AVERROR(EAGAIN) if they can handle
160
     * a specific command but are not able to at the moment.
161
     * When a reply is requested that is not available yet, the
162
     * demuxer should also return AVERROR(EAGAIN).
163
     *
164
     * Depending on \p opt, the \p data will be either a pointer
165
     * to the command payload structure for the specified ID, or
166
     * a pointer to the buffer for the command reply for the
167
     * specified ID.
168
     *
169
     * When a command is submitted, before a previous reply
170
     * was requested from the demuxer, the demuxer should discard
171
     * the old reply.
172
     *
173
     * @see avformat_send_command()
174
     * @see avformat_receive_command_reply()
175
     */
176
    int (*handle_command)(struct AVFormatContext *,
177
                          enum FFInputFormatCommandOption opt,
178
                          enum AVFormatCommandID id, void *data);
179
180
    /**
181
     * Seek to timestamp ts.
182
     * Seeking will be done so that the point from which all active streams
183
     * can be presented successfully will be closest to ts and within min/max_ts.
184
     * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
185
     */
186
    int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
187
188
    /**
189
     * Returns device list with it properties.
190
     * @see avdevice_list_devices() for more details.
191
     */
192
    int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
193
} FFInputFormat;
194
195
static inline const FFInputFormat *ffifmt(const AVInputFormat *fmt)
196
0
{
197
0
    return (const FFInputFormat*)fmt;
198
0
}
Unexecuted instantiation: avformat.c:ffifmt
Unexecuted instantiation: demux.c:ffifmt
Unexecuted instantiation: demux_utils.c:ffifmt
Unexecuted instantiation: format.c:ffifmt
Unexecuted instantiation: id3v2.c:ffifmt
Unexecuted instantiation: options.c:ffifmt
Unexecuted instantiation: seek.c:ffifmt
Unexecuted instantiation: allformats.c:ffifmt
199
200
0
#define MAX_STD_TIMEBASES (30*12+30+3+6)
201
typedef struct FFStreamInfo {
202
    int64_t last_dts;
203
    int64_t duration_gcd;
204
    int duration_count;
205
    int64_t rfps_duration_sum;
206
    double (*duration_error)[2][MAX_STD_TIMEBASES];
207
    int64_t codec_info_duration;
208
    int64_t codec_info_duration_fields;
209
    int frame_delay_evidence;
210
211
    /**
212
     * 0  -> decoder has not been searched for yet.
213
     * >0 -> decoder found
214
     * <0 -> decoder with codec_id == -found_decoder has not been found
215
     */
216
    int found_decoder;
217
218
    int64_t last_duration;
219
220
    /**
221
     * Those are used for average framerate estimation.
222
     */
223
    int64_t fps_first_dts;
224
    int     fps_first_dts_idx;
225
    int64_t fps_last_dts;
226
    int     fps_last_dts_idx;
227
} FFStreamInfo;
228
229
/**
230
 * Returned by demuxers to indicate that data was consumed but discarded
231
 * (ignored streams or junk data). The framework will re-call the demuxer.
232
 */
233
0
#define FFERROR_REDO FFERRTAG('R','E','D','O')
234
235
/**
236
 * Read a transport packet from a media file.
237
 *
238
 * @param s media file handle
239
 * @param pkt is filled
240
 * @return 0 if OK, AVERROR_xxx on error
241
 */
242
int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
243
244
void ff_read_frame_flush(AVFormatContext *s);
245
246
/**
247
 * Perform a binary search using av_index_search_timestamp() and
248
 * FFInputFormat.read_timestamp().
249
 *
250
 * @param target_ts target timestamp in the time base of the given stream
251
 * @param stream_index stream number
252
 */
253
int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
254
                         int64_t target_ts, int flags);
255
256
/**
257
 * Update cur_dts of all streams based on the given timestamp and AVStream.
258
 *
259
 * Stream ref_st unchanged, others set cur_dts in their native time base.
260
 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
261
 * @param timestamp new dts expressed in time_base of param ref_st
262
 * @param ref_st reference stream giving time_base of param timestamp
263
 */
264
void avpriv_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
265
266
int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
267
                    int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
268
269
/**
270
 * Perform a binary search using read_timestamp().
271
 *
272
 * @param target_ts target timestamp in the time base of the given stream
273
 * @param stream_index stream number
274
 */
275
int64_t ff_gen_search(AVFormatContext *s, int stream_index,
276
                      int64_t target_ts, int64_t pos_min,
277
                      int64_t pos_max, int64_t pos_limit,
278
                      int64_t ts_min, int64_t ts_max,
279
                      int flags, int64_t *ts_ret,
280
                      int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
281
282
/**
283
 * Internal version of av_index_search_timestamp
284
 */
285
int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
286
                              int64_t wanted_timestamp, int flags);
287
288
/**
289
 * Internal version of av_add_index_entry
290
 */
291
int ff_add_index_entry(AVIndexEntry **index_entries,
292
                       int *nb_index_entries,
293
                       unsigned int *index_entries_allocated_size,
294
                       int64_t pos, int64_t timestamp, int size, int distance, int flags);
295
296
void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
297
298
/**
299
 * Ensure the index uses less memory than the maximum specified in
300
 * AVFormatContext.max_index_size by discarding entries if it grows
301
 * too large.
302
 */
303
void ff_reduce_index(AVFormatContext *s, int stream_index);
304
305
/**
306
 * add frame for rfps calculation.
307
 *
308
 * @param dts timestamp of the i-th frame
309
 * @return 0 if OK, AVERROR_xxx on error
310
 */
311
int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
312
313
void ff_rfps_calculate(AVFormatContext *ic);
314
315
/**
316
 * Rescales a timestamp and the endpoints of an interval to which the temstamp
317
 * belongs, from a timebase `tb_in` to a timebase `tb_out`.
318
 *
319
 * The upper (lower) bound of the output interval is rounded up (down) such that
320
 * the output interval always falls within the input interval. The timestamp is
321
 * rounded to the nearest integer and halfway cases away from zero, then
322
 * clamped to the output interval.
323
 *
324
 * Useful to simplify the rescaling of the arguments of FFInputFormat::read_seek2()
325
 *
326
 * @param[in] tb_in      Timebase of the input `min_ts`, `ts` and `max_ts`
327
 * @param[in] tb_out     Timebase of the output `min_ts`, `ts` and `max_ts`
328
 * @param[in,out] min_ts Lower bound of the interval
329
 * @param[in,out] ts     Timestamp
330
 * @param[in,out] max_ts Upper bound of the interval
331
 */
332
void ff_rescale_interval(AVRational tb_in, AVRational tb_out,
333
                         int64_t *min_ts, int64_t *ts, int64_t *max_ts);
334
335
void avpriv_stream_set_need_parsing(AVStream *st, enum AVStreamParseType type);
336
337
/**
338
 * Add a new chapter.
339
 *
340
 * @param s media file handle
341
 * @param id unique ID for this chapter
342
 * @param start chapter start time in time_base units
343
 * @param end chapter end time in time_base units
344
 * @param title chapter title
345
 *
346
 * @return AVChapter or NULL on error
347
 */
348
AVChapter *avpriv_new_chapter(AVFormatContext *s, int64_t id, AVRational time_base,
349
                              int64_t start, int64_t end, const char *title);
350
351
/**
352
 * Add an attached pic to an AVStream.
353
 *
354
 * @param st   if set, the stream to add the attached pic to;
355
 *             if unset, a new stream will be added to s.
356
 * @param pb   AVIOContext to read data from if buf is unset.
357
 * @param buf  if set, it contains the data and size information to be used
358
 *             for the attached pic; if unset, data is read from pb.
359
 * @param size the size of the data to read if buf is unset.
360
 *
361
 * @return 0 on success, < 0 on error. On error, this function removes
362
 *         the stream it has added (if any).
363
 */
364
int ff_add_attached_pic(AVFormatContext *s, AVStream *st, AVIOContext *pb,
365
                        AVBufferRef **buf, int size);
366
367
/**
368
 * Add side data to a packet for changing parameters to the given values.
369
 * Parameters set to 0 aren't included in the change.
370
 */
371
int ff_add_param_change(AVPacket *pkt, int32_t channels,
372
                        uint64_t channel_layout, int32_t sample_rate,
373
                        int32_t width, int32_t height);
374
375
/**
376
 * Generate standard extradata for AVC-Intra based on width/height and field
377
 * order.
378
 */
379
int ff_generate_avci_extradata(AVStream *st);
380
381
/**
382
 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
383
 * which is always set to 0 and fill it from pb.
384
 *
385
 * @param size size of extradata
386
 * @return >= 0 if OK, AVERROR_xxx on error
387
 */
388
int ff_get_extradata(void *logctx, AVCodecParameters *par, AVIOContext *pb, int size);
389
390
/**
391
 * Find stream index based on format-specific stream ID
392
 * @return stream index, or < 0 on error
393
 */
394
int ff_find_stream_index(const AVFormatContext *s, int id);
395
396
/**
397
 * Parse the gapless playback information Apple encoders store in an iTunSMPB
398
 * tag. The tag is a list of hexadecimal fields; the ones of interest are
399
 *
400
 *   <reserved> <priming> <remainder> <valid samples>
401
 *
402
 * The decoded stream holds the three sample counts back to back, the priming
403
 * and remainder samples being encoder artifacts.
404
 *
405
 * The counts are returned small enough to be added and rescaled without
406
 * overflowing.
407
 *
408
 * @param value     tag contents
409
 * @param priming   number of samples to discard at the start of the stream
410
 * @param remainder number of samples to discard at the end of the stream
411
 * @param samples   number of valid samples between the two
412
 * @return >= 0 if OK, AVERROR_INVALIDDATA if the tag could not be parsed or
413
 *         holds counts too large to be sample counts
414
 */
415
int ff_itunes_parse_smpb(const char *value, int64_t *priming,
416
                         int64_t *remainder, int64_t *samples);
417
418
int ff_buffer_packet(AVFormatContext *s, AVPacket *pkt);
419
420
#endif /* AVFORMAT_DEMUX_H */