All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Files | Data Structures | Enumerations | Functions

AVFrame is an abstraction for reference-counted raw multimedia data. More...


file  frame.h
 reference-counted frame API

Data Structures

struct  AVFrameSideData
 Structure to hold side data for an AVFrame. More...
struct  AVFrame
 This structure describes decoded (raw) audio or video data. More...


enum  AVFrameSideDataType {
enum  AVActiveFormatDescription {
  AV_AFD_SAME = 8, AV_AFD_4_3 = 9, AV_AFD_16_9 = 10, AV_AFD_14_9 = 11,
  AV_AFD_4_3_SP_14_9 = 13, AV_AFD_16_9_SP_14_9 = 14, AV_AFD_SP_4_3 = 15


int64_t av_frame_get_best_effort_timestamp (const AVFrame *frame)
 Accessors for some AVFrame fields. More...
void av_frame_set_best_effort_timestamp (AVFrame *frame, int64_t val)
int64_t av_frame_get_pkt_duration (const AVFrame *frame)
void av_frame_set_pkt_duration (AVFrame *frame, int64_t val)
int64_t av_frame_get_pkt_pos (const AVFrame *frame)
void av_frame_set_pkt_pos (AVFrame *frame, int64_t val)
int64_t av_frame_get_channel_layout (const AVFrame *frame)
void av_frame_set_channel_layout (AVFrame *frame, int64_t val)
int av_frame_get_channels (const AVFrame *frame)
void av_frame_set_channels (AVFrame *frame, int val)
int av_frame_get_sample_rate (const AVFrame *frame)
void av_frame_set_sample_rate (AVFrame *frame, int val)
AVDictionaryav_frame_get_metadata (const AVFrame *frame)
void av_frame_set_metadata (AVFrame *frame, AVDictionary *val)
int av_frame_get_decode_error_flags (const AVFrame *frame)
void av_frame_set_decode_error_flags (AVFrame *frame, int val)
int av_frame_get_pkt_size (const AVFrame *frame)
void av_frame_set_pkt_size (AVFrame *frame, int val)
AVDictionary ** avpriv_frame_get_metadatap (AVFrame *frame)
int8_t * av_frame_get_qp_table (AVFrame *f, int *stride, int *type)
int av_frame_set_qp_table (AVFrame *f, AVBufferRef *buf, int stride, int type)
enum AVColorSpace av_frame_get_colorspace (const AVFrame *frame)
void av_frame_set_colorspace (AVFrame *frame, enum AVColorSpace val)
enum AVColorRange av_frame_get_color_range (const AVFrame *frame)
void av_frame_set_color_range (AVFrame *frame, enum AVColorRange val)
const char * av_get_colorspace_name (enum AVColorSpace val)
 Get the name of a colorspace. More...
AVFrameav_frame_alloc (void)
 Allocate an AVFrame and set its fields to default values. More...
void av_frame_free (AVFrame **frame)
 Free the frame and any dynamically allocated objects in it, e.g. More...
int av_frame_ref (AVFrame *dst, const AVFrame *src)
 Set up a new reference to the data described by the source frame. More...
AVFrameav_frame_clone (const AVFrame *src)
 Create a new frame that references the same data as src. More...
void av_frame_unref (AVFrame *frame)
 Unreference all the buffers referenced by frame and reset the frame fields. More...
void av_frame_move_ref (AVFrame *dst, AVFrame *src)
 Move everything contained in src to dst and reset src. More...
int av_frame_get_buffer (AVFrame *frame, int align)
 Allocate new buffer(s) for audio or video data. More...
int av_frame_is_writable (AVFrame *frame)
 Check if the frame data is writable. More...
int av_frame_make_writable (AVFrame *frame)
 Ensure that the frame data is writable, avoiding data copy if possible. More...
int av_frame_copy (AVFrame *dst, const AVFrame *src)
 Copy the frame data from src to dst. More...
int av_frame_copy_props (AVFrame *dst, const AVFrame *src)
 Copy only "metadata" fields from src to dst. More...
AVBufferRefav_frame_get_plane_buffer (AVFrame *frame, int plane)
 Get the buffer reference a given data plane is stored in. More...
AVFrameSideDataav_frame_new_side_data (AVFrame *frame, enum AVFrameSideDataType type, int size)
 Add a new side data to a frame. More...
AVFrameSideDataav_frame_get_side_data (const AVFrame *frame, enum AVFrameSideDataType type)
void av_frame_remove_side_data (AVFrame *frame, enum AVFrameSideDataType type)
 If side data of the supplied type exists in the frame, free it and remove it from the frame. More...
const char * av_frame_side_data_name (enum AVFrameSideDataType type)

Detailed Description

AVFrame is an abstraction for reference-counted raw multimedia data.

Enumeration Type Documentation


The data is the AVPanScan struct defined in libavcodec.


ATSC A53 Part 4 Closed Captions.

A53 CC bitstream is stored as uint8_t in AVFrameSideData.data. The number of bytes of CC data is AVFrameSideData.size.


Stereoscopic 3d metadata.

The data is the AVStereo3D struct defined in libavutil/stereo3d.h.


The data is the AVMatrixEncoding enum defined in libavutil/channel_layout.h.


Metadata relevant to a downmix procedure.

The data is the AVDownmixInfo struct defined in libavutil/downmix_info.h.


ReplayGain information in the form of the AVReplayGain struct.


This side data contains a 3x3 transformation matrix describing an affine transformation that needs to be applied to the frame for correct presentation.

See libavutil/display.h for a detailed description of the data.


Active Format Description data consisting of a single byte as specified in ETSI TS 101 154 using AVActiveFormatDescription enum.


Motion vectors exported by some codecs (on demand through the export_mvs flag set in the libavcodec AVCodecContext flags2 option).

The data is the AVMotionVector struct defined in libavutil/motion_vector.h.


Recommmends skipping the specified number of samples.

This is exported only if the "skip_manual" AVOption is set in libavcodec. This has the same format as AV_PKT_DATA_SKIP_SAMPLES.

u32le number of samples to skip from start of this packet
u32le number of samples to skip from end of this packet
u8 reason for start skip
u8 reason for end skip (0=padding silence, 1=convergence)

This side data must be associated with an audio frame and corresponds to enum AVAudioServiceType defined in avcodec.h.


Mastering display metadata associated with a video frame.

The payload is an AVMasteringDisplayMetadata type and contains information about the mastering display color volume.


The GOP timecode in 25 bit timecode format.

Data format is 64-bit integer. This is set on the first frame of a GOP that has a temporal reference of 0.

Definition at line 48 of file frame.h.


Definition at line 127 of file frame.h.

Function Documentation

int64_t av_frame_get_best_effort_timestamp ( const AVFrame frame)

Accessors for some AVFrame fields.

The position of these field in the structure is not part of the ABI, they should not be accessed directly outside libavutil.

filtering_video.c, and transcoding.c.

Referenced by decode_video(), decoder_decode_frame(), main(), movie_push_frame(), and show_frame().

void av_frame_set_best_effort_timestamp ( AVFrame frame,
int64_t  val 
int64_t av_frame_get_pkt_duration ( const AVFrame frame)
void av_frame_set_pkt_duration ( AVFrame frame,
int64_t  val 
int64_t av_frame_get_pkt_pos ( const AVFrame frame)
void av_frame_set_pkt_pos ( AVFrame frame,
int64_t  val 
int64_t av_frame_get_channel_layout ( const AVFrame frame)

Referenced by print_frame(), and show_frame().

void av_frame_set_channel_layout ( AVFrame frame,
int64_t  val 
int av_frame_get_channels ( const AVFrame frame)
void av_frame_set_channels ( AVFrame frame,
int  val 
int av_frame_get_sample_rate ( const AVFrame frame)
void av_frame_set_sample_rate ( AVFrame frame,
int  val 

Referenced by request_frame().

AVDictionary* av_frame_get_metadata ( const AVFrame frame)
void av_frame_set_metadata ( AVFrame frame,
AVDictionary val 
int av_frame_get_decode_error_flags ( const AVFrame frame)

Referenced by check_decode_result().

void av_frame_set_decode_error_flags ( AVFrame frame,
int  val 
int av_frame_get_pkt_size ( const AVFrame frame)

Referenced by show_frame().

void av_frame_set_pkt_size ( AVFrame frame,
int  val 
AVDictionary** avpriv_frame_get_metadatap ( AVFrame frame)
int8_t* av_frame_get_qp_table ( AVFrame f,
int *  stride,
int *  type 

Definition at line 65 of file frame.c.

Referenced by filter_frame(), and pp_filter_frame().

int av_frame_set_qp_table ( AVFrame f,
AVBufferRef buf,
int  stride,
int  type 

Definition at line 50 of file frame.c.

Referenced by ff_mjpeg_decode_frame(), ff_mpv_export_qp_table(), and filter_frame().

enum AVColorSpace av_frame_get_colorspace ( const AVFrame frame)
void av_frame_set_colorspace ( AVFrame frame,
enum AVColorSpace  val 
enum AVColorRange av_frame_get_color_range ( const AVFrame frame)
void av_frame_set_color_range ( AVFrame frame,
enum AVColorRange  val 
const char* av_get_colorspace_name ( enum AVColorSpace  val)

Get the name of a colorspace.

a static string identifying the colorspace; can be NULL.

Definition at line 79 of file frame.c.

Referenced by avcodec_string(), and show_stream().

AVFrame* av_frame_alloc ( void  )

Allocate an AVFrame and set its fields to default values.

The resulting struct must be freed using av_frame_free().

An AVFrame filled with default values or NULL on failure.
this only allocates the AVFrame itself, not the data buffers. Those must be allocated through other means, e.g. with av_frame_get_buffer() or manually.

Definition at line 141 of file frame.c.

Referenced by aasc_decode_init(), alloc_audio_frame(), alloc_frame(), alloc_frame_empty(), alloc_picture(), apng_encode_frame(), audio_decode_example(), audio_encode_example(), audio_thread(), av_buffersink_get_samples(), av_buffersrc_add_frame_flags(), av_buffersrc_add_frame_internal(), av_frame_clone(), avcodec_encode_audio2(), avcodec_open2(), avs_decode_init(), bethsoftvid_decode_init(), cdg_decode_init(), cinepak_decode_init(), cinepak_encode_init(), cinvideo_decode_init(), cmv_decode_init(), config_input(), config_output(), cpia_decode_init(), decklink_write_video_packet(), decode_audio(), decode_entropy_coded_image(), decode_init(), decode_video(), dirac_decode_init(), do_video_out(), downscale(), dxva2_alloc(), encode_apng(), encode_frame(), encode_init(), escape124_decode_init(), ff_cavs_init(), ff_create_schro_frame(), ff_default_get_audio_buffer(), ff_ffv1_common_init(), ff_frame_thread_init(), ff_libwebp_get_frame(), ff_load_image(), ff_mjpeg_decode_init(), ff_mpv_common_init(), ff_mpv_encode_init(), ff_thread_video_encode_frame(), ff_video_frame_pool_get(), ff_vp56_init_context(), fic_decode_init(), filter_encode_write_frame(), flashsv_decode_init(), flic_decode_init(), frame_queue_init(), get_free_frame(), get_surface(), gif_decode_init(), gif_encode_frame(), h264_init_context(), hevc_init_context(), init(), init_axis_from_file(), init_axis_from_font(), init_frames(), init_input_frame(), init_output_frame(), ipvideo_decode_init(), ir2_decode_init(), lavfi_read_header(), main(), mca(), mimic_decode_init(), mm_decode_init(), movie_push_frame(), mp_decode_init(), msrle_decode_init(), mss1_decode_init(), mss2_decode_init(), mss3_decode_init(), mss4_decode_init(), msvideo1_decode_init(), mvc_decode_init(), mxpeg_decode_init(), pad_last_frame(), paf_video_init(), png_dec_init(), qtrle_decode_init(), qtrle_encode_init(), read_interval_packets(), reap_filters(), reget_buffer_internal(), roq_decode_init(), roq_encode_init(), rpza_decode_init(), rscc_init(), run_test(), screenpresso_init(), seek_test(), sender_thread(), seqvideo_decode_init(), sgirle_decode_init(), smc_decode_init(), smvjpeg_decode_init(), sub2video_prepare(), svq1_decode_init(), svq1_encode_init(), svq3_decode_init(), tdsc_init(), tgv_decode_init(), truemotion1_decode_init(), try_decode_frame(), try_decode_video_frame(), try_push_frame(), tscc2_decode_init(), ulti_decode_init(), utvideo_decode_init(), vc1_decode_init(), vdpau_alloc(), video_decode(), video_decode_example(), video_encode_example(), video_thread(), videotoolbox_init(), vmdvideo_decode_init(), vp8_init_frames(), vp8_lossy_decode_alpha(), xan_decode_init(), yop_decode_init(), and zerocodec_decode_init().

void av_frame_free ( AVFrame **  frame)

Free the frame and any dynamically allocated objects in it, e.g.

extended_data. If the frame is reference counted, it will be unreferenced first.

frameframe to be freed. The pointer will be set to NULL.

Definition at line 154 of file frame.c.

Referenced by aasc_decode_end(), add_to_queue(), alloc_frame(), alloc_frame_empty(), amv_encode_picture(), apng_encode_frame(), apply_lut(), apply_palette(), audio_decode_example(), audio_encode_example(), audio_thread(), av_buffersink_get_frame_flags(), av_buffersink_get_samples(), av_buffersrc_add_frame_flags(), av_buffersrc_add_frame_internal(), av_frame_clone(), avcodec_close(), avcodec_encode_audio2(), avfilter_link_free(), avs_decode_end(), bethsoftvid_decode_end(), blend_frame(), cdg_decode_end(), channelmap_filter_frame(), cinepak_decode_end(), cinepak_encode_end(), cinepak_encode_init(), cinvideo_decode_end(), close_decoder(), close_stream(), cmv_decode_end(), cmv_decode_init(), common_uninit(), compand_delay(), compand_nodelay(), config_output(), config_video(), config_video_output(), cpia_decode_end(), decimate_uninit(), decklink_write_video_packet(), decode_close(), decode_end(), decode_init(), dirac_decode_end(), dirac_decode_init(), do_video_out(), downscale(), dxva2_uninit(), encode_apng(), encode_end(), encode_frame(), encode_write_frame(), escape124_decode_close(), ff_bufqueue_add(), ff_bufqueue_discard_all(), ff_cavs_end(), ff_create_schro_frame(), ff_default_get_audio_buffer(), ff_ffv1_close(), ff_filter_frame(), ff_filter_frame_framed(), ff_filter_frame_needs_framing(), ff_frame_thread_free(), ff_framesync_get_frame(), ff_framesync_uninit(), ff_h264_free_context(), ff_ivi_decode_close(), ff_load_image(), ff_mjpeg_decode_end(), ff_mpv_common_end(), ff_mpv_encode_end(), ff_qsv_decode_reset(), ff_qsv_enc_close(), ff_snow_common_end(), ff_thread_video_encode_frame(), ff_vc1_decode_end(), ff_video_frame_pool_get(), ff_vp56_free_context(), ff_vp8_decode_free(), ffmpeg_cleanup(), fic_decode_close(), fic_decode_frame(), fieldmatch_uninit(), filter_encode_write_frame(), filter_frame(), fixstride(), flashsv_decode_end(), flic_decode_end(), flush(), flush_fifo(), flush_frame(), frame_queue_destory(), framepack_uninit(), framesync_advance(), free_frame(), free_schro_frame(), geq_filter_frame(), get_best_frame(), get_scene_score(), gif_decode_close(), gif_encode_close(), h264_decode_end(), hevc_decode_free(), if(), image_ctx_free(), init_axis_from_file(), init_axis_from_font(), init_frames(), init_output_frame(), ipvideo_decode_end(), ipvideo_decode_init(), ir2_decode_end(), join_uninit(), lavfi_read_close(), libopenjpeg_encode_frame(), libwebp_anim_encode_close(), libwebp_anim_encode_frame(), libwebp_encode_close(), libwebp_encode_frame(), load_encode_and_write(), main(), mimic_decode_end(), mm_decode_end(), movie_push_frame(), mp_decode_end(), msrle_decode_end(), mss1_decode_end(), mss1_decode_init(), mss2_decode_end(), mss3_decode_end(), mss3_decode_init(), mss4_decode_end(), msvideo1_decode_end(), mvc_decode_end(), mxpeg_decode_end(), next_source(), null_filter_frame(), output_frame(), pad_last_frame(), paf_video_close(), plot_freqs(), png_dec_end(), png_dec_init(), png_enc_close(), pp_filter_frame(), process_frame(), qtrle_decode_end(), qtrle_encode_end(), read_decode_convert_and_store(), read_from_fifo(), read_interval_packets(), receiver_thread(), reget_buffer_internal(), request_frame(), return_audio_frame(), roq_decode_end(), roq_decode_init(), roq_encode_end(), rpza_decode_end(), rscc_close(), run_test(), decklink_output_callback::ScheduledFrameCompleted(), screenpresso_close(), seek_test(), sender_thread(), seqvideo_decode_end(), sgirle_decode_end(), shuffleplanes_filter_frame(), smc_decode_end(), smvjpeg_decode_end(), smvjpeg_decode_init(), svq1_decode_end(), svq1_encode_end(), svq3_decode_end(), svq3_decode_init(), tdsc_close(), tgv_decode_end(), truemotion1_decode_end(), try_decode_frame(), try_decode_video_frame(), try_push_frame(), try_push_frames(), tscc2_decode_end(), ulti_decode_end(), uninit(), utvideo_decode_close(), vdpau_uninit(), video_decode(), video_decode_example(), video_encode_example(), video_thread(), videotoolbox_uninit(), vmdvideo_decode_end(), vp3_decode_end(), vp8_lossy_decode_alpha(), vp9_decode_free(), worker(), wrapped_avframe_encode(), wrapped_avframe_release_buffer(), write_packet(), write_to_fifo(), xan_decode_end(), yae_clear(), yop_decode_close(), and zerocodec_decode_close().

int av_frame_ref ( AVFrame dst,
const AVFrame src 

Set up a new reference to the data described by the source frame.

Copy frame properties from src to dst and create a new reference for each AVBufferRef from src.

If src is not reference counted, new buffers are allocated and the data is copied.

0 on success, a negative AVERROR on error

Definition at line 375 of file frame.c.

Referenced by aasc_decode_frame(), av_buffersink_get_frame_flags(), av_buffersrc_add_frame_flags(), av_buffersrc_add_frame_internal(), av_frame_clone(), avs_decode_frame(), bethsoftvid_decode_frame(), cavs_decode_frame(), cdg_decode_frame(), cinepak_decode_frame(), cinvideo_decode_frame(), cmv_decode_frame(), copy_frame(), cpia_decode_frame(), decode_frame(), decode_video(), dirac_decode_frame(), do_qsv_decode(), do_video_out(), encode_apng(), encode_frame(), escape124_decode_frame(), ff_h263_decode_frame(), ff_hevc_output_frame(), ff_mjpeg_decode_frame(), ff_rv34_decode_frame(), ff_thread_ref_frame(), ff_thread_video_encode_frame(), ff_vp56_decode_frame(), ff_vp56_decode_mbs(), fic_decode_frame(), finish_frame(), flashsv_decode_frame(), flic_decode_frame_15_16BPP(), flic_decode_frame_8BPP(), get_delayed_pic(), gif_decode_frame(), gif_encode_frame(), h261_decode_frame(), ipvideo_decode_frame(), ir2_decode_frame(), load_input_picture(), mimic_decode_frame(), mjpegb_decode_frame(), mm_decode_frame(), mp_decode_frame(), mpeg_decode_frame(), msrle_decode_frame(), mss1_decode_frame(), mss2_decode_frame(), mss3_decode_frame(), mss4_decode_frame(), msvideo1_decode_frame(), mvc_decode_frame(), mxpeg_decode_frame(), output_frame(), paf_video_decode(), qtrle_decode_frame(), qtrle_encode_frame(), roq_decode_frame(), rpza_decode_frame(), rscc_decode_frame(), rv10_decode_frame(), screenpresso_decode_frame(), seqvideo_decode_frame(), sgirle_decode_frame(), slice_end(), smc_decode_frame(), smvjpeg_decode_frame(), submit_frame(), svq1_decode_frame(), svq3_decode_frame(), tgv_decode_frame(), truemotion1_decode_frame(), tscc2_decode_frame(), ulti_decode_frame(), vc1_decode_frame(), vmdvideo_decode_frame(), vp78_decode_frame(), vp9_decode_frame(), xan_decode_frame(), yop_decode_frame(), and zerocodec_decode_frame().

AVFrame* av_frame_clone ( const AVFrame src)
void av_frame_unref ( AVFrame frame)

Unreference all the buffers referenced by frame and reset the frame fields.

Definition at line 474 of file frame.c.

Referenced by aac_decode_frame_int(), audio_get_buffer(), av_frame_free(), av_frame_make_writable(), av_frame_ref(), avcodec_decode_audio4(), avcodec_decode_video2(), avcodec_flush_buffers(), cavs_decode_frame(), cdg_decode_frame(), clear_unused_frames(), cmv_decode_frame(), cmv_process_header(), codec_reinit(), copy_frame(), decode_frame(), decode_packet(), decode_pic(), decode_subframe(), decode_video(), dirac_decode_data_unit(), dirac_decode_frame(), do_video_out(), dxva2_retrieve_data(), encode_apng(), encode_frame(), escape124_decode_frame(), execute_code(), ff_mjpeg_decode_end(), ff_mjpeg_decode_sof(), ff_mpeg_unref_picture(), ff_snow_release_buffer(), ff_thread_flush(), ff_thread_release_buffer(), ff_vp56_decode_frame(), ff_vp56_decode_mbs(), fixstride(), flashsv_decode_frame(), flush(), frame_configure_elements(), frame_queue_unref_item(), frame_worker_thread(), free_picture(), free_sequence_buffers(), get_audio_buffer(), get_video_buffer(), get_video_frame(), gif_decode_frame(), gif_encode_frame(), hevc_frame_start(), ipvideo_decode_frame(), lavfi_read_packet(), main(), mss2_decode_frame(), mxpeg_decode_frame(), qsv_clear_unused_frames(), qtrle_encode_frame(), reap_filters(), reget_buffer_internal(), release_delayed_buffers(), select_input_picture(), smvjpeg_decode_frame(), sub2video_get_blank_frame(), submit_frame(), svq1_decode_frame(), svq1_flush(), svq3_decode_frame(), tdsc_decode_jpeg_tile(), tgv_decode_frame(), truemotion1_decode_header(), unrefcount_frame(), vdpau_retrieve_data(), video_get_buffer(), video_thread(), videotoolbox_retrieve_data(), vmdvideo_decode_frame(), vorbis_decode_frame(), worker(), xan_decode_frame(), and zerocodec_decode_frame().

void av_frame_move_ref ( AVFrame dst,
AVFrame src 
int av_frame_get_buffer ( AVFrame frame,
int  align 

Allocate new buffer(s) for audio or video data.

The following fields must be set on frame before calling this function:

  • format (pixel format for video, sample format for audio)
  • width and height for video
  • nb_samples and channel_layout for audio

This function will fill AVFrame.data and AVFrame.buf arrays and, if necessary, allocate and fill AVFrame.extended_data and AVFrame.extended_buf. For planar formats, one buffer will be allocated for each plane.

frameframe in which to store the new buffers.
alignrequired buffer size alignment
0 on success, a negative AVERROR on error.

Definition at line 271 of file frame.c.

Referenced by alloc_audio_frame(), alloc_frame(), alloc_frame_empty(), alloc_picture(), apng_encode_frame(), av_frame_make_writable(), av_frame_ref(), avresample_convert_frame(), config_input(), config_output(), decklink_write_video_packet(), decode_entropy_coded_image(), downscale(), dxva2_retrieve_data(), encode_apng(), encode_frame(), ff_default_get_audio_buffer(), ff_libwebp_get_frame(), ff_mpv_encode_init(), get_input(), init_output_frame(), pad_last_frame(), run_test(), sender_thread(), sub2video_get_blank_frame(), swr_convert_frame(), tdsc_parse_tdsf(), vdpau_retrieve_data(), and videotoolbox_retrieve_data().

int av_frame_is_writable ( AVFrame frame)

Check if the frame data is writable.

A positive value if the frame data is writable (which is true if and only if each of the underlying buffers has only one reference, namely the one stored in this frame). Return 0 otherwise.

If 1 is returned the answer is valid until av_buffer_ref() is called on any of the underlying AVBufferRefs (e.g. through av_frame_ref() or directly).

See Also
av_frame_make_writable(), av_buffer_is_writable()

Definition at line 505 of file frame.c.

Referenced by apply_lut(), av_frame_make_writable(), compand_nodelay(), ff_filter_frame_framed(), filter_frame(), frame_needs_copy(), and reget_buffer_internal().

int av_frame_make_writable ( AVFrame frame)

Ensure that the frame data is writable, avoiding data copy if possible.

Do nothing if the frame is writable, allocate new buffers and copy the data if it is not.

0 on success, a negative AVERROR on error.
See Also
av_frame_is_writable(), av_buffer_is_writable(), av_buffer_make_writable()

Definition at line 522 of file frame.c.

Referenced by apply_palette(), ff_framesync_get_frame(), ff_h263_decode_frame(), ff_print_debug_info2(), fill_yuv_image(), filter_frame(), plot_spectrum_column(), and write_audio_frame().

int av_frame_copy ( AVFrame dst,
const AVFrame src 

Copy the frame data from src to dst.

This function does not allocate anything, dst must be already initialized and allocated with the same parameters as src.

This function only copies the frame data (i.e. the contents of the data / extended data arrays), not any other properties.

>= 0 on success, a negative AVERROR on error.

Definition at line 695 of file frame.c.

Referenced by apng_encode_frame(), av_frame_make_writable(), av_frame_ref(), encode_apng(), encode_frame(), ff_libwebp_get_frame(), filter_frame(), libschroedinger_frame_from_data(), reget_buffer_internal(), roq_decode_frame(), shuffleplanes_filter_frame(), submit_frame(), and tdsc_decode_frame().

int av_frame_copy_props ( AVFrame dst,
const AVFrame src 

Copy only "metadata" fields from src to dst.

Metadata for the purpose of this function are those fields that do not affect the data layout in the buffers. E.g. pts, sample rate (for audio) or sample aspect ratio (for video), but not width/height or channel layout. Side data is also copied.

Definition at line 565 of file frame.c.

Referenced by apply_lut(), apply_palette(), av_frame_make_writable(), blend_frame(), blend_frames16(), blend_frames8(), compand_delay(), compand_nodelay(), create_weave_frame(), dxva2_retrieve_data(), ff_filter_frame_framed(), ff_filter_frame_needs_framing(), filter(), filter_frame(), fixstride(), frame_end(), geq_filter_frame(), get_frame(), load_input_picture(), pad_last_frame(), pp_filter_frame(), process_frame(), return_frame(), select_input_picture(), shuffleplanes_filter_frame(), try_push_frame(), unrefcount_frame(), vdpau_retrieve_data(), and videotoolbox_retrieve_data().

AVBufferRef* av_frame_get_plane_buffer ( AVFrame frame,
int  plane 

Get the buffer reference a given data plane is stored in.

planeindex of the data plane of interest in frame->extended_data.
the buffer reference that contains the plane or NULL if the input frame is not valid.

Definition at line 570 of file frame.c.

Referenced by buffer_needs_copy(), and try_push_frame().

AVFrameSideData* av_frame_new_side_data ( AVFrame frame,
enum AVFrameSideDataType  type,
int  size 

Add a new side data to a frame.

framea frame to which the side data should be added
typetype of the added side data
sizesize of the side data
newly added side data on success, NULL on error

Definition at line 601 of file frame.c.

Referenced by av_downmix_info_update_side_data(), av_mastering_display_metadata_create_side_data(), av_stereo3d_create_side_data(), decode_frame(), decode_postinit(), ff_init_buffer_info(), ff_print_debug_info2(), ff_side_data_update_matrix_encoding(), frame_copy_props(), mpeg_decode_frame(), mpeg_field_start(), and set_side_data().

AVFrameSideData* av_frame_get_side_data ( const AVFrame frame,
enum AVFrameSideDataType  type 
a pointer to the side data of a given type on success, NULL if there is no side data with such type in this frame.

Definition at line 637 of file frame.c.

Referenced by av_downmix_info_update_side_data(), avcodec_encode_audio2(), decode_packet(), encode_headers(), ff_mpeg1_encode_picture_header(), ff_side_data_update_matrix_encoding(), filter_frame(), mpeg1_encode_sequence_header(), qsv_h264_set_encode_ctrl(), reconfig_encoder(), and X264_frame().

void av_frame_remove_side_data ( AVFrame frame,
enum AVFrameSideDataType  type 

If side data of the supplied type exists in the frame, free it and remove it from the frame.

Definition at line 708 of file frame.c.

Referenced by filter_frame().

const char* av_frame_side_data_name ( enum AVFrameSideDataType  type)
a string identifying the side data type

Definition at line 722 of file frame.c.

Referenced by show_frame().