Sat Nov 1 06:29:05 2008

Asterisk developer's documentation

frame.h File Reference

Asterisk internal frame definitions. More...

#include <sys/types.h>
#include <sys/time.h>
#include "asterisk/compiler.h"
#include "asterisk/endian.h"
#include "asterisk/linkedlists.h"

Include dependency graph for frame.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct ast_codec_pref

struct ast_format_list

Definition of supported media formats (codecs). More...

struct ast_frame

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

struct ast_option_header

struct oprmode

Defines

#define AST_FORMAT_ADPCM   (1 << 5)

#define AST_FORMAT_ALAW   (1 << 3)

#define AST_FORMAT_AUDIO_MASK   ((1 << 16)-1)

#define AST_FORMAT_G722   (1 << 12)

#define AST_FORMAT_G723_1   (1 << 0)

#define AST_FORMAT_G726   (1 << 11)

#define AST_FORMAT_G726_AAL2   (1 << 4)

#define AST_FORMAT_G729A   (1 << 8)

#define AST_FORMAT_GSM   (1 << 1)

#define AST_FORMAT_H261   (1 << 18)

#define AST_FORMAT_H263   (1 << 19)

#define AST_FORMAT_H263_PLUS   (1 << 20)

#define AST_FORMAT_H264   (1 << 21)

#define AST_FORMAT_ILBC   (1 << 10)

#define AST_FORMAT_JPEG   (1 << 16)

#define AST_FORMAT_LPC10   (1 << 7)

#define AST_FORMAT_MAX_AUDIO   (1 << 15)

#define AST_FORMAT_MAX_VIDEO   (1 << 24)

#define AST_FORMAT_PNG   (1 << 17)

#define AST_FORMAT_SLINEAR   (1 << 6)

#define AST_FORMAT_SPEEX   (1 << 9)

#define AST_FORMAT_ULAW   (1 << 2)

#define AST_FORMAT_VIDEO_MASK   (((1 << 25)-1) & ~(AST_FORMAT_AUDIO_MASK))

#define ast_frame_byteswap_be(fr)   do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data, __f->data, __f->samples); } while(0)

#define ast_frame_byteswap_le(fr)   do { ; } while(0)

#define AST_FRAME_DTMF   AST_FRAME_DTMF_END

#define AST_FRAME_SET_BUFFER(fr, _base, _ofs, _datalen)

#define ast_frfree(fr)   ast_frame_free(fr, 1)

#define AST_FRIENDLY_OFFSET   64

#define AST_HTML_BEGIN   4

#define AST_HTML_DATA   2

#define AST_HTML_END   8

#define AST_HTML_LDCOMPLETE   16

#define AST_HTML_LINKREJECT   20

#define AST_HTML_LINKURL   18

#define AST_HTML_NOSUPPORT   17

#define AST_HTML_UNLINK   19

#define AST_HTML_URL   1

#define AST_MALLOCD_DATA   (1 << 1)

#define AST_MALLOCD_HDR   (1 << 0)

#define AST_MALLOCD_SRC   (1 << 2)

#define AST_MIN_OFFSET   32

#define AST_MODEM_T38   1

#define AST_MODEM_V150   2

#define AST_OPTION_AUDIO_MODE   4

#define AST_OPTION_ECHOCAN   8

#define AST_OPTION_FLAG_ACCEPT   1

#define AST_OPTION_FLAG_ANSWER   5

#define AST_OPTION_FLAG_QUERY   4

#define AST_OPTION_FLAG_REJECT   2

#define AST_OPTION_FLAG_REQUEST   0

#define AST_OPTION_FLAG_WTF   6

#define AST_OPTION_OPRMODE   7

#define AST_OPTION_RELAXDTMF   3

#define AST_OPTION_RXGAIN   6

#define AST_OPTION_TDD   2

#define AST_OPTION_TONE_VERIFY   1

#define AST_OPTION_TXGAIN   5

#define ast_smoother_feed(s, f)   __ast_smoother_feed(s, f, 0)

#define ast_smoother_feed_be(s, f)   __ast_smoother_feed(s, f, 1)

#define ast_smoother_feed_le(s, f)   __ast_smoother_feed(s, f, 0)

#define AST_SMOOTHER_FLAG_BE   (1 << 1)

#define AST_SMOOTHER_FLAG_G729   (1 << 0)

Enumerations

enum { AST_FRFLAG_HAS_TIMING_INFO = (1 << 0), AST_FRFLAG_FROM_TRANSLATOR = (1 << 1), AST_FRFLAG_FROM_DSP = (1 << 2) }

