Wed Apr 6 11:30:12 2011

Asterisk developer's documentation


ast_frame Struct Reference

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
timeval delivery
unsigned int flags
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
ast_frame_subclass 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 __analog_handle_event(), __dahdi_exception(), __frame_free(), action_originate(), adjust_frame_for_plc(), analog_exception(), ast_cc_build_frame(), ast_channel_connected_line_macro(), ast_channel_redirecting_macro(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_clear(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_indicate_data(), ast_prod(), ast_rtp_raw_write(), ast_rtp_read(), ast_slinfactory_read(), ast_smoother_read(), ast_write(), create_video_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), disable_t38(), do_immediate_setup(), free_signaling_queue_entry(), function_ilink(), g719read(), g723_read(), g726_read(), g729_read(), generic_fax_exec(), gsm_read(), gsm_sample(), h263_read(), h263p_encap(), h264_encap(), h264_read(), handle_frame(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), ilbc_read(), ilbc_sample(), jpeg_write_image(), lpc10_sample(), milliwatt_generate(), misdn_read(), misdn_write(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), pcm_read(), phone_exception(), phone_read(), phone_write(), process_cn_rfc3389(), receivefax_t38_init(), red_t140_to_red(), remote_bridge_loop(), rpt(), rtp_red_buffer(), rtp_red_init(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sendfax_t38_init(), siren14read(), siren7read(), slinear_read(), speex16_sample(), speex_callback(), speex_sample(), spy_generate(), transmit_audio(), transmit_t38(), udptl_rx_packet(), usbradio_read(), vox_read(), waitstream_core(), and wav_read().

int datalen

Length of data

Definition at line 148 of file frame.h.

Referenced by __analog_handle_event(), __dahdi_exception(), adjust_frame_for_plc(), adsi_careful_send(), analog_exception(), ast_audiohook_write_frame(), ast_cc_build_frame(), ast_channel_connected_line_macro(), ast_channel_redirecting_macro(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_clear(), ast_frdup(), ast_frisolate(), ast_indicate_data(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_smoother_read(), ast_write(), create_dtmf_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), disable_t38(), do_immediate_setup(), dump_hint(), function_ilink(), g719read(), g723_read(), g726_read(), g729_read(), generic_fax_exec(), gsm_write(), h263_read(), h264_read(), handle_frame(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), iaxfrdup2(), ilbc_read(), jpeg_write_image(), milliwatt_generate(), misdn_read(), mpeg4_decode(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), pcm_read(), phone_exception(), phone_read(), phone_write(), print_frame(), process_cn_rfc3389(), receivefax_t38_init(), red_t140_to_red(), remote_bridge_loop(), rpt(), rtp_red_buffer(), rtp_red_init(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sendfax_t38_init(), siren14read(), siren7read(), slinear_read(), spy_generate(), transmit_audio(), transmit_t38(), udptl_rx_packet(), usbradio_read(), vox_read(), waitstream_core(), and wav_read().

struct timeval delivery

Global delivery time

Definition at line 162 of file frame.h.

Referenced by __dahdi_exception(), __get_from_jb(), analog_exception(), ast_frdup(), ast_rtp_raw_write(), ast_smoother_read(), ast_translate(), dahdi_read(), do_immediate_setup(), h263_read(), h264_read(), iax_frame_wrap(), misdn_read(), nbs_xread(), phone_exception(), phone_read(), process_cn_rfc3389(), and schedule_delivery().

unsigned int flags

Misc. frame flags

Definition at line 166 of file frame.h.

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

struct { ... } frame_list

For placing in a linked list

enum ast_frame_type frametype

Kind of frame

Definition at line 144 of file frame.h.

Referenced by __analog_handle_event(), __ast_answer(), __ast_queue_frame(), __dahdi_exception(), __get_from_jb(), adsi_careful_send(), analog_exception(), analog_handle_dtmf(), ast_audiohook_write_list(), ast_bridge_handle_trip(), ast_cc_build_frame(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_indicate_data(), ast_is_deferrable_frame(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_smoother_read(), ast_translate(), ast_write(), audiohook_read_frame_both(), audiohook_read_frame_single(), autoservice_run(), background_detect_exec(), conf_run(), create_dtmf_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_read(), dahdi_write(), dial_exec_full(), disable_t38(), do_immediate_setup(), fax_generator_generate(), function_ilink(), g719read(), g723_read(), g726_read(), g729_read(), generic_fax_exec(), gsm_read(), gtalk_write(), h263_read(), h264_read(), handle_frame(), handle_frame_ownerless(), handle_link_data(), handle_speechrecognize(), hook_event_cb(), iax2_send(), iax_frame_wrap(), ilbc_read(), jack_hook_callback(), jingle_digit(), jingle_write(), jpeg_write_image(), lintospeex_frameout(), mgcp_write(), milliwatt_generate(), misdn_read(), multicast_rtp_write(), mute_callback(), my_handle_dtmf(), nbs_xwrite(), ogg_vorbis_read(), oh323_write(), pcm_read(), phone_exception(), phone_read(), phone_write(), print_frame(), process_cn_rfc3389(), queue_dtmf_readq(), receivefax_t38_init(), remote_bridge_loop(), rtp_red_init(), schedule_delivery(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sendfax_t38_init(), silence_generator_generate(), sip_read(), sip_write(), siren14read(), siren7read(), skinny_write(), slinear_read(), socket_process(), softmix_bridge_write(), spandsp_fax_read(), speex_callback(), t38_tx_packet_handler(), transmit_audio(), transmit_t38(), udptl_rx_packet(), unistim_write(), unwrap_timestamp(), usbradio_read(), volume_callback(), vox_read(), waitstream_core(), and wav_read().

long len

Length in milliseconds

Definition at line 170 of file frame.h.

Referenced by ast_frdup(), ast_frisolate(), ast_jb_put(), ast_translate(), ast_write(), create_jb(), framein(), iax_frame_wrap(), jb_put_adaptive(), jb_put_first_fixed(), jb_put_fixed(), print_frame(), and queue_dtmf_readq().

int mallocd

Was the data malloc'd? i.e. should we free it when we discard the frame?

Definition at line 152 of file frame.h.

Referenced by __analog_handle_event(), __dahdi_exception(), __frame_free(), analog_exception(), ast_cc_build_frame(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_read(), create_dtmf_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), do_immediate_setup(), function_ilink(), g719read(), g723_read(), g726_read(), g729_read(), gsm_read(), gsm_sample(), h263_read(), h264_read(), handle_link_data(), iax_frame_wrap(), ilbc_read(), ilbc_sample(), lpc10_sample(), misdn_read(), nbs_xread(), ogg_vorbis_read(), pcm_read(), phone_exception(), phone_read(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), siren14read(), siren7read(), slinear_read(), speex16_sample(), speex_callback(), speex_sample(), udptl_rx_packet(), vox_read(), and wav_read().

size_t mallocd_hdr_len

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

Definition at line 154 of file frame.h.

Referenced by ast_frdup().

struct ast_frame* next

Definition at line 164 of file frame.h.

Referenced by ast_frame_clear(), ast_frame_free(), and jb_get_and_deliver().

int offset

How many bytes exist _before_ "data" that can be used if needed

Definition at line 156 of file frame.h.

Referenced by __analog_handle_event(), __dahdi_exception(), __frame_free(), __get_from_jb(), adjust_frame_for_plc(), analog_exception(), ast_frdup(), ast_frisolate(), ast_rtp_read(), ast_rtp_write(), ast_slinfactory_read(), ast_smoother_read(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), do_immediate_setup(), function_ilink(), g719seek(), g729_seek(), g729_tell(), gsm_sample(), gsm_seek(), gsm_tell(), handle_link_data(), iax_frame_wrap(), ilbc_sample(), ilbc_seek(), ilbc_tell(), lpc10_sample(), misdn_read(), mp3_exec(), multicast_rtp_write(), nbs_xread(), NBScat_exec(), pcm_seek(), phone_exception(), phone_read(), process_cn_rfc3389(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), send_waveform_to_channel(), siren14seek(), siren7seek(), slinear_seek(), speex16_sample(), speex_sample(), udptl_rx_packet(), vox_seek(), vox_tell(), and wav_read().

char pad[8]

Definition at line 160 of file frame.h.

void* ptr

Definition at line 160 of file frame.h.

Referenced by __analog_handle_event(), __dahdi_exception(), __frame_free(), adjust_frame_for_plc(), analog_exception(), ast_cc_build_frame(), ast_channel_connected_line_macro(), ast_channel_redirecting_macro(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_clear(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_indicate_data(), ast_prod(), ast_rtp_raw_write(), ast_rtp_read(), ast_slinfactory_read(), ast_smoother_read(), ast_write(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), disable_t38(), do_immediate_setup(), free_signaling_queue_entry(), function_ilink(), g719read(), g723_read(), g726_read(), g729_read(), generic_fax_exec(), gsm_read(), h263_read(), h264_read(), handle_frame(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), ilbc_read(), jpeg_write_image(), milliwatt_generate(), misdn_read(), misdn_write(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), pcm_read(), phone_exception(), phone_read(), phone_write(), process_cn_rfc3389(), receivefax_t38_init(), red_t140_to_red(), remote_bridge_loop(), rpt(), rtp_red_buffer(), rtp_red_init(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sendfax_t38_init(), siren14read(), siren7read(), slinear_read(), speex_callback(), spy_generate(), tone_detect(), transmit_audio(), transmit_t38(), udptl_rx_packet(), usbradio_read(), vox_read(), waitstream_core(), and wav_read().

int samples

Number of samples in this frame

Definition at line 150 of file frame.h.

Referenced by __analog_handle_event(), __dahdi_exception(), __get_from_jb(), adjust_frame_for_plc(), adpcm_sample(), alaw_sample(), analog_exception(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_slinfactory_feed(), ast_slinfactory_read(), ast_smoother_read(), ast_translate(), ast_write(), audio_audiohook_write_list(), create_dtmf_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), debug_check_frame_for_silence(), dictate_exec(), do_immediate_setup(), fax_generator_generate(), fsk_serial(), function_ilink(), g719read(), g722_sample(), g723_read(), g726_read(), g726_sample(), g729_read(), gsm_read(), gsm_sample(), h263_read(), h264_read(), handle_jack_audio(), handle_link_data(), iax_frame_wrap(), ilbc_read(), ilbc_sample(), lintoadpcm_frameout(), lintospeex_frameout(), lpc10_sample(), milliwatt_generate(), misdn_read(), misdn_write(), nbs_xread(), ogg_vorbis_read(), pcm_read(), phone_exception(), phone_read(), print_frame(), process_cn_rfc3389(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), siren14read(), siren7read(), slin16_sample(), slin8_sample(), slinear_read(), speex16_sample(), speex_callback(), speex_sample(), stream_monitor(), transmit_audio(), ulaw_sample(), vox_read(), and wav_read().

int seqno

Sequence number

Definition at line 172 of file frame.h.

Referenced by ast_frdup(), ast_frisolate(), ast_rtp_read(), ast_translate(), framein(), transmit_t38(), and udptl_rx_packet().

const char* src

Optional source of frame for debugging

Definition at line 158 of file frame.h.

Referenced by __analog_handle_event(), __dahdi_exception(), __frame_free(), __get_from_jb(), analog_exception(), ast_frdup(), ast_frisolate(), ast_prod(), ast_rtcp_read(), ast_rtp_read(), ast_write(), create_dtmf_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), do_immediate_setup(), get_filestream(), get_input(), gsm_sample(), iax_frame_wrap(), ilbc_sample(), lpc10_sample(), misdn_read(), misdn_write(), nbs_xread(), pcm_seek(), phone_exception(), phone_read(), print_frame(), speex16_sample(), speex_callback(), speex_sample(), and udptl_rx_packet().

union ast_frame_subclass subclass

Subclass, frame dependent

Definition at line 146 of file frame.h.

Referenced by __analog_handle_event(), __ast_answer(), __ast_queue_frame(), __dahdi_exception(), __get_from_jb(), action_atxfer(), adsi_careful_send(), analog_exception(), analog_handle_dtmf(), ast_bridge_handle_trip(), ast_cc_build_frame(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_indicate_data(), ast_prod(), ast_rtcp_read(), ast_rtp_dtmf_end_with_duration(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_smoother_read(), ast_translate(), ast_write(), audio_audiohook_write_list(), background_detect_exec(), bridge_handle_dtmf(), calc_rxstamp(), create_dtmf_frame(), create_jb(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_read(), dahdi_write(), dial_exec_full(), disable_t38(), do_immediate_setup(), function_ilink(), g719read(), g723_read(), g726_read(), g729_read(), generic_fax_exec(), gsm_read(), gtalk_write(), h261_encap(), h263_encap(), h263_read(), h263p_encap(), h264_read(), handle_frame(), handle_frame_ownerless(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), ilbc_read(), jack_hook_callback(), jingle_write(), jpeg_write_image(), mgcp_write(), misdn_read(), misdn_write(), multicast_rtp_write(), my_handle_dtmf(), nbs_xwrite(), ogg_vorbis_read(), oh323_write(), pcm_read(), phone_exception(), phone_read(), phone_write(), print_frame(), process_cn_rfc3389(), queue_dtmf_readq(), receivefax_t38_init(), remote_bridge_loop(), rpt_call(), rtp_red_init(), schedule_delivery(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sendfax_t38_init(), sip_write(), siren14read(), siren7read(), skinny_write(), slinear_read(), softmix_bridge_write(), transmit_audio(), transmit_t38(), udptl_rx_packet(), unistim_write(), usbradio_read(), volume_callback(), vox_read(), waitstream_core(), and wav_read().

long ts

Timestamp in milliseconds

Definition at line 168 of file frame.h.

Referenced by ast_frdup(), ast_frisolate(), ast_jb_put(), ast_rtp_raw_write(), ast_translate(), create_jb(), framein(), h263_read(), h264_read(), jb_put_adaptive(), jb_put_first_adaptive(), jb_put_first_fixed(), jb_put_fixed(), rtp_red_buffer(), and rtp_red_init().

uint32_t uint32

Definition at line 160 of file frame.h.

Referenced by ast_frdup(), and ast_frisolate().


The documentation for this struct was generated from the following file:
Generated on Wed Apr 6 11:30:12 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7