FFmpeg
Data Fields
FFOutputFormat Struct Reference

#include <mux.h>

Data Fields

AVOutputFormat p
 The public AVOutputFormat. More...
 
int priv_data_size
 size of private data so that it can be allocated in the wrapper More...
 
int flags_internal
 Internal flags. More...
 
int(* write_header )(AVFormatContext *)
 
int(* write_packet )(AVFormatContext *, AVPacket *pkt)
 Write a packet. More...
 
int(* write_trailer )(AVFormatContext *)
 
int(* interleave_packet )(AVFormatContext *s, AVPacket *pkt, int flush, int has_packet)
 A format-specific function for interleavement. More...
 
int(* query_codec )(enum AVCodecID id, int std_compliance)
 Test if the given codec can be stored in this container. More...
 
void(* get_output_timestamp )(AVFormatContext *s, int stream, int64_t *dts, int64_t *wall)
 
int(* control_message )(AVFormatContext *s, int type, void *data, size_t data_size)
 Allows sending messages from application to device. More...
 
int(* write_uncoded_frame )(AVFormatContext *, int stream_index, struct AVFrame **frame, unsigned flags)
 Write an uncoded AVFrame. More...
 
int(* get_device_list )(AVFormatContext *s, struct AVDeviceInfoList *device_list)
 Returns device list with it properties. More...
 
int(* init )(AVFormatContext *)
 Initialize format. More...
 
void(* deinit )(AVFormatContext *)
 Deinitialize format. More...
 
int(* check_bitstream )(AVFormatContext *s, AVStream *st, const AVPacket *pkt)
 Set up any necessary bitstream filtering and extract any extra data needed for the global header. More...
 

Detailed Description

Definition at line 61 of file mux.h.

Field Documentation

◆ p

AVOutputFormat FFOutputFormat::p

The public AVOutputFormat.

See avformat.h for it.

Definition at line 65 of file mux.h.

Referenced by fifo_init(), init_muxer(), mpeg_mux_init(), and next_output().

◆ priv_data_size

int FFOutputFormat::priv_data_size

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

Definition at line 69 of file mux.h.

Referenced by avformat_alloc_output_context2(), and init_muxer().

◆ flags_internal

int FFOutputFormat::flags_internal

Internal flags.

See FF_OFMT_FLAG_* above and FF_FMT_FLAG_* in internal.h.

Definition at line 74 of file mux.h.

Referenced by av_write_frame(), and init_muxer().

◆ write_header

int(* FFOutputFormat::write_header) (AVFormatContext *)

Definition at line 76 of file mux.h.

Referenced by avformat_write_header().

◆ write_packet

int(* FFOutputFormat::write_packet) (AVFormatContext *, AVPacket *pkt)

Write a packet.

If FF_OFMT_FLAG_ALLOW_FLUSH is set in flags_internal, pkt can be NULL in order to flush data buffered in the muxer. When flushing, return 0 if there still is more data to flush, or 1 if everything was flushed and there is no more buffered data.

Definition at line 84 of file mux.h.

Referenced by av_write_frame(), and write_packet().

◆ write_trailer

int(* FFOutputFormat::write_trailer) (AVFormatContext *)

Definition at line 85 of file mux.h.

Referenced by av_write_trailer().

◆ interleave_packet

int(* FFOutputFormat::interleave_packet) (AVFormatContext *s, AVPacket *pkt, int flush, int has_packet)

A format-specific function for interleavement.

If unset, packets will be interleaved by dts.

Parameters
sAn AVFormatContext for output. pkt will be added to resp. taken from its packet buffer.
[in,out]pktA packet to be interleaved if has_packet is set; also used to return packets. If no packet is returned (e.g. on error), pkt is blank on return.
flush1 if no further packets are available as input and all remaining packets should be output.
has_packetIf set, pkt contains a packet to be interleaved on input; otherwise pkt is blank on input.
Returns
1 if a packet was output, 0 if no packet could be output, < 0 if an error occurred

Definition at line 102 of file mux.h.

Referenced by init_muxer(), and seg_write_packet().

◆ query_codec

int(* FFOutputFormat::query_codec) (enum AVCodecID id, int std_compliance)

Test if the given codec can be stored in this container.

Returns
1 if the codec is supported, 0 if it is not. A negative number if unknown. MKTAG('A', 'P', 'I', 'C') if the codec is only supported as AV_DISPOSITION_ATTACHED_PIC

Definition at line 111 of file mux.h.

Referenced by avformat_query_codec().

◆ get_output_timestamp

void(* FFOutputFormat::get_output_timestamp) (AVFormatContext *s, int stream, int64_t *dts, int64_t *wall)

Definition at line 113 of file mux.h.

Referenced by av_get_output_timestamp().

◆ control_message

int(* FFOutputFormat::control_message) (AVFormatContext *s, int type, void *data, size_t data_size)

Allows sending messages from application to device.

Definition at line 118 of file mux.h.

Referenced by avdevice_app_to_dev_control_message().

◆ write_uncoded_frame

int(* FFOutputFormat::write_uncoded_frame) (AVFormatContext *, int stream_index, struct AVFrame **frame, unsigned flags)

Write an uncoded AVFrame.

See av_write_uncoded_frame() for details.

The library will free *frame afterwards, but the muxer can prevent it by setting the pointer to NULL.

Definition at line 129 of file mux.h.

Referenced by av_write_uncoded_frame_query(), write_packet(), and write_uncoded_frame_internal().

◆ get_device_list

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

Returns device list with it properties.

See also
avdevice_list_devices() for more details.

Definition at line 135 of file mux.h.

Referenced by avdevice_list_devices().

◆ init

int(* FFOutputFormat::init) (AVFormatContext *)

Initialize format.

May allocate data here, and set any AVFormatContext or AVStream parameters that need to be set before packets are sent. This method must not write output.

Return 0 if streams were fully configured, 1 if not, negative AVERROR on failure

Any allocations made here must be freed in deinit().

Definition at line 145 of file mux.h.

Referenced by avformat_init_output(), and init_muxer().

◆ deinit

void(* FFOutputFormat::deinit) (AVFormatContext *)

Deinitialize format.

If present, this is called whenever the muxer is being destroyed, regardless of whether or not the header has been written.

If a trailer is being written, this is called after write_trailer().

This is called if init() fails as well.

Definition at line 154 of file mux.h.

Referenced by avformat_free_context(), deinit_muxer(), and init_muxer().

◆ check_bitstream

int(* FFOutputFormat::check_bitstream) (AVFormatContext *s, AVStream *st, const AVPacket *pkt)

Set up any necessary bitstream filtering and extract any extra data needed for the global header.

Note
pkt might have been directly forwarded by a meta-muxer; therefore pkt->stream_index as well as the pkt's timebase might be invalid. Return 0 if more packets from this stream must be checked; 1 if not.

Definition at line 163 of file mux.h.

Referenced by check_bitstream(), dash_check_bitstream(), and seg_check_bitstream().


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