enum ast_control_frame_type {
  AST_CONTROL_HANGUP = 1, AST_CONTROL_RING = 2, AST_CONTROL_RINGING = 3, AST_CONTROL_ANSWER = 4,
  AST_CONTROL_BUSY = 5, AST_CONTROL_TAKEOFFHOOK = 6, AST_CONTROL_OFFHOOK = 7, AST_CONTROL_CONGESTION = 8,
  AST_CONTROL_FLASH = 9, AST_CONTROL_WINK = 10, AST_CONTROL_OPTION = 11, AST_CONTROL_RADIO_KEY = 12,
  AST_CONTROL_RADIO_UNKEY = 13, AST_CONTROL_PROGRESS = 14, AST_CONTROL_PROCEEDING = 15, AST_CONTROL_HOLD = 16,
  AST_CONTROL_UNHOLD = 17, AST_CONTROL_VIDUPDATE = 18, AST_CONTROL_SRCUPDATE = 20
}

enum ast_frame_type {
  AST_FRAME_DTMF_END = 1, AST_FRAME_VOICE, AST_FRAME_VIDEO, AST_FRAME_CONTROL,
  AST_FRAME_NULL, AST_FRAME_IAX, AST_FRAME_TEXT, AST_FRAME_IMAGE,
  AST_FRAME_HTML, AST_FRAME_CNG, AST_FRAME_MODEM, AST_FRAME_DTMF_BEGIN
}

Frame types. More...

Functions

int __ast_smoother_feed (struct ast_smoother *s, struct ast_frame *f, int swap)

char * ast_codec2str (int codec)

Get a name from a format Gets a name from a format.

int ast_codec_choose (struct ast_codec_pref *pref, int formats, int find_best)

Select the best audio format according to preference list from supplied options. If "find_best" is non-zero then if nothing is found, the "Best" format of the format list is selected, otherwise 0 is returned.

int ast_codec_get_len (int format, int samples)

Returns the number of bytes for the number of samples of the given format.

int ast_codec_get_samples (struct ast_frame *f)

Returns the number of samples contained in the frame.

static int ast_codec_interp_len (int format)

Gets duration in ms of interpolation frame for a format.

int ast_codec_pref_append (struct ast_codec_pref *pref, int format)

Append a audio codec to a preference list, removing it first if it was already there.

void ast_codec_pref_convert (struct ast_codec_pref *pref, char *buf, size_t size, int right)

Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string.

ast_format_list ast_codec_pref_getsize (struct ast_codec_pref *pref, int format)

Get packet size for codec.

int ast_codec_pref_index (struct ast_codec_pref *pref, int index)

Codec located at a particular place in the preference index See Audio Codec Preferences.

void ast_codec_pref_init (struct ast_codec_pref *pref)

Initialize an audio codec preference to "no preference" See Audio Codec Preferences.

void ast_codec_pref_prepend (struct ast_codec_pref *pref, int format, int only_if_existing)

Prepend an audio codec to a preference list, removing it first if it was already there.

void ast_codec_pref_remove (struct ast_codec_pref *pref, int format)

Remove audio a codec from a preference list.

int ast_codec_pref_setsize (struct ast_codec_pref *pref, int format, int framems)

Set packet size for codec.

int ast_codec_pref_string (struct ast_codec_pref *pref, char *buf, size_t size)

Dump audio codec preference list into a string.

static force_inline int ast_format_rate (int format)

Get the sample rate for a given format.

int ast_frame_adjust_volume (struct ast_frame *f, int adjustment)

Adjusts the volume of the audio samples contained in a frame.

void ast_frame_dump (const char *name, struct ast_frame *f, char *prefix)

ast_frame * ast_frame_enqueue (struct ast_frame *head, struct ast_frame *f, int maxlen, int dupe)

Appends a frame to the end of a list of frames, truncating the maximum length of the list.

void ast_frame_free (struct ast_frame *fr, int cache)

Requests a frame to be allocated Frees a frame.

int ast_frame_slinear_sum (struct ast_frame *f1, struct ast_frame *f2)

Sums two frames of audio samples.

ast_frame * ast_frdup (const struct ast_frame *fr)

Copies a frame.

ast_frame * ast_frisolate (struct ast_frame *fr)

Makes a frame independent of any static storage.

ast_format_list * ast_get_format_list (size_t *size)

ast_format_list * ast_get_format_list_index (int index)

int ast_getformatbyname (const char *name)

Gets a format from a name.

char * ast_getformatname (int format)

Get the name of a format.

char * ast_getformatname_multiple (char *buf, size_t size, int format)

Get the names of a set of formats.

void ast_parse_allow_disallow (struct ast_codec_pref *pref, int *mask, const char *list, int allowing)

Parse an "allow" or "deny" line in a channel or device configuration and update the capabilities mask and pref if provided. Video codecs are not added to codec preference lists, since we can not transcode.

void ast_smoother_free (struct ast_smoother *s)

int ast_smoother_get_flags (struct ast_smoother *smoother)

ast_smoother * ast_smoother_new (int bytes)

ast_frame * ast_smoother_read (struct ast_smoother *s)

void ast_smoother_reset (struct ast_smoother *s, int bytes)

void ast_smoother_set_flags (struct ast_smoother *smoother, int flags)

int ast_smoother_test_flag (struct ast_smoother *s, int flag)

