AVInputFormat Struct Reference

#include <avformat.h>

Data Fields
const char *	name
const char *	long_name
int	priv_data_size
int(*	read_probe )(AVProbeData *)
int(*	read_header )(struct AVFormatContext *, AVFormatParameters *ap)
int(*	read_packet )(struct AVFormatContext *, AVPacket *pkt)
int(*	read_close )(struct AVFormatContext *)
int(*	read_seek )(struct AVFormatContext *, int stream_index, int64_t timestamp, int flags)
int64_t(*	read_timestamp )(struct AVFormatContext *s, int stream_index, int64_t *pos, int64_t pos_limit)
int	flags
const char *	extensions
int	value
int(*	read_play )(struct AVFormatContext *)
int(*	read_pause )(struct AVFormatContext *)
AVCodecTag **	codec_tag
AVInputFormat *	next

---

Detailed Description

Definition at line 222 of file avformat.h.

---

Field Documentation

const char* AVInputFormat::name

Definition at line 223 of file avformat.h.

Referenced by av_estimate_timings(), av_find_input_format(), dump_format(), format_to_name(), libextractor_thumbnailffmpeg_extract(), set_codec_from_probe_data(), and show_formats().

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

Referenced by libextractor_thumbnailffmpeg_extract(), and show_formats().

int AVInputFormat::priv_data_size

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

Definition at line 231 of file avformat.h.

Referenced by av_open_input_stream().

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

Tell if a given file has a chance of being parsed by 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.

Referenced by av_probe_input_format2(), and libextractor_thumbnailffmpeg_extract().

int(* AVInputFormat::read_header)(struct AVFormatContext *, AVFormatParameters *ap)

read the format header and initialize the AVFormatContext structure. Return 0 if OK. 'ap' if non NULL contains additional paramters. Only used in raw format right now. 'av_new_stream' should be called to create new streams.

Referenced by av_open_input_stream().

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

read one packet and put it in 'pkt'. pts and flags are also set. 'av_new_stream' can be called only if the flag AVFMTCTX_NOHEADER is used.

Referenced by av_read_packet().

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

close the stream. The AVFormatContext and AVStreams are not freed by this function

Referenced by av_close_input_stream().

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)

Referenced by av_seek_frame_generic().

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

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

Returns:

the timestamp or AV_NOPTS_VALUE if an error occurred

Referenced by av_seek_frame_binary().

int AVInputFormat::flags

can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER

Definition at line 268 of file avformat.h.

Referenced by av_close_input_file(), av_estimate_timings(), av_open_input_file(), av_probe_input_format2(), dump_stream_format(), and libextractor_thumbnailffmpeg_extract().

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

Referenced by av_probe_input_format2().

int AVInputFormat::value

general purpose read only value that the format can use

Definition at line 274 of file avformat.h.

Referenced by audio_read_header(), raw_read_header(), and video_read_header().

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

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

Referenced by av_read_play().

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

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

Referenced by av_read_pause().

struct AVCodecTag** AVInputFormat::codec_tag

Definition at line 284 of file avformat.h.

struct AVInputFormat* AVInputFormat::next

Definition at line 287 of file avformat.h.

Referenced by av_find_input_format(), av_iformat_next(), av_probe_input_format2(), and av_register_input_format().

---

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

• avformat.h

---