FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Data Fields
AVInputFormat Struct Reference

#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 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.
 
const char * extensions
 If extensions are defined, then no probe is done.
 
struct AVCodecTag *const * codec_tag
 
const AVClasspriv_class
 AVClass for the private context.
 
const char * mime_type
 Comma-separated list of mime types.
 
struct AVInputFormatnext
 
int raw_codec_id
 Raw demuxers store their codec ID here.
 
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 *)
 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)
 Get the next timestamp in stream[stream_index].time_base units.
 
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).
 
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.
 
int(* get_device_list )(struct AVFormatContext *s, struct AVDeviceInfoList *device_list)
 Returns device list with it properties.
 
int(* create_device_capabilities )(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps)
 Initialize device capabilities submodule.
 
int(* free_device_capabilities )(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps)
 Free device capabilities submodule.
 

Detailed Description

Definition at line 560 of file avformat.h.

Field Documentation

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

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

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 579 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(), print_times(), probe(), process_input(), read_frame_internal(), read_thread(), seek_frame_internal(), and show_stream().

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

Referenced by av_probe_input_format3(), and show_help_demuxer().

struct AVCodecTag* const* AVInputFormat::codec_tag

Definition at line 588 of file avformat.h.

const AVClass* AVInputFormat::priv_class
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 597 of file avformat.h.

Referenced by av_probe_input_format3().

struct AVInputFormat* AVInputFormat::next

Definition at line 606 of file avformat.h.

Referenced by av_iformat_next(), and av_register_input_format().

int AVInputFormat::raw_codec_id
int AVInputFormat::priv_data_size

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

Definition at line 616 of file avformat.h.

Referenced by avformat_open_input().

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

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

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

Read the format header and initialize the AVFormatContext structure.

Return 0 if OK. Only used in raw format right now. 'avformat_new_stream' should be called to create new streams.

Definition at line 630 of file avformat.h.

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

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

Referenced by ff_img_read_packet(), and ff_read_packet().

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

Close the stream.

The AVFormatContext and AVStreams are not freed by this function

Definition at line 647 of file avformat.h.

Referenced by avformat_close_input().

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_indexMust not be -1.
flagsSelects which direction should be preferred if no exact match is available.
Returns
>= 0 on success (but not necessarily the new offset)

Definition at line 657 of file avformat.h.

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

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

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

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

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

Definition at line 671 of file avformat.h.

Referenced by av_read_play().

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

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

Definition at line 677 of file avformat.h.

Referenced by av_read_pause().

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

Referenced by av_seek_frame(), and avformat_seek_file().

int(* AVInputFormat::get_device_list)(struct AVFormatContext *s, struct AVDeviceInfoList *device_list)

Returns device list with it properties.

See Also
avdevice_list_devices() for more details.

Definition at line 691 of file avformat.h.

Referenced by avdevice_list_devices().

int(* AVInputFormat::create_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps)

Initialize device capabilities submodule.

See Also
avdevice_capabilities_create() for more details.

Definition at line 697 of file avformat.h.

Referenced by avdevice_capabilities_create().

int(* AVInputFormat::free_device_capabilities)(struct AVFormatContext *s, struct AVDeviceCapabilitiesQuery *caps)

Free device capabilities submodule.

See Also
avdevice_capabilities_free() for more details.

Definition at line 703 of file avformat.h.

Referenced by avdevice_capabilities_free().


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