AVInputFormat Struct Reference

#include <avformat.h>


Data Fields

const char * name
const char * long_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 by 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 *)
 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 ** codec_tag
struct AVInputFormatnext


Detailed Description

Definition at line 194 of file avformat.h.


Field Documentation

const char* AVInputFormat::name

Definition at line 196 of file avformat.h.

Referenced by opt_show_formats().

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

Definition at line 198 of file avformat.h.

Referenced by av_open_input_stream(), and http_receive_data().

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

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

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

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(), av_seek_frame_generic(), and open_input_stream().

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 occured

Referenced by av_seek_frame(), and av_seek_frame_binary().

can use flags: AVFMT_NOFILE, AVFMT_NEEDNUMBER

Definition at line 235 of file avformat.h.

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

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

Referenced by av_probe_input_format2().

general purpose read only value that the format can use

Definition at line 241 of file avformat.h.

Referenced by raw_read_header(), and video_read_header().

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

Referenced by av_read_play().

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

Referenced by av_read_pause().

Definition at line 251 of file avformat.h.


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

Generated on Thu Apr 2 07:15:45 2009 for ffmpeg by  doxygen 1.5.6