AVInputFormat Struct Reference

#include <avformat.h>


Data Fields

const char * name
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.
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.
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 *)
 Starts/resumes playing - only meaningful if using a network-based format (RTSP).
int(* read_pause )(struct AVFormatContext *)
 Pauses 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)
 Seeks to timestamp ts.
const AVMetadataConvmetadata_conv
struct AVInputFormatnext


Detailed Description

Definition at line 290 of file avformat.h.


Field Documentation

const char * AVInputFormat::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 297 of file avformat.h.

Referenced by show_format(), and show_formats().

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

Definition at line 299 of file avformat.h.

Referenced by av_open_input_stream().

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_format2(), and probe().

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_open_input_stream().

int(* AVInputFormat::read_packet)(struct AVFormatContext *, AVPacket *pkt) ( 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.

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().

int(* AVInputFormat::read_close)(struct AVFormatContext *) ( 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) ( 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(), av_seek_frame_generic(), avformat_seek_file(), and open_input_stream().

int64_t(* AVInputFormat::read_timestamp)(struct AVFormatContext *s, int stream_index, int64_t *pos, int64_t pos_limit) ( 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(), av_seek_frame_binary(), and avformat_seek_file().

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

Referenced by av_probe_input_format2().

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

Definition at line 348 of file avformat.h.

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

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

Starts/resumes playing - only meaningful if using a network-based format (RTSP).

Referenced by av_read_play().

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

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

Referenced by av_read_pause().

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

Definition at line 358 of file avformat.h.

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

Seeks 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().

Definition at line 368 of file avformat.h.

Referenced by av_transcode(), and show_format().


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

Generated on Tue Apr 20 17:40:02 2010 for FFmpeg by  doxygen 1.5.6