void ast_swapcopy_samples (void *dst, const void *src, int samples)

Variables

ast_frame ast_null_frame

Detailed Description

Asterisk internal frame definitions.

For an explanation of frames, see AST Multimedia and signalling frames
Frames are send of Asterisk channels, see Asterisk Channels

Definition in file frame.h.

Define Documentation

#define AST_FORMAT_ADPCM (1 << 5)

ADPCM (IMA)

Definition at line 244 of file frame.h.

Referenced by adpcmtolin_sample(), ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), convertcap(), vox_read(), and vox_write().

#define AST_FORMAT_ALAW (1 << 3)

Raw A-law data (G.711)

Definition at line 240 of file frame.h.

Referenced by alawtolin_sample(), alawtoulaw_sample(), ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_dsp_process(), cb_events(), codec_ast2skinny(), codec_skinny2ast(), convertcap(), dahdi_new(), dahdi_read(), dahdi_write(), misdn_read(), misdn_set_opt_exec(), oh323_rtp_read(), pcm_seek(), pcm_write(), read_config(), and sms_generate().

#define AST_FORMAT_AUDIO_MASK ((1 << 16)-1)

Maximum audio mask

Definition at line 262 of file frame.h.

Referenced by add_sdp(), ast_best_codec(), ast_codec_choose(), ast_openstream_full(), ast_parse_allow_disallow(), ast_request(), ast_translate_available_formats(), ast_translator_best_choice(), begin_dial(), func_channel_read(), generator_force(), gtalk_rtp_read(), process_sdp(), set_format(), sip_call(), sip_rtp_read(), and sip_write().

#define AST_FORMAT_G722 (1 << 12)

G.722

Definition at line 258 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_format_rate(), ast_rtp_write(), au_seek(), convertcap(), and pcm_read().

#define AST_FORMAT_G723_1 (1 << 0)

G.723.1 compression

Definition at line 234 of file frame.h.

Referenced by add_codec_to_sdp(), ast_best_codec(), ast_codec_get_samples(), ast_rtp_write(), codec_ast2skinny(), codec_skinny2ast(), convertcap(), g723_read(), g723_write(), load_module(), phone_request(), phone_setup(), phone_write(), zap_destroy(), and zap_translate().

#define AST_FORMAT_G726 (1 << 11)

ADPCM (G.726, 32kbps, RFC3551 codeword packing)

Definition at line 256 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_rtp_set_rtpmap_type(), g726_read(), g726_write(), and g726tolin_sample().

#define AST_FORMAT_G726_AAL2 (1 << 4)

ADPCM (G.726, 32kbps, AAL2 codeword packing)

Definition at line 242 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_rtp_lookup_mime_subtype(), ast_rtp_set_rtpmap_type(), codec_ast2skinny(), and codec_skinny2ast().

#define AST_FORMAT_G729A (1 << 8)

G.729A audio

Definition at line 250 of file frame.h.

Referenced by add_codec_to_sdp(), ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), codec_ast2skinny(), codec_skinny2ast(), convertcap(), g729_read(), g729_write(), zap_destroy(), and zap_translate().

#define AST_FORMAT_GSM (1 << 1)

GSM compression

Definition at line 236 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), convertcap(), gsm_read(), gsm_write(), gsmtolin_sample(), wav_read(), and wav_write().

#define AST_FORMAT_H261 (1 << 18)

H.261 Video

Definition at line 268 of file frame.h.

Referenced by codec_ast2skinny(), and codec_skinny2ast().

#define AST_FORMAT_H263 (1 << 19)

H.263 Video

Definition at line 270 of file frame.h.

Referenced by codec_ast2skinny(), codec_skinny2ast(), h263_read(), and h263_write().

#define AST_FORMAT_H263_PLUS (1 << 20)

H.263+ Video

Definition at line 272 of file frame.h.

#define AST_FORMAT_H264 (1 << 21)

H.264 Video

Definition at line 274 of file frame.h.

Referenced by h264_read(), and h264_write().

#define AST_FORMAT_ILBC (1 << 10)

iLBC Free Compression

Definition at line 254 of file frame.h.

Referenced by add_codec_to_sdp(), ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_codec_interp_len(), convertcap(), ilbc_read(), ilbc_write(), and ilbctolin_sample().

#define AST_FORMAT_JPEG (1 << 16)

JPEG Images

Definition at line 264 of file frame.h.

Referenced by jpeg_read_image(), and jpeg_write_image().

#define AST_FORMAT_LPC10 (1 << 7)

LPC10, 180 samples/frame

Definition at line 248 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_samples(), and lpc10tolin_sample().

#define AST_FORMAT_MAX_AUDIO (1 << 15)

Maximum audio format

Definition at line 260 of file frame.h.

Referenced by add_sdp(), ast_closestream(), ast_filehelper(), ast_openvstream(), ast_playstream(), ast_rtp_read(), ast_translate_available_formats(), ast_writestream(), oh323_request(), phone_read(), sip_request_call(), skinny_request(), transmit_connect_with_sdp(), and transmit_modify_with_sdp().

