#include <avformat.h>

Data Fields
const char *	name
	A comma separated list of short names for the format.

const char *	long_name
	Descriptive name for the format, meant to be more human-readable than name.

int	flags
	Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS, AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH, AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS.

const char *	extensions
	If extensions are defined, then no probe is done.

struct AVCodecTag const	codec_tag

const AVClass *	priv_class
	AVClass for the private context.

struct AVInputFormat *	next

int	raw_codec_id
	Raw demuxers store their codec ID here.

int	priv_data_size
	Size of private data so that it can be allocated in the wrapper.

int(*	read_probe )(AVProbeData *)
	Tell if a given file has a chance of being parsed as this format.

int(*	read_header )(struct AVFormatContext *)
	Read the format header and initialize the AVFormatContext structure.

int(*	read_packet )(struct AVFormatContext , AVPacket pkt)
	Read one packet and put it in 'pkt'.

int(*	read_close )(struct AVFormatContext *)
	Close the stream.

int(*	read_seek )(struct AVFormatContext *, int stream_index, int64_t timestamp, int flags)
	Seek to a given timestamp relative to the frames in stream component stream_index.

int64_t(*	read_timestamp )(struct AVFormatContext s, int stream_index, int64_t pos, int64_t pos_limit)
	Get the next timestamp in stream[stream_index].time_base units.

int(*	read_play )(struct AVFormatContext *)
	Start/resume playing - only meaningful if using a network-based format (RTSP).

int(*	read_pause )(struct AVFormatContext *)
	Pause playing - only meaningful if using a network-based format (RTSP).

int(*	read_seek2 )(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)
	Seek to timestamp ts.

Detailed Description

Definition at line 459 of file avformat.h.

Field Documentation

const char* AVInputFormat::name

A comma separated list of short names for the format.

New names may be appended with a minor bump.

Definition at line 464 of file avformat.h.

Referenced by av_dump_format(), av_find_input_format(), avformat_open_input(), compute_pkt_fields(), estimate_timings(), format_to_name(), is_realtime(), open_input_stream(), probe(), read_thread(), set_codec_from_probe_data(), show_format(), show_formats(), and show_help_demuxer().

const char* AVInputFormat::long_name

Descriptive name for the format, meant to be more human-readable than name.

You should use the NULL_IF_CONFIG_SMALL() macro to define it.

Definition at line 471 of file avformat.h.

Referenced by show_format(), show_formats(), and show_help_demuxer().

int AVInputFormat::flags

Can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER, AVFMT_SHOW_IDS, AVFMT_GENERIC_INDEX, AVFMT_TS_DISCONT, AVFMT_NOBINSEARCH, AVFMT_NOGENSEARCH, AVFMT_NO_BYTE_SEEK, AVFMT_SEEK_TO_PTS.

Definition at line 478 of file avformat.h.

Referenced by av_probe_input_format3(), av_read_frame(), avformat_close_input(), avformat_open_input(), dump_stream_format(), estimate_timings(), img_read_header(), init_input(), probe(), process_input(), read_frame_internal(), read_thread(), seek_frame_internal(), and show_stream().

const char* AVInputFormat::extensions

If extensions are defined, then no probe is done.

You should usually not use extension format guessing because it is not reliable enough

Definition at line 485 of file avformat.h.

Referenced by av_probe_input_format3(), and show_help_demuxer().

struct AVCodecTag* const* AVInputFormat::codec_tag

Definition at line 487 of file avformat.h.

const AVClass* AVInputFormat::priv_class

AVClass for the private context.

Definition at line 489 of file avformat.h.

Referenced by avformat_free_context(), avformat_open_input(), format_child_class_next(), format_child_next(), open_input_file(), show_format_opts(), and show_help_demuxer().

struct AVInputFormat* AVInputFormat::next

Definition at line 498 of file avformat.h.

Referenced by av_iformat_next(), and av_register_input_format().

int AVInputFormat::raw_codec_id

Raw demuxers store their codec ID here.

Definition at line 503 of file avformat.h.

Referenced by adts_aac_read_header(), adx_read_header(), ff_raw_audio_read_header(), ff_raw_video_read_header(), gsm_read_header(), loas_read_header(), pcm_read_header(), and rawvideo_read_header().

int AVInputFormat::priv_data_size

Size of private data so that it can be allocated in the wrapper.

Definition at line 508 of file avformat.h.

Referenced by avformat_open_input().

int(* AVInputFormat::read_probe)(AVProbeData *)

Tell if a given file has a chance of being parsed as this format.

The buffer provided is guaranteed to be AVPROBE_PADDING_SIZE bytes big so you do not have to check for that unless you need more.

Definition at line 515 of file avformat.h.

Referenced by av_probe_input_format3(), and probe().

int(* AVInputFormat::read_header)(struct AVFormatContext *)

Read the format header and initialize the AVFormatContext structure.

Return 0 if OK. Only used in raw format right now. 'avformat_new_stream' should be called to create new streams.

Definition at line 522 of file avformat.h.

Referenced by av_demuxer_open(), and avformat_open_input().

int(* AVInputFormat::read_packet)(struct AVFormatContext *, AVPacket *pkt)

Read one packet and put it in 'pkt'.

pts and flags are also set. 'avformat_new_stream' can be called only if the flag AVFMTCTX_NOHEADER is used and only in the calling thread (not in a background thread).

Returns: 0 on success, < 0 on error. When returning an error, pkt must not have been allocated or must be freed before returning

Definition at line 533 of file avformat.h.

Referenced by ff_read_packet().

int(* AVInputFormat::read_close)(struct AVFormatContext *)

Close the stream.

The AVFormatContext and AVStreams are not freed by this function

Definition at line 539 of file avformat.h.

Referenced by avformat_close_input().

int(* AVInputFormat::read_seek)(struct AVFormatContext *, int stream_index, int64_t timestamp, int flags)

Seek to a given timestamp relative to the frames in stream component stream_index.

Parameters

stream_index	Must not be -1.
flags	Selects which direction should be preferred if no exact match is available.

Returns: >= 0 on success (but not necessarily the new offset)

Definition at line 549 of file avformat.h.

Referenced by avformat_seek_file(), open_input_stream(), seek_frame_generic(), and seek_frame_internal().

int64_t(* AVInputFormat::read_timestamp)(struct AVFormatContext *s, int stream_index, int64_t *pos, int64_t pos_limit)

Get the next timestamp in stream[stream_index].time_base units.

Returns: the timestamp or AV_NOPTS_VALUE if an error occurred

Definition at line 556 of file avformat.h.

Referenced by avformat_seek_file(), ff_seek_frame_binary(), and seek_frame_internal().

int(* AVInputFormat::read_play)(struct AVFormatContext *)

Start/resume playing - only meaningful if using a network-based format (RTSP).

Definition at line 563 of file avformat.h.

Referenced by av_read_play().

int(* AVInputFormat::read_pause)(struct AVFormatContext *)

Pause playing - only meaningful if using a network-based format (RTSP).

Definition at line 569 of file avformat.h.

Referenced by av_read_pause().

int(* AVInputFormat::read_seek2)(struct AVFormatContext *s, int stream_index, int64_t min_ts, int64_t ts, int64_t max_ts, int flags)

Seek to timestamp ts.

Seeking will be done so that the point from which all active streams can be presented successfully will be closest to ts and within min/max_ts. Active streams are all streams that have AVStream.discard < AVDISCARD_ALL.

Definition at line 577 of file avformat.h.

Referenced by avformat_seek_file().

The documentation for this struct was generated from the following file:

libavformat/avformat.h

Data Fields

Detailed Description

Field Documentation