Thu Oct 11 06:50:21 2012

Asterisk developer's documentation


ast_frame Struct Reference

Data structure associated with a single frame of data. More...

#include <frame.h>

Collaboration diagram for ast_frame:

Collaboration graph
[legend]

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 subclass
long ts

Detailed Description

Data structure associated with a single frame of data.

Definition at line 142 of file frame.h.


Field Documentation

union { ... } data

Pointer to actual data

Referenced by __ast_read(), __ast_smoother_feed(), __dahdi_exception(), __frame_free(), __send_command(), action_originate(), adjust_frame_for_plc(), adpcmtolin_framein(), adsi_careful_send(), alawtolin_framein(), alawtoulaw_framein(), alsa_read(), alsa_write(), ast_bridge_call(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_noise(), ast_dsp_process(), ast_dsp_silence(), ast_frame_adjust_volume(), ast_frame_dump(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_generic_bridge(), ast_prod(), ast_queue_control_data(), ast_queue_hangup_with_cause(), ast_recvtext(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_slinfactory_feed(), ast_slinfactory_read(), ast_smoother_read(), ast_trans_frameout(), ast_udptl_write(), ast_waitfordigit_full(), ast_write(), audiohook_read_frame_both(), bridge_native_loop(), bridge_p2p_loop(), cb_events(), conf_run(), console_sendtext(), console_write(), create_video_frame(), dahdi_decoder_framein(), dahdi_decoder_frameout(), dahdi_encoder_framein(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), disa_exec(), do_immediate_setup(), eivr_comm(), free_signaling_queue_entry(), function_ilink(), g722tolin_framein(), g723_read(), g723_write(), g726_read(), g726_write(), g726aal2tolin_framein(), g726tolin_framein(), g729_read(), g729_write(), gsm_read(), gsm_sample(), gsm_write(), gsmtolin_framein(), h261_encap(), h263_encap(), h263_read(), h263_write(), h263p_encap(), h264_encap(), h264_read(), h264_write(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax2_trunk_queue(), iax_frame_wrap(), ices_exec(), ilbc_read(), ilbc_sample(), ilbc_write(), ilbctolin_framein(), jpeg_read_image(), jpeg_write_image(), lintoadpcm_framein(), lintoalaw_framein(), lintog722_framein(), lintog726_framein(), lintog726aal2_framein(), lintogsm_framein(), lintoilbc_framein(), lintolpc10_framein(), lintospeex_framein(), lintoulaw(), lintoulaw_framein(), local_indicate(), local_sendhtml(), local_sendtext(), lpc10_sample(), lpc10tolin_framein(), measurenoise(), milliwatt_generate(), misdn_read(), misdn_write(), moh_generate(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), ogg_vorbis_write(), oss_read(), oss_write(), pcm_read(), pcm_write(), phone_exception(), phone_read(), phone_write(), playtones_generator(), process_rfc3389(), queue_signalling(), queue_voice_frame(), receive_dtmf_digits(), receive_message(), red_buffer_t140(), red_t140_to_red(), resample_frame(), rpt(), rpt_exec(), rtp_red_init(), run_agi(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sip_rtp_read(), siren14read(), siren14write(), siren7read(), siren7write(), slinear_read(), slinear_write(), smoother_frame_feed(), sms_generate(), socket_process(), socket_process_meta(), softmix_bridge_join(), speech_background(), speex_callback(), speex_sample(), speextolin_framein(), spy_generate(), tonepair_generator(), transmit_audio(), transmit_t38(), udptl_rx_packet(), ulawtoalaw_framein(), ulawtolin_framein(), usbradio_read(), usbradio_write(), vox_read(), vox_write(), wait_for_answer(), wait_for_winner(), waitstream_core(), wav_read(), and wav_write().

int datalen

Length of data

Definition at line 148 of file frame.h.

Referenced by __ast_smoother_feed(), __dahdi_exception(), __send_command(), adjust_frame_for_plc(), adpcmtolin_framein(), adsi_careful_send(), alsa_read(), alsa_write(), ast_bridge_call(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_noise(), ast_dsp_process(), ast_dsp_silence(), ast_frame_dump(), ast_frdup(), ast_frisolate(), ast_generic_bridge(), ast_queue_control_data(), ast_read_generator_actions(), ast_recvtext(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_smoother_read(), ast_trans_frameout(), ast_udptl_write(), ast_waitfordigit_full(), ast_write(), bridge_native_loop(), bridge_p2p_loop(), cb_events(), cli_console_sendtext(), conf_run(), console_sendtext(), create_dtmf_frame(), create_video_frame(), dahdi_decoder_framein(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), dump_hint(), framein(), function_ilink(), g723_read(), g723_write(), g726_read(), g726_write(), g726aal2tolin_framein(), g726tolin_framein(), g729_read(), g729_write(), gsm_write(), gsmtolin_framein(), h263_read(), h263_write(), h264_read(), h264_write(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax2_trunk_queue(), iax_frame_wrap(), iaxfrdup2(), ices_exec(), ilbc_read(), ilbc_write(), ilbctolin_framein(), jpeg_read_image(), jpeg_write_image(), linear_generator(), lintoadpcm_framein(), lintogsm_framein(), lintoilbc_framein(), lintolpc10_framein(), lintospeex_framein(), local_indicate(), local_sendhtml(), local_sendtext(), lpc10tolin_framein(), milliwatt_generate(), misdn_read(), moh_generate(), mpeg4_decode(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), ogg_vorbis_write(), oss_read(), oss_write(), pcm_read(), pcm_write(), phone_exception(), phone_read(), phone_write(), playtones_generator(), process_rfc3389(), receive_message(), red_buffer_t140(), red_t140_to_red(), rpt(), rpt_exec(), rtp_red_init(), run_agi(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sip_rtp_read(), siren14read(), siren14write(), siren7read(), siren7write(), slinear_read(), slinear_write(), smoother_frame_feed(), sms_generate(), socket_process(), socket_process_meta(), softmix_bridge_join(), speech_background(), speextolin_framein(), spy_generate(), tonepair_generator(), transmit_audio(), transmit_t38(), udptl_rx_packet(), usbradio_read(), usbradio_write(), vox_read(), vox_write(), wait_for_answer(), waitstream_core(), wav_read(), and wav_write().

struct timeval delivery [read]

unsigned int flags

Misc. frame flags

Definition at line 166 of file frame.h.

Referenced by conf_run(), oss_call(), process_cisco_dtmf(), recordthread(), and session_do().

struct { ... } frame_list

For placing in a linked list

Kind of frame

Definition at line 144 of file frame.h.

Referenced by __adsi_transmit_messages(), __ast_answer(), __ast_play_and_record(), __ast_queue_frame(), __ast_read(), __ast_request_and_dial(), __ast_smoother_feed(), __attempt_transmit(), __dahdi_exception(), __get_from_jb(), __oh323_update_info(), __send_command(), adpcm_sample(), adsi_careful_send(), agent_ack_sleep(), agent_read(), agent_write(), alaw_sample(), alsa_read(), ast_audiohook_write_list(), ast_autoservice_stop(), ast_bridge_call(), ast_bridge_handle_trip(), ast_channel_clear_softhangup(), ast_dsp_call_progress(), ast_dsp_noise(), ast_dsp_process(), ast_dsp_silence(), ast_frame_adjust_volume(), ast_frame_dump(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_generic_bridge(), ast_is_deferrable_frame(), ast_jb_put(), ast_read_generator_actions(), ast_recvtext(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_smoother_read(), ast_trans_frameout(), ast_translate(), ast_udptl_bridge(), ast_udptl_write(), ast_waitfordigit_full(), ast_write(), ast_writestream(), async_wait(), audiohook_read_frame_both(), audiohook_read_frame_single(), autoservice_run(), background_detect_exec(), bridge_native_loop(), bridge_p2p_loop(), calc_timestamp(), cb_events(), channel_spy(), cli_console_sendtext(), conf_exec(), conf_run(), console_call(), console_dial(), console_sendtext(), create_dtmf_frame(), create_video_frame(), dahdi_bridge(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_read(), dahdi_write(), decode_frame(), dial_exec_full(), dictate_exec(), disa_exec(), do_immediate_setup(), do_waiting(), echo_exec(), eivr_comm(), fakesrc_sample(), fax_generator_generate(), feature_request_and_dial(), function_ilink(), g722_sample(), g723_read(), g723_write(), g726_read(), g726_sample(), g726_write(), g729_read(), g729_write(), gsm_read(), gsm_sample(), gsm_write(), gtalk_digit(), gtalk_rtp_read(), gtalk_write(), h263_read(), h263_write(), h264_read(), h264_write(), handle_frame(), handle_frame_ownerless(), handle_jack_audio(), handle_keypad_button_message(), handle_link_data(), handle_recordfile(), handle_request(), handle_speechrecognize(), iax2_bridge(), iax2_send(), iax2_write(), iax_frame_wrap(), ices_exec(), ilbc_read(), ilbc_sample(), ilbc_write(), isAnsweringMachine(), jack_exec(), jack_hook_callback(), jingle_digit(), jingle_rtp_read(), jingle_write(), jpeg_read_image(), jpeg_write_image(), launch_asyncagi(), linear_generator(), lintospeex_frameout(), local_queue_frame(), local_write(), lpc10_sample(), manage_parkinglot(), measurenoise(), mgcp_rtp_read(), mgcp_write(), milliwatt_generate(), misdn_bridge(), misdn_read(), mohalloc(), mp3_exec(), nbs_xwrite(), NBScat_exec(), ogg_vorbis_read(), ogg_vorbis_write(), oh323_rtp_read(), oh323_simulate_dtmf_end(), oh323_write(), oss_call(), oss_read(), pcm_read(), pcm_write(), phone_exception(), phone_read(), phone_write(), playtones_generator(), process_ast_dsp(), process_rfc3389(), queue_dtmf_readq(), queue_signalling(), receive_digit(), receive_dtmf_digits(), receive_message(), record_exec(), recordthread(), resend_with_token(), rpt(), rpt_exec(), rtp_red_init(), run_agi(), schedule_delivery(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), send_waveform_to_channel(), sendurl_exec(), silence_generator_generate(), sip_read(), sip_rtp_read(), sip_write(), siren14read(), siren14write(), siren7read(), siren7write(), skinny_rtp_read(), skinny_write(), slin16_sample(), slin8_sample(), slinear_read(), slinear_write(), sms_generate(), socket_process(), socket_process_meta(), softmix_bridge_join(), softmix_bridge_write(), speech_background(), speex_callback(), speex_sample(), ss_thread(), stream_monitor(), t38_tx_packet_handler(), tonepair_generator(), transmit_audio(), transmit_t38(), udptl_rx_packet(), ulaw_sample(), unistim_do_senddigit(), unistim_rtp_read(), unistim_senddigit_end(), unistim_write(), unwrap_timestamp(), usbradio_read(), volume_callback(), vox_read(), vox_write(), wait_for_answer(), wait_for_winner(), waitforring_exec(), waitstream_core(), wav_read(), and wav_write().

long len

int mallocd

The number of bytes allocated for a malloc'd frame header

Definition at line 154 of file frame.h.

Referenced by ast_frame_header_new(), and ast_frdup().

struct ast_frame* next [read]

Definition at line 164 of file frame.h.

Referenced by ast_frame_free(), and jb_get_and_deliver().

int offset

char pad[8]

Definition at line 160 of file frame.h.

void* ptr

Definition at line 160 of file frame.h.

Referenced by __ast_smoother_feed(), __dahdi_exception(), __frame_free(), __send_command(), adjust_frame_for_plc(), adpcmtolin_framein(), adsi_careful_send(), alawtolin_framein(), alawtoulaw_framein(), alsa_read(), alsa_write(), ast_bridge_call(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_noise(), ast_dsp_process(), ast_dsp_silence(), ast_frame_adjust_volume(), ast_frame_dump(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_generic_bridge(), ast_prod(), ast_queue_control_data(), ast_recvtext(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_slinfactory_feed(), ast_slinfactory_read(), ast_smoother_read(), ast_trans_frameout(), ast_udptl_write(), ast_waitfordigit_full(), ast_write(), audiohook_read_frame_both(), bridge_native_loop(), bridge_p2p_loop(), cb_events(), conf_run(), console_sendtext(), console_write(), create_video_frame(), dahdi_decoder_framein(), dahdi_decoder_frameout(), dahdi_encoder_framein(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), free_signaling_queue_entry(), function_ilink(), g722tolin_framein(), g723_read(), g723_write(), g726_read(), g726_write(), g726aal2tolin_framein(), g726tolin_framein(), g729_read(), g729_write(), gsm_read(), gsm_write(), gsmtolin_framein(), h261_encap(), h263_encap(), h263_read(), h263_write(), h263p_encap(), h264_encap(), h264_read(), h264_write(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax2_trunk_queue(), iax_frame_wrap(), ices_exec(), ilbc_read(), ilbc_write(), ilbctolin_framein(), jpeg_read_image(), jpeg_write_image(), lintoadpcm_framein(), lintoalaw_framein(), lintog722_framein(), lintog726_framein(), lintog726aal2_framein(), lintogsm_framein(), lintoilbc_framein(), lintolpc10_framein(), lintospeex_framein(), lintoulaw(), lintoulaw_framein(), local_indicate(), local_sendhtml(), local_sendtext(), lpc10tolin_framein(), measurenoise(), milliwatt_generate(), misdn_read(), misdn_write(), moh_generate(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), ogg_vorbis_write(), oss_read(), oss_write(), pcm_read(), pcm_write(), phone_exception(), phone_read(), phone_write(), playtones_generator(), process_rfc3389(), queue_signalling(), queue_voice_frame(), receive_message(), red_buffer_t140(), red_t140_to_red(), resample_frame(), rpt(), rpt_exec(), rtp_red_init(), run_agi(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sip_rtp_read(), siren14read(), siren14write(), siren7read(), siren7write(), slinear_read(), slinear_write(), smoother_frame_feed(), sms_generate(), socket_process(), socket_process_meta(), softmix_bridge_join(), speech_background(), speex_callback(), speextolin_framein(), spy_generate(), tone_detect(), tonepair_generator(), transmit_audio(), transmit_t38(), udptl_rx_packet(), ulawtoalaw_framein(), ulawtolin_framein(), usbradio_read(), usbradio_write(), vox_read(), vox_write(), wait_for_answer(), waitstream_core(), wav_read(), and wav_write().

int samples

Number of samples in this frame

Definition at line 150 of file frame.h.

Referenced by __ast_read(), __ast_smoother_feed(), __dahdi_exception(), __get_from_jb(), adjust_frame_for_plc(), adpcm_sample(), adpcmtolin_framein(), adsi_careful_send(), alaw_sample(), alawtolin_framein(), alawtoulaw_framein(), alsa_read(), ast_frame_adjust_volume(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_read_generator_actions(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_slinfactory_feed(), ast_slinfactory_read(), ast_smoother_read(), ast_trans_frameout(), ast_translate(), ast_write(), audio_audiohook_write_list(), calc_cost(), calc_timestamp(), cb_events(), conf_run(), console_write(), create_dtmf_frame(), create_video_frame(), dahdi_decoder_framein(), dahdi_decoder_frameout(), dahdi_encoder_framein(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dictate_exec(), do_immediate_setup(), fax_generator_generate(), framein(), fsk_serial(), function_ilink(), g722_sample(), g722tolin_framein(), g723_read(), g726_read(), g726_sample(), g726aal2tolin_framein(), g726tolin_framein(), g729_read(), gen_generate(), gsm_read(), gsm_sample(), h263_read(), h263_write(), h264_read(), h264_write(), handle_jack_audio(), handle_link_data(), iax_frame_wrap(), ilbc_read(), ilbc_sample(), ilbctolin_framein(), jb_get_and_deliver(), linear_generator(), lintoadpcm_framein(), lintoadpcm_frameout(), lintoalaw_framein(), lintog722_framein(), lintog726_framein(), lintog726aal2_framein(), lintogsm_framein(), lintoilbc_framein(), lintolpc10_framein(), lintospeex_framein(), lintospeex_frameout(), lintoulaw(), lintoulaw_framein(), lpc10_sample(), measurenoise(), milliwatt_generate(), misdn_read(), misdn_write(), moh_files_generator(), moh_generate(), nbs_xread(), ogg_vorbis_read(), ogg_vorbis_write(), oss_read(), pcm_read(), phone_exception(), phone_read(), playtones_generator(), process_cisco_dtmf(), process_rfc2833(), process_rfc3389(), queue_voice_frame(), receive_digit(), resample_frame(), rpt(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), send_waveform_to_channel(), siren14read(), siren7read(), slin16_sample(), slin8_sample(), slinear_read(), smoother_frame_feed(), sms_generate(), socket_process(), socket_process_meta(), softmix_bridge_join(), speex_callback(), speex_sample(), stream_monitor(), tonepair_generator(), transmit_audio(), ulaw_sample(), ulawtoalaw_framein(), ulawtolin_framein(), usbradio_read(), vox_read(), and wav_read().

int seqno

const char* src

int subclass

Subclass, frame dependent

Definition at line 146 of file frame.h.

Referenced by __adsi_transmit_messages(), __ast_answer(), __ast_play_and_record(), __ast_queue_frame(), __ast_read(), __ast_request_and_dial(), __ast_smoother_feed(), __attempt_transmit(), __dahdi_exception(), __get_from_jb(), __oh323_update_info(), __send_command(), adsi_careful_send(), agent_ack_sleep(), agent_read(), agent_write(), alsa_call(), alsa_read(), ast_bridge_call(), ast_bridge_handle_trip(), ast_channel_clear_softhangup(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_noise(), ast_dsp_process(), ast_dsp_silence(), ast_frame_adjust_volume(), ast_frame_dump(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_generic_bridge(), ast_prod(), ast_queue_control(), ast_queue_control_data(), ast_read_generator_actions(), ast_recvtext(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_senddigit_end_with_duration(), ast_rtp_write(), ast_slinfactory_feed(), ast_smoother_read(), ast_trans_frameout(), ast_translate(), ast_udptl_write(), ast_waitfordigit_full(), ast_write(), ast_writestream(), async_wait(), audio_audiohook_write_list(), background_detect_exec(), bridge_handle_dtmf(), bridge_native_loop(), bridge_p2p_loop(), calc_rxstamp(), calc_timestamp(), cb_events(), channel_spy(), cli_console_dial(), conf_exec(), conf_run(), console_call(), console_dial(), console_sendtext(), create_dtmf_frame(), create_jb(), create_video_frame(), dahdi_decoder_framein(), dahdi_decoder_frameout(), dahdi_encoder_framein(), dahdi_encoder_frameout(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_read(), dahdi_write(), decode_frame(), dial_exec_full(), dictate_exec(), disa_exec(), do_immediate_setup(), echo_exec(), eivr_comm(), feature_request_and_dial(), function_ilink(), g723_read(), g723_write(), g726_read(), g726_write(), g729_read(), g729_write(), gsm_read(), gsm_write(), gtalk_handle_dtmf(), gtalk_rtp_read(), gtalk_write(), h261_encap(), h263_encap(), h263_read(), h263_write(), h263p_encap(), h264_encap(), h264_read(), h264_write(), handle_frame(), handle_frame_ownerless(), handle_keypad_button_message(), handle_link_data(), handle_recordfile(), handle_request(), handle_request_info(), handle_speechrecognize(), iax2_bridge(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), ilbc_read(), ilbc_write(), jack_exec(), jack_hook_callback(), jb_get_and_deliver(), jingle_handle_dtmf(), jingle_rtp_read(), jingle_write(), jpeg_read_image(), jpeg_write_image(), launch_asyncagi(), local_digit_begin(), local_digit_end(), local_indicate(), local_queue_frame(), local_sendhtml(), manage_parkinglot(), measurenoise(), mgcp_queue_control(), mgcp_rtp_read(), mgcp_write(), misdn_bridge(), misdn_read(), misdn_write(), mohalloc(), mpeg4_encap(), nbs_xwrite(), ogg_vorbis_read(), ogg_vorbis_write(), oh323_rtp_read(), oh323_write(), oss_call(), oss_read(), pcm_read(), pcm_write(), phone_exception(), phone_read(), phone_write(), playtones_generator(), process_ast_dsp(), process_rfc2833(), process_rfc3389(), queue_dtmf_readq(), receive_digit(), receive_dtmf_digits(), receive_message(), record_exec(), resend_with_token(), rpt(), rpt_call(), rpt_exec(), rtp_red_init(), schedule_delivery(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), send_waveform_to_channel(), sendurl_exec(), sip_rtp_read(), sip_write(), siren14read(), siren14write(), siren7read(), siren7write(), skinny_rtp_read(), skinny_write(), slinear_read(), slinear_write(), sms_generate(), socket_process(), socket_process_meta(), softmix_bridge_join(), softmix_bridge_write(), speech_background(), ss_thread(), tonepair_generator(), transmit_audio(), transmit_t38(), udptl_rx_packet(), unistim_rtp_read(), unistim_senddigit_end(), unistim_write(), usbradio_read(), volume_callback(), vox_read(), vox_write(), wait_for_answer(), wait_for_winner(), waitforring_exec(), waitstream_core(), wav_read(), and wav_write().

long ts

uint32_t uint32


The documentation for this struct was generated from the following file:

Generated on Thu Oct 11 06:50:21 2012 for Asterisk - the Open Source PBX by  doxygen 1.5.6