#define AST_FORMAT_MAX_VIDEO (1 << 24)

Maximum video format

Definition at line 276 of file frame.h.

Referenced by add_sdp(), ast_openvstream(), and ast_translate_available_formats().

#define AST_FORMAT_PNG (1 << 17)

PNG Images

Definition at line 266 of file frame.h.

Referenced by phone_read().

#define AST_FORMAT_SLINEAR (1 << 6)

Raw 16-bit Signed Linear (8000 Hz) PCM

Definition at line 246 of file frame.h.

Referenced by __ast_play_and_record(), __ast_register_translator(), action_originate(), agent_new(), alsa_new(), alsa_read(), alsa_request(), ast_audiohook_read_frame(), ast_best_codec(), ast_channel_make_compatible(), ast_channel_start_silence_generator(), ast_codec_get_len(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_digitdetect(), ast_dsp_process(), ast_dsp_silence(), ast_frame_adjust_volume(), ast_frame_slinear_sum(), ast_rtp_read(), ast_slinfactory_feed(), attempt_reconnect(), audio_audiohook_write_list(), audiohook_read_frame_both(), audiohook_read_frame_single(), background_detect_exec(), build_conf(), chanspy_exec(), conf_run(), connect_link(), dahdi_new(), dahdi_read(), dahdi_write(), dictate_exec(), do_waiting(), eagi_exec(), extenspy_exec(), handle_recordfile(), iax_frame_wrap(), ices_exec(), init_outgoing(), isAnsweringMachine(), linear_alloc(), linear_generator(), lintoadpcm_sample(), lintoalaw_sample(), lintog726_sample(), lintogsm_sample(), lintoilbc_sample(), lintolpc10_sample(), lintospeex_sample(), lintoulaw_sample(), load_module(), load_moh_classes(), measurenoise(), misdn_set_opt_exec(), mixmonitor_thread(), moh_class_malloc(), mp3_exec(), nbs_request(), nbs_xwrite(), NBScat_exec(), ogg_vorbis_read(), ogg_vorbis_write(), oh323_rtp_read(), orig_app(), orig_exten(), oss_new(), oss_read(), oss_request(), parkandannounce_exec(), phone_new(), phone_read(), phone_request(), phone_setup(), phone_write(), playtones_alloc(), read_config(), rpt(), rpt_call(), rpt_tele_thread(), send_waveform_to_channel(), silence_generator_generate(), slinear_read(), slinear_write(), sms_generate(), socket_process(), speech_background(), speech_create(), spy_generate(), tonepair_alloc(), wav_read(), and wav_write().

#define AST_FORMAT_SPEEX (1 << 9)

SpeeX Free Compression

Definition at line 252 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_samples(), ast_rtp_write(), convertcap(), and speextolin_sample().

#define AST_FORMAT_ULAW (1 << 2)

Raw mu-law data (G.711)

Definition at line 238 of file frame.h.

Referenced by __adsi_transmit_messages(), adsi_careful_send(), alarmreceiver_exec(), ast_adsi_transmit_message_full(), ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_dsp_process(), codec_ast2skinny(), codec_skinny2ast(), conf_run(), convertcap(), dahdi_new(), dahdi_read(), dahdi_write(), disa_exec(), load_module(), milliwatt_generate(), oh323_rtp_read(), old_milliwatt_exec(), phone_request(), phone_setup(), phone_write(), send_tone_burst(), ulawtoalaw_sample(), and ulawtolin_sample().

#define AST_FORMAT_VIDEO_MASK (((1 << 25)-1) & ~(AST_FORMAT_AUDIO_MASK))

Definition at line 277 of file frame.h.

Referenced by add_sdp(), ast_request(), ast_translate_available_formats(), check_user_full(), create_addr_from_peer(), func_channel_read(), gtalk_new(), gtalk_rtp_read(), sip_new(), and sip_rtp_read().

#define ast_frame_byteswap_be ( fr ) do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data, __f->data, __f->samples); } while(0)

Definition at line 428 of file frame.h.

Referenced by ast_rtp_read(), and socket_process().

#define ast_frame_byteswap_le ( fr ) do { ; } while(0)

Definition at line 427 of file frame.h.

Referenced by phone_read().

#define AST_FRAME_DTMF AST_FRAME_DTMF_END

Definition at line 125 of file frame.h.

Referenced by __action_dialoffhook(), __adsi_transmit_messages(), __ast_play_and_record(), agent_ack_sleep(), app_exec(), ast_audiohook_write_list(), ast_bridge_call(), ast_dsp_process(), ast_feature_request_and_dial(), ast_jb_put(), background_detect_exec(), cb_events(), channel_spy(), conf_exec(), conf_run(), console_dial(), console_dial_deprecated(), dahdi_bridge(), dahdi_read(), dictate_exec(), disa_exec(), do_immediate_setup(), echo_exec(), gtalk_handle_dtmf(), handle_recordfile(), handle_request(), handle_request_info(), mgcp_rtp_read(), misdn_bridge(), mp3_exec(), NBScat_exec(), oh323_rtp_read(), phone_exception(), process_ast_dsp(), receive_dtmf_digits(), rpt(), rpt_call(), send_waveform_to_channel(), sip_rtp_read(), speech_background(), ss_thread(), wait_for_answer(), and wait_for_winner().

#define AST_FRAME_SET_BUFFER	(	fr,
		_base,
		_ofs,
		_datalen	)

