#include <libavformat/avformat.h>

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

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

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. More...

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

const struct AVCodecTag const	codec_tag

const AVClass *	priv_class
	AVClass for the private context. More...

const char *	mime_type
	Comma-separated list of mime types. More...

struct AVInputFormat *	next

int	raw_codec_id
	Raw demuxers store their codec ID here. More...

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

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

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

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

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

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. More...

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. More...

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

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

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. More...

int(*	get_device_list )(struct AVFormatContext s, struct AVDeviceInfoList device_list)
	Returns device list with it properties. More...

int(*	create_device_capabilities )(struct AVFormatContext s, struct AVDeviceCapabilitiesQuery caps)
	Initialize device capabilities submodule. More...

int(*	free_device_capabilities )(struct AVFormatContext s, struct AVDeviceCapabilitiesQuery caps)
	Free device capabilities submodule. More...

Detailed Description

Definition at line 642 of file avformat.h.

Field Documentation

◆ name

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 647 of file avformat.h.

Referenced by ac3_eac3_probe(), amr_read_packet(), av_demuxer_open(), av_dump_format(), av_find_input_format(), av_probe_input_format3(), avformat_close_input(), avformat_find_stream_info(), avformat_open_input(), check_keyboard_interaction(), compute_pkt_fields(), estimate_timings(), ff_rtsp_open_transport_ctx(), format_to_name(), get_rotation(), io_open_default(), is_realtime(), mlp_thd_probe(), mmf_read_packet(), print_times(), probe(), read_gab2_sub(), read_header(), read_thread(), set_codec_from_probe_data(), set_spdif(), show_format(), show_formats_devices(), and show_help_demuxer().

◆ long_name

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 654 of file avformat.h.

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

◆ flags

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 661 of file avformat.h.

Referenced by av_probe_input_format3(), av_read_frame(), avformat_close_input(), avformat_find_stream_info(), avformat_open_input(), dump_stream_format(), estimate_timings(), ff_img_read_header(), init_input(), open_input_file(), print_times(), probe(), process_input(), read_frame_internal(), read_thread(), seek_frame_internal(), show_stream(), and stream_component_open().

◆ extensions

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 668 of file avformat.h.

Referenced by av_probe_input_format3(), and show_help_demuxer().

◆ codec_tag

const struct AVCodecTag* const* AVInputFormat::codec_tag

Definition at line 670 of file avformat.h.

◆ priv_class

const AVClass* AVInputFormat::priv_class

AVClass for the private context.

Definition at line 672 of file avformat.h.

Referenced by avformat_find_stream_info(), avformat_free_context(), avformat_open_input(), ff_alloc_input_device_context(), format_child_class_next(), format_child_next(), get_rotation(), open_input_file(), show_format_opts(), show_formats_devices(), and show_help_demuxer().

◆ mime_type

const char* AVInputFormat::mime_type

Comma-separated list of mime types.

It is used check for matching mime types while probing.

See also: av_probe_input_format2

Definition at line 679 of file avformat.h.

Referenced by av_probe_input_format3(), and pcm_read_header().

◆ next

struct AVInputFormat* AVInputFormat::next

Definition at line 688 of file avformat.h.

◆ raw_codec_id

int AVInputFormat::raw_codec_id

Raw demuxers store their codec ID here.

Definition at line 693 of file avformat.h.

Referenced by adts_aac_read_header(), adx_read_header(), ff_img_read_header(), ff_img_read_packet(), ff_raw_audio_read_header(), ff_raw_data_read_header(), ff_raw_video_read_header(), g726_read_header(), gsm_read_header(), loas_read_header(), pcm_read_header(), rawvideo_read_header(), v210_read_header(), and wsd_read_header().

◆ priv_data_size

int AVInputFormat::priv_data_size

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

Definition at line 698 of file avformat.h.

Referenced by avformat_open_input(), and ff_alloc_input_device_context().

◆ read_probe

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 705 of file avformat.h.

Referenced by av_probe_input_format3(), ff_img_read_header(), and probe().

◆ read_header

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

Read the format header and initialize the AVFormatContext structure.

Return 0 if OK. 'avformat_new_stream' should be called to create new streams.

Definition at line 712 of file avformat.h.

Referenced by av_demuxer_open(), avformat_open_input(), and ff_img_read_header().

◆ read_packet

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 723 of file avformat.h.

Referenced by ff_img_read_packet(), and ff_read_packet().

◆ read_close

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

Close the stream.

The AVFormatContext and AVStreams are not freed by this function

Definition at line 729 of file avformat.h.

Referenced by avformat_close_input().

◆ read_seek

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 739 of file avformat.h.

Referenced by av_seek_frame(), avformat_seek_file(), seek_frame_generic(), seek_frame_internal(), and stream_component_open().

◆ read_timestamp

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 746 of file avformat.h.

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

◆ read_play

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

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

Definition at line 753 of file avformat.h.

Referenced by av_read_play().

◆ read_pause

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

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

Definition at line 759 of file avformat.h.

Referenced by av_read_pause().

◆ read_seek2

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 767 of file avformat.h.

Referenced by av_seek_frame(), and avformat_seek_file().