Fri Jun 19 12:10:59 2009

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


Detailed Description

Data structure associated with a single frame of data.

Definition at line 145 of file frame.h.


Field Documentation

union { ... } data

Pointer to actual data

Referenced by __dahdi_exception(), action_originate(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_free(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_prod(), ast_rtp_read(), ast_slinfactory_read(), ast_write(), bridge_native_loop(), cb_events(), create_video_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), function_ilink(), h263p_encap(), h264_encap(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), jpeg_write_image(), milliwatt_generate(), misdn_read(), misdn_write(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), red_t140_to_red(), rpt(), rtp_red_init(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), speex_callback(), transmit_audio(), transmit_t38(), usbradio_read(), and waitstream_core().

int datalen

Length of data

Definition at line 151 of file frame.h.

Referenced by __dahdi_exception(), adsi_careful_send(), ast_dsp_call_progress(), ast_dsp_process(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_read(), ast_rtp_write(), ast_write(), bridge_native_loop(), cb_events(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), dump_hint(), function_ilink(), gsm_write(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), iaxfrdup2(), jpeg_write_image(), milliwatt_generate(), misdn_read(), mpeg4_decode(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), red_buffer_t140(), red_t140_to_red(), rpt(), rtp_red_init(), send_dtmf(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), transmit_audio(), transmit_t38(), usbradio_read(), and waitstream_core().

struct timeval delivery

Global delivery time

Definition at line 165 of file frame.h.

Referenced by __dahdi_exception(), __get_from_jb(), ast_frdup(), ast_rtp_read(), ast_translate(), cb_events(), dahdi_read(), do_immediate_setup(), iax_frame_wrap(), misdn_read(), nbs_xread(), phone_exception(), phone_read(), process_rfc3389(), and schedule_delivery().

unsigned int flags

Misc. frame flags

Definition at line 169 of file frame.h.

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

struct { ... } frame_list

For placing in a linked list

Referenced by __ast_answer(), __ast_queue_frame(), __ast_read(), ast_autoservice_stop(), ast_slinfactory_destroy(), ast_slinfactory_feed(), ast_slinfactory_flush(), ast_slinfactory_read(), autoservice_run(), create_video_frame(), frame_cache_cleanup(), and rpt().

enum ast_frame_type frametype

Kind of frame

Definition at line 147 of file frame.h.

Referenced by __ast_answer(), __ast_queue_frame(), __ast_read(), __dahdi_exception(), __get_from_jb(), adsi_careful_send(), ast_audiohook_write_list(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_read(), ast_rtp_write(), ast_translate(), ast_write(), audiohook_read_frame_both(), audiohook_read_frame_single(), autoservice_run(), background_detect_exec(), bridge_native_loop(), cb_events(), conf_run(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_dtmfup(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), fax_generator_generate(), function_ilink(), gtalk_digit(), gtalk_write(), handle_frame(), handle_frame_ownerless(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax_frame_wrap(), jack_hook_callback(), jingle_digit(), jingle_write(), jpeg_write_image(), lintospeex_frameout(), mgcp_write(), milliwatt_generate(), misdn_read(), nbs_xwrite(), ogg_vorbis_read(), oh323_write(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), queue_dtmf_readq(), rtp_red_init(), schedule_delivery(), send_dtmf(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), silence_generator_generate(), sip_read(), sip_write(), skinny_write(), socket_process(), speex_callback(), t38_tx_packet_handler(), transmit_audio(), transmit_t38(), unistim_write(), unwrap_timestamp(), usbradio_read(), volume_callback(), and waitstream_core().

long len

Length in milliseconds

Definition at line 173 of file frame.h.

Referenced by ast_frdup(), ast_frisolate(), ast_jb_put(), ast_rtp_read(), ast_translate(), ast_write(), create_jb(), framein(), iax_frame_wrap(), jb_put_adaptive(), jb_put_first_fixed(), jb_put_fixed(), 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 155 of file frame.h.

Referenced by __dahdi_exception(), ast_frame_free(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_read(), cb_events(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), do_immediate_setup(), function_ilink(), handle_link_data(), iax_frame_wrap(), misdn_read(), nbs_xread(), ogg_vorbis_read(), phone_exception(), phone_read(), send_dtmf(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), and send_usb_txt().

size_t mallocd_hdr_len

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

Definition at line 157 of file frame.h.

Referenced by ast_frdup().

struct ast_frame* next

Definition at line 167 of file frame.h.

Referenced by jb_get_and_deliver().

int offset

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

Definition at line 159 of file frame.h.

Referenced by __dahdi_exception(), __get_from_jb(), ast_frame_free(), ast_frdup(), ast_frisolate(), ast_rtp_read(), ast_rtp_write(), ast_slinfactory_read(), cb_events(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), do_immediate_setup(), function_ilink(), g729_seek(), g729_tell(), gsm_seek(), gsm_tell(), handle_link_data(), iax_frame_wrap(), ilbc_seek(), ilbc_tell(), misdn_read(), mp3_exec(), nbs_xread(), NBScat_exec(), pcm_seek(), phone_exception(), phone_read(), process_rfc3389(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), send_waveform_to_channel(), slinear_seek(), vox_seek(), and vox_tell().

char pad[8]

Definition at line 163 of file frame.h.

void* ptr

Definition at line 163 of file frame.h.

Referenced by __dahdi_exception(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_free(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_prod(), ast_rtp_read(), ast_slinfactory_read(), ast_write(), bridge_native_loop(), cb_events(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), function_ilink(), handle_jack_audio(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), jpeg_write_image(), milliwatt_generate(), misdn_read(), misdn_write(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), red_t140_to_red(), rpt(), rtp_red_init(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), speex_callback(), tone_detect(), transmit_audio(), transmit_t38(), usbradio_read(), and waitstream_core().

int samples

Number of 8khz samples in this frame

Definition at line 153 of file frame.h.

Referenced by __dahdi_exception(), __get_from_jb(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_read(), ast_slinfactory_read(), ast_translate(), audio_audiohook_write_list(), cb_events(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dictate_exec(), do_immediate_setup(), fax_generator_generate(), fsk_serial(), function_ilink(), g722tolin16_sample(), g722tolin_sample(), g726tolin_sample(), handle_jack_audio(), handle_link_data(), iax_frame_wrap(), lin16tog722_sample(), lintoadpcm_frameout(), lintog722_sample(), lintog726_sample(), lintospeex_frameout(), milliwatt_generate(), misdn_read(), misdn_write(), nbs_xread(), ogg_vorbis_read(), phone_exception(), phone_read(), process_rfc2833(), process_rfc3389(), send_dtmf(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), slin16_to_slin8_sample(), slin8_to_slin16_sample(), speex_callback(), stream_monitor(), transmit_audio(), and wav_read().

int seqno

Sequence number

Definition at line 175 of file frame.h.

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

const char* src

Optional source of frame for debugging

Definition at line 161 of file frame.h.

Referenced by __dahdi_exception(), __get_from_jb(), ast_dsp_process(), ast_frame_free(), ast_frdup(), ast_frisolate(), ast_prod(), ast_rtcp_read(), cb_events(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), do_immediate_setup(), get_input(), iax_frame_wrap(), misdn_read(), misdn_write(), nbs_xread(), pcm_seek(), phone_exception(), phone_read(), and send_dtmf().

int subclass

Subclass, frame dependent

Definition at line 149 of file frame.h.

Referenced by __ast_answer(), __ast_queue_frame(), __dahdi_exception(), __get_from_jb(), adsi_careful_send(), ast_dsp_call_progress(), ast_dsp_process(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_prod(), ast_rtcp_read(), ast_rtp_read(), ast_rtp_write(), ast_translate(), ast_write(), audio_audiohook_write_list(), autoservice_run(), background_detect_exec(), bridge_native_loop(), cb_events(), create_jb(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_dtmfup(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), function_ilink(), gtalk_write(), h261_encap(), h263_encap(), h263p_encap(), handle_frame(), handle_frame_ownerless(), handle_link_data(), handle_speechrecognize(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), jack_hook_callback(), jingle_write(), jpeg_write_image(), mgcp_write(), misdn_read(), misdn_write(), nbs_xwrite(), ogg_vorbis_read(), oh323_write(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), queue_dtmf_readq(), rpt_call(), rtp_red_init(), send_dtmf(), send_link_dtmf(), send_link_keyquery(), send_tone_burst(), send_usb_txt(), sip_write(), skinny_write(), transmit_audio(), transmit_t38(), unistim_write(), usbradio_read(), volume_callback(), and waitstream_core().

long ts

Timestamp in milliseconds

Definition at line 171 of file frame.h.

Referenced by ast_frdup(), ast_frisolate(), ast_jb_put(), ast_rtp_read(), ast_translate(), create_jb(), framein(), h263_read(), h264_read(), jb_put_adaptive(), jb_put_first_fixed(), jb_put_fixed(), red_buffer_t140(), and rtp_red_init().

uint32_t uint32

Definition at line 163 of file frame.h.

Referenced by ast_frdup().


The documentation for this struct was generated from the following file:
Generated on Fri Jun 19 12:10:59 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7