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			/**
43			* Automatically parse ID3v2 metadata
44			*/
45			#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			int (*read_probe)(const AVProbeData *);
93
94			/**
95			* Read the format header and initialize the AVFormatContext
96			* structure. Return 0 if OK. 'avformat_new_stream' should be
97			* called to create new streams.
98			*/
99			int (*read_header)(struct AVFormatContext *);
100
101			/**
102			* Read one packet and put it in 'pkt'. pts and flags are also
103			* set. 'avformat_new_stream' can be called only if the flag
104			* AVFMTCTX_NOHEADER is used and only in the calling thread (not in a
105			* background thread).
106			* @return 0 on success, < 0 on error.
107			* Upon returning an error, pkt must be unreferenced by the caller.
108			*/
109			int (*read_packet)(struct AVFormatContext *, AVPacket *pkt);
110
111			/**
112			* Close the stream. The AVFormatContext and AVStreams are not
113			* freed by this function
114			*/
115			int (*read_close)(struct AVFormatContext *);
116
117			/**
118			* Seek to a given timestamp relative to the frames in
119			* stream component stream_index.
120			* @param stream_index Must not be -1.
121			* @param flags Selects which direction should be preferred if no exact
122			* match is available.
123			* @return >= 0 on success (but not necessarily the new offset)
124			*/
125			int (*read_seek)(struct AVFormatContext *,
126			int stream_index, int64_t timestamp, int flags);
127
128			/**
129			* Get the next timestamp in stream[stream_index].time_base units.
130			* @return the timestamp or AV_NOPTS_VALUE if an error occurred
131			*/
132			int64_t (*read_timestamp)(struct AVFormatContext *s, int stream_index,
133			int64_t *pos, int64_t pos_limit);
134
135			/**
136			* Change the stream state - only meaningful if using a network-based format
137			* (RTSP).
138			*/
139			int (*read_set_state)(struct AVFormatContext *,
140			enum FFInputFormatStreamState state);
141
142			/**
143			* Handle demuxer commands
144			* This callback is used to either send a command to a demuxer
145			* (FF_INFMT_COMMAND_SUBMIT), or to retrieve the reply for
146			* a previously sent command (FF_INFMT_COMMAND_GET_REPLY).
147			*
148			* Demuxers implementing this must return AVERROR(ENOTSUP)
149			* if the provided \p id is not handled by the demuxer.
150			* Demuxers should return AVERROR(EAGAIN) if they can handle
151			* a specific command but are not able to at the moment.
152			* When a reply is requested that is not available yet, the
153			* demuxer should also return AVERROR(EAGAIN).
154			*
155			* Depending on \p opt, the \p data will be either a pointer
156			* to the command payload structure for the specified ID, or
157			* a pointer to the buffer for the command reply for the
158			* specified ID.
159			*
160			* When a command is submitted, before a previous reply
161			* was requested from the demuxer, the demuxer should discard
162			* the old reply.
163			*
164			* @see avformat_send_command()
165			* @see avformat_receive_command_reply()
166			*/
167			int (*handle_command)(struct AVFormatContext *,
168			enum FFInputFormatCommandOption opt,
169			enum AVFormatCommandID id, void *data);
170
171			/**
172			* Seek to timestamp ts.
173			* Seeking will be done so that the point from which all active streams
174			* can be presented successfully will be closest to ts and within min/max_ts.
175			* Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.
176			*/
177			int (*read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags);
178
179			/**
180			* Returns device list with it properties.
181			* @see avdevice_list_devices() for more details.
182			*/
183			int (*get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list);
184			} FFInputFormat;
185
186		6299308	static inline const FFInputFormat *ffifmt(const AVInputFormat *fmt)
187			{
188		6299308	return (const FFInputFormat*)fmt;
189			}
190
191			#define MAX_STD_TIMEBASES (30*12+30+3+6)
192			typedef struct FFStreamInfo {
193			int64_t last_dts;
194			int64_t duration_gcd;
195			int duration_count;
196			int64_t rfps_duration_sum;
197			double (*duration_error)[2][MAX_STD_TIMEBASES];
198			int64_t codec_info_duration;
199			int64_t codec_info_duration_fields;
200			int frame_delay_evidence;
201
202			/**
203			* 0 -> decoder has not been searched for yet.
204			* >0 -> decoder found
205			* <0 -> decoder with codec_id == -found_decoder has not been found
206			*/
207			int found_decoder;
208
209			int64_t last_duration;
210
211			/**
212			* Those are used for average framerate estimation.
213			*/
214			int64_t fps_first_dts;
215			int fps_first_dts_idx;
216			int64_t fps_last_dts;
217			int fps_last_dts_idx;
218			} FFStreamInfo;
219
220			/**
221			* Returned by demuxers to indicate that data was consumed but discarded
222			* (ignored streams or junk data). The framework will re-call the demuxer.
223			*/
224			#define FFERROR_REDO FFERRTAG('R','E','D','O')
225
226			/**
227			* Read a transport packet from a media file.
228			*
229			* @param s media file handle
230			* @param pkt is filled
231			* @return 0 if OK, AVERROR_xxx on error
232			*/
233			int ff_read_packet(AVFormatContext *s, AVPacket *pkt);
234
235			void ff_read_frame_flush(AVFormatContext *s);
236
237			/**
238			* Perform a binary search using av_index_search_timestamp() and
239			* FFInputFormat.read_timestamp().
240			*
241			* @param target_ts target timestamp in the time base of the given stream
242			* @param stream_index stream number
243			*/
244			int ff_seek_frame_binary(AVFormatContext *s, int stream_index,
245			int64_t target_ts, int flags);
246
247			/**
248			* Update cur_dts of all streams based on the given timestamp and AVStream.
249			*
250			* Stream ref_st unchanged, others set cur_dts in their native time base.
251			* Only needed for timestamp wrapping or if (dts not set and pts!=dts).
252			* @param timestamp new dts expressed in time_base of param ref_st
253			* @param ref_st reference stream giving time_base of param timestamp
254			*/
255			void avpriv_update_cur_dts(AVFormatContext *s, AVStream *ref_st, int64_t timestamp);
256
257			int ff_find_last_ts(AVFormatContext *s, int stream_index, int64_t *ts, int64_t *pos,
258			int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
259
260			/**
261			* Perform a binary search using read_timestamp().
262			*
263			* @param target_ts target timestamp in the time base of the given stream
264			* @param stream_index stream number
265			*/
266			int64_t ff_gen_search(AVFormatContext *s, int stream_index,
267			int64_t target_ts, int64_t pos_min,
268			int64_t pos_max, int64_t pos_limit,
269			int64_t ts_min, int64_t ts_max,
270			int flags, int64_t *ts_ret,
271			int64_t (*read_timestamp)(struct AVFormatContext *, int , int64_t *, int64_t ));
272
273			/**
274			* Internal version of av_index_search_timestamp
275			*/
276			int ff_index_search_timestamp(const AVIndexEntry *entries, int nb_entries,
277			int64_t wanted_timestamp, int flags);
278
279			/**
280			* Internal version of av_add_index_entry
281			*/
282			int ff_add_index_entry(AVIndexEntry **index_entries,
283			int *nb_index_entries,
284			unsigned int *index_entries_allocated_size,
285			int64_t pos, int64_t timestamp, int size, int distance, int flags);
286
287			void ff_configure_buffers_for_index(AVFormatContext *s, int64_t time_tolerance);
288
289			/**
290			* Ensure the index uses less memory than the maximum specified in
291			* AVFormatContext.max_index_size by discarding entries if it grows
292			* too large.
293			*/
294			void ff_reduce_index(AVFormatContext *s, int stream_index);
295
296			/**
297			* add frame for rfps calculation.
298			*
299			* @param dts timestamp of the i-th frame
300			* @return 0 if OK, AVERROR_xxx on error
301			*/
302			int ff_rfps_add_frame(AVFormatContext *ic, AVStream *st, int64_t dts);
303
304			void ff_rfps_calculate(AVFormatContext *ic);
305
306			/**
307			* Rescales a timestamp and the endpoints of an interval to which the temstamp
308			* belongs, from a timebase `tb_in` to a timebase `tb_out`.
309			*
310			* The upper (lower) bound of the output interval is rounded up (down) such that
311			* the output interval always falls within the input interval. The timestamp is
312			* rounded to the nearest integer and halfway cases away from zero, and can
313			* therefore fall outside of the output interval.
314			*
315			* Useful to simplify the rescaling of the arguments of FFInputFormat::read_seek2()
316			*
317			* @param[in] tb_in Timebase of the input `min_ts`, `ts` and `max_ts`
318			* @param[in] tb_out Timebase of the output `min_ts`, `ts` and `max_ts`
319			* @param[in,out] min_ts Lower bound of the interval
320			* @param[in,out] ts Timestamp
321			* @param[in,out] max_ts Upper bound of the interval
322			*/
323			void ff_rescale_interval(AVRational tb_in, AVRational tb_out,
324			int64_t *min_ts, int64_t *ts, int64_t *max_ts);
325
326			void avpriv_stream_set_need_parsing(AVStream *st, enum AVStreamParseType type);
327
328			/**
329			* Add a new chapter.
330			*
331			* @param s media file handle
332			* @param id unique ID for this chapter
333			* @param start chapter start time in time_base units
334			* @param end chapter end time in time_base units
335			* @param title chapter title
336			*
337			* @return AVChapter or NULL on error
338			*/
339			AVChapter *avpriv_new_chapter(AVFormatContext *s, int64_t id, AVRational time_base,
340			int64_t start, int64_t end, const char *title);
341
342			/**
343			* Add an attached pic to an AVStream.
344			*
345			* @param st if set, the stream to add the attached pic to;
346			* if unset, a new stream will be added to s.
347			* @param pb AVIOContext to read data from if buf is unset.
348			* @param buf if set, it contains the data and size information to be used
349			* for the attached pic; if unset, data is read from pb.
350			* @param size the size of the data to read if buf is unset.
351			*
352			* @return 0 on success, < 0 on error. On error, this function removes
353			* the stream it has added (if any).
354			*/
355			int ff_add_attached_pic(AVFormatContext *s, AVStream *st, AVIOContext *pb,
356			AVBufferRef **buf, int size);
357
358			/**
359			* Add side data to a packet for changing parameters to the given values.
360			* Parameters set to 0 aren't included in the change.
361			*/
362			int ff_add_param_change(AVPacket *pkt, int32_t channels,
363			uint64_t channel_layout, int32_t sample_rate,
364			int32_t width, int32_t height);
365
366			/**
367			* Generate standard extradata for AVC-Intra based on width/height and field
368			* order.
369			*/
370			int ff_generate_avci_extradata(AVStream *st);
371
372			/**
373			* Allocate extradata with additional AV_INPUT_BUFFER_PADDING_SIZE at end
374			* which is always set to 0 and fill it from pb.
375			*
376			* @param size size of extradata
377			* @return >= 0 if OK, AVERROR_xxx on error
378			*/
379			int ff_get_extradata(void *logctx, AVCodecParameters *par, AVIOContext *pb, int size);
380
381			/**
382			* Find stream index based on format-specific stream ID
383			* @return stream index, or < 0 on error
384			*/
385			int ff_find_stream_index(const AVFormatContext *s, int id);
386
387			int ff_buffer_packet(AVFormatContext *s, AVPacket *pkt);
388
389			#endif /* AVFORMAT_DEMUX_H */
390