AVInputFormat Struct Reference
[Demuxing]

#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 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 *, AVFormatParameters *ap)
 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.
attribute_deprecated 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)
 Gets the next timestamp in stream[stream_index].time_base units.
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.
const char * extensions
 If extensions are defined, then no probe is done.
int value
 General purpose read-only value that the format can use.
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).
struct AVCodecTag *const * codec_tag
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.
const AVMetadataConvmetadata_conv
const AVClasspriv_class
 AVClass for the private context.
struct AVInputFormatnext


Detailed Description

Definition at line 401 of file avformat.h.


Field Documentation

struct AVCodecTag* const* AVInputFormat::codec_tag [read]

Definition at line 503 of file avformat.h.

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

Referenced by av_probe_input_format3().

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

Definition at line 477 of file avformat.h.

Referenced by av_open_input_stream(), av_probe_input_format3(), av_seek_frame(), avformat_close_input(), avformat_open_input(), dump_stream_format(), estimate_timings(), init_input(), probe(), read_frame_internal(), read_header(), read_thread(), show_stream(), and transcode().

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

Referenced by opt_formats(), and show_format().

Definition at line 514 of file avformat.h.

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

Referenced by av_dump_format(), av_find_input_format(), estimate_timings(), format_to_name(), open_input_stream(), opt_formats(), probe(), read_thread(), set_codec_from_probe_data(), and show_format().

Definition at line 520 of file avformat.h.

Referenced by av_iformat_next(), and av_register_input_format().

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

Definition at line 418 of file avformat.h.

Referenced by avformat_open_input().

Close the stream.

The AVFormatContext and AVStreams are not freed by this function

Referenced by av_close_input_stream().

Read the format header and initialize the AVFormatContext structure.

Return 0 if OK. 'ap' if non-NULL contains additional parameters. Only used in raw format right now. 'av_new_stream' should be called to create new streams.

Referenced by av_demuxer_open(), and avformat_open_input().

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

Referenced by av_read_packet().

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

Referenced by av_read_pause().

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

Referenced by av_read_play().

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.

Referenced by av_probe_input_format3(), and probe().

attribute_deprecated 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(), avformat_seek_file(), open_input_stream(), and seek_frame_generic().

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.

Referenced by avformat_seek_file().

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 avformat_seek_file(), and ff_seek_frame_binary().

General purpose read-only value that the format can use.

Definition at line 489 of file avformat.h.

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


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

Generated on Fri Oct 26 02:43:55 2012 for FFmpeg by  doxygen 1.5.8