switch_codec_implementation Struct Reference

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:

[legend]

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_destroy_func_t destroy
uint32_t codec_id
uint32_t impl_id
switch_codec_implementationnext

Detailed Description

A table of settings and callbacks that define a paticular implementation of a codec.

Definition at line 607 of file switch_module_interfaces.h.


Field Documentation

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 619 of file switch_module_interfaces.h.

Referenced by audio_bridge_thread(), early_thread_run(), inband_dtmf_generate_callback(), rtp_common_write(), setup_ringback(), switch_channel_event_set_basic_data(), switch_core_media_bug_read(), switch_core_session_set_codec_slin(), switch_ivr_activate_unicast(), switch_ivr_detect_speech(), 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(), switch_ivr_record_session(), switch_ivr_sound_test(), switch_ivr_speak_text(), switch_ivr_wait_for_answer(), switch_ivr_wait_for_silence(), switch_loadable_module_process(), switch_loadable_module_unprocess(), switch_raw_decode(), and switch_raw_encode().

int switch_codec_implementation::bits_per_second

bits transferred per second

Definition at line 621 of file switch_module_interfaces.h.

Referenced by switch_channel_event_set_basic_data(), switch_core_codec_init_with_bitrate(), switch_loadable_module_get_codecs_sorted(), and switch_loadable_module_process().

int switch_codec_implementation::codec_frames_per_packet

number of codec frames packetized into one packet

Definition at line 633 of file switch_module_interfaces.h.

uint32_t switch_codec_implementation::codec_id

Definition at line 642 of file switch_module_interfaces.h.

switch_codec_type_t switch_codec_implementation::codec_type

enumeration defining the type of the codec

Definition at line 609 of file switch_module_interfaces.h.

Referenced by switch_loadable_module_get_codecs_sorted().

switch_core_codec_decode_func_t switch_codec_implementation::decode

function to decode encoded data into raw data

Definition at line 639 of file switch_module_interfaces.h.

uint32_t switch_codec_implementation::decoded_bytes_per_packet

number of bytes one packet will decompress to

Definition at line 627 of file switch_module_interfaces.h.

Referenced by audio_bridge_thread(), setup_ringback(), switch_core_media_bug_read(), switch_g711a_decode(), switch_g711u_decode(), switch_ivr_collect_digits_count(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_record_session(), switch_ivr_sleep(), switch_ivr_wait_for_answer(), and switch_loadable_module_process().

switch_core_codec_destroy_func_t switch_codec_implementation::destroy

deinitalize a codec handle using this implementation

Definition at line 641 of file switch_module_interfaces.h.

switch_core_codec_encode_func_t switch_codec_implementation::encode

function to encode raw data into encoded data

Definition at line 637 of file switch_module_interfaces.h.

uint32_t switch_codec_implementation::encoded_bytes_per_packet

number of encoded bytes in the RTP payload

Definition at line 629 of file switch_module_interfaces.h.

Referenced by switch_ivr_play_file(), and switch_ivr_wait_for_answer().

char* switch_codec_implementation::fmtp

default fmtp to send (can be overridden by the init function)

Definition at line 615 of file switch_module_interfaces.h.

switch_payload_t switch_codec_implementation::ianacode

the IANA code number

Definition at line 611 of file switch_module_interfaces.h.

Referenced by rtp_common_write(), 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().

char* switch_codec_implementation::iananame

the IANA code name

Definition at line 613 of file switch_module_interfaces.h.

Referenced by inherit_codec(), setup_ringback(), switch_channel_event_set_basic_data(), switch_ivr_displace_session(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_wait_for_answer(), switch_loadable_module_get_codecs(), switch_loadable_module_get_codecs_sorted(), switch_loadable_module_process(), and switch_loadable_module_unprocess().

uint32_t switch_codec_implementation::impl_id

Definition at line 643 of file switch_module_interfaces.h.

Referenced by setup_ringback(), and switch_core_codec_add_implementation().

switch_core_codec_init_func_t switch_codec_implementation::init

function to initialize a codec handle using this implementation

Definition at line 635 of file switch_module_interfaces.h.

Referenced by switch_core_codec_init_with_bitrate().

int switch_codec_implementation::microseconds_per_packet

number of microseconds of media in one packet (ptime * 1000)

Definition at line 623 of file switch_module_interfaces.h.

Referenced by audio_bridge_thread(), early_thread_run(), inherit_codec(), setup_ringback(), switch_core_codec_init_with_bitrate(), switch_core_session_set_codec_slin(), switch_ivr_activate_unicast(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_eavesdrop_session(), switch_ivr_gentones(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_sleep(), switch_ivr_sound_test(), switch_ivr_speak_text(), switch_ivr_wait_for_silence(), switch_loadable_module_get_codecs(), switch_loadable_module_get_codecs_sorted(), switch_loadable_module_process(), and switch_loadable_module_unprocess().

struct switch_codec_implementation* switch_codec_implementation::next

Definition at line 644 of file switch_module_interfaces.h.

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

uint8_t switch_codec_implementation::number_of_channels

number of channels represented

Definition at line 631 of file switch_module_interfaces.h.

Referenced by rtp_common_write(), setup_ringback(), switch_core_codec_init_with_bitrate(), switch_ivr_collect_digits_count(), switch_ivr_displace_session(), switch_ivr_eavesdrop_session(), switch_ivr_insert_file(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_record_file(), switch_ivr_record_session(), switch_ivr_sleep(), switch_ivr_sound_test(), switch_ivr_wait_for_answer(), and switch_ivr_wait_for_silence().

uint32_t switch_codec_implementation::samples_per_packet

number of samples in one packet

Definition at line 625 of file switch_module_interfaces.h.

Referenced by switch_ivr_delay_echo(), switch_ivr_play_file(), switch_ivr_preprocess_session(), switch_ivr_record_file(), switch_ivr_sound_test(), switch_ivr_wait_for_answer(), and switch_ivr_wait_for_silence().

uint32_t switch_codec_implementation::samples_per_second

samples transferred per second

Definition at line 617 of file switch_module_interfaces.h.

Referenced by inherit_codec(), switch_core_codec_init_with_bitrate(), switch_ivr_collect_digits_count(), switch_ivr_delay_echo(), switch_ivr_park(), switch_ivr_play_file(), switch_ivr_preprocess_session(), switch_ivr_process_fh(), switch_ivr_sleep(), switch_ivr_sound_test(), and switch_loadable_module_get_codecs_sorted().


The documentation for this struct was generated from the following file:
Generated on Wed May 16 04:00:27 2012 for FreeSWITCH API Documentation by  doxygen 1.4.7