Name of the codec implementation.

The name is globally unique among encoders and among decoders (but an encoder and a decoder can share the same name). This is the primary way to find a codec from the user perspective.

Definition at line 209 of file codec.h.

Referenced by convert_from_tensorflow.Operand::__str__(), avcodec_get_name(), avcodec_open2(), avcodec_string(), choose_pixel_fmt(), context_to_name(), cuvid_test_capabilities(), dshow_cycle_formats(), find_codec_by_name(), find_codec_or_die(), get_compliance_normal_pix_fmts(), init(), main(), print_codecs(), print_codecs_for_id(), show_codecs(), transcode_init(), and video_decode().

Descriptive name for the codec, meant to be more human readable than name.

You should use the NULL_IF_CONFIG_SMALL() macro to define it.

Definition at line 214 of file codec.h.

Referenced by print_codecs().

Examples

demuxing_decoding.c.

Definition at line 215 of file codec.h.

Referenced by avcodec_decode_subtitle2(), avcodec_open2(), choose_decoder(), decode_packet(), decode_simple_internal(), encode_receive_packet_internal(), encode_send_frame_internal(), encode_simple_internal(), ff_cbs_sei_find_type(), ff_decode_frame_props(), ff_frame_thread_init(), find_codec_or_die(), init_context_defaults(), LLVMFuzzerTestOneInput(), main(), and mf_create().

Examples

decode_audio.c, decode_video.c, and encode_video.c.

Definition at line 216 of file codec.h.

Referenced by a64multi_encode_init(), adpcm_compress_trellis(), adpcm_decode_frame(), adpcm_decode_init(), adpcm_encode_init(), amf_copy_buffer(), amf_init_encoder(), avcodec_open2(), binkaudio_receive_frame(), choose_decoder(), cuvid_decode_init(), decode_end(), decode_init(), dpcm_decode_frame(), dpcm_decode_init(), eightsvx_decode_init(), encode_init(), ff_amf_receive_packet(), ff_aptx_init(), ff_h263_decode_init(), ff_mjpeg_decode_init(), ff_mjpeg_init_hvsample(), ff_mpv_decode_init(), ff_mpv_encode_init(), ff_print_debug_info2(), ff_wma_init(), find_codec(), find_probe_decoder(), get_nb_samples(), h263_get_format(), init(), init_context_defaults(), init_output_stream_encode(), LLVMFuzzerTestOneInput(), main(), mf_create(), nvdec_mpeg4_start_frame(), nvenc_check_capabilities(), nvenc_codec_specific_pic_params(), nvenc_setup_codec_config(), nvenc_setup_device(), nvenc_setup_encoder(), omx_component_init(), omx_encode_init(), open_input_file(), open_output_file(), pcm_decode_frame(), pcm_encode_frame(), pcm_encode_init(), process_output_surface(), siren_init(), stream_component_open(), transcode_init(), vaapi_mpeg4_start_frame(), vdpau_mpeg4_start_frame(), vp6_decode_init(), vp78_decode_init(), and wma_decode_init().

Codec capabilities.

see AV_CODEC_CAP_*

Examples

transcoding.c.

Definition at line 221 of file codec.h.

Referenced by apply_param_change(), av1_init_static(), avcodec_decode_subtitle2(), avcodec_flush_buffers(), avcodec_open2(), decode_receive_frame_internal(), decode_simple_internal(), do_video_out(), encode_send_frame_internal(), encode_simple_internal(), ff_decode_preinit(), ff_frame_thread_encoder_init(), find_codec(), find_probe_decoder(), main(), print_codecs(), reap_filters(), submit_packet(), try_decode_frame(), and validate_thread_parameters().

maximum value for lowres supported by the decoder

Definition at line 222 of file codec.h.

Referenced by ff_decode_preinit(), and stream_component_open().

array of supported framerates, or NULL if any, array is terminated by {0,0}

Definition at line 223 of file codec.h.

Referenced by main().

array of supported pixel formats, or NULL if unknown, array is terminated by -1

Examples

transcoding.c.

Definition at line 224 of file codec.h.

Referenced by av1_init_static(), choose_pixel_fmt(), ff_encode_preinit(), ff_vp9_init_static(), ffmmal_init_decoder(), h263_get_format(), libx265_encode_init_csp(), main(), open_output_file(), vc1_decode_init(), and X264_init_static().

array of supported audio samplerates, or NULL if unknown, array is terminated by 0

Examples

encode_audio.c.

Definition at line 225 of file codec.h.

Referenced by ff_encode_preinit(), main(), sbc_encode_init(), and select_sample_rate().

array of supported sample formats, or NULL if unknown, array is terminated by -1

Examples

encode_audio.c, transcode_aac.c, and transcoding.c.

Definition at line 226 of file codec.h.

Referenced by check_sample_fmt(), ff_encode_preinit(), main(), open_output_file(), and pcm_decode_init().

array of support channel layouts, or NULL if unknown. array is terminated by 0

Examples

encode_audio.c.

Definition at line 227 of file codec.h.

Referenced by ff_encode_preinit(), main(), and select_channel_layout().

