FFmpeg
[フレーム]
Modules | Files | Data Structures | Enumerations | Functions
AVFrame
libavutil » Data Structures

Modules

 

Files

file   frame.h
 

Data Structures

struct   AVFrameSideData
  Structure to hold side data for an AVFrame. More...
 
struct   AVRegionOfInterest
  Structure describing a single Region Of Interest. More...
 
struct   AVFrame
  This structure describes decoded (raw) audio or video data. More...
 

Enumerations

 
 
enum   { AV_FRAME_CROP_UNALIGNED = 1 << 0 }
  Flags for frame cropping. More...
 

Functions

  Get the name of a colorspace. More...
 
  Allocate an AVFrame and set its fields to default values. More...
 
  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...
 
  Create a new frame that references the same data as src. More...
 
  Unreference all the buffers referenced by frame and reset the frame fields. More...
 
  Move everything contained in src to dst and reset src. More...
 
  Allocate new buffer(s) for audio or video data. More...
 
  Check if the frame data is writable. More...
 
  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...
 
  Copy only "metadata" fields from src to dst. More...
 
  Get the buffer reference a given data plane is stored in. More...
 
  Add a new side data to a frame. More...
 
  Add a new side data to a frame from an existing AVBufferRef. More...
 
 
  Remove and free all side data instances of the given type. More...
 
  Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ crop_bottom fields. More...
 
 

Detailed Description

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

Enumeration Type Documentation

AVFrameSideDataType

Enumerator
AV_FRAME_DATA_PANSCAN 

The data is the AVPanScan struct defined in libavcodec.

AV_FRAME_DATA_A53_CC 

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.

AV_FRAME_DATA_STEREO3D 

Stereoscopic 3d metadata.

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

AV_FRAME_DATA_MATRIXENCODING 

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

AV_FRAME_DATA_DOWNMIX_INFO 

Metadata relevant to a downmix procedure.

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

AV_FRAME_DATA_REPLAYGAIN 

ReplayGain information in the form of the AVReplayGain struct.

AV_FRAME_DATA_DISPLAYMATRIX 

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.

AV_FRAME_DATA_AFD 

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

AV_FRAME_DATA_MOTION_VECTORS 

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.

AV_FRAME_DATA_SKIP_SAMPLES 

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)
AV_FRAME_DATA_AUDIO_SERVICE_TYPE 

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

AV_FRAME_DATA_MASTERING_DISPLAY_METADATA 

Mastering display metadata associated with a video frame.

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

AV_FRAME_DATA_GOP_TIMECODE 

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.

AV_FRAME_DATA_SPHERICAL 

The data represents the AVSphericalMapping structure defined in libavutil/spherical.h.

AV_FRAME_DATA_CONTENT_LIGHT_LEVEL 

Content light level (based on CTA-861.3).

This payload contains data in the form of the AVContentLightMetadata struct.

AV_FRAME_DATA_ICC_PROFILE 

The data contains an ICC profile as an opaque octet buffer following the format described by ISO 15076-1 with an optional name defined in the metadata key entry "name".

AV_FRAME_DATA_S12M_TIMECODE 

Timecode which conforms to SMPTE ST 12-1.

The data is an array of 4 uint32_t where the first uint32_t describes how many (1-3) of the other timecodes are used. The timecode format is described in the documentation of av_timecode_get_smpte_from_framenum() function in libavutil/timecode.h.

AV_FRAME_DATA_DYNAMIC_HDR_PLUS 

HDR dynamic metadata associated with a video frame.

The payload is an AVDynamicHDRPlus type and contains information for color volume transform - application 4 of SMPTE 2094-40:2016 standard.

AV_FRAME_DATA_REGIONS_OF_INTEREST 

Regions Of Interest, the data is an array of AVRegionOfInterest type, the number of array element is implied by AVFrameSideData.size / AVRegionOfInterest.self_size.

AV_FRAME_DATA_VIDEO_ENC_PARAMS 

Encoding parameters for a video frame, as described by AVVideoEncParams.

AV_FRAME_DATA_SEI_UNREGISTERED 

User data unregistered metadata associated with a video frame.

This is the H.26[45] UDU SEI message, and shouldn't be used for any other purpose The data is stored as uint8_t in AVFrameSideData.data which is 16 bytes of uuid_iso_iec_11578 followed by AVFrameSideData.size - 16 bytes of user_data_payload_byte.

AV_FRAME_DATA_FILM_GRAIN_PARAMS 

Film grain parameters for a frame, described by AVFilmGrainParams.

Must be present for every frame which should have film grain applied.

AV_FRAME_DATA_DETECTION_BBOXES 

Bounding boxes for object detection and classification, as described by AVDetectionBBoxHeader.