Value:

{              \
   (fr)->data = (char *)_base + (_ofs);   \
   (fr)->offset = (_ofs);        \
   (fr)->datalen = (_datalen);      \
   }

Set the various field of a frame to point to a buffer. Typically you set the base address of the buffer, the offset as AST_FRIENDLY_OFFSET, and the datalen as the amount of bytes queued. The remaining things (to be done manually) is set the number of samples, which cannot be derived from the datalen unless you know the number of bits per sample.

Definition at line 183 of file frame.h.

Referenced by g723_read(), g726_read(), g729_read(), gsm_read(), h263_read(), h264_read(), ilbc_read(), ogg_vorbis_read(), pcm_read(), slinear_read(), vox_read(), and wav_read().

#define ast_frfree ( fr ) ast_frame_free(fr, 1)

Definition at line 403 of file frame.h.

Referenced by __adsi_transmit_messages(), __ast_play_and_record(), __ast_read(), __ast_request_and_dial(), adsi_careful_send(), agent_ack_sleep(), agent_read(), app_exec(), ast_audiohook_read_frame(), ast_autoservice_stop(), ast_bridge_call(), ast_channel_free(), ast_dsp_process(), ast_feature_request_and_dial(), ast_jb_destroy(), ast_jb_put(), ast_queue_frame(), ast_recvtext(), ast_rtp_write(), ast_safe_sleep_conditional(), ast_send_image(), ast_slinfactory_destroy(), ast_slinfactory_feed(), ast_slinfactory_flush(), ast_slinfactory_read(), ast_tonepair(), ast_translate(), ast_udptl_bridge(), ast_waitfordigit_full(), ast_write(), ast_writestream(), async_wait(), audio_audiohook_write_list(), autoservice_run(), background_detect_exec(), bridge_native_loop(), bridge_p2p_loop(), builtin_atxfer(), calc_cost(), channel_spy(), check_goto_on_transfer(), conf_exec(), conf_flush(), conf_free(), conf_run(), create_jb(), dahdi_bridge(), dictate_exec(), disa_exec(), do_parking_thread(), do_waiting(), echo_exec(), find_cache(), gen_generate(), handle_invite_replaces(), handle_recordfile(), iax_park_thread(), ices_exec(), isAnsweringMachine(), jb_empty_and_reset_adaptive(), jb_empty_and_reset_fixed(), jb_get_and_deliver(), masq_park_call(), measurenoise(), moh_files_generator(), monitor_dial(), mp3_exec(), NBScat_exec(), receive_dtmf_digits(), recordthread(), rpt(), run_agi(), send_tone_burst(), send_waveform_to_channel(), sendurl_exec(), speech_background(), spy_generate(), ss_thread(), wait_for_answer(), wait_for_hangup(), wait_for_winner(), waitforring_exec(), and waitstream_core().

#define AST_FRIENDLY_OFFSET 64

#define AST_HTML_BEGIN 4

Beginning frame

Definition at line 218 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_DATA 2

Data frame

Definition at line 216 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_END 8

End frame

Definition at line 220 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_LDCOMPLETE 16

Load is complete

Definition at line 222 of file frame.h.

Referenced by ast_frame_dump(), and sendurl_exec().

#define AST_HTML_LINKREJECT 20

Reject link request

Definition at line 230 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_LINKURL 18

Send URL, and track

Definition at line 226 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_NOSUPPORT 17

Peer is unable to support HTML

Definition at line 224 of file frame.h.

Referenced by ast_frame_dump(), and sendurl_exec().

#define AST_HTML_UNLINK 19

No more HTML linkage

Definition at line 228 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_URL 1

Sending a URL

Definition at line 214 of file frame.h.

Referenced by ast_channel_sendurl(), and ast_frame_dump().

#define AST_MALLOCD_DATA (1 << 1)

Need the data be free'd?

Definition at line 202 of file frame.h.

Referenced by ast_frame_free(), and ast_frisolate().

#define AST_MALLOCD_HDR (1 << 0)

Need the header be free'd?

Definition at line 200 of file frame.h.

Referenced by ast_frame_free(), ast_frame_header_new(), ast_frdup(), and ast_frisolate().

#define AST_MALLOCD_SRC (1 << 2)

Need the source be free'd? (haha!)

Definition at line 204 of file frame.h.