AVClass for the private context.

Definition at line 228 of file codec.h.

Referenced by avcodec_close(), avcodec_open2(), ff_frame_thread_encoder_init(), ff_frame_thread_free(), filter_codec_opts(), init_context_defaults(), init_thread(), priv_data_size_wrong(), and show_stream().

array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}

Definition at line 229 of file codec.h.

Referenced by av_get_profile_name().

Group name of the codec implementation.

This is a short symbolic name of the wrapper backing this codec. A wrapper uses some kind of external implementation for the codec, such as an external library, or a codec implementation provided by the OS or the hardware. If this field is NULL, this is a builtin, libavcodec native codec. If non-NULL, this will be the suffix in AVCodec.name in most cases (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").

Definition at line 241 of file codec.h.

Internal codec capabilities.

See FF_CODEC_CAP_* in internal.h

Definition at line 254 of file codec.h.

Referenced by avcodec_open2(), avpriv_codec_get_cap_skip_frame_fill_param(), decode_receive_frame_internal(), decode_simple_internal(), ff_decode_frame_props(), ff_decode_get_packet(), ff_get_buffer(), ff_slice_thread_init(), frame_worker_thread(), init_thread(), lock_avcodec(), main(), thread_get_buffer_internal(), unlock_avcodec(), and validate_thread_parameters().

Definition at line 256 of file codec.h.

Referenced by avcodec_open2(), ff_mjpeg_encode_picture_header(), init_context_defaults(), init_thread(), main(), and priv_data_size_wrong().

Copy necessary context variables from a previous thread context to the current one.

If not defined, the next thread will start automatically; otherwise, the codec must call ff_thread_finish_setup().

dst and src will (rarely) point to the same context, in which case memcpy should be skipped.

Definition at line 268 of file codec.h.

Referenced by ff_thread_can_start_frame(), frame_worker_thread(), hap_decode(), main(), thread_get_buffer_internal(), update_context_from_thread(), and vp78_decode_frame().

Copy variables back to the user-facing context.

Definition at line 273 of file codec.h.

Referenced by main(), and update_context_from_thread().

Private codec-specific defaults.

Definition at line 279 of file codec.h.

Referenced by init_context_defaults().

Initialize codec static data, called from av_codec_iterate().

This is not intended for time consuming operations as it is run for every codec regardless of that codec being used.

Definition at line 287 of file codec.h.

Referenced by av_codec_init_static().

Definition at line 289 of file codec.h.

Referenced by avcodec_open2(), init_thread(), lock_avcodec(), and unlock_avcodec().

Definition at line 290 of file codec.h.

Referenced by av_codec_is_encoder(), avcodec_encode_subtitle(), and main().

Encode data to an AVPacket.

Parameters

avctx codec context

avpkt output AVPacket

[in] frame AVFrame containing the raw data to be encoded

[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a non-empty packet was returned in avpkt.

Returns

0 on success, negative error code on failure

Definition at line 302 of file codec.h.

Referenced by av_codec_is_encoder(), encode_simple_internal(), main(), and worker().

Decode picture or subtitle data.

Parameters

avctx codec context

outdata codec type dependent output struct

[out] got_frame_ptr decoder sets to 0 or 1 to indicate that a non-empty frame or subtitle was returned in outdata.

[in] avpkt AVPacket containing the data to be decoded

Returns

amount of bytes read from the packet on success, negative error code on failure

Definition at line 316 of file codec.h.

Referenced by av_codec_is_decoder(), avcodec_decode_subtitle2(), decode_simple_internal(), frame_worker_thread(), get_category(), and main().

Definition at line 318 of file codec.h.

Referenced by avcodec_close(), and ff_frame_thread_free().

Encode API with decoupled frame/packet dataflow.

This function is called to get one output packet. It should call ff_encode_get_frame() to obtain input data.

Definition at line 324 of file codec.h.

Referenced by av_codec_is_encoder(), encode_receive_packet_internal(), and main().

Decode API with decoupled packet/frame dataflow.

This function is called to get one output frame. It should call ff_decode_get_packet() to obtain input data.

Definition at line 331 of file codec.h.

Referenced by av_codec_is_decoder(), decode_receive_frame_internal(), and main().

Flush buffers.

Will be called when seeking

Definition at line 336 of file codec.h.

Referenced by avcodec_flush_buffers(), and ff_thread_flush().

Decoding only, a comma-separated list of bitstream filters to apply to packets before decoding.

Definition at line 342 of file codec.h.

Referenced by cuvid_decode_init(), decode_bsfs_init(), and main().

Array of pointers to hardware configurations supported by the codec, or NULL if no hardware supported.

The array is terminated by a NULL pointer.

The user can only access this field via avcodec_get_hw_config().

Definition at line 351 of file codec.h.

Referenced by avcodec_default_get_format(), avcodec_get_hw_config(), avcodec_get_hw_frames_parameters(), and ff_get_format().

List of supported codec_tags, terminated by FF_CODEC_TAGS_END.

Definition at line 356 of file codec.h.

Referenced by LLVMFuzzerTestOneInput().