AV_FRAME_DATA_DOVI_RPU_BUFFER 

Dolby Vision RPU raw data, suitable for passing to x265 or other libraries.

Array of uint8_t, with NAL emulation bytes intact.

AV_FRAME_DATA_DOVI_METADATA 

Parsed Dolby Vision metadata, suitable for passing to a software implementation.

The payload is the AVDOVIMetadata struct defined in libavutil/dovi_meta.h.

Definition at line 48 of file frame.h.

AVActiveFormatDescription

Enumerator
AV_AFD_SAME 
AV_AFD_4_3 
AV_AFD_16_9 
AV_AFD_14_9 
AV_AFD_4_3_SP_14_9 
AV_AFD_16_9_SP_14_9 
AV_AFD_SP_4_3 

Definition at line 206 of file frame.h.

anonymous enum

anonymous enum

Flags for frame cropping.

Enumerator
AV_FRAME_CROP_UNALIGNED 

Apply the maximum possible cropping, even if it requires setting the AVFrame.data[] entries to unaligned pointers.

Passing unaligned data to FFmpeg API is generally not allowed, and causes undefined behavior (such as crashes). You can pass unaligned data only to FFmpeg APIs that are explicitly documented to accept it. Use this flag only if you absolutely know what you are doing.

Definition at line 887 of file frame.h.

Function Documentation

av_get_colorspace_name()

const attribute_deprecated char* av_get_colorspace_name ( enum AVColorSpace  val )

Get the name of a colorspace.

Returns
a static string identifying the colorspace; can be NULL.
Deprecated:
use av_color_space_name()

Definition at line 37 of file frame.c.

av_frame_alloc()

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

Returns
An AVFrame filled with default values or NULL on failure.
Note
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 97 of file frame.c.

Referenced by aasc_decode_init(), add_input_streams(), alloc_audio_frame(), alloc_frame(), alloc_frame_empty(), alloc_picture(), amf_load_library(), apng_encode_frame(), audio_thread(), av1_decode_init(), av_buffersrc_add_frame_flags(), av_frame_clone(), av_hwframe_get_buffer(), avcodec_open2(), avs_decode_init(), bethsoftvid_decode_init(), cdg_decode_init(), cdtoons_decode_init(), cinepak_decode_init(), cinepak_encode_init(), cinvideo_decode_init(), clv_decode_init(), cmv_decode_init(), config_input(), config_output(), context_init_threaded(), cpia_decode_init(), cri_decode_init(), cudascale_filter_frame(), cudascale_init(), cuvid_output_frame(), dec_enc(), decode_entropy_coded_image(), decode_init(), decode_write(), dirac_decode_init(), downscale(), drm_transfer_data_from(), drm_transfer_data_to(), ds_open(), dxva2_transfer_data_from(), dxva2_transfer_data_to(), eb_enc_init(), encode_apng(), encode_frame(), encode_init(), escape124_decode_init(), ff_cavs_init(), ff_default_get_video_buffer(), ff_dnn_fill_gettingoutput_task(), ff_ffv1_common_init(), ff_frame_pool_get(), ff_frame_thread_encoder_init(), ff_hwframe_map_create(), ff_libwebp_get_frame(), ff_load_image(), ff_mjpeg_decode_init(), ff_mpv_common_init(), ff_mpv_encode_init(), ff_nvenc_encode_init(), ff_snow_common_init(), ff_thread_release_buffer(), ff_v4l2_m2m_create_context(), ff_vaapi_encode_init(), ff_vp56_init_context(), ffat_init_encoder(), fic_decode_init(), flashsv_decode_init(), flic_decode_init(), frame_queue_init(), get_free_frame(), get_surface(), gif_decode_init(), gif_encode_frame(), h264_init_pic(), hevc_init_context(), hwaccel_retrieve_data(), hwframe_pool_prealloc(), hwmap_filter_frame(), hwmap_get_buffer(), imx_decode_init(), init(), init_axis_from_file(), init_axis_from_font(), init_filters(), init_frames(), init_input_frame(), init_output_frame(), init_thread(), ipvideo_decode_init(), ir2_decode_init(), kmsgrab_read_packet(), lavfi_read_header(), librav1e_encode_init(), LLVMFuzzerTestOneInput(), lscr_decode_init(), main(), mf_init(), mimic_decode_init(), mm_decode_init(), mobiclip_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(), mxpeg_decode_init(), new_output_stream(), new_video_stream(), nppscale_filter_frame(), nppscale_init(), nppsharpen_filter_frame(), nppsharpen_init(), npptranspose_filter_frame(), npptranspose_init(), nvenc_alloc_surface(), open_input_file(), paf_video_init(), png_dec_init(), qsv_frame_lock(), qsv_map_from(), qsv_transfer_data_child(), qtrle_decode_init(), qtrle_encode_init(), query_frame(), read_interval_packets(), read_packet_vs(), realign_frame(), reget_buffer_internal(), roq_decode_init(), roq_encode_init(), rpza_decode_init(), rpza_encode_init(), rscc_init(), run_test(), screenpresso_init(), seek_test(), sender_thread(), seqvideo_decode_init(), smc_decode_init(), smc_encode_init(), spawn_empty_frame(), sub2video_prepare(), svq1_decode_init(), svq1_encode_init(), svq3_decode_init(), sws_init_context(), tdsc_init(), tgv_decode_init(), tiff_init(), transfer_data_alloc(), truemotion1_decode_init(), try_decode_frame(), try_push_frame(), tscc2_decode_init(), ulti_decode_init(), vaapi_av1_decode_init(), vaapi_encode_issue(), vaapi_encode_send_frame(), vaapi_transfer_data_from(), vaapi_transfer_data_to(), vc1_decode_frame(), video_decode(), video_decode_example(), video_thread(), vmdvideo_decode_init(), vp8_init_frames(), vp8_lossy_decode_alpha(), vp9_decode_init(), vqa_decode_init(), vt_transfer_data_from(), vt_transfer_data_to(), wavpack_decode_init(), xan_decode_init(), xma_decode_init(), xvid_encode_init(), yop_decode_init(), and zerocodec_decode_init().

