Codename Pineapple

Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:02:00 2007

Asterisk developer's documentation :: Codename Pineapple

ast_frame Struct Reference

#include <frame.h>

Detailed Description

Data structure associated with a single frame of data.

Definition at line 129 of file frame.h.

Public Member Functions

 AST_LIST_ENTRY (ast_frame) frame_list

Data Fields

void * data
int datalen
timeval delivery
enum ast_frame_type frametype
int has_timing_info
long len
int mallocd
size_t mallocd_hdr_len
int offset
int samples
int seqno
const char * src
int subclass
long ts

Member Function Documentation

AST_LIST_ENTRY (  ast_frame   ) 
 

For placing in a linked list

Field Documentation

void* data
 

Pointer to actual data

Definition at line 147 of file frame.h.

Referenced by __ast_read(), __ast_smoother_feed(), __get_from_jb(), __send_command(), __zt_exception(), alsa_read(), alsa_write(), ast_bridge_call(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_dsp_silence(), ast_frame_adjust_volume(), ast_frame_dump(), ast_frame_free(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_prod(), ast_queue_control_data(), ast_recvtext(), ast_rtp_raw_write(), ast_rtp_read(), ast_slinfactory_read(), ast_trans_frameout(), ast_udptl_write(), ast_waitfordigit_full(), ast_write(), cb_events(), console_sendtext(), copy_data_from_queue(), do_immediate_setup(), iax2_send(), iax2_sendimage(), iax2_trunk_queue(), iax_frame_wrap(), jb_get_and_deliver(), local_indicate(), local_sendhtml(), local_sendtext(), misdn_read(), misdn_write(), nbs_xread(), nbs_xwrite(), oss_read(), oss_write(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), rtpread(), run_agi(), socket_process(), socket_process_meta(), udptlread(), waitstream_core(), zt_handle_event(), zt_read(), and zt_write().

int datalen
 

Length of data

Definition at line 135 of file frame.h.

Referenced by __ast_smoother_feed(), __get_from_jb(), __send_command(), __zt_exception(), adsi_careful_send(), alsa_read(), alsa_write(), ast_bridge_call(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_dsp_silence(), ast_frdup(), ast_frisolate(), ast_queue_control_data(), ast_recvtext(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_trans_frameout(), ast_udptl_write(), ast_waitfordigit_full(), ast_write(), cb_events(), console_sendtext(), copy_data_from_queue(), do_immediate_setup(), framein(), iax2_send(), iax2_sendimage(), iax2_trunk_queue(), iax_frame_wrap(), iaxfrdup2(), jb_get_and_deliver(), local_indicate(), local_sendhtml(), local_sendtext(), misdn_read(), nbs_xread(), nbs_xwrite(), oss_read(), oss_write(), phone_exception(), phone_read(), phone_write(), process_rfc3389(), run_agi(), send_dtmf(), socket_process(), socket_process_meta(), waitstream_core(), zt_handle_event(), zt_read(), and zt_write().

struct timeval delivery
 

Global delivery time

Definition at line 149 of file frame.h.

Referenced by __ast_smoother_feed(), __get_from_jb(), __zt_exception(), alsa_read(), ast_frdup(), ast_rtp_raw_write(), ast_rtp_read(), ast_translate(), calc_timestamp(), cb_events(), do_immediate_setup(), iax_frame_wrap(), jb_get_and_deliver(), misdn_read(), nbs_xread(), phone_exception(), phone_read(), process_rfc3389(), schedule_delivery(), and zt_read().

enum ast_frame_type frametype
 

Kind of frame

Definition at line 131 of file frame.h.

Referenced by __adsi_transmit_messages(), __ast_read(), __ast_request_and_dial(), __ast_smoother_feed(), __attempt_transmit(), __get_from_jb(), __oh323_update_info(), __send_command(), __zt_exception(), adsi_careful_send(), agent_ack_sleep(), agent_read(), agent_write(), alsa_read(), ast_bridge_call(), ast_channel_spy_read_frame(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_dsp_silence(), ast_feature_request_and_dial(), ast_frame_adjust_volume(), ast_frame_dump(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_jb_put(), ast_queue_frame(), ast_recvtext(), ast_rtcp_read(), ast_rtp_read(), ast_rtp_write(), ast_trans_frameout(), ast_udptl_write(), ast_waitfordigit_full(), ast_write(), ast_writestream(), async_wait(), calc_timestamp(), cb_events(), console_sendtext(), decode_frame(), do_immediate_setup(), gtalk_digit(), gtalk_rtp_read(), gtalk_write(), handle_frame(), handle_frame_ownerless(), handle_keypad_button_message(), handle_recordfile(), handle_request(), iax2_send(), iax2_write(), iax_frame_wrap(), jb_get_and_deliver(), jingle_digit(), jingle_rtp_read(), jingle_write(), local_queue_frame(), local_write(), mgcp_rtp_read(), mgcp_write(), misdn_bridge(), misdn_read(), nbs_xwrite(), oh323_rtp_read(), oh323_simulate_dtmf_end(), oh323_write(), oss_call(), oss_read(), phone_exception(), phone_read(), phone_write(), process_ast_dsp(), process_rfc3389(), receive_digit(), run_agi(), schedule_delivery(), send_dtmf(), silence_generator_generate(), sip_rtp_read(), sip_write(), skinny_rtp_read(), skinny_write(), socket_process(), socket_process_meta(), ss_thread(), waitstream_core(), zt_bridge(), zt_handle_event(), zt_read(), and zt_write().

int has_timing_info
 

Timing data flag

Definition at line 153 of file frame.h.

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

long len
 

Length in milliseconds

Definition at line 157 of file frame.h.

Referenced by ast_frdup(), ast_frisolate(), ast_jb_put(), ast_rtp_read(), ast_translate(), ast_write(), create_jb(), framein(), handle_request_info(), jb_get_and_deliver(), jb_put_adaptive(), jb_put_first_fixed(), jb_put_fixed(), local_digit_end(), and process_rfc2833().

int mallocd
 

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

Definition at line 139 of file frame.h.

Referenced by __get_from_jb(), __send_command(), __zt_exception(), alsa_read(), ast_frame_free(), ast_frdup(), ast_frisolate(), ast_rtcp_read(), ast_rtp_read(), ast_trans_frameout(), cb_events(), do_immediate_setup(), iax_frame_wrap(), jb_get_and_deliver(), misdn_read(), nbs_xread(), phone_exception(), phone_read(), send_dtmf(), socket_process(), socket_process_meta(), zt_handle_event(), and zt_read().

size_t mallocd_hdr_len
 

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

Definition at line 141 of file frame.h.

Referenced by ast_frame_header_new(), and ast_frdup().

int offset
 

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

Definition at line 143 of file frame.h.

Referenced by __ast_smoother_feed(), __get_from_jb(), __send_command(), __zt_exception(), alsa_read(), ast_frame_free(), ast_frdup(), ast_frisolate(), ast_rtp_read(), ast_rtp_write(), ast_trans_frameout(), cb_events(), copy_data_from_queue(), do_immediate_setup(), iax_frame_wrap(), jb_get_and_deliver(), misdn_read(), nbs_xread(), phone_exception(), phone_read(), process_rfc3389(), socket_process(), socket_process_meta(), zt_handle_event(), and zt_read().

int samples
 

Number of 8khz samples in this frame

Definition at line 137 of file frame.h.

Referenced by __ast_smoother_feed(), __get_from_jb(), __send_command(), __zt_exception(), alsa_read(), ast_frame_adjust_volume(), 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_trans_frameout(), ast_translate(), ast_write(), calc_cost(), calc_timestamp(), cb_events(), copy_data_from_queue(), do_immediate_setup(), framein(), fsk_serial(), iax_frame_wrap(), jb_get_and_deliver(), misdn_read(), misdn_write(), moh_files_generator(), nbs_xread(), oss_read(), phone_exception(), phone_read(), process_cisco_dtmf(), process_rfc2833(), process_rfc3389(), queue_frame_to_spies(), send_dtmf(), socket_process(), socket_process_meta(), zt_handle_event(), and zt_read().

int seqno
 

Sequence number

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

Referenced by __get_from_jb(), __send_command(), __zt_exception(), alsa_read(), ast_dsp_process(), ast_frame_free(), ast_frdup(), ast_frisolate(), ast_jb_put(), ast_prod(), ast_rtcp_read(), ast_rtp_read(), ast_trans_frameout(), cb_events(), do_immediate_setup(), handle_keypad_button_message(), handle_request(), iax_frame_wrap(), jb_get_and_deliver(), misdn_read(), nbs_xread(), oss_read(), phone_exception(), phone_read(), send_dtmf(), socket_process(), socket_process_meta(), zt_handle_event(), and zt_read().

int subclass
 

Subclass, frame dependent

Definition at line 133 of file frame.h.

Referenced by __adsi_transmit_messages(), __ast_read(), __ast_request_and_dial(), __ast_smoother_feed(), __attempt_transmit(), __get_from_jb(), __oh323_update_info(), __send_command(), __zt_exception(), adsi_careful_send(), agent_ack_sleep(), agent_read(), agent_write(), alsa_call(), alsa_read(), ast_bridge_call(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_dsp_silence(), ast_feature_request_and_dial(), ast_frame_adjust_volume(), ast_frame_dump(), ast_frame_slinear_sum(), ast_frdup(), ast_frisolate(), ast_prod(), ast_queue_control(), ast_queue_control_data(), ast_queue_frame(), ast_recvtext(), ast_rtcp_read(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_write(), ast_slinfactory_feed(), ast_trans_frameout(), ast_waitfordigit_full(), ast_write(), ast_writestream(), async_wait(), cb_events(), console_dial(), console_sendtext(), create_jb(), decode_frame(), do_immediate_setup(), gtalk_handle_dtmf(), gtalk_rtp_read(), gtalk_write(), handle_frame(), handle_frame_ownerless(), handle_keypad_button_message(), handle_recordfile(), handle_request(), handle_request_info(), iax2_send(), iax2_sendimage(), iax_frame_wrap(), jb_get_and_deliver(), jingle_handle_dtmf(), jingle_rtp_read(), jingle_write(), local_digit_begin(), local_digit_end(), local_indicate(), local_queue_frame(), local_sendhtml(), mgcp_queue_control(), mgcp_rtp_read(), mgcp_write(), misdn_bridge(), misdn_read(), misdn_write(), nbs_xwrite(), oh323_rtp_read(), oh323_write(), oss_call(), oss_read(), phone_exception(), phone_read(), phone_write(), process_ast_dsp(), process_rfc3389(), queue_frame_to_spies(), receive_digit(), send_dtmf(), sip_rtp_read(), sip_write(), skinny_rtp_read(), skinny_write(), socket_process(), socket_process_meta(), ss_thread(), waitstream_core(), zt_handle_event(), zt_read(), and zt_write().

long ts
 

Timestamp in milliseconds

Definition at line 155 of file frame.h.

Referenced by ast_frdup(), ast_frisolate(), ast_jb_put(), ast_rtp_raw_write(), ast_rtp_read(), ast_translate(), create_jb(), framein(), jb_get_and_deliver(), jb_put_adaptive(), jb_put_first_fixed(), and jb_put_fixed().

The documentation for this struct was generated from the following file:
Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen