A table of settings and callbacks that define a paticular implementation of a codec. More...
#include <switch_module_interfaces.h>
Collaboration diagram for switch_codec_implementation:
Data Fields | |
| switch_codec_type_t | codec_type |
| switch_payload_t | ianacode |
| char * | iananame |
| char * | fmtp |
| uint32_t | samples_per_second |
| uint32_t | actual_samples_per_second |
| int | bits_per_second |
| int | microseconds_per_packet |
| uint32_t | samples_per_packet |
| uint32_t | decoded_bytes_per_packet |
| uint32_t | encoded_bytes_per_packet |
| uint8_t | number_of_channels |
| int | codec_frames_per_packet |
| switch_core_codec_init_func_t | init |
| switch_core_codec_encode_func_t | encode |
| switch_core_codec_decode_func_t | decode |
| switch_core_codec_video_encode_func_t | encode_video |
| switch_core_codec_video_decode_func_t | decode_video |
| switch_core_codec_control_func_t | codec_control |
| switch_core_codec_destroy_func_t | destroy |
| uint32_t | codec_id |
| uint32_t | impl_id |
| char * | modname |
| struct switch_codec_implementation * | next |
Detailed Description
A table of settings and callbacks that define a paticular implementation of a codec.
Definition at line 723 of file switch_module_interfaces.h.
Field Documentation
◆ actual_samples_per_second
| uint32_t switch_codec_implementation::actual_samples_per_second |
actual samples transferred per second for those who are not moron g722 RFC writers
Definition at line 735 of file switch_module_interfaces.h.
Referenced by audio_bridge_thread(), early_thread_run(), inband_dtmf_generate_callback(), main(), record_callback(), rtp_common_write(), send_record_stop_event(), setup_ringback(), switch_channel_event_set_basic_data(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_copy(), switch_core_codec_init_with_bitrate(), switch_core_media_bug_read(), switch_core_media_get_offered_pt(), switch_core_media_negotiate_sdp(), switch_core_media_set_codec(), switch_core_session_read_frame(), switch_core_session_send_dtmf_string(), switch_core_session_set_codec_slin(), switch_core_session_set_read_codec(), switch_core_session_set_real_read_codec(), switch_core_session_set_video_read_codec(), switch_core_session_set_video_write_codec(), switch_core_session_set_write_codec(), switch_core_session_write_frame(), switch_ivr_activate_unicast(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_detect_speech_init(), switch_ivr_displace_session(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_inband_dtmf_session(), switch_ivr_insert_file(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_record_session_event(), switch_ivr_sleep(), switch_ivr_sound_test(), switch_ivr_speak_text(), switch_ivr_tone_detect_session(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), switch_loadable_module_get_codecs_sorted(), switch_loadable_module_process(), switch_loadable_module_unprocess(), switch_raw_decode(), switch_raw_encode(), and switch_speex_init().
◆ bits_per_second
| int switch_codec_implementation::bits_per_second |
bits transferred per second
Definition at line 737 of file switch_module_interfaces.h.
Referenced by generate_m(), switch_channel_event_set_basic_data(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_init_with_bitrate(), switch_core_media_negotiate_sdp(), switch_core_media_set_codec(), switch_core_session_set_read_codec(), switch_core_session_set_real_read_codec(), switch_core_session_set_write_codec(), switch_loadable_module_get_codecs_sorted(), and switch_loadable_module_process().
◆ codec_control
| switch_core_codec_control_func_t switch_codec_implementation::codec_control |
function to send control messages to the codec
Definition at line 761 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_video_implementation(), and switch_core_codec_control().
◆ codec_frames_per_packet
| int switch_codec_implementation::codec_frames_per_packet |
number of codec frames packetized into one packet
Definition at line 749 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_implementation(), and switch_core_codec_add_video_implementation().
◆ codec_id
| uint32_t switch_codec_implementation::codec_id |
Definition at line 764 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_session_get_read_impl(), switch_core_session_get_real_read_impl(), switch_core_session_get_video_read_impl(), switch_core_session_get_video_write_impl(), switch_core_session_get_write_impl(), switch_core_session_set_write_codec(), and switch_core_session_write_frame().
◆ codec_type
| switch_codec_type_t switch_codec_implementation::codec_type |
enumeration defining the type of the codec
Definition at line 725 of file switch_module_interfaces.h.
Referenced by generate_m(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_media_check_video_codecs(), switch_core_media_gen_local_sdp(), switch_core_media_negotiate_sdp(), switch_core_media_set_r_sdp_codec_string(), and switch_loadable_module_get_codecs_sorted().
◆ decode
| switch_core_codec_decode_func_t switch_codec_implementation::decode |
function to decode encoded data into raw data
Definition at line 755 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_implementation(), and switch_core_codec_decode().
◆ decode_video
| switch_core_codec_video_decode_func_t switch_codec_implementation::decode_video |
function to decode video encoded data into raw data
Definition at line 759 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_video_implementation(), and switch_core_codec_decode_video().
◆ decoded_bytes_per_packet
| uint32_t switch_codec_implementation::decoded_bytes_per_packet |
number of bytes one packet will decompress to
Definition at line 743 of file switch_module_interfaces.h.
Referenced by audio_bridge_thread(), recording_thread(), setup_ringback(), switch_core_codec_add_implementation(), switch_core_codec_decode(), switch_core_media_bug_add(), switch_core_media_bug_read(), switch_core_session_read_frame(), switch_core_session_set_read_codec(), switch_core_session_set_real_read_codec(), switch_core_session_transcoding(), switch_core_session_write_frame(), switch_g711a_decode(), switch_g711u_decode(), switch_ivr_collect_digits_count(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_record_session_event(), switch_ivr_sleep(), switch_ivr_wait_for_answer(), switch_loadable_module_process(), and switch_speex_decode().
◆ destroy
| switch_core_codec_destroy_func_t switch_codec_implementation::destroy |
deinitalize a codec handle using this implementation
Definition at line 763 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_destroy(), and switch_core_codec_reset().
◆ encode
| switch_core_codec_encode_func_t switch_codec_implementation::encode |
function to encode raw data into encoded data
Definition at line 753 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_implementation(), and switch_core_codec_encode().
◆ encode_video
| switch_core_codec_video_encode_func_t switch_codec_implementation::encode_video |
function to encode video raw data into encoded data
Definition at line 757 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_video_implementation(), and switch_core_codec_encode_video().
◆ encoded_bytes_per_packet
| uint32_t switch_codec_implementation::encoded_bytes_per_packet |
number of encoded bytes in the RTP payload
Definition at line 745 of file switch_module_interfaces.h.
Referenced by main(), switch_core_codec_add_implementation(), switch_core_codec_decode(), switch_core_media_read_frame(), switch_core_media_write_frame(), switch_ivr_originate(), switch_ivr_play_file(), switch_ivr_record_file_event(), and switch_ivr_wait_for_answer().
◆ fmtp
| char* switch_codec_implementation::fmtp |
default fmtp to send (can be overridden by the init function)
Definition at line 731 of file switch_module_interfaces.h.
Referenced by generate_m(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), and switch_core_media_gen_local_sdp().
◆ ianacode
| switch_payload_t switch_codec_implementation::ianacode |
the IANA code number
Definition at line 727 of file switch_module_interfaces.h.
Referenced by rtp_common_write(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_gen_encoded_silence(), switch_core_media_gen_local_sdp(), switch_core_media_negotiate_sdp(), switch_core_media_set_r_sdp_codec_string(), switch_core_session_read_frame(), switch_core_session_set_read_codec(), switch_core_session_set_real_read_codec(), switch_core_session_write_frame(), switch_loadable_module_get_codecs(), switch_loadable_module_get_codecs_sorted(), switch_loadable_module_process(), and switch_loadable_module_unprocess().
◆ iananame
| char* switch_codec_implementation::iananame |
the IANA code name
Definition at line 729 of file switch_module_interfaces.h.
Referenced by generate_m(), inherit_codec(), setup_ringback(), switch_channel_event_set_basic_data(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_copy(), switch_core_gen_encoded_silence(), switch_core_media_activate_rtp(), switch_core_media_gen_local_sdp(), switch_core_media_get_offered_pt(), switch_core_media_negotiate_sdp(), switch_core_media_set_codec(), switch_core_media_set_r_sdp_codec_string(), switch_core_media_set_video_codec(), switch_core_session_read_frame(), switch_core_session_set_read_codec(), switch_core_session_set_real_read_codec(), switch_core_session_set_video_read_codec(), switch_core_session_set_video_write_codec(), switch_core_session_set_write_codec(), switch_ivr_displace_session(), switch_ivr_eavesdrop_session(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_record_session_event(), switch_ivr_wait_for_answer(), switch_jb_set_session(), switch_loadable_module_get_codecs(), switch_loadable_module_get_codecs_sorted(), switch_loadable_module_process(), switch_loadable_module_unprocess(), and switch_rtp_enable_vad().
◆ impl_id
| uint32_t switch_codec_implementation::impl_id |
Definition at line 765 of file switch_module_interfaces.h.
Referenced by setup_ringback(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_session_read_frame(), switch_core_session_transcoding(), and text_bridge_thread().
◆ init
| switch_core_codec_init_func_t switch_codec_implementation::init |
function to initialize a codec handle using this implementation
Definition at line 751 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_init_with_bitrate(), and switch_core_codec_reset().
◆ microseconds_per_packet
| int switch_codec_implementation::microseconds_per_packet |
number of microseconds of media in one packet (ptime * 1000)
Definition at line 739 of file switch_module_interfaces.h.
Referenced by audio_bridge_thread(), audio_write_thread(), check_jb(), early_thread_run(), generate_m(), inherit_codec(), record_callback(), setup_ringback(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_copy(), switch_core_codec_init_with_bitrate(), switch_core_media_activate_rtp(), switch_core_media_gen_local_sdp(), switch_core_media_negotiate_sdp(), switch_core_media_set_codec(), switch_core_session_read_frame(), switch_core_session_set_codec_slin(), switch_core_session_wait_for_video_input_params(), switch_core_session_write_frame(), switch_ivr_activate_unicast(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_sleep(), switch_ivr_sound_test(), switch_ivr_speak_text(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), switch_loadable_module_get_codecs(), switch_loadable_module_get_codecs_sorted(), switch_loadable_module_process(), switch_loadable_module_sort_codecs(), switch_loadable_module_unprocess(), and switch_rtp_enable_vad().
◆ modname
| char* switch_codec_implementation::modname |
Definition at line 766 of file switch_module_interfaces.h.
Referenced by add_audio_codec(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_copy(), switch_core_media_gen_local_sdp(), switch_core_media_negotiate_sdp(), switch_core_media_set_r_sdp_codec_string(), and switch_rtp_enable_vad().
◆ next
| struct switch_codec_implementation* switch_codec_implementation::next |
Definition at line 767 of file switch_module_interfaces.h.
Referenced by switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_init_with_bitrate(), switch_loadable_module_get_codecs(), switch_loadable_module_get_codecs_sorted(), switch_loadable_module_process(), and switch_loadable_module_unprocess().
◆ number_of_channels
| uint8_t switch_codec_implementation::number_of_channels |
number of channels represented
Definition at line 747 of file switch_module_interfaces.h.
Referenced by audio_bridge_thread(), early_thread_run(), generate_m(), is_silence_frame(), recording_thread(), rtp_common_write(), session_audio_callback(), setup_ringback(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_copy(), switch_core_codec_decode(), switch_core_codec_init_with_bitrate(), switch_core_media_bug_read(), switch_core_media_gen_local_sdp(), switch_core_media_negotiate_sdp(), switch_core_media_set_codec(), switch_core_session_get_read_impl(), switch_core_session_get_video_read_impl(), switch_core_session_get_video_write_impl(), switch_core_session_get_write_impl(), switch_core_session_read_frame(), switch_core_session_set_codec_slin(), switch_core_session_write_frame(), switch_ivr_collect_digits_count(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_displace_session(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_insert_file(), switch_ivr_originate(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file_event(), switch_ivr_record_session_event(), switch_ivr_sleep(), switch_ivr_sound_test(), switch_ivr_speak_text(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), switch_loadable_module_get_codecs_sorted(), switch_loadable_module_process(), and switch_rtp_enable_vad().
◆ samples_per_packet
| uint32_t switch_codec_implementation::samples_per_packet |
number of samples in one packet
Definition at line 741 of file switch_module_interfaces.h.
Referenced by audio_write_thread(), check_jb(), check_media_timeout_params(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_media_activate_rtp(), switch_core_media_read_frame(), switch_core_media_set_codec(), switch_core_media_write_frame(), switch_core_session_enable_heartbeat(), switch_core_session_read_frame(), switch_core_session_write_frame(), switch_ivr_delay_echo(), switch_ivr_detect_audio(), switch_ivr_detect_silence(), switch_ivr_originate(), switch_ivr_play_file(), switch_ivr_preprocess_session(), switch_ivr_record_file_event(), switch_ivr_sound_test(), switch_ivr_wait_for_answer(), and switch_ivr_wait_for_silence().
◆ samples_per_second
| uint32_t switch_codec_implementation::samples_per_second |
samples transferred per second
Definition at line 733 of file switch_module_interfaces.h.
Referenced by check_jb(), check_media_timeout_params(), generate_m(), inherit_codec(), is_silence_frame(), switch_core_codec_add_implementation(), switch_core_codec_add_video_implementation(), switch_core_codec_copy(), switch_core_codec_init_with_bitrate(), switch_core_media_activate_rtp(), switch_core_media_gen_local_sdp(), switch_core_media_negotiate_sdp(), switch_core_media_read_frame(), switch_core_media_set_codec(), switch_core_media_set_video_codec(), switch_core_session_enable_heartbeat(), switch_core_session_read_frame(), switch_core_session_set_read_codec(), switch_core_session_set_real_read_codec(), switch_core_session_set_write_codec(), switch_ivr_collect_digits_count(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_preprocess_session(), switch_ivr_sound_test(), switch_loadable_module_get_codecs_sorted(), and switch_rtp_enable_vad().
The documentation for this struct was generated from the following file:
