Sat Aug 6 00:40:08 2011

Asterisk developer's documentation


ast_frame Struct Reference

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

#include <frame.h>


Data Fields

void * 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 135 of file frame.h.


Field Documentation

void* data

Pointer to actual data

Definition at line 153 of file frame.h.

Referenced by __ast_read(), __dahdi_exception(), __frame_free(), adjust_frame_for_plc(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_prod(), ast_rtp_read(), ast_slinfactory_read(), ast_write(), bridge_native_loop(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), function_ilink(), handle_link_data(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), jpeg_write_image(), misdn_read(), misdn_write(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), rpt(), send_link_dtmf(), send_tone_burst(), spy_generate(), and waitstream_core().

int datalen

Length of data

Definition at line 141 of file frame.h.

Referenced by __dahdi_exception(), adjust_frame_for_plc(), adsi_careful_send(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_read(), ast_rtp_write(), ast_write(), bridge_native_loop(), create_dtmf_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), function_ilink(), gsm_write(), handle_link_data(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), iaxfrdup2(), jpeg_write_image(), milliwatt_generate(), misdn_read(), nbs_xread(), nbs_xwrite(), ogg_vorbis_read(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), rpt(), send_link_dtmf(), send_tone_burst(), spy_generate(), and waitstream_core().

struct timeval delivery

Global delivery time

Definition at line 155 of file frame.h.

Referenced by __dahdi_exception(), __get_from_jb(), ast_frdup(), ast_rtp_read(), ast_translate(), 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 159 of file frame.h.

Referenced by __ast_read(), conf_run(), dump_hint(), and recordthread().

struct { ... } frame_list

For placing in a linked list

enum ast_frame_type frametype

Kind of frame

Definition at line 137 of file frame.h.

Referenced by __ast_queue_frame(), __attempt_transmit(), __dahdi_exception(), __get_from_jb(), adsi_careful_send(), ast_audiohook_write_list(), ast_channel_clear_softhangup(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_is_deferrable_frame(), 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(), conf_run(), create_dtmf_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), function_ilink(), gtalk_digit(), gtalk_write(), handle_frame(), handle_frame_ownerless(), handle_link_data(), iax2_send(), iax_frame_wrap(), 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(), schedule_delivery(), send_link_dtmf(), send_tone_burst(), silence_generator_generate(), sip_read(), sip_write(), skinny_write(), socket_process(), unwrap_timestamp(), and waitstream_core().

long len

Length in milliseconds

Definition at line 163 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 145 of file frame.h.

Referenced by __dahdi_exception(), __frame_free(), 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(), handle_link_data(), iax_frame_wrap(), misdn_read(), nbs_xread(), ogg_vorbis_read(), phone_exception(), phone_read(), send_link_dtmf(), and send_tone_burst().

size_t mallocd_hdr_len

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

Definition at line 147 of file frame.h.

Referenced by ast_frdup().

struct ast_frame* next

Definition at line 157 of file frame.h.

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

int offset

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

Definition at line 149 of file frame.h.

Referenced by __dahdi_exception(), __frame_free(), __get_from_jb(), adjust_frame_for_plc(), ast_frdup(), ast_frisolate(), ast_rtp_read(), ast_rtp_write(), 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(), phone_exception(), phone_read(), process_rfc3389(), send_link_dtmf(), and send_tone_burst().

int samples

Number of samples in this frame

Definition at line 143 of file frame.h.

Referenced by __dahdi_exception(), __get_from_jb(), adjust_frame_for_plc(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_read(), ast_slinfactory_feed(), ast_slinfactory_read(), ast_translate(), ast_write(), audio_audiohook_write_list(), create_dtmf_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_event(), dahdi_read(), dictate_exec(), do_immediate_setup(), function_ilink(), g722tolin_sample(), g726tolin_sample(), handle_link_data(), iax_frame_wrap(), 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_link_dtmf(), send_tone_burst(), and wav_read().

int seqno

Sequence number

Definition at line 165 of file frame.h.

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

const char* src

Optional source of frame for debugging

Definition at line 151 of file frame.h.

Referenced by __dahdi_exception(), __frame_free(), __get_from_jb(), ast_dsp_process(), 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(), iax_frame_wrap(), misdn_read(), misdn_write(), nbs_xread(), pcm_seek(), phone_exception(), and phone_read().

int subclass

Subclass, frame dependent

Definition at line 139 of file frame.h.

Referenced by __ast_queue_frame(), __attempt_transmit(), __dahdi_exception(), __get_from_jb(), adsi_careful_send(), ast_channel_clear_softhangup(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_prod(), ast_rtcp_read(), ast_rtp_read(), ast_rtp_senddigit_end_with_duration(), ast_rtp_write(), ast_translate(), ast_write(), audio_audiohook_write_list(), background_detect_exec(), bridge_native_loop(), calc_rxstamp(), create_dtmf_frame(), create_jb(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_read(), dahdi_write(), do_immediate_setup(), function_ilink(), gtalk_write(), handle_frame(), handle_frame_ownerless(), handle_link_data(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), 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(), schedule_delivery(), send_link_dtmf(), send_tone_burst(), sip_write(), skinny_write(), and waitstream_core().

long ts

Timestamp in milliseconds

Definition at line 161 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_adaptive(), jb_put_first_fixed(), and jb_put_fixed().


The documentation for this struct was generated from the following file:
Generated on Sat Aug 6 00:40:08 2011 for Asterisk - the Open Source PBX by  doxygen 1.4.7