Asterisk - The Open Source Telephony Project
21.4.1
|
Data structure associated with a single frame of data. More...
#include <frame.h>
Data Fields | |
union { | |
char pad [8] | |
void * ptr | |
uint32_t uint32 | |
} | data |
int | datalen |
struct timeval | delivery |
unsigned int | flags |
struct { | |
struct ast_frame * next | |
} | frame_list |
enum ast_frame_type | frametype |
long | len |
int | mallocd |
size_t | mallocd_hdr_len |
int | offset |
int | samples |
int | seqno |
const char * | src |
int | stream_num |
struct ast_frame_subclass | subclass |
long | ts |
Data structure associated with a single frame of data.
Definition at line 165 of file include/asterisk/frame.h.
union { ... } data |
Pointer to actual data
Referenced by __analog_handle_event(), __ast_frisolate(), __ast_read(), __ast_request_and_dial(), adpcmtolin_framein(), alawtolin_framein(), alawtoulaw_framein(), ast_audiosocket_receive_frame(), ast_audiosocket_send_frame(), ast_bridge_channel_queue_frame(), ast_cc_build_frame(), ast_channel_connected_line_sub(), ast_channel_redirecting_sub(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_adjust_volume(), ast_frame_adjust_volume_float(), ast_frame_clear(), ast_frame_slinear_sum(), ast_frame_subclass2str(), ast_indicate_data(), ast_msg_data_queue_frame(), ast_prod(), ast_queue_hangup_with_cause(), ast_queue_hold(), ast_recvtext(), ast_rtcp_interpret(), ast_rtp_write(), ast_sendtext_data(), ast_slinfactory_feed(), ast_slinfactory_read(), ast_trans_frameout(), ast_transfer_protocol(), ast_unreal_sendhtml(), ast_unreal_sendtext(), ast_waitfordigit_full(), ast_write_stream(), codec2tolin_framein(), dial_exec_full(), fax_detect_framehook(), fax_gateway_detect_t38(), g726aal2tolin_framein(), g726tolin_framein(), generic_fax_exec(), gsmtolin_framein(), handle_frame(), handle_jack_audio(), ilbctolin_framein(), lintoadpcm_framein(), lintoalaw_framein(), lintocodec2_framein(), lintog726_framein(), lintog726aal2_framein(), lintogsm_framein(), lintoilbc_framein(), lintospeex_feedback(), lintospeex_framein(), lintoulaw_framein(), make_silence(), multicast_rtp_write(), newpvt(), ogg_speex_read(), ogg_vorbis_read(), ogg_vorbis_write(), queue_signalling(), receive_dtmf_digits(), remb_collector_alloc(), rtp_raw_write(), rtp_red_buffer(), rtp_red_init(), run_agi(), schedule_delivery(), sms_generate(), snoop_destroy(), spandsp_fax_gateway_process(), spandsp_fax_gw_t30_gen(), spandsp_fax_write(), speech_background(), speextolin_framein(), stasis_app_control_snoop(), t38_framehook(), ulawtoalaw_framein(), ulawtolin_framein(), wait_for_answer(), and waitstream_core().
int datalen |
Length of data
Definition at line 171 of file include/asterisk/frame.h.
Referenced by __analog_handle_event(), __ast_frisolate(), __ast_request_and_dial(), adpcmtolin_framein(), ast_audiosocket_receive_frame(), ast_audiosocket_send_frame(), ast_bridge_channel_queue_control_data(), ast_bridge_channel_queue_frame(), ast_bridge_channel_write_control_data(), ast_cc_build_frame(), ast_channel_connected_line_sub(), ast_channel_redirecting_sub(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_clear(), ast_frame_subclass2str(), ast_indicate_data(), ast_msg_data_queue_frame(), ast_queue_hold(), ast_recvtext(), ast_rtcp_interpret(), ast_rtp_write(), ast_sendtext_data(), ast_trans_frameout(), ast_unreal_sendhtml(), ast_unreal_sendtext(), ast_waitfordigit_full(), ast_write_stream(), chan_pjsip_indicate(), cli_console_sendtext(), codec2tolin_framein(), create_binaural_frame(), dial_exec_full(), fax_detect_framehook(), fax_gateway_detect_t38(), framein(), g726aal2tolin_framein(), g726tolin_framein(), generic_fax_exec(), gsmtolin_framein(), handle_frame(), handle_jack_audio(), ilbctolin_framein(), lintoadpcm_framein(), lintocodec2_framein(), lintogsm_framein(), lintoilbc_framein(), lintospeex_framein(), lintospeex_frameout(), make_silence(), ogg_speex_read(), ogg_vorbis_read(), ogg_vorbis_write(), queue_signalling(), red_write(), remb_collector_alloc(), rtp_raw_write(), rtp_red_buffer(), run_agi(), schedule_delivery(), sms_generate(), softmix_mixing_loop(), spandsp_fax_gateway_process(), spandsp_fax_gw_t30_gen(), spandsp_fax_write(), speech_background(), speextolin_framein(), stasis_app_control_snoop(), wait_for_answer(), and waitstream_core().
struct timeval delivery |
Global delivery time
Definition at line 185 of file include/asterisk/frame.h.
Referenced by ast_rtcp_interpret(), ast_translate(), rtp_raw_write(), and schedule_delivery().
unsigned int flags |
Misc. frame flags
Definition at line 189 of file include/asterisk/frame.h.
struct { ... } frame_list |
For placing in a linked list
enum ast_frame_type frametype |
Kind of frame
Definition at line 167 of file include/asterisk/frame.h.
Referenced by __analog_handle_event(), __ast_answer(), __ast_frisolate(), __ast_play_and_record(), __ast_read(), __ast_request_and_dial(), ast_audiohook_write_list(), ast_audiosocket_receive_frame(), ast_autoservice_stop(), ast_bridge_channel_notify_talking(), ast_bridge_channel_queue_control_data(), ast_bridge_channel_queue_frame(), ast_bridge_channel_write_control_data(), ast_bridge_queue_everyone_else(), ast_cc_build_frame(), ast_channel_clear_softhangup(), ast_codec_samples_count(), ast_control_tone(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_adjust_volume(), ast_frame_adjust_volume_float(), ast_frame_dump(), ast_frame_slinear_sum(), ast_frame_subclass2str(), ast_indicate_data(), ast_is_deferrable_frame(), ast_jb_put(), ast_msg_data_queue_frame(), ast_recvtext(), ast_rtcp_interpret(), ast_rtcp_read(), ast_rtp_read(), ast_rtp_write(), ast_sendtext_data(), ast_transfer_protocol(), ast_translate(), ast_unreal_write_stream(), ast_waitfordigit_full(), ast_write_stream(), ast_writestream(), bridge_hold(), bridge_ringing(), bridge_unhold(), chan_pjsip_indicate(), chan_pjsip_read_stream(), cli_console_sendtext(), dial_exec_full(), dtmf_store_framehook(), fax_detect_framehook(), fax_gateway_framehook(), generic_fax_exec(), handle_frame(), handle_jack_audio(), hold_intercept_framehook(), jingle_read(), jingle_write(), lintospeex_frameout(), make_silence(), multicast_rtp_write(), newpvt(), queue_signalling(), read_mf_digits(), read_sf_digits(), receive_dtmf_digits(), remb_collector_alloc(), rtp_raw_write(), rtp_red_init(), run_agi(), schedule_delivery(), sms_generate(), spandsp_fax_gateway_process(), spandsp_fax_gw_t30_gen(), spandsp_fax_read(), speech_background(), stasis_app_control_snoop(), stream_monitor(), t38_framehook(), transfer_target_framehook_cb(), unreal_queue_frame(), wait_for_answer(), and waitstream_core().
long len |
Length in milliseconds
Definition at line 193 of file include/asterisk/frame.h.
Referenced by __ast_frisolate(), __ast_read(), ast_audiosocket_receive_frame(), ast_dsp_process(), ast_jb_put(), ast_translate(), ast_unreal_digit_end(), ast_write_stream(), cli_console_sendtext(), framein(), fsk_serial(), and schedule_delivery().
int mallocd |
Was the data malloc'd? i.e. should we free it when we discard the frame?
Definition at line 175 of file include/asterisk/frame.h.
Referenced by __analog_handle_event(), __ast_frisolate(), ast_cc_build_frame(), ast_rtcp_interpret(), ast_sendtext_data(), make_silence(), newpvt(), sms_generate(), and stasis_app_control_snoop().
size_t mallocd_hdr_len |
The number of bytes allocated for a malloc'd frame header
Definition at line 177 of file include/asterisk/frame.h.
int offset |
How many bytes exist before "data" that can be used if needed
Definition at line 179 of file include/asterisk/frame.h.
Referenced by __analog_handle_event(), __ast_frisolate(), ast_rtcp_interpret(), ast_rtp_write(), ast_slinfactory_read(), multicast_rtp_write(), newpvt(), sms_generate(), and stasis_app_control_snoop().
int samples |
Number of samples in this frame
Definition at line 173 of file include/asterisk/frame.h.
Referenced by __analog_handle_event(), __ast_frisolate(), adpcmtolin_framein(), alawtolin_framein(), alawtoulaw_framein(), ast_audiosocket_receive_frame(), ast_frame_adjust_volume(), ast_frame_adjust_volume_float(), ast_frame_slinear_sum(), ast_rtcp_interpret(), ast_slinfactory_feed(), ast_slinfactory_read(), ast_trans_frameout(), ast_translate(), audio_audiohook_write_list(), calc_monitor_jump(), create_binaural_frame(), fax_gateway_framehook(), framein(), fsk_serial(), g726aal2tolin_framein(), g726tolin_framein(), handle_jack_audio(), ilbctolin_framein(), lintoadpcm_framein(), lintoadpcm_frameout(), lintoalaw_framein(), lintocodec2_framein(), lintocodec2_frameout(), lintog726_framein(), lintog726aal2_framein(), lintogsm_framein(), lintogsm_frameout(), lintoilbc_framein(), lintoilbc_frameout(), lintospeex_framein(), lintospeex_frameout(), lintoulaw_framein(), make_silence(), ogg_speex_read(), ogg_vorbis_read(), ogg_vorbis_write(), rtp_raw_write(), sms_generate(), softmix_mixing_loop(), softmix_process_write_binaural_audio(), spandsp_fax_gateway_process(), spandsp_fax_gw_t30_gen(), spandsp_fax_read(), spandsp_fax_write(), stasis_app_control_snoop(), stream_monitor(), ulawtoalaw_framein(), and ulawtolin_framein().
int seqno |
Sequence number
Definition at line 195 of file include/asterisk/frame.h.
Referenced by __ast_frisolate(), ast_rtp_read(), ast_translate(), framein(), rtp_raw_write(), spandsp_fax_gateway_process(), and spandsp_fax_write().
const char* src |
Optional source of frame for debugging
Definition at line 181 of file include/asterisk/frame.h.
Referenced by __analog_handle_event(), __ast_frisolate(), ast_dsp_process(), ast_jb_put(), ast_prod(), ast_rtcp_interpret(), ast_sendtext_data(), ast_write_stream(), fax_gateway_request_t38(), framein(), ilbctolin_framein(), newpvt(), sms_generate(), and stasis_app_control_snoop().
int stream_num |
Stream number the frame originated from
Definition at line 197 of file include/asterisk/frame.h.
Referenced by __ast_frisolate(), __ast_read(), ast_bridge_channel_queue_frame(), ast_rtcp_interpret(), ast_unreal_write_stream(), and is_compatible_format().
struct ast_frame_subclass subclass |
Subclass, frame dependent
Definition at line 169 of file include/asterisk/frame.h.
Referenced by __analog_handle_event(), __ast_answer(), __ast_frisolate(), __ast_play_and_record(), __ast_read(), __ast_request_and_dial(), ast_cc_build_frame(), ast_channel_clear_softhangup(), ast_codec_samples_count(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_adjust_volume(), ast_frame_adjust_volume_float(), ast_frame_dump(), ast_frame_slinear_sum(), ast_frame_subclass2str(), ast_indicate_data(), ast_prod(), ast_recvtext(), ast_rtcp_interpret(), ast_rtcp_read(), ast_rtp_destroy(), ast_rtp_dtmf_end_with_duration(), ast_rtp_new(), ast_rtp_read(), ast_rtp_write(), ast_sendtext_data(), ast_slinfactory_feed(), ast_transfer_protocol(), ast_translate(), ast_unreal_digit_begin(), ast_unreal_digit_end(), ast_unreal_sendhtml(), ast_unreal_write_stream(), ast_waitfordigit_full(), ast_write_stream(), ast_writestream(), audio_audiohook_write_list(), chan_pjsip_indicate(), chan_pjsip_read_stream(), dial_exec_full(), dtmf_store_framehook(), fax_detect_framehook(), fax_gateway_framehook(), fax_gateway_request_t38(), generic_fax_exec(), handle_frame(), hold_intercept_framehook(), ilbctolin_framein(), is_compatible_format(), jingle_read(), jingle_write(), lintoilbc_frameout(), lintospeex_feedback(), make_silence(), multicast_rtp_write(), newpvt(), read_mf_digits(), read_sf_digits(), receive_dtmf_digits(), remb_collector_alloc(), rtp_raw_write(), rtp_red_init(), schedule_delivery(), sig_pri_dial_complete(), sms_generate(), softmix_bridge_leave(), softmix_mixing_loop(), spandsp_fax_gateway_process(), speech_background(), stasis_app_control_snoop(), t38_framehook(), transfer_target_framehook_cb(), unreal_queue_frame(), wait_for_answer(), and waitstream_core().
long ts |
Timestamp in milliseconds
Definition at line 191 of file include/asterisk/frame.h.
Referenced by __ast_frisolate(), ast_jb_put(), ast_translate(), framein(), rtp_raw_write(), and rtp_red_buffer().