FFmpeg coverage

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