av_frame_free()

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.

Parameters
frame frame to be freed. The pointer will be set to NULL.

Definition at line 109 of file frame.c.

Referenced by aasc_decode_end(), activate(), add_to_queue(), addroi_filter_frame(), alloc_frame(), alloc_frame_empty(), amf_release_buffer_with_frame_ref(), apng_encode_frame(), apply_lut(), apply_palette(), audio_thread(), av1_decode_free(), av_buffersrc_add_frame_flags(), av_frame_clone(), av_hwframe_get_buffer(), avcodec_close(), avgblur_opencl_filter_frame(), avgblur_vulkan_filter_frame(), avs_decode_end(), bethsoftvid_decode_end(), blend_frame(), blur_frame(), cdg_decode_end(), cdtoons_decode_end(), celt_frame_setup_input(), channelmap_filter_frame(), chromaber_vulkan_filter_frame(), cinepak_decode_end(), cinepak_encode_end(), cinvideo_decode_end(), clear_frame_list(), clear_unused_frames(), close_stream(), clv_decode_end(), cmv_decode_end(), common_uninit(), compand_delay(), compand_nodelay(), config_filter(), config_input(), config_output(), config_video(), config_video_output(), configure_filtergraph(), convert_coeffs(), convolution_opencl_filter_frame(), cpia_decode_end(), cri_decode_close(), cudascale_filter_frame(), cudascale_uninit(), cudaupload_filter_frame(), cuvid_output_frame(), dec_enc(), decimate_uninit(), decklink_write_video_packet(), decode_close(), decode_end(), decode_write(), deint_cuda_uninit(), deint_vaapi_filter_frame(), deint_vaapi_pipeline_uninit(), dirac_decode_end(), dirac_decode_init(), do_morpho(), downscale(), drm_transfer_data_from(), drm_transfer_data_to(), ds_free(), dxva2_transfer_data_from(), dxva2_transfer_data_to(), eb_enc_close(), empty_buffer_done(), encode_apng(), encode_end(), encode_frame(), end_last_frame(), escape124_decode_close(), ff_amf_encode_close(), ff_bufqueue_add(), ff_bufqueue_discard_all(), ff_cavs_end(), ff_default_get_video_buffer(), ff_dnn_fill_gettingoutput_task(), ff_dnn_free_model_native(), ff_dnn_free_model_ov(), ff_dnn_free_model_tf(), ff_ffv1_close(), ff_filter_frame(), ff_filter_frame_framed(), ff_frame_pool_get(), ff_frame_thread_encoder_free(), ff_frame_thread_free(), ff_framequeue_free(), ff_framesync_dualinput_get(), ff_framesync_dualinput_get_writable(), ff_framesync_get_frame(), ff_framesync_uninit(), ff_hwframe_map_create(), ff_hwframe_unmap(), ff_inlink_make_frame_writable(), ff_inlink_set_status(), ff_ivi_decode_close(), ff_load_image(), ff_mjpeg_decode_end(), ff_mpv_common_end(), ff_mpv_encode_end(), ff_nvenc_encode_close(), ff_qsv_enc_close(), ff_qsvvpp_filter_frame(), ff_snow_common_end(), ff_vaapi_encode_close(), ff_vc1_decode_end(), ff_vk_discard_exec_deps(), ff_vp56_free_context(), ff_vp8_decode_free(), ff_yadif_filter_frame(), ffat_close_encoder(), ffmpeg_cleanup(), fic_decode_close(), fic_decode_frame(), fieldmatch_uninit(), filter_frame(), filter_frame16(), filter_frame8(), fir_frame(), fixstride(), flashsv_decode_end(), flic_decode_end(), flip_bayer(), flush(), flush_frame(), frame_queue_destory(), framepack_uninit(), framesync_advance(), free_exec_ctx(), free_frame(), free_frames(), gblur_vulkan_filter_frame(), gblur_vulkan_uninit(), geq_filter_frame(), get_best_frame(), get_output_native(), get_output_ov(), get_output_tf(), get_scene_score(), gif_decode_close(), gif_encode_close(), h264_free_pic(), headphone_frame(), hevc_decode_free(), hwaccel_retrieve_data(), hwdownload_filter_frame(), hwframe_pool_prealloc(), hwmap_filter_frame(), hwmap_get_buffer(), hwupload_filter_frame(), if(), ifilter_send_frame(), image_ctx_free(), imx_decode_close(), init_axis_from_file(), init_axis_from_font(), init_output_frame(), inject_frame(), ipvideo_decode_end(), ir2_decode_end(), join_uninit(), kmsgrab_free_frame(), kmsgrab_read_packet(), lavfi_read_close(), libopenjpeg_encode_frame(), librav1e_encode_close(), libwebp_anim_encode_close(), libwebp_anim_encode_frame(), libwebp_encode_close(), libwebp_encode_frame(), LLVMFuzzerTestOneInput(), load_apply_palette(), load_encode_and_write(), lscr_decode_close(), magy_encode_frame(), main(), mf_close(), mimic_decode_end(), misc_vaapi_filter_frame(), mm_decode_end(), mobiclip_close(), move_audio(), movie_push_frame(), mp_decode_end(), msrle_decode_end(), mss1_decode_end(), mss1_decode_init(), mss2_decode_end(), mss3_decode_end(), mss4_decode_end(), msvideo1_decode_end(), mxpeg_decode_end(), neighbor_opencl_filter_frame(), nlmeans_opencl_filter_frame(), nppscale_filter_frame(), nppscale_uninit(), nppsharpen_filter_frame(), nppsharpen_init(), nppsharpen_uninit(), npptranspose_filter_frame(), npptranspose_uninit(), null_filter_frame(), nvenc_alloc_surface(), output_frame(), output_single_frame(), overlay_cuda_blend(), overlay_opencl_blend(), overlay_vulkan_blend(), paf_video_close(), pixscope_filter_frame(), plot_freqs(), png_dec_end(), png_dec_init(), png_enc_close(), pp_filter_frame(), procamp_vaapi_filter_frame(), process_frame(), program_opencl_run(), qsv_decode_close_qsvcontext(), qsv_frame_lock(), qsv_frame_unlock(), qsv_map_from(), qsv_transfer_data_child(), qsvdeint_filter_frame(), qsvdeint_uninit(), qsvscale_filter_frame(), qtrle_decode_end(), qtrle_encode_end(), read_decode_convert_and_store(), read_interval_packets(), read_packet_vs(), realign_frame(), receiver_thread(), reget_buffer_internal(), decklink_frame::Release(), request_frame(), return_or_keep_frame(), roq_decode_end(), roq_encode_end(), rpza_decode_end(), rpza_encode_end(), rscc_close(), run_test(), scale_frame(), scale_vaapi_filter_frame(), scale_vulkan_filter_frame(), screenpresso_close(), seek_test(), sender_thread(), seqvideo_decode_end(), shuffleplanes_filter_frame(), smc_decode_end(), smc_encode_end(), spatial_activate(), spawn_empty_frame(), submit_frame(), svq1_decode_end(), svq1_encode_end(), svq3_decode_end(), sws_freeContext(), take_samples(), tdsc_close(), tgv_decode_end(), tiff_end(), tonemap_opencl_filter_frame(), tonemap_vaapi_filter_frame(), transfer_data_alloc(), transpose_opencl_filter_frame(), transpose_vaapi_filter_frame(), truemotion1_decode_end(), try_decode_frame(), try_push_frame(), try_push_frames(), tscc2_decode_end(), ulti_decode_end(), uncoded_frame_free(), uninit(), uninit_segment(), unsharp_opencl_filter_frame(), v4l2_m2m_destroy_context(), vaapi_av1_decode_uninit(), vaapi_encode_free(), vaapi_encode_issue(), vaapi_encode_wait(), vaapi_transfer_data_from(), vaapi_transfer_data_to(), video_decode(), video_decode_example(), video_thread(), vmdvideo_decode_end(), vp3_decode_end(), vp8_lossy_decode_alpha(), vp9_decode_free(), vqa_decode_end(), vt_transfer_data_from(), vt_transfer_data_to(), wavpack_decode_end(), wrapped_avframe_encode(), wrapped_avframe_release_buffer(), write_frame(), write_uncoded_frame_internal(), xan_decode_end(), xfade_activate(), xfade_frame(), xfade_opencl_activate(), xma_decode_end(), xvid_encode_init(), yae_clear(), yop_decode_close(), and zerocodec_decode_close().

