FFmpeg coverage


Directory: ../../../ffmpeg/
File: src/libavformat/demux.h
Date: 2024-04-25 15:36:26
Exec Total Coverage
Lines: 4 4 100.0%
Functions: 2 2 100.0%
Branches: 0 0 -%

Line Branch Exec 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 #define FF_INFMT_FLAG_INIT_CLEANUP (1 << 0)
36
37 typedef struct FFInputFormat {
38 /**
39 * The public AVInputFormat. See avformat.h for it.
40 */
41 AVInputFormat p;
42
43 /**
44 * Raw demuxers store their codec ID here.
45 */
46 enum AVCodecID raw_codec_id;
47
48 /**
49 * Size of private data so that it can be allocated in the wrapper.
50 */
51 int priv_data_size;
52
53 /**
54 * Internal flags. See FF_INFMT_FLAG_* above and FF_FMT_FLAG_* in internal.h.
55 */
56 int flags_internal;
57
58 /**
59 * Tell if a given file has a chance of being parsed as this format.
60 * The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes
61 * big so you do not have to check for that unless you need more.
62 */
63 int (*read_probe)(const AVProbeData *);
64
65 /**
66 * Read the format header and initialize the AVFormatContext
67 * structure. Return 0 if OK. 'avformat_new_stream' should be
68 * called to create new streams.
69 */
70 int (*read_header)(struct AVFormatContext *);
71
72 /**
73 * Read one packet and put it in 'pkt'. pts and flags are also
74 * set. 'avformat_new_stream' can be called only if the flag
75 * AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
76 * background thread).
77 * @return 0 on success, < 0 on error.
78 * Upon returning an error, pkt must be unreferenced by the caller.
79 */
80 int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
81
82 /**
83 * Close the stream. The AVFormatContext and AVStreams are not
84 * freed by this function
85 */
86 int (*read_close)(struct AVFormatContext *);
87
88 /**
89 * Seek to a given timestamp relative to the frames in
90 * stream component stream_index.
91 * @param stream_index Must not be -1.
92 * @param flags Selects which direction should be preferred if no exact
93 * match is available.
94 * @return >= 0 on success (but not necessarily the new offset)
95 */
96 int (*read_seek)(struct AVFormatContext *,
97 int stream_index, int64_t timestamp, int flags);
98
99 /**
100 * Get the next timestamp in stream[stream_index].time_base units.
101 * @return the timestamp or AV_NOPTS_VALUE if an error occurred
102 */
103 int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
104 int64_t *pos, int64_t pos_limit);
105
106 /**
107 * Start/resume playing - only meaningful if using a network-based format
108 * (RTSP).
109 */
110 int (*read_play)(struct AVFormatContext *);
111
112 /**
113 * Pause playing - only meaningful if using a network-based format
114 * (RTSP).
115 */
116 int (*read_pause)(struct AVFormatContext *);
117
118 /**
119 * Seek to timestamp ts.
120 * Seeking will be done so that the point from which all active streams
121 * can be presented successfully will be closest to ts and within min/max_ts.
122 * Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
123 */
124 int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
125
126 /**
127 * Returns device list with it properties.
128 * @see avdevice_list_devices() for more details.
129 */
130 int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
131 } FFInputFormat;
132
133 5868315 static inline const FFInputFormat *ffifmt(const AVInputFormat *fmt)
134 {
135 5868315 return (const FFInputFormat*)fmt;
136 }
137
138 #define MAX_STD_TIMEBASES (30*12+30+3+6)
139 typedef struct FFStreamInfo {
140 int64_t last_dts;
141 int64_t duration_gcd;
142 int duration_count;
143 int64_t rfps_duration_sum;
144 double (*duration_error)[2][MAX_STD_TIMEBASES];
145 int64_t codec_info_duration;
146 int64_t codec_info_duration_fields;
147 int frame_delay_evidence;
148
149 /**
150 * 0 -> decoder has not been searched for yet.
151 * >0 -> decoder found
152 * <0 -> decoder with codec_id == -found_decoder has not been found
153 */
154 int found_decoder;
155
156 int64_t last_duration;
157
158 /**
159 * Those are used for average framerate estimation.
160 */
161 int64_t fps_first_dts;
162 int fps_first_dts_idx;
163 int64_t fps_last_dts;
164 int fps_last_dts_idx;
165 } FFStreamInfo;
166
167 /**
168 * Returned by demuxers to indicate that data was consumed but discarded
169 * (ignored streams or junk data). The framework will re-call the demuxer.
170 */
171 #define FFERROR_REDO FFERRTAG('R','E','D','O')
172
173 #define RELATIVE_TS_BASE (INT64_MAX - (1LL << 48))
174
175 1598634 static av_always_inline int is_relative(int64_t ts)
176 {
177 1598634 return ts > (RELATIVE_TS_BASE - (1LL << 48));
178 }
179
180 /**
181 * Wrap a given time stamp, if there is an indication for an overflow
182 *
183 * @param st stream
184 * @param timestamp the time stamp to wrap
185 * @return resulting time stamp
186 */
187 int64_t ff_wrap_timestamp(const AVStream *st, int64_t timestamp);
188
189 /**
190 * Read a transport packet from a media file.
191 *
192 * @param s media file handle
193 * @param pkt is filled
194 * @return 0 if OK, AVERROR_xxx on error
195 */
196 int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
197
198 void ff_read_frame_flush(AVFormatContext *s);
199
200 /**
201 * Perform a binary search using av_index_search_timestamp() and
202 * FFInputFormat.read_timestamp().
203 *
204 * @param target_ts target timestamp in the time base of the given stream
205 * @param stream_index stream number
206 */
207 int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
208 int64_t target_ts, int flags);
209
210 /**
211 * Update cur_dts of all streams based on the given timestamp and AVStream.
212 *
213 * Stream ref_st unchanged, others set cur_dts in their native time base.
214 * Only needed for timestamp wrapping or if (dts not set and pts!=dts).
215 * @param timestamp new dts expressed in time_base of param ref_st
216 * @param ref_st reference stream giving time_base of param timestamp
217 */
218 void avpriv_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
219
220 int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
221 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
222
223 /**
224 * Perform a binary search using read_timestamp().
225 *
226 * @param target_ts target timestamp in the time base of the given stream
227 * @param stream_index stream number
228 */
229 int64_t ff_gen_search(AVFormatContext *s, int stream_index,
230 int64_t target_ts, int64_t pos_min,
231 int64_t pos_max, int64_t pos_limit,
232 int64_t ts_min, int64_t ts_max,
233 int flags, int64_t *ts_ret,
234 int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
235
236 /**
237 * Internal version of av_index_search_timestamp
238 */
239 int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
240 int64_t wanted_timestamp, int flags);
241
242 /**
243 * Internal version of av_add_index_entry
244 */
245 int ff_add_index_entry(AVIndexEntry **index_entries,
246 int *nb_index_entries,
247 unsigned int *index_entries_allocated_size,
248 int64_t pos, int64_t timestamp, int size, int distance, int flags);
249
250 void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
251
252 /**
253 * Ensure the index uses less memory than the maximum specified in
254 * AVFormatContext.max_index_size by discarding entries if it grows
255 * too large.
256 */
257 void ff_reduce_index(AVFormatContext *s, int stream_index);
258
259 /**
260 * add frame for rfps calculation.
261 *
262 * @param dts timestamp of the i-th frame
263 * @return 0 if OK, AVERROR_xxx on error
264 */
265 int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
266
267 void ff_rfps_calculate(AVFormatContext *ic);
268
269 /**
270 * Rescales a timestamp and the endpoints of an interval to which the temstamp
271 * belongs, from a timebase `tb_in` to a timebase `tb_out`.
272 *
273 * The upper (lower) bound of the output interval is rounded up (down) such that
274 * the output interval always falls within the intput interval. The timestamp is
275 * rounded to the nearest integer and halfway cases away from zero, and can
276 * therefore fall outside of the output interval.
277 *
278 * Useful to simplify the rescaling of the arguments of FFInputFormat::read_seek2()
279 *
280 * @param[in] tb_in Timebase of the input `min_ts`, `ts` and `max_ts`
281 * @param[in] tb_out Timebase of the output `min_ts`, `ts` and `max_ts`
282 * @param[in,out] min_ts Lower bound of the interval
283 * @param[in,out] ts Timestamp
284 * @param[in,out] max_ts Upper bound of the interval
285 */
286 void ff_rescale_interval(AVRational tb_in, AVRational tb_out,
287 int64_t *min_ts, int64_t *ts, int64_t *max_ts);
288
289 void avpriv_stream_set_need_parsing(AVStream *st, enum AVStreamParseType type);
290
291 /**
292 * Add a new chapter.
293 *
294 * @param s media file handle
295 * @param id unique ID for this chapter
296 * @param start chapter start time in time_base units
297 * @param end chapter end time in time_base units
298 * @param title chapter title
299 *
300 * @return AVChapter or NULL on error
301 */
302 AVChapter *avpriv_new_chapter(AVFormatContext *s, int64_t id, AVRational time_base,
303 int64_t start, int64_t end, const char *title);
304
305 /**
306 * Add an attached pic to an AVStream.
307 *
308 * @param st if set, the stream to add the attached pic to;
309 * if unset, a new stream will be added to s.
310 * @param pb AVIOContext to read data from if buf is unset.
311 * @param buf if set, it contains the data and size information to be used
312 * for the attached pic; if unset, data is read from pb.
313 * @param size the size of the data to read if buf is unset.
314 *
315 * @return 0 on success, < 0 on error. On error, this function removes
316 * the stream it has added (if any).
317 */
318 int ff_add_attached_pic(AVFormatContext *s, AVStream *st, AVIOContext *pb,
319 AVBufferRef **buf, int size);
320
321 /**
322 * Add side data to a packet for changing parameters to the given values.
323 * Parameters set to 0 aren't included in the change.
324 */
325 int ff_add_param_change(AVPacket *pkt, int32_t channels,
326 uint64_t channel_layout, int32_t sample_rate,
327 int32_t width, int32_t height);
328
329 /**
330 * Generate standard extradata for AVC-Intra based on width/height and field
331 * order.
332 */
333 int ff_generate_avci_extradata(AVStream *st);
334
335 /**
336 * Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
337 * which is always set to 0 and fill it from pb.
338 *
339 * @param size size of extradata
340 * @return >= 0 if OK, AVERROR_xxx on error
341 */
342 int ff_get_extradata(void *logctx, AVCodecParameters *par, AVIOContext *pb, int size);
343
344 /**
345 * Find stream index based on format-specific stream ID
346 * @return stream index, or < 0 on error
347 */
348 int ff_find_stream_index(const AVFormatContext *s, int id);
349
350 int ff_buffer_packet(AVFormatContext *s, AVPacket *pkt);
351
352 #endif /* AVFORMAT_DEMUX_H */
353