Referenced by ast_frame_free(), and ast_frisolate().

#define AST_MIN_OFFSET 32

Definition at line 197 of file frame.h.

Referenced by __ast_smoother_feed().

#define AST_MODEM_T38 1

T.38 Fax-over-IP

Definition at line 208 of file frame.h.

Referenced by ast_frame_dump(), and udptl_rx_packet().

#define AST_MODEM_V150 2

V.150 Modem-over-IP

Definition at line 210 of file frame.h.

Referenced by ast_frame_dump().

#define AST_OPTION_AUDIO_MODE 4

Set (or clear) Audio (Not-Clear) Mode

Definition at line 323 of file frame.h.

Referenced by dahdi_hangup(), and dahdi_setoption().

#define AST_OPTION_ECHOCAN 8

Explicitly enable or disable echo cancelation for the given channel

Definition at line 345 of file frame.h.

Referenced by dahdi_setoption().

#define AST_OPTION_FLAG_ACCEPT 1

Definition at line 306 of file frame.h.

#define AST_OPTION_FLAG_ANSWER 5

Definition at line 309 of file frame.h.

#define AST_OPTION_FLAG_QUERY 4

Definition at line 308 of file frame.h.

#define AST_OPTION_FLAG_REJECT 2

Definition at line 307 of file frame.h.

#define AST_OPTION_FLAG_REQUEST 0

Definition at line 305 of file frame.h.

Referenced by ast_bridge_call(), and iax2_setoption().

#define AST_OPTION_FLAG_WTF 6

Definition at line 310 of file frame.h.

#define AST_OPTION_OPRMODE 7

Definition at line 342 of file frame.h.

Referenced by dahdi_setoption().

#define AST_OPTION_RELAXDTMF 3

Relax the parameters for DTMF reception (mainly for radio use)

Definition at line 320 of file frame.h.

Referenced by dahdi_setoption(), and rpt().

#define AST_OPTION_RXGAIN 6

Set channel receive gain Option data is a single signed char representing number of decibels (dB) to set gain to (on top of any gain specified in channel driver)

Definition at line 339 of file frame.h.

Referenced by dahdi_setoption(), func_channel_write(), iax2_setoption(), play_record_review(), reset_volumes(), set_talk_volume(), and vm_forwardoptions().

#define AST_OPTION_TDD 2

Put a compatible channel into TDD (TTY for the hearing-impared) mode

Definition at line 317 of file frame.h.

Referenced by dahdi_hangup(), dahdi_setoption(), and handle_tddmode().

#define AST_OPTION_TONE_VERIFY 1

Verify touchtones by muting audio transmission (and reception) and verify the tone is still present

Definition at line 314 of file frame.h.

Referenced by conf_run(), dahdi_hangup(), dahdi_setoption(), rpt(), and try_calling().

#define AST_OPTION_TXGAIN 5

Set channel transmit gain Option data is a single signed char representing number of decibels (dB) to set gain to (on top of any gain specified in channel driver)

Definition at line 331 of file frame.h.

Referenced by common_exec(), dahdi_setoption(), func_channel_write(), iax2_setoption(), reset_volumes(), and set_listen_volume().

#define ast_smoother_feed	(	s,
		f		)	__ast_smoother_feed(s, f, 0)

Definition at line 477 of file frame.h.

Referenced by ast_rtp_write().

#define ast_smoother_feed_be	(	s,
		f		)	__ast_smoother_feed(s, f, 1)

Definition at line 479 of file frame.h.

Referenced by ast_rtp_write().

#define ast_smoother_feed_le	(	s,
		f		)	__ast_smoother_feed(s, f, 0)

Definition at line 480 of file frame.h.

#define AST_SMOOTHER_FLAG_BE (1 << 1)

Definition at line 302 of file frame.h.

Referenced by ast_rtp_write().

#define AST_SMOOTHER_FLAG_G729 (1 << 0)

Definition at line 301 of file frame.h.

Referenced by __ast_smoother_feed(), and ast_smoother_read().

Enumeration Type Documentation

anonymous enum

Enumerator:

AST_FRFLAG_HAS_TIMING_INFO	This frame contains valid timing information
AST_FRFLAG_FROM_TRANSLATOR	This frame came from a translator and is still the original frame. The translator can not be free'd if the frame inside of it still has this flag set.
AST_FRFLAG_FROM_DSP	This frame came from a dsp and is still the original frame. The dsp cannot be free'd if the frame inside of it still has this flag set.

Definition at line 127 of file frame.h.