av_frame_ref()

int av_frame_ref ( AVFramedst,
const AVFramesrc 
)

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.

Warning
: dst MUST have been either unreferenced with av_frame_unref(dst), or newly allocated with av_frame_alloc() before calling this function, or undefined behavior will occur.
Returns
0 on success, a negative AVERROR on error

Definition at line 325 of file frame.c.

Referenced by aasc_decode_frame(), apply_palette(), av_buffersrc_add_frame_flags(), av_frame_clone(), av_hwframe_map(), avs_decode_frame(), bethsoftvid_decode_frame(), cavs_decode_frame(), cdg_decode_frame(), cdtoons_decode_frame(), cinepak_decode_frame(), cinvideo_decode_frame(), clv_decode_frame(), cmv_decode_frame(), cpia_decode_frame(), decode_frame(), decode_frame_lscr(), dirac_decode_frame(), do_vmaf(), encode_apng(), encode_frame(), encode_send_frame_internal(), escape124_decode_frame(), ff_h263_decode_frame(), ff_hevc_output_frame(), ff_hwframe_map_create(), ff_hwframe_map_replace(), ff_mjpeg_receive_frame(), ff_rv34_decode_frame(), ff_thread_ref_frame(), ff_vp56_decode_frame(), ff_vp56_decode_mbs(), ffat_encode_callback(), fic_decode_frame(), finish_frame(), flashsv_decode_frame(), flic_decode_frame_15_16BPP(), flic_decode_frame_24BPP(), flic_decode_frame_8BPP(), get_delayed_pic(), gif_decode_frame(), gif_encode_frame(), h261_decode_frame(), imx_decode_frame(), ipvideo_decode_frame(), ir2_decode_frame(), load_input_picture(), mimic_decode_frame(), mjpegb_decode_frame(), mm_decode_frame(), mobiclip_decode(), mp_decode_frame(), mpeg_decode_frame(), msrle_decode_frame(), mss1_decode_frame(), mss2_decode_frame(), mss3_decode_frame(), mss4_decode_frame(), msvideo1_decode_frame(), mxpeg_decode_frame(), nvenc_upload_frame(), output_frame(), paf_video_decode(), qsv_decode(), qtrle_decode_frame(), qtrle_encode_frame(), return_or_keep_frame(), roq_decode_frame(), rpza_decode_frame(), rscc_decode_frame(), rv10_decode_frame(), screenpresso_decode_frame(), seqvideo_decode_frame(), set_output_frame(), slice_end(), smc_decode_frame(), smc_encode_frame(), smv_process_frame(), submit_frame(), svq1_decode_frame(), svq3_decode_frame(), sws_frame_start(), tgv_decode_frame(), truemotion1_decode_frame(), tscc2_decode_frame(), ulti_decode_frame(), vc1_decode_frame(), vmdvideo_decode_frame(), vp78_decode_frame(), vp9_decode_frame(), vqa_decode_frame(), wavpack_decode_frame(), xan_decode_frame(), yop_decode_frame(), and zerocodec_decode_frame().

av_frame_clone()

AVFrame* av_frame_clone ( const AVFramesrc )

Create a new frame that references the same data as src.

This is a shortcut for av_frame_alloc()+av_frame_ref().

Returns
newly created AVFrame on success, NULL on error.

Definition at line 422 of file frame.c.

Referenced by activate(), amf_create_buffer_with_frame_ref(), create_weave_frame(), decklink_write_video_packet(), end_last_frame(), ff_framesync_get_frame(), ff_libwebp_get_frame(), ff_vk_add_exec_dep(), ff_yadif_filter_frame(), ff_yadif_request_frame(), ffat_encode(), fic_decode_frame(), filter_frame(), filter_frame16(), filter_frame8(), get_scene_score(), ifilter_send_frame(), init(), libopenjpeg_encode_frame(), magy_encode_frame(), omx_encode_frame(), opus_encode_frame(), plot_spectrum_column(), process_frame(), process_work_frame(), request_frame(), submit_frame(), vorbis_encode_frame(), wrapped_avframe_encode(), and write_frame().

av_frame_unref()

void av_frame_unref ( AVFrameframe )

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

Definition at line 435 of file frame.c.

Referenced by aac_decode_frame_int(), apply_palette(), audio_get_buffer(), av_frame_free(), av_frame_make_writable(), av_frame_ref(), av_hwframe_map(), avcodec_flush_buffers(), avcodec_receive_frame(), cavs_decode_frame(), cdg_decode_frame(), clear_unused_frames(), cmv_decode_frame(), cmv_process_header(), codec_reinit(), compute_crc_of_packets(), cri_decode_frame(), cuvid_output_frame(), decode_audio(), decode_flush(), decode_frame(), decode_packet(), decode_pic(), decode_read(), decode_receive_frame_internal(), decode_simple_internal(), decode_subframe(), decode_video(), dirac_decode_data_unit(), dirac_decode_frame(), dng_decode_jpeg(), do_video_out(), eb_receive_packet(), encode_apng(), encode_frame(), encode_simple_internal(), escape124_decode_frame(), execute_code(), ff_amf_receive_packet(), ff_get_buffer(), ff_hwframe_map_replace(), ff_ivi_decode_frame(), ff_mjpeg_decode_end(), ff_mjpeg_decode_sof(), ff_mjpeg_receive_frame(), ff_mpeg_unref_picture(), ff_nvenc_receive_packet(), ff_snow_release_buffer(), ff_thread_flush(), ff_thread_release_buffer(), ff_v4l2_buffer_buf_to_avframe(), ff_vp56_decode_frame(), ff_vp56_decode_mbs(), ffat_encode_callback(), filter_encode_write_frame(), fixstride(), flashsv_decode_frame(), 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(), hwaccel_retrieve_data(), imx_decode_flush(), init_frames(), init_hwframe_ctx(), init_stage(), ipvideo_decode_frame(), lavfi_read_packet(), libdav1d_receive_frame(), librav1e_receive_packet(), libuavs3d_decode_frame(), LLVMFuzzerTestOneInput(), lscr_decode_flush(), main(), mf_receive_packet(), mobiclip_flush(), mpeg_decode_frame(), msrle_decode_flush(), mss2_decode_frame(), mxpeg_decode_frame(), nvenc_upload_frame(), output_frame(), pad_last_frame(), process_output_surface(), qsv_clear_unused_frames(), qsv_frames_uninit(), qsv_transfer_data_to(), qtrle_decode_flush(), qtrle_encode_frame(), reap_filters(), reget_buffer_internal(), release_delayed_buffers(), decklink_output_callback::ScheduledFrameCompleted(), select_input_picture(), set_output_frame(), smc_encode_frame(), smv_process_frame(), sub2video_get_blank_frame(), submit_frame(), svq1_decode_frame(), svq1_flush(), svq3_decode_frame(), sws_frame_end(), sws_frame_start(), synth_superframe(), tdsc_decode_jpeg_tile(), tgv_decode_frame(), truemotion1_decode_header(), v4l2_m2m_destroy_context(), v4l2_receive_packet(), video_decode(), video_decode_example(), video_get_buffer(), video_thread(), videotoolbox_postproc_frame(), vmdvideo_decode_frame(), vorbis_decode_frame(), vpx_decode(), worker(), wrapped_avframe_decode(), xan_decode_frame(), xma_decode_packet(), zerocodec_decode_flush(), and zerocodec_decode_frame().