00127      {
00128    /*! This frame contains valid timing information */
00129    AST_FRFLAG_HAS_TIMING_INFO = (1 << 0),
00130    /*! This frame came from a translator and is still the original frame.
00131     *  The translator can not be free'd if the frame inside of it still has
00132     *  this flag set. */
00133    AST_FRFLAG_FROM_TRANSL


Data Structures
struct	ast_codec_pref
struct	ast_format_list
	Definition of supported media formats (codecs). More...
struct	ast_frame
	Data structure associated with a single frame of data. More...
struct	ast_option_header
struct	oprmode
Defines
#define	AST_FORMAT_ADPCM (1 << 5)
#define	AST_FORMAT_ALAW (1 << 3)
#define	AST_FORMAT_AUDIO_MASK ((1 << 16)-1)
#define	AST_FORMAT_G722 (1 << 12)
#define	AST_FORMAT_G723_1 (1 << 0)
#define	AST_FORMAT_G726 (1 << 11)
#define	AST_FORMAT_G726_AAL2 (1 << 4)
#define	AST_FORMAT_G729A (1 << 8)
#define	AST_FORMAT_GSM (1 << 1)
#define	AST_FORMAT_H261 (1 << 18)
#define	AST_FORMAT_H263 (1 << 19)
#define	AST_FORMAT_H263_PLUS (1 << 20)
#define	AST_FORMAT_H264 (1 << 21)
#define	AST_FORMAT_ILBC (1 << 10)
#define	AST_FORMAT_JPEG (1 << 16)
#define	AST_FORMAT_LPC10 (1 << 7)
#define	AST_FORMAT_MAX_AUDIO (1 << 15)
#define	AST_FORMAT_MAX_VIDEO (1 << 24)
#define	AST_FORMAT_PNG (1 << 17)
#define	AST_FORMAT_SLINEAR (1 << 6)
#define	AST_FORMAT_SPEEX (1 << 9)
#define	AST_FORMAT_ULAW (1 << 2)
#define	AST_FORMAT_VIDEO_MASK (((1 << 25)-1) & ~(AST_FORMAT_AUDIO_MASK))
#define	ast_frame_byteswap_be(fr) do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data, __f->data, __f->samples); } while(0)
#define	ast_frame_byteswap_le(fr) do { ; } while(0)
#define	AST_FRAME_DTMF AST_FRAME_DTMF_END
#define	AST_FRAME_SET_BUFFER(fr, _base, _ofs, _datalen)
#define	ast_frfree(fr) ast_frame_free(fr, 1)
#define	AST_FRIENDLY_OFFSET 64
#define	AST_HTML_BEGIN 4
#define	AST_HTML_DATA 2
#define	AST_HTML_END 8
#define	AST_HTML_LDCOMPLETE 16
#define	AST_HTML_LINKREJECT 20
#define	AST_HTML_LINKURL 18
#define	AST_HTML_NOSUPPORT 17
#define	AST_HTML_UNLINK 19
#define	AST_HTML_URL 1
#define	AST_MALLOCD_DATA (1 << 1)
#define	AST_MALLOCD_HDR (1 << 0)
#define	AST_MALLOCD_SRC (1 << 2)
#define	AST_MIN_OFFSET 32
#define	AST_MODEM_T38 1
#define	AST_MODEM_V150 2
#define	AST_OPTION_AUDIO_MODE 4
#define	AST_OPTION_ECHOCAN 8
#define	AST_OPTION_FLAG_ACCEPT 1
#define	AST_OPTION_FLAG_ANSWER 5
#define	AST_OPTION_FLAG_QUERY 4
#define	AST_OPTION_FLAG_REJECT 2
#define	AST_OPTION_FLAG_REQUEST 0
#define	AST_OPTION_FLAG_WTF 6
#define	AST_OPTION_OPRMODE 7
#define	AST_OPTION_RELAXDTMF 3
#define	AST_OPTION_RXGAIN 6
#define	AST_OPTION_TDD 2
#define	AST_OPTION_TONE_VERIFY 1
#define	AST_OPTION_TXGAIN 5
#define	ast_smoother_feed(s, f) __ast_smoother_feed(s, f, 0)
#define	ast_smoother_feed_be(s, f) __ast_smoother_feed(s, f, 1)
#define	ast_smoother_feed_le(s, f) __ast_smoother_feed(s, f, 0)
#define	AST_SMOOTHER_FLAG_BE (1 << 1)
#define	AST_SMOOTHER_FLAG_G729 (1 << 0)
Enumerations
enum	{ AST_FRFLAG_HAS_TIMING_INFO = (1 << 0), AST_FRFLAG_FROM_TRANSLATOR = (1 << 1), AST_FRFLAG_FROM_DSP = (1 << 2) }
enum	ast_control_frame_type { AST_CONTROL_HANGUP = 1, AST_CONTROL_RING = 2, AST_CONTROL_RINGING = 3, AST_CONTROL_ANSWER = 4, AST_CONTROL_BUSY = 5, AST_CONTROL_TAKEOFFHOOK = 6, AST_CONTROL_OFFHOOK = 7, AST_CONTROL_CONGESTION = 8, AST_CONTROL_FLASH = 9, AST_CONTROL_WINK = 10, AST_CONTROL_OPTION = 11, AST_CONTROL_RADIO_KEY = 12, AST_CONTROL_RADIO_UNKEY = 13, AST_CONTROL_PROGRESS = 14, AST_CONTROL_PROCEEDING = 15, AST_CONTROL_HOLD = 16, AST_CONTROL_UNHOLD = 17, AST_CONTROL_VIDUPDATE = 18, AST_CONTROL_SRCUPDATE = 20 }
enum	ast_frame_type { AST_FRAME_DTMF_END = 1, AST_FRAME_VOICE, AST_FRAME_VIDEO, AST_FRAME_CONTROL, AST_FRAME_NULL, AST_FRAME_IAX, AST_FRAME_TEXT, AST_FRAME_IMAGE, AST_FRAME_HTML, AST_FRAME_CNG, AST_FRAME_MODEM, AST_FRAME_DTMF_BEGIN }
	Frame types. More...
Functions
int	__ast_smoother_feed (struct ast_smoother s, struct ast_frame f, int swap)
char *	ast_codec2str (int codec)
	Get a name from a format Gets a name from a format.
int	ast_codec_choose (struct ast_codec_pref *pref, int formats, int find_best)
	Select the best audio format according to preference list from supplied options. If "find_best" is non-zero then if nothing is found, the "Best" format of the format list is selected, otherwise 0 is returned.
int	ast_codec_get_len (int format, int samples)
	Returns the number of bytes for the number of samples of the given format.
int	ast_codec_get_samples (struct ast_frame *f)
	Returns the number of samples contained in the frame.
static int	ast_codec_interp_len (int format)
	Gets duration in ms of interpolation frame for a format.
int	ast_codec_pref_append (struct ast_codec_pref *pref, int format)
	Append a audio codec to a preference list, removing it first if it was already there.
void	ast_codec_pref_convert (struct ast_codec_pref pref, char buf, size_t size, int right)
	Shift an audio codec preference list up or down 65 bytes so that it becomes an ASCII string.
ast_format_list	ast_codec_pref_getsize (struct ast_codec_pref *pref, int format)
	Get packet size for codec.
int	ast_codec_pref_index (struct ast_codec_pref *pref, int index)
	Codec located at a particular place in the preference index See Audio Codec Preferences.
void	ast_codec_pref_init (struct ast_codec_pref *pref)
	Initialize an audio codec preference to "no preference" See Audio Codec Preferences.
void	ast_codec_pref_prepend (struct ast_codec_pref *pref, int format, int only_if_existing)
	Prepend an audio codec to a preference list, removing it first if it was already there.
void	ast_codec_pref_remove (struct ast_codec_pref *pref, int format)
	Remove audio a codec from a preference list.
int	ast_codec_pref_setsize (struct ast_codec_pref *pref, int format, int framems)
	Set packet size for codec.
int	ast_codec_pref_string (struct ast_codec_pref pref, char buf, size_t size)
	Dump audio codec preference list into a string.
static force_inline int	ast_format_rate (int format)
	Get the sample rate for a given format.
int	ast_frame_adjust_volume (struct ast_frame *f, int adjustment)
	Adjusts the volume of the audio samples contained in a frame.
void	ast_frame_dump (const char name, struct ast_frame f, char *prefix)
ast_frame *	ast_frame_enqueue (struct ast_frame head, struct ast_frame f, int maxlen, int dupe)
	Appends a frame to the end of a list of frames, truncating the maximum length of the list.
void	ast_frame_free (struct ast_frame *fr, int cache)
	Requests a frame to be allocated Frees a frame.
int	ast_frame_slinear_sum (struct ast_frame f1, struct ast_frame f2)
	Sums two frames of audio samples.
ast_frame *	ast_frdup (const struct ast_frame *fr)
	Copies a frame.
ast_frame *	ast_frisolate (struct ast_frame *fr)
	Makes a frame independent of any static storage.
ast_format_list *	ast_get_format_list (size_t *size)
ast_format_list *	ast_get_format_list_index (int index)
int	ast_getformatbyname (const char *name)
	Gets a format from a name.
char *	ast_getformatname (int format)
	Get the name of a format.
char *	ast_getformatname_multiple (char *buf, size_t size, int format)
	Get the names of a set of formats.
void	ast_parse_allow_disallow (struct ast_codec_pref pref, int mask, const char *list, int allowing)
	Parse an "allow" or "deny" line in a channel or device configuration and update the capabilities mask and pref if provided. Video codecs are not added to codec preference lists, since we can not transcode.
void	ast_smoother_free (struct ast_smoother *s)
int	ast_smoother_get_flags (struct ast_smoother *smoother)
ast_smoother *	ast_smoother_new (int bytes)
ast_frame *	ast_smoother_read (struct ast_smoother *s)
void	ast_smoother_reset (struct ast_smoother *s, int bytes)
void	ast_smoother_set_flags (struct ast_smoother *smoother, int flags)
int	ast_smoother_test_flag (struct ast_smoother *s, int flag)
void	ast_swapcopy_samples (void dst, const void src, int samples)
Variables
ast_frame	ast_null_frame