av_frame_move_ref()

void av_frame_move_ref ( AVFramedst,
AVFramesrc 
)

Move everything contained in src to dst and reset src.

Warning
: dst is not unreferenced, but directly overwritten without reading or deallocating its contents. Call av_frame_unref(dst) manually before calling this function to ensure that no memory is leaked.

Definition at line 462 of file frame.c.

Referenced by audio_thread(), av_buffersrc_add_frame_flags(), avcodec_receive_frame(), cavs_decode_frame(), cmv_decode_frame(), cudascale_scale(), decode_packet(), do_video_out(), ff_encode_get_frame(), ff_ivi_decode_frame(), ff_thread_decode_frame(), ff_thread_release_buffer(), ff_thread_video_encode_frame(), fixstride(), hevc_decode_frame(), hwaccel_retrieve_data(), nppscale_scale(), nppsharpen_filter_frame(), npptranspose_filter(), queue_picture(), reget_buffer_internal(), return_or_keep_frame(), transfer_data_alloc(), vaapi_encode_send_frame(), wrapped_avframe_decode(), and wrapped_avframe_encode().

av_frame_get_buffer()

int av_frame_get_buffer ( AVFrameframe,
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.

Warning
: if frame already has been allocated, calling this function will leak memory. In addition, undefined behavior can occur in certain cases.
Parameters
frame frame in which to store the new buffers.
align Required buffer size alignment. If equal to 0, alignment will be chosen automatically for the current CPU. It is highly recommended to pass 0 here unless you know what you are doing.
Returns
0 on success, a negative AVERROR on error.

Definition at line 243 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(), config_input(), config_output(), decode_entropy_coded_image(), downscale(), encode_apng(), encode_frame(), ff_libwebp_get_frame(), ff_mpv_encode_init(), get_input(), init_output_frame(), main(), pad_last_frame(), qsv_transfer_data_to(), realign_frame(), rpza_encode_frame(), run_test(), sender_thread(), spawn_empty_frame(), sub2video_get_blank_frame(), submit_frame(), swr_convert_frame(), sws_frame_start(), tdsc_parse_tdsf(), and transfer_data_alloc().

av_frame_is_writable()

int av_frame_is_writable ( AVFrameframe )

Check if the frame data is writable.

Returns
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 473 of file frame.c.

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

av_frame_make_writable()

int av_frame_make_writable ( AVFrameframe )

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.

Returns
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 490 of file frame.c.

Referenced by activate(), apply_palette(), ff_framesync_get_frame(), ff_h263_decode_frame(), filter_frame(), filter_frame16(), filter_frame8(), get_video_frame(), main(), overlay_cuda_blend(), plot_spectrum_column(), run_test(), and write_audio_frame().

av_frame_copy()

int av_frame_copy ( AVFramedst,
const AVFramesrc 
)

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.

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

Definition at line 678 of file frame.c.

Referenced by apng_encode_frame(), av_frame_make_writable(), av_frame_ref(), clv_decode_frame(), decode_frame(), decompress_p(), decompress_p3(), drm_transfer_data_from(), drm_transfer_data_to(), encode_apng(), encode_frame(), ff_inlink_make_frame_writable(), ff_libwebp_get_frame(), filter_frame(), interpolate(), pixscope_filter_frame(), qsv_transfer_data_to(), realign_frame(), reget_buffer_internal(), roq_decode_frame(), shuffleplanes_filter_frame(), submit_frame(), tdsc_decode_frame(), vaapi_transfer_data_from(), vaapi_transfer_data_to(), vt_transfer_data_from(), and vt_transfer_data_to().

av_frame_copy_props()

int av_frame_copy_props ( AVFramedst,
const AVFramesrc 
)

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 537 of file frame.c.

Referenced by activate(), apply_lut(), apply_palette(), av_frame_make_writable(), avgblur_opencl_filter_frame(), avgblur_vulkan_filter_frame(), blend_frame(), blend_frames(), blur_frame(), chromaber_vulkan_filter_frame(), compand_delay(), compand_nodelay(), convolution_opencl_filter_frame(), create_weave_frame(), cudascale_scale(), cudaupload_filter_frame(), deint_vaapi_filter_frame(), do_morpho(), drm_map_from(), dxva2_map_from(), ff_hevc_output_frame(), ff_inlink_make_frame_writable(), ff_yadif_filter_frame(), filter(), filter_frame(), fixstride(), flip_bayer(), gblur_vulkan_filter_frame(), geq_filter_frame(), get_frame(), hwaccel_retrieve_data(), hwdownload_filter_frame(), hwmap_filter_frame(), hwupload_filter_frame(), load_input_picture(), misc_vaapi_filter_frame(), neighbor_opencl_filter_frame(), nlmeans_opencl_filter_frame(), nppscale_scale(), nppsharpen_filter_frame(), npptranspose_filter(), output_frame(), overlay_opencl_blend(), overlay_vulkan_blend(), pad_last_frame(), pixscope_filter_frame(), pp_filter_frame(), procamp_vaapi_filter_frame(), process_frame(), program_opencl_run(), qsvscale_filter_frame(), realign_frame(), return_frame(), scale_frame(), scale_vaapi_filter_frame(), scale_vulkan_filter_frame(), select_input_picture(), shuffleplanes_filter_frame(), submit_frame(), take_samples(), tonemap_opencl_filter_frame(), tonemap_vaapi_filter_frame(), transpose_opencl_filter_frame(), transpose_vaapi_filter_frame(), try_push_frame(), unsharp_opencl_filter_frame(), vaapi_map_to_memory(), and xfade_frame().

av_frame_get_plane_buffer()

AVBufferRef* av_frame_get_plane_buffer ( AVFrameframe,
int  plane 
)

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

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

Definition at line 542 of file frame.c.

Referenced by buffer_needs_copy(), and try_push_frame().

av_frame_new_side_data()

AVFrameSideData* av_frame_new_side_data ( AVFrameframe,
enum AVFrameSideDataType  type,
size_t  size 
)

Add a new side data to a frame.

Parameters
frame a frame to which the side data should be added
type type of the added side data
size size of the side data
Returns
newly added side data on success, NULL on error

Definition at line 605 of file frame.c.

Referenced by addroi_filter_frame(), av_content_light_metadata_create_side_data(), av_downmix_info_update_side_data(), av_dynamic_hdr_plus_create_side_data(), av_film_grain_params_create_side_data(), av_mastering_display_metadata_create_side_data(), av_stereo3d_create_side_data(), cri_decode_frame(), decode_frame(), decode_simple_internal(), ff_decode_frame_props(), ff_mjpeg_receive_frame(), ff_print_debug_info2(), ff_side_data_update_matrix_encoding(), filter_frame(), frame_copy_props(), h264_export_frame_props(), mpeg_decode_frame(), mpeg_field_start(), output_frame(), set_side_data(), tiff_decode_tag(), and webp_decode_frame().

av_frame_new_side_data_from_buf()

AVFrameSideData* av_frame_new_side_data_from_buf ( AVFrameframe,
enum AVFrameSideDataType  type,
AVBufferRefbuf 
)

Add a new side data to a frame from an existing AVBufferRef.

Parameters
frame a frame to which the side data should be added
type the type of the added side data
buf an AVBufferRef to add as side data. The ownership of the reference is transferred to the frame.
Returns
newly added side data on success, NULL on error. On failure the frame is unchanged and the AVBufferRef remains owned by the caller.

Definition at line 573 of file frame.c.

Referenced by addroi_filter_frame(), av_detection_bbox_create_side_data(), av_frame_new_side_data(), av_video_enc_params_create_side_data(), ff_dovi_attach_side_data(), frame_copy_props(), h264_export_frame_props(), libdav1d_receive_frame(), mpeg_field_start(), and set_side_data().

av_frame_get_side_data()

AVFrameSideData* av_frame_get_side_data ( const AVFrameframe,
enum AVFrameSideDataType  type 
)
Returns
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 617 of file frame.c.

Referenced by addroi_filter_frame(), av_downmix_info_update_side_data(), contain_valid_detection_bbox(), create_subcc_packet(), decode_packet(), dnn_classify_post_proc(), dnn_detect_post_proc_ov(), dnn_detect_post_proc_tf(), encode_frame(), encode_headers(), encode_send_frame_internal(), extract_lltask_from_task(), ff_alloc_a53_sei(), ff_alloc_timecode_sei(), ff_determine_signal_peak(), ff_frame_to_dnn_classify(), ff_h264_field_end(), ff_qp_table_extract(), ff_side_data_update_matrix_encoding(), ff_update_hdr_metadata(), filter_frame(), hevc_frame_end(), ifilter_parameters_from_frame(), ifilter_send_frame(), libx265_encode_set_roi(), prepare_sei_data_array(), process_frame(), reconfig_encoder(), tonemap_vaapi_save_metadata(), vaapi_encode_check_frame(), vaapi_encode_h265_init_picture_params(), vaapi_encode_issue(), vpx_encode(), vtenc_send_frame(), and X264_frame().

av_frame_remove_side_data()

void av_frame_remove_side_data ( AVFrameframe,
enum AVFrameSideDataType  type 
)

Remove and free all side data instances of the given type.

Definition at line 691 of file frame.c.

Referenced by addroi_filter_frame(), do_video_out(), ff_hevc_output_frame(), filter_frame(), output_frame(), and write_frame().

av_frame_apply_cropping()

int av_frame_apply_cropping ( AVFrameframe,
int  flags 
)

Crop the given video AVFrame according to its crop_left/crop_top/crop_right/ crop_bottom fields.

If cropping is successful, the function will adjust the data pointers and the width/height fields, and set the crop fields to 0.

In all cases, the cropping boundaries will be rounded to the inherent alignment of the pixel format. In some cases, such as for opaque hwaccel formats, the left/top cropping is ignored. The crop fields are set to 0 even if the cropping was rounded or ignored.

Parameters
frame the frame which should be cropped
flags Some combination of AV_FRAME_CROP_* flags, or 0.
Returns
>= 0 on success, a negative AVERROR on error. If the cropping fields were invalid, AVERROR(ERANGE) is returned, and nothing is changed.

Definition at line 769 of file frame.c.

Referenced by apply_cropping().

av_frame_side_data_name()

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

Definition at line 705 of file frame.c.

Referenced by show_frame().


Generated on Wed Aug 24 2022 21:38:54 for FFmpeg by   doxygen 1.8.17

AltStyle によって変換されたページ (->オリジナル) /