Wed Aug 15 01:25:11 2007

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_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_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
}
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.
struct 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_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.
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)
struct ast_frameast_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.
int ast_frame_slinear_sum (struct ast_frame *f1, struct ast_frame *f2)
 Sums two frames of audio samples.
struct ast_frameast_frdup (const struct ast_frame *fr)
 Copies a frame.
static void force_inline ast_frfree (struct ast_frame *fr)
struct ast_frameast_frisolate (struct ast_frame *fr)
 Makes a frame independent of any static storage.
struct ast_format_listast_get_format_list (size_t *size)
struct ast_format_listast_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)
struct ast_smootherast_smoother_new (int bytes)
struct ast_frameast_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

struct ast_frame ast_null_frame


Detailed Description

Asterisk internal frame definitions.

Definition in file frame.h.


Define Documentation

#define AST_FORMAT_ADPCM   (1 << 5)

ADPCM (IMA)

Definition at line 230 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 226 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(), misdn_read(), misdn_set_opt_exec(), oh323_rtp_read(), pcm_seek(), pcm_write(), read_config(), sms_exec(), sms_generate(), zt_new(), zt_read(), and zt_write().

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

Maximum audio mask

Definition at line 248 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(), begin_dial(), func_channel_read(), 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 244 of file frame.h.

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

#define AST_FORMAT_G723_1   (1 << 0)

G.723.1 compression

Definition at line 220 of file frame.h.

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

#define AST_FORMAT_G726   (1 << 11)

ADPCM (G.726, 32kbps, RFC3551 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_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 228 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 236 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(), and g729_write().

#define AST_FORMAT_GSM   (1 << 1)

GSM compression

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

Referenced by codec_ast2skinny(), and codec_skinny2ast().

#define AST_FORMAT_H263   (1 << 19)

H.263 Video

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

#define AST_FORMAT_H264   (1 << 21)

H.264 Video

Definition at line 260 of file frame.h.

Referenced by h264_read(), and h264_write().

#define AST_FORMAT_ILBC   (1 << 10)

iLBC Free Compression

Definition at line 240 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(), and ilbc_write().

#define AST_FORMAT_JPEG   (1 << 16)

JPEG Images

Definition at line 250 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 234 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 246 of file frame.h.

Referenced by add_sdp(), ast_closestream(), ast_filehelper(), ast_openvstream(), ast_playstream(), ast_rtp_raw_write(), 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 262 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 252 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 232 of file frame.h.

Referenced by __ast_play_and_record(), __ast_register_translator(), action_originate(), agent_new(), alsa_new(), alsa_read(), alsa_request(), ast_best_codec(), ast_channel_make_compatible(), ast_channel_spy_add(), ast_channel_start_silence_generator(), ast_channel_whisper_stop(), 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(), ast_write(), attempt_reconnect(), attempt_thread(), background_detect_exec(), build_conf(), channel_spy(), chanspy_exec(), conf_run(), connect_link(), dictate_exec(), do_waiting(), eagi_exec(), extenspy_exec(), fast_originate(), handle_recordfile(), iax_frame_wrap(), ices_exec(), isAnsweringMachine(), launch_monitor_thread(), linear_alloc(), linear_generator(), lintoadpcm_sample(), lintoalaw_sample(), lintog726_sample(), lintogsm_sample(), lintolpc10_sample(), lintospeex_sample(), lintoulaw_sample(), load_module(), load_moh_classes(), measurenoise(), misdn_set_opt_exec(), 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(), playtones_generator(), queue_frame_to_spies(), read_config(), record_exec(), rpt(), rpt_call(), rpt_exec(), rpt_tele_thread(), send_waveform_to_channel(), silence_generator_generate(), slinear_read(), slinear_write(), sms_exec(), sms_generate(), socket_process(), speech_background(), speech_create(), tonepair_alloc(), tonepair_generator(), wav_read(), wav_write(), zt_new(), zt_read(), and zt_write().

#define AST_FORMAT_SPEEX   (1 << 9)

SpeeX Free Compression

Definition at line 238 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 224 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(), disa_exec(), load_module(), milliwatt_exec(), milliwatt_generate(), oh323_rtp_read(), phone_request(), phone_setup(), phone_write(), send_tone_burst(), ulawtoalaw_sample(), ulawtolin_sample(), zt_new(), zt_read(), and zt_write().

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

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

Referenced by ast_rtp_read(), and socket_process().

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

Definition at line 415 of file frame.h.

Referenced by phone_read().

#define AST_FRAME_DTMF   AST_FRAME_DTMF_END

Definition at line 124 of file frame.h.

Referenced by __adsi_transmit_messages(), __ast_play_and_record(), action_zapdialoffhook(), agent_ack_sleep(), app_exec(), ast_bridge_call(), ast_dsp_process(), ast_feature_request_and_dial(), ast_generic_bridge(), ast_jb_put(), background_detect_exec(), bridge_native_loop(), bridge_p2p_loop(), cb_events(), channel_spy(), conf_exec(), conf_run(), console_dial(), console_dial_deprecated(), dictate_exec(), disa_exec(), do_immediate_setup(), echo_exec(), gtalk_handle_dtmf(), handle_recordfile(), handle_request(), handle_request_info(), iax2_bridge(), mgcp_rtp_read(), misdn_bridge(), mp3_exec(), NBScat_exec(), oh323_rtp_read(), phone_exception(), process_ast_dsp(), receive_dtmf_digits(), record_exec(), rpt(), rpt_call(), rpt_exec(), send_waveform_to_channel(), sip_rtp_read(), speech_background(), ss_thread(), wait_for_answer(), wait_for_winner(), zt_bridge(), and zt_read().

#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 169 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_FRIENDLY_OFFSET   64

Definition at line 180 of file frame.h.

Referenced by __get_from_jb(), alsa_read(), ast_frdup(), ast_frisolate(), ast_prod(), ast_rtcp_read(), ast_rtp_read(), ast_smoother_read(), ast_trans_frameout(), ast_udptl_read(), conf_run(), g723_read(), g726_read(), g729_read(), gsm_read(), h263_read(), h264_read(), iax_frame_wrap(), ilbc_read(), jb_get_and_deliver(), linear_generator(), milliwatt_generate(), moh_generate(), mohalloc(), mp3_exec(), NBScat_exec(), newpvt(), ogg_vorbis_read(), oss_read(), pcm_read(), phone_read(), playtones_generator(), process_rfc3389(), send_tone_burst(), send_waveform_to_channel(), slinear_read(), sms_generate(), tonepair_generator(), vox_read(), wav_read(), zap_frameout(), and zt_read().

#define AST_HTML_BEGIN   4

Beginning frame

Definition at line 204 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_DATA   2

Data frame

Definition at line 202 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_END   8

End frame

Definition at line 206 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_LDCOMPLETE   16

Load is complete

Definition at line 208 of file frame.h.

Referenced by ast_frame_dump(), and sendurl_exec().

#define AST_HTML_LINKREJECT   20

Reject link request

Definition at line 216 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_LINKURL   18

Send URL, and track

Definition at line 212 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_NOSUPPORT   17

Peer is unable to support HTML

Definition at line 210 of file frame.h.

Referenced by ast_frame_dump(), and sendurl_exec().

#define AST_HTML_UNLINK   19

No more HTML linkage

Definition at line 214 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_URL   1

Sending a URL

Definition at line 200 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 188 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 186 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 190 of file frame.h.

Referenced by ast_frame_free(), and ast_frisolate().

#define AST_MIN_OFFSET   32

Definition at line 183 of file frame.h.

Referenced by __ast_smoother_feed().

#define AST_MODEM_T38   1

T.38 Fax-over-IP

Definition at line 194 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 196 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 308 of file frame.h.

Referenced by zt_hangup(), and zt_setoption().

#define AST_OPTION_ECHOCAN   8

Explicitly enable or disable echo cancelation for the given channel

Definition at line 330 of file frame.h.

Referenced by zt_setoption().

#define AST_OPTION_FLAG_ACCEPT   1

Definition at line 291 of file frame.h.

#define AST_OPTION_FLAG_ANSWER   5

Definition at line 294 of file frame.h.

#define AST_OPTION_FLAG_QUERY   4

Definition at line 293 of file frame.h.

#define AST_OPTION_FLAG_REJECT   2

Definition at line 292 of file frame.h.

#define AST_OPTION_FLAG_REQUEST   0

Definition at line 290 of file frame.h.

Referenced by ast_bridge_call(), and iax2_setoption().

#define AST_OPTION_FLAG_WTF   6

Definition at line 295 of file frame.h.

#define AST_OPTION_OPRMODE   7

Definition at line 327 of file frame.h.

Referenced by zt_setoption().

#define AST_OPTION_RELAXDTMF   3

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

Definition at line 305 of file frame.h.

Referenced by rpt(), and zt_setoption().

#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 324 of file frame.h.

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

#define AST_OPTION_TDD   2

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

Definition at line 302 of file frame.h.

Referenced by handle_tddmode(), zt_hangup(), and zt_setoption().

#define AST_OPTION_TONE_VERIFY   1

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

Definition at line 299 of file frame.h.

Referenced by conf_run(), rpt(), rpt_exec(), try_calling(), zt_hangup(), and zt_setoption().

#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 316 of file frame.h.

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

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

Definition at line 465 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 467 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 468 of file frame.h.

#define AST_SMOOTHER_FLAG_BE   (1 << 1)

Definition at line 287 of file frame.h.

Referenced by ast_rtp_write().

#define AST_SMOOTHER_FLAG_G729   (1 << 0)

Definition at line 286 of file frame.h.

Referenced by __ast_smoother_feed(), and ast_smoother_read().


Enumeration Type Documentation

enum ast_control_frame_type

Enumerator:
AST_CONTROL_HANGUP  Other end has hungup
AST_CONTROL_RING  Local ring
AST_CONTROL_RINGING  Remote end is ringing
AST_CONTROL_ANSWER  Remote end has answered
AST_CONTROL_BUSY  Remote end is busy
AST_CONTROL_TAKEOFFHOOK  Make it go off hook
AST_CONTROL_OFFHOOK  Line is off hook
AST_CONTROL_CONGESTION  Congestion (circuits busy)
AST_CONTROL_FLASH  Flash hook
AST_CONTROL_WINK  Wink
AST_CONTROL_OPTION  Set a low-level option
AST_CONTROL_RADIO_KEY  Key Radio
AST_CONTROL_RADIO_UNKEY  Un-Key Radio
AST_CONTROL_PROGRESS  Indicate PROGRESS
AST_CONTROL_PROCEEDING  Indicate CALL PROCEEDING
AST_CONTROL_HOLD  Indicate call is placed on hold
AST_CONTROL_UNHOLD  Indicate call is left from hold
AST_CONTROL_VIDUPDATE  Indicate video frame update

Definition at line 265 of file frame.h.

00265                             {
00266    AST_CONTROL_HANGUP = 1,    /*!< Other end has hungup */
00267    AST_CONTROL_RING = 2,      /*!< Local ring */
00268    AST_CONTROL_RINGING = 3,   /*!< Remote end is ringing */
00269    AST_CONTROL_ANSWER = 4,    /*!< Remote end has answered */
00270    AST_CONTROL_BUSY = 5,      /*!< Remote end is busy */
00271    AST_CONTROL_TAKEOFFHOOK = 6,  /*!< Make it go off hook */
00272    AST_CONTROL_OFFHOOK = 7,   /*!< Line is off hook */
00273    AST_CONTROL_CONGESTION = 8,   /*!< Congestion (circuits busy) */
00274    AST_CONTROL_FLASH = 9,     /*!< Flash hook */
00275    AST_CONTROL_WINK = 10,     /*!< Wink */
00276    AST_CONTROL_OPTION = 11,   /*!< Set a low-level option */
00277    AST_CONTROL_RADIO_KEY = 12,   /*!< Key Radio */
00278    AST_CONTROL_RADIO_UNKEY = 13, /*!< Un-Key Radio */
00279    AST_CONTROL_PROGRESS = 14, /*!< Indicate PROGRESS */
00280    AST_CONTROL_PROCEEDING = 15,  /*!< Indicate CALL PROCEEDING */
00281    AST_CONTROL_HOLD = 16,     /*!< Indicate call is placed on hold */
00282    AST_CONTROL_UNHOLD = 17,   /*!< Indicate call is left from hold */
00283    AST_CONTROL_VIDUPDATE = 18,   /*!< Indicate video frame update */
00284 };

enum ast_frame_type

Frame types.

Note:
It is important that the values of each frame type are never changed, because it will break backwards compatability with older versions.
Enumerator:
AST_FRAME_DTMF_END  DTMF end event, subclass is the digit
AST_FRAME_VOICE  Voice data, subclass is AST_FORMAT_*
AST_FRAME_VIDEO  Video frame, maybe?? :)
AST_FRAME_CONTROL  A control frame, subclass is AST_CONTROL_*
AST_FRAME_NULL  An empty, useless frame
AST_FRAME_IAX  Inter Asterisk Exchange private frame type
AST_FRAME_TEXT  Text messages
AST_FRAME_IMAGE  Image Frames
AST_FRAME_HTML  HTML Frame
AST_FRAME_CNG  Comfort Noise frame (subclass is level of CNG in -dBov), body may include zero or more 8-bit quantization coefficients
AST_FRAME_MODEM  Modem-over-IP data streams
AST_FRAME_DTMF_BEGIN  DTMF begin event, subclass is the digit

Definition at line 97 of file frame.h.

00097                     {
00098    /*! DTMF end event, subclass is the digit */
00099    AST_FRAME_DTMF_END = 1,
00100    /*! Voice data, subclass is AST_FORMAT_* */
00101    AST_FRAME_VOICE,
00102    /*! Video frame, maybe?? :) */
00103    AST_FRAME_VIDEO,
00104    /*! A control frame, subclass is AST_CONTROL_* */
00105    AST_FRAME_CONTROL,
00106    /*! An empty, useless frame */
00107    AST_FRAME_NULL,
00108    /*! Inter Asterisk Exchange private frame type */
00109    AST_FRAME_IAX,
00110    /*! Text messages */
00111    AST_FRAME_TEXT,
00112    /*! Image Frames */
00113    AST_FRAME_IMAGE,
00114    /*! HTML Frame */
00115    AST_FRAME_HTML,
00116    /*! Comfort Noise frame (subclass is level of CNG in -dBov), 
00117        body may include zero or more 8-bit quantization coefficients */
00118    AST_FRAME_CNG,
00119    /*! Modem-over-IP data streams */
00120    AST_FRAME_MODEM,  
00121    /*! DTMF begin event, subclass is the digit */
00122    AST_FRAME_DTMF_BEGIN,
00123 };


Function Documentation

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

Definition at line 170 of file frame.c.

References AST_FRAME_VOICE, ast_log(), AST_MIN_OFFSET, AST_SMOOTHER_FLAG_G729, ast_swapcopy_samples(), ast_smoother::data, ast_frame::data, ast_frame::datalen, ast_smoother::delivery, ast_frame::delivery, ast_smoother::flags, ast_smoother::format, ast_frame::frametype, ast_smoother::len, LOG_NOTICE, LOG_WARNING, ast_frame::offset, ast_smoother::opt, ast_smoother::optimizablestream, ast_frame::samples, ast_smoother::samplesperbyte, ast_smoother::size, SMOOTHER_SIZE, and ast_frame::subclass.

00171 {
00172    if (f->frametype != AST_FRAME_VOICE) {
00173       ast_log(LOG_WARNING, "Huh?  Can't smooth a non-voice frame!\n");
00174       return -1;
00175    }
00176    if (!s->format) {
00177       s->format = f->subclass;
00178       s->samplesperbyte = (float)f->samples / (float)f->datalen;
00179    } else if (s->format != f->subclass) {
00180       ast_log(LOG_WARNING, "Smoother was working on %d format frames, now trying to feed %d?\n", s->format, f->subclass);
00181       return -1;
00182    }
00183    if (s->len + f->datalen > SMOOTHER_SIZE) {
00184       ast_log(LOG_WARNING, "Out of smoother space\n");
00185       return -1;
00186    }
00187    if (((f->datalen == s->size) || ((f->datalen < 10) && (s->flags & AST_SMOOTHER_FLAG_G729)))
00188              && !s->opt && (f->offset >= AST_MIN_OFFSET)) {
00189       if (!s->len) {
00190          /* Optimize by sending the frame we just got
00191             on the next read, thus eliminating the douple
00192             copy */
00193          if (swap)
00194             ast_swapcopy_samples(f->data, f->data, f->samples);
00195          s->opt = f;
00196          return 0;
00197       } else {
00198          s->optimizablestream++;
00199          if (s->optimizablestream > 10) {
00200             /* For the past 10 rounds, we have input and output
00201                frames of the correct size for this smoother, yet
00202                we were unable to optimize because there was still
00203                some cruft left over.  Lets just drop the cruft so
00204                we can move to a fully optimized path */
00205             if (swap)
00206                ast_swapcopy_samples(f->data, f->data, f->samples);
00207             s->len = 0;
00208             s->opt = f;
00209             return 0;
00210          }
00211       }
00212    } else 
00213       s->optimizablestream = 0;
00214    if (s->flags & AST_SMOOTHER_FLAG_G729) {
00215       if (s->len % 10) {
00216          ast_log(LOG_NOTICE, "Dropping extra frame of G.729 since we already have a VAD frame at the end\n");
00217          return 0;
00218       }
00219    }
00220    if (swap)
00221       ast_swapcopy_samples(s->data+s->len, f->data, f->samples);
00222    else
00223       memcpy(s->data + s->len, f->data, f->datalen);
00224    /* If either side is empty, reset the delivery time */
00225    if (!s->len || ast_tvzero(f->delivery) || ast_tvzero(s->delivery))   /* XXX really ? */
00226       s->delivery = f->delivery;
00227    s->len += f->datalen;
00228    return 0;
00229 }

char* ast_codec2str ( int  codec  ) 

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

Parameters:
codec codec number (1,2,4,8,16,etc.)
Returns:
This returns a static string identifying the format on success, 0 on error.

Definition at line 605 of file frame.c.

References ast_format_list::desc.

00606 {
00607    int x;
00608    char *ret = "unknown";
00609    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
00610       if(AST_FORMAT_LIST[x].visible && AST_FORMAT_LIST[x].bits == codec) {
00611          ret = AST_FORMAT_LIST[x].desc;
00612          break;
00613       }
00614    }
00615    return ret;
00616 }

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.

Definition at line 1249 of file frame.c.

References ast_best_codec(), AST_FORMAT_AUDIO_MASK, ast_log(), ast_format_list::bits, LOG_DEBUG, option_debug, and ast_codec_pref::order.

01250 {
01251    int x, ret = 0, slot;
01252 
01253    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01254       slot = pref->order[x];
01255 
01256       if (!slot)
01257          break;
01258       if (formats & AST_FORMAT_LIST[slot-1].bits) {
01259          ret = AST_FORMAT_LIST[slot-1].bits;
01260          break;
01261       }
01262    }
01263    if(ret & AST_FORMAT_AUDIO_MASK)
01264       return ret;
01265 
01266    if (option_debug > 3)
01267       ast_log(LOG_DEBUG, "Could not find preferred codec - %s\n", find_best ? "Going for the best codec" : "Returning zero codec");
01268 
01269       return find_best ? ast_best_codec(formats) : 0;
01270 }

int ast_codec_get_len ( int  format,
int  samples 
)

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

Definition at line 1508 of file frame.c.

References AST_FORMAT_ADPCM, AST_FORMAT_ALAW, AST_FORMAT_G726, AST_FORMAT_G726_AAL2, AST_FORMAT_G729A, AST_FORMAT_GSM, AST_FORMAT_ILBC, AST_FORMAT_SLINEAR, AST_FORMAT_ULAW, ast_getformatname(), ast_log(), len, and LOG_WARNING.

01509 {
01510    int len = 0;
01511 
01512    /* XXX Still need speex, g723, and lpc10 XXX */ 
01513    switch(format) {
01514    case AST_FORMAT_ILBC:
01515       len = (samples / 240) * 50;
01516       break;
01517    case AST_FORMAT_GSM:
01518       len = (samples / 160) * 33;
01519       break;
01520    case AST_FORMAT_G729A:
01521       len = samples / 8;
01522       break;
01523    case AST_FORMAT_SLINEAR:
01524       len = samples * 2;
01525       break;
01526    case AST_FORMAT_ULAW:
01527    case AST_FORMAT_ALAW:
01528       len = samples;
01529       break;
01530    case AST_FORMAT_ADPCM:
01531    case AST_FORMAT_G726:
01532    case AST_FORMAT_G726_AAL2:
01533       len = samples / 2;
01534       break;
01535    default:
01536       ast_log(LOG_WARNING, "Unable to calculate sample length for format %s\n", ast_getformatname(format));
01537    }
01538 
01539    return len;
01540 }

int ast_codec_get_samples ( struct ast_frame f  ) 

Returns the number of samples contained in the frame.

Definition at line 1465 of file frame.c.

References AST_FORMAT_ADPCM, AST_FORMAT_ALAW, AST_FORMAT_G722, AST_FORMAT_G723_1, AST_FORMAT_G726, AST_FORMAT_G726_AAL2, AST_FORMAT_G729A, AST_FORMAT_GSM, AST_FORMAT_ILBC, AST_FORMAT_LPC10, AST_FORMAT_SLINEAR, AST_FORMAT_SPEEX, AST_FORMAT_ULAW, ast_getformatname(), ast_log(), ast_frame::data, ast_frame::datalen, g723_samples(), LOG_WARNING, speex_samples(), and ast_frame::subclass.

01466 {
01467    int samples=0;
01468    switch(f->subclass) {
01469    case AST_FORMAT_SPEEX:
01470       samples = speex_samples(f->data, f->datalen);
01471       break;
01472    case AST_FORMAT_G723_1:
01473                 samples = g723_samples(f->data, f->datalen);
01474       break;
01475    case AST_FORMAT_ILBC:
01476       samples = 240 * (f->datalen / 50);
01477       break;
01478    case AST_FORMAT_GSM:
01479       samples = 160 * (f->datalen / 33);
01480       break;
01481    case AST_FORMAT_G729A:
01482       samples = f->datalen * 8;
01483       break;
01484    case AST_FORMAT_SLINEAR:
01485       samples = f->datalen / 2;
01486       break;
01487    case AST_FORMAT_LPC10:
01488                 /* assumes that the RTP packet contains one LPC10 frame */
01489       samples = 22 * 8;
01490       samples += (((char *)(f->data))[7] & 0x1) * 8;
01491       break;
01492    case AST_FORMAT_ULAW:
01493    case AST_FORMAT_ALAW:
01494    case AST_FORMAT_G722:
01495       samples = f->datalen;
01496       break;
01497    case AST_FORMAT_ADPCM:
01498    case AST_FORMAT_G726:
01499    case AST_FORMAT_G726_AAL2:
01500       samples = f->datalen * 2;
01501       break;
01502    default:
01503       ast_log(LOG_WARNING, "Unable to calculate samples for format %s\n", ast_getformatname(f->subclass));
01504    }
01505    return samples;
01506 }

static int ast_codec_interp_len ( int  format  )  [inline, static]

Gets duration in ms of interpolation frame for a format.

Definition at line 538 of file frame.h.

References AST_FORMAT_ILBC.

Referenced by __get_from_jb(), and jb_get_and_deliver().

00539 { 
00540    return (format == AST_FORMAT_ILBC) ? 30 : 20;
00541 }

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.

Definition at line 1144 of file frame.c.

References ast_codec_pref_remove(), and ast_codec_pref::order.

01145 {
01146    int x, newindex = -1;
01147 
01148    ast_codec_pref_remove(pref, format);
01149 
01150    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01151       if(AST_FORMAT_LIST[x].bits == format) {
01152          newindex = x + 1;
01153          break;
01154       }
01155    }
01156 
01157    if(newindex) {
01158       for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01159          if(!pref->order[x]) {
01160             pref->order[x] = newindex;
01161             break;
01162          }
01163       }
01164    }
01165 
01166    return x;
01167 }

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.

Definition at line 1046 of file frame.c.

References ast_codec_pref::order.

01047 {
01048    int x, differential = (int) 'A', mem;
01049    char *from, *to;
01050 
01051    if(right) {
01052       from = pref->order;
01053       to = buf;
01054       mem = size;
01055    } else {
01056       to = pref->order;
01057       from = buf;
01058       mem = 32;
01059    }
01060 
01061    memset(to, 0, mem);
01062    for (x = 0; x < 32 ; x++) {
01063       if(!from[x])
01064          break;
01065       to[x] = right ? (from[x] + differential) : (from[x] - differential);
01066    }
01067 }

struct ast_format_list ast_codec_pref_getsize ( struct ast_codec_pref pref,
int  format 
) [read]

Get packet size for codec.

Definition at line 1210 of file frame.c.

References ast_format_list::bits, ast_format_list::cur_ms, ast_format_list::def_ms, format, ast_format_list::inc_ms, ast_format_list::max_ms, and ast_format_list::min_ms.

01211 {
01212    int x, index = -1, framems = 0;
01213    struct ast_format_list fmt = {0};
01214 
01215    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01216       if(AST_FORMAT_LIST[x].bits == format) {
01217          fmt = AST_FORMAT_LIST[x];
01218          index = x;
01219          break;
01220       }
01221    }
01222 
01223    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01224       if(pref->order[x] == (index + 1)) {
01225          framems = pref->framing[x];
01226          break;
01227       }
01228    }
01229 
01230    /* size validation */
01231    if(!framems)
01232       framems = AST_FORMAT_LIST[index].def_ms;
01233 
01234    if(AST_FORMAT_LIST[index].inc_ms && framems % AST_FORMAT_LIST[index].inc_ms) /* avoid division by zero */
01235       framems -= framems % AST_FORMAT_LIST[index].inc_ms;
01236 
01237    if(framems < AST_FORMAT_LIST[index].min_ms)
01238       framems = AST_FORMAT_LIST[index].min_ms;
01239 
01240    if(framems > AST_FORMAT_LIST[index].max_ms)
01241       framems = AST_FORMAT_LIST[index].max_ms;
01242 
01243    fmt.cur_ms = framems;
01244 
01245    return fmt;
01246 }

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.

Definition at line 1104 of file frame.c.

References ast_format_list::bits, and ast_codec_pref::order.

01105 {
01106    int slot = 0;
01107 
01108    
01109    if((index >= 0) && (index < sizeof(pref->order))) {
01110       slot = pref->order[index];
01111    }
01112 
01113    return slot ? AST_FORMAT_LIST[slot-1].bits : 0;
01114 }

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_remove ( struct ast_codec_pref pref,
int  format 
)

Remove audio a codec from a preference list.

Definition at line 1117 of file frame.c.

References ast_codec_pref::framing, and ast_codec_pref::order.

01118 {
01119    struct ast_codec_pref oldorder;
01120    int x, y = 0;
01121    int slot;
01122    int size;
01123 
01124    if(!pref->order[0])
01125       return;
01126 
01127    memcpy(&oldorder, pref, sizeof(oldorder));
01128    memset(pref, 0, sizeof(*pref));
01129 
01130    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01131       slot = oldorder.order[x];
01132       size = oldorder.framing[x];
01133       if(! slot)
01134          break;
01135       if(AST_FORMAT_LIST[slot-1].bits != format) {
01136          pref->order[y] = slot;
01137          pref->framing[y++] = size;
01138       }
01139    }
01140    
01141 }

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

Set packet size for codec.

Definition at line 1171 of file frame.c.

References ast_format_list::def_ms, ast_codec_pref::framing, ast_format_list::inc_ms, ast_format_list::max_ms, ast_format_list::min_ms, and ast_codec_pref::order.

01172 {
01173    int x, index = -1;
01174 
01175    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01176       if(AST_FORMAT_LIST[x].bits == format) {
01177          index = x;
01178          break;
01179       }
01180    }
01181 
01182    if(index < 0)
01183       return -1;
01184 
01185    /* size validation */
01186    if(!framems)
01187       framems = AST_FORMAT_LIST[index].def_ms;
01188 
01189    if(AST_FORMAT_LIST[index].inc_ms && framems % AST_FORMAT_LIST[index].inc_ms) /* avoid division by zero */
01190       framems -= framems % AST_FORMAT_LIST[index].inc_ms;
01191 
01192    if(framems < AST_FORMAT_LIST[index].min_ms)
01193       framems = AST_FORMAT_LIST[index].min_ms;
01194 
01195    if(framems > AST_FORMAT_LIST[index].max_ms)
01196       framems = AST_FORMAT_LIST[index].max_ms;
01197 
01198 
01199    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01200       if(pref->order[x] == (index + 1)) {
01201          pref->framing[x] = framems;
01202          break;
01203       }
01204    }
01205 
01206    return x;
01207 }

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

Dump audio codec preference list into a string.

Definition at line 1069 of file frame.c.

References ast_codec_pref_index(), and ast_getformatname().

01070 {
01071    int x, codec; 
01072    size_t total_len, slen;
01073    char *formatname;
01074    
01075    memset(buf,0,size);
01076    total_len = size;
01077    buf[0] = '(';
01078    total_len--;
01079    for(x = 0; x < 32 ; x++) {
01080       if(total_len <= 0)
01081          break;
01082       if(!(codec = ast_codec_pref_index(pref,x)))
01083          break;
01084       if((formatname = ast_getformatname(codec))) {
01085          slen = strlen(formatname);
01086          if(slen > total_len)
01087             break;
01088          strncat(buf,formatname,total_len);
01089          total_len -= slen;
01090       }
01091       if(total_len && x < 31 && ast_codec_pref_index(pref , x + 1)) {
01092          strncat(buf,"|",total_len);
01093          total_len--;
01094       }
01095    }
01096    if(total_len) {
01097       strncat(buf,")",total_len);
01098       total_len--;
01099    }
01100 
01101    return size - total_len;
01102 }

int ast_frame_adjust_volume ( struct ast_frame f,
int  adjustment 
)

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

Parameters:
f The frame containing the samples (must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR)
adjustment The number of dB to adjust up or down.
Returns:
0 for success, non-zero for an error

Definition at line 1542 of file frame.c.

References AST_FORMAT_SLINEAR, AST_FRAME_VOICE, ast_slinear_saturated_divide(), ast_slinear_saturated_multiply(), ast_frame::data, ast_frame::frametype, ast_frame::samples, and ast_frame::subclass.

01543 {
01544    int count;
01545    short *fdata = f->data;
01546    short adjust_value = abs(adjustment);
01547 
01548    if ((f->frametype != AST_FRAME_VOICE) || (f->subclass != AST_FORMAT_SLINEAR))
01549       return -1;
01550 
01551    if (!adjustment)
01552       return 0;
01553 
01554    for (count = 0; count < f->samples; count++) {
01555       if (adjustment > 0) {
01556          ast_slinear_saturated_multiply(&fdata[count], &adjust_value);
01557       } else if (adjustment < 0) {
01558          ast_slinear_saturated_divide(&fdata[count], &adjust_value);
01559       }
01560    }
01561 
01562    return 0;
01563 }

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

Dump a frame for debugging purposes

Definition at line 759 of file frame.c.

References AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_FLASH, AST_CONTROL_HANGUP, AST_CONTROL_OFFHOOK, AST_CONTROL_OPTION, AST_CONTROL_RADIO_KEY, AST_CONTROL_RADIO_UNKEY, AST_CONTROL_RING, AST_CONTROL_RINGING, AST_CONTROL_TAKEOFFHOOK, AST_CONTROL_WINK, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, AST_FRAME_HTML, AST_FRAME_IAX, AST_FRAME_IMAGE, AST_FRAME_MODEM, AST_FRAME_NULL, AST_FRAME_TEXT, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_getformatname(), AST_HTML_BEGIN, AST_HTML_DATA, AST_HTML_END, AST_HTML_LDCOMPLETE, AST_HTML_LINKREJECT, AST_HTML_LINKURL, AST_HTML_NOSUPPORT, AST_HTML_UNLINK, AST_HTML_URL, AST_MODEM_T38, AST_MODEM_V150, ast_strlen_zero(), ast_verbose(), COLOR_BLACK, COLOR_BRCYAN, COLOR_BRGREEN, COLOR_BRMAGENTA, COLOR_BRRED, COLOR_YELLOW, ast_frame::data, ast_frame::frametype, ast_frame::subclass, and term_color().

00760 {
00761    const char noname[] = "unknown";
00762    char ftype[40] = "Unknown Frametype";
00763    char cft[80];
00764    char subclass[40] = "Unknown Subclass";
00765    char csub[80];
00766    char moreinfo[40] = "";
00767    char cn[60];
00768    char cp[40];
00769    char cmn[40];
00770 
00771    if (!name)
00772       name = noname;
00773 
00774 
00775    if (!f) {
00776       ast_verbose("%s [ %s (NULL) ] [%s]\n", 
00777          term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
00778          term_color(cft, "HANGUP", COLOR_BRRED, COLOR_BLACK, sizeof(cft)), 
00779          term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
00780       return;
00781    }
00782    /* XXX We should probably print one each of voice and video when the format changes XXX */
00783    if (f->frametype == AST_FRAME_VOICE)
00784       return;
00785    if (f->frametype == AST_FRAME_VIDEO)
00786       return;
00787    switch(f->frametype) {
00788    case AST_FRAME_DTMF_BEGIN:
00789       strcpy(ftype, "DTMF Begin");
00790       subclass[0] = f->subclass;
00791       subclass[1] = '\0';
00792       break;
00793    case AST_FRAME_DTMF_END:
00794       strcpy(ftype, "DTMF End");
00795       subclass[0] = f->subclass;
00796       subclass[1] = '\0';
00797       break;
00798    case AST_FRAME_CONTROL:
00799       strcpy(ftype, "Control");
00800       switch(f->subclass) {
00801       case AST_CONTROL_HANGUP:
00802          strcpy(subclass, "Hangup");
00803          break;
00804       case AST_CONTROL_RING:
00805          strcpy(subclass, "Ring");
00806          break;
00807       case AST_CONTROL_RINGING:
00808          strcpy(subclass, "Ringing");
00809          break;
00810       case AST_CONTROL_ANSWER:
00811          strcpy(subclass, "Answer");
00812          break;
00813       case AST_CONTROL_BUSY:
00814          strcpy(subclass, "Busy");
00815          break;
00816       case AST_CONTROL_TAKEOFFHOOK:
00817          strcpy(subclass, "Take Off Hook");
00818          break;
00819       case AST_CONTROL_OFFHOOK:
00820          strcpy(subclass, "Line Off Hook");
00821          break;
00822       case AST_CONTROL_CONGESTION:
00823          strcpy(subclass, "Congestion");
00824          break;
00825       case AST_CONTROL_FLASH:
00826          strcpy(subclass, "Flash");
00827          break;
00828       case AST_CONTROL_WINK:
00829          strcpy(subclass, "Wink");
00830          break;
00831       case AST_CONTROL_OPTION:
00832          strcpy(subclass, "Option");
00833          break;
00834       case AST_CONTROL_RADIO_KEY:
00835          strcpy(subclass, "Key Radio");
00836          break;
00837       case AST_CONTROL_RADIO_UNKEY:
00838          strcpy(subclass, "Unkey Radio");
00839          break;
00840       case -1:
00841          strcpy(subclass, "Stop generators");
00842          break;
00843       default:
00844          snprintf(subclass, sizeof(subclass), "Unknown control '%d'", f->subclass);
00845       }
00846       break;
00847    case AST_FRAME_NULL:
00848       strcpy(ftype, "Null Frame");
00849       strcpy(subclass, "N/A");
00850       break;
00851    case AST_FRAME_IAX:
00852       /* Should never happen */
00853       strcpy(ftype, "IAX Specific");
00854       snprintf(subclass, sizeof(subclass), "IAX Frametype %d", f->subclass);
00855       break;
00856    case AST_FRAME_TEXT:
00857       strcpy(ftype, "Text");
00858       strcpy(subclass, "N/A");
00859       ast_copy_string(moreinfo, f->data, sizeof(moreinfo));
00860       break;
00861    case AST_FRAME_IMAGE:
00862       strcpy(ftype, "Image");
00863       snprintf(subclass, sizeof(subclass), "Image format %s\n", ast_getformatname(f->subclass));
00864       break;
00865    case AST_FRAME_HTML:
00866       strcpy(ftype, "HTML");
00867       switch(f->subclass) {
00868       case AST_HTML_URL:
00869          strcpy(subclass, "URL");
00870          ast_copy_string(moreinfo, f->data, sizeof(moreinfo));
00871          break;
00872       case AST_HTML_DATA:
00873          strcpy(subclass, "Data");
00874          break;
00875       case AST_HTML_BEGIN:
00876          strcpy(subclass, "Begin");
00877          break;
00878       case AST_HTML_END:
00879          strcpy(subclass, "End");
00880          break;
00881       case AST_HTML_LDCOMPLETE:
00882          strcpy(subclass, "Load Complete");
00883          break;
00884       case AST_HTML_NOSUPPORT:
00885          strcpy(subclass, "No Support");
00886          break;
00887       case AST_HTML_LINKURL:
00888          strcpy(subclass, "Link URL");
00889          ast_copy_string(moreinfo, f->data, sizeof(moreinfo));
00890          break;
00891       case AST_HTML_UNLINK:
00892          strcpy(subclass, "Unlink");
00893          break;
00894       case AST_HTML_LINKREJECT:
00895          strcpy(subclass, "Link Reject");
00896          break;
00897       default:
00898          snprintf(subclass, sizeof(subclass), "Unknown HTML frame '%d'\n", f->subclass);
00899          break;
00900       }
00901       break;
00902    case AST_FRAME_MODEM:
00903       strcpy(ftype, "Modem");
00904       switch (f->subclass) {
00905       case AST_MODEM_T38:
00906          strcpy(subclass, "T.38");
00907          break;
00908       case AST_MODEM_V150:
00909          strcpy(subclass, "V.150");
00910          break;
00911       default:
00912          snprintf(subclass, sizeof(subclass), "Unknown MODEM frame '%d'\n", f->subclass);
00913          break;
00914       }
00915       break;
00916    default:
00917       snprintf(ftype, sizeof(ftype), "Unknown Frametype '%d'", f->frametype);
00918    }
00919    if (!ast_strlen_zero(moreinfo))
00920       ast_verbose("%s [ TYPE: %s (%d) SUBCLASS: %s (%d) '%s' ] [%s]\n",  
00921              term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
00922              term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
00923              f->frametype, 
00924              term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
00925              f->subclass, 
00926              term_color(cmn, moreinfo, COLOR_BRGREEN, COLOR_BLACK, sizeof(cmn)),
00927              term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
00928    else
00929       ast_verbose("%s [ TYPE: %s (%d) SUBCLASS: %s (%d) ] [%s]\n",  
00930              term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
00931              term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
00932              f->frametype, 
00933              term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
00934              f->subclass, 
00935              term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
00936 }

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

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.

Parameters:
source Request a frame be allocated. source is an optional source of the frame, len is the requested length, or "0" if the caller will supply the buffer
Frees a frame

Parameters:
fr Frame to free
cache Whether to consider this frame for frame caching

Definition at line 334 of file frame.c.

References AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_UNLOCK, AST_MALLOCD_DATA, AST_MALLOCD_HDR, AST_MALLOCD_SRC, ast_frame::data, FRAME_CACHE_MAX_SIZE, frames, free, ast_frame_cache::list, ast_frame::mallocd, ast_frame::offset, ast_frame_cache::size, and ast_frame::src.

00335 {
00336    if (!fr->mallocd)
00337       return;
00338 
00339 #if !defined(LOW_MEMORY)
00340    if (cache && fr->mallocd == AST_MALLOCD_HDR) {
00341       /* Cool, only the header is malloc'd, let's just cache those for now 
00342        * to keep things simple... */
00343       struct ast_frame_cache *frames;
00344 
00345       if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames))) 
00346           && frames->size < FRAME_CACHE_MAX_SIZE) {
00347          AST_LIST_INSERT_HEAD(&frames->list, fr, frame_list);
00348          frames->size++;
00349          return;
00350       }
00351    }
00352 #endif
00353    
00354    if (fr->mallocd & AST_MALLOCD_DATA) {
00355       if (fr->data) 
00356          free(fr->data - fr->offset);
00357    }
00358    if (fr->mallocd & AST_MALLOCD_SRC) {
00359       if (fr->src)
00360          free((char *)fr->src);
00361    }
00362    if (fr->mallocd & AST_MALLOCD_HDR) {
00363 #ifdef TRACE_FRAMES
00364       AST_LIST_LOCK(&headerlist);
00365       headers--;
00366       AST_LIST_REMOVE(&headerlist, fr, frame_list);
00367       AST_LIST_UNLOCK(&headerlist);
00368 #endif         
00369       free(fr);
00370    }
00371 }

int ast_frame_slinear_sum ( struct ast_frame f1,
struct ast_frame f2 
)

Sums two frames of audio samples.

Parameters:
f1 The first frame (which will contain the result)
f2 The second frame
Returns:
0 for success, non-zero for an error
The frames must be AST_FRAME_VOICE and must contain AST_FORMAT_SLINEAR samples, and must contain the same number of samples.

Definition at line 1565 of file frame.c.

References AST_FORMAT_SLINEAR, AST_FRAME_VOICE, ast_slinear_saturated_add(), ast_frame::data, ast_frame::frametype, ast_frame::samples, and ast_frame::subclass.

01566 {
01567    int count;
01568    short *data1, *data2;
01569 
01570    if ((f1->frametype != AST_FRAME_VOICE) || (f1->subclass != AST_FORMAT_SLINEAR))
01571       return -1;
01572 
01573    if ((f2->frametype != AST_FRAME_VOICE) || (f2->subclass != AST_FORMAT_SLINEAR))
01574       return -1;
01575 
01576    if (f1->samples != f2->samples)
01577       return -1;
01578 
01579    for (count = 0, data1 = f1->data, data2 = f2->data;
01580         count < f1->samples;
01581         count++, data1++, data2++)
01582       ast_slinear_saturated_add(data1, data2);
01583 
01584    return 0;
01585 }

struct ast_frame* ast_frdup ( const struct ast_frame fr  )  [read]

Copies a frame.

Parameters:
fr frame to copy Duplicates a frame -- should only rarely be used, typically frisolate is good enough
Returns:
Returns a frame on success, NULL on error

Definition at line 434 of file frame.c.

References ast_calloc_cache, AST_FRIENDLY_OFFSET, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_MALLOCD_HDR, ast_frame::data, ast_frame::datalen, ast_frame::delivery, frames, ast_frame::frametype, ast_frame::has_timing_info, ast_frame::len, len, ast_frame_cache::list, ast_frame::mallocd, ast_frame::mallocd_hdr_len, ast_frame::offset, ast_frame::samples, ast_frame::seqno, ast_frame_cache::size, ast_frame::src, ast_frame::subclass, and ast_frame::ts.

00435 {
00436    struct ast_frame *out = NULL;
00437    int len, srclen = 0;
00438    void *buf = NULL;
00439 
00440 #if !defined(LOW_MEMORY)
00441    struct ast_frame_cache *frames;
00442 #endif
00443 
00444    /* Start with standard stuff */
00445    len = sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
00446    /* If we have a source, add space for it */
00447    /*
00448     * XXX Watch out here - if we receive a src which is not terminated
00449     * properly, we can be easily attacked. Should limit the size we deal with.
00450     */
00451    if (f->src)
00452       srclen = strlen(f->src);
00453    if (srclen > 0)
00454       len += srclen + 1;
00455    
00456 #if !defined(LOW_MEMORY)
00457    if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames)))) {
00458       AST_LIST_TRAVERSE_SAFE_BEGIN(&frames->list, out, frame_list) {
00459          if (out->mallocd_hdr_len >= len) {
00460             size_t mallocd_len = out->mallocd_hdr_len;
00461             AST_LIST_REMOVE_CURRENT(&frames->list, frame_list);
00462             memset(out, 0, sizeof(*out));
00463             out->mallocd_hdr_len = mallocd_len;
00464             buf = out;
00465             frames->size--;
00466             break;
00467          }
00468       }
00469       AST_LIST_TRAVERSE_SAFE_END
00470    }
00471 #endif
00472 
00473    if (!buf) {
00474       if (!(buf = ast_calloc_cache(1, len)))
00475          return NULL;
00476       out = buf;
00477       out->mallocd_hdr_len = len;
00478    }
00479 
00480    out->frametype = f->frametype;
00481    out->subclass = f->subclass;
00482    out->datalen = f->datalen;
00483    out->samples = f->samples;
00484    out->delivery = f->delivery;
00485    /* Set us as having malloc'd header only, so it will eventually
00486       get freed. */
00487    out->mallocd = AST_MALLOCD_HDR;
00488    out->offset = AST_FRIENDLY_OFFSET;
00489    if (out->datalen) {
00490       out->data = buf + sizeof(*out) + AST_FRIENDLY_OFFSET;
00491       memcpy(out->data, f->data, out->datalen); 
00492    }
00493    if (srclen > 0) {
00494       out->src = buf + sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
00495       /* Must have space since we allocated for it */
00496       strcpy((char *)out->src, f->src);
00497    }
00498    out->has_timing_info = f->has_timing_info;
00499    out->ts = f->ts;
00500    out->len = f->len;
00501    out->seqno = f->seqno;
00502    return out;
00503 }

static void force_inline ast_frfree ( struct ast_frame fr  )  [static]

Definition at line 388 of file frame.h.

References ast_frame_free().

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_bridge_call(), ast_channel_free(), ast_channel_spy_free(), ast_channel_spy_read_frame(), ast_dsp_process(), ast_feature_request_and_dial(), ast_generic_bridge(), ast_jb_destroy(), ast_jb_put(), ast_masq_park_call(), ast_queue_frame(), ast_recvtext(), ast_rtp_write(), ast_safe_sleep_conditional(), ast_send_image(), ast_slinfactory_destroy(), ast_slinfactory_read(), ast_tonepair(), ast_translate(), ast_udptl_bridge(), ast_waitfordigit_full(), ast_write(), async_wait(), 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(), copy_data_from_queue(), create_jb(), dictate_exec(), disa_exec(), do_parking_thread(), do_waiting(), echo_exec(), find_cache(), gen_generate(), handle_invite_replaces(), handle_recordfile(), iax2_bridge(), iax_park_thread(), ices_exec(), isAnsweringMachine(), jb_get_and_deliver(), measurenoise(), moh_files_generator(), monitor_dial(), mp3_exec(), NBScat_exec(), queue_frame_to_spies(), receive_dtmf_digits(), record_exec(), recordthread(), rpt(), rpt_exec(), run_agi(), send_tone_burst(), send_waveform_to_channel(), sendurl_exec(), sms_exec(), speech_background(), spy_generate(), ss_thread(), wait_for_answer(), wait_for_hangup(), wait_for_winner(), waitforring_exec(), waitstream_core(), and zt_bridge().

00389 {
00390    ast_frame_free(fr, 1);
00391 }

struct ast_frame* ast_frisolate ( struct ast_frame fr  )  [read]

Makes a frame independent of any static storage.

Parameters:
fr frame to act upon Take a frame, and if it's not been malloc'd, make a malloc'd copy and if the data hasn't been malloced then make the data malloc'd. If you need to store frames, say for queueing, then you should call this function.
Returns:
Returns a frame on success, NULL on error

Definition at line 378 of file frame.c.

References ast_frame_header_new(), AST_FRIENDLY_OFFSET, ast_malloc, AST_MALLOCD_DATA, AST_MALLOCD_HDR, AST_MALLOCD_SRC, ast_strdup, ast_frame::data, ast_frame::datalen, ast_frame::frametype, free, ast_frame::has_timing_info, ast_frame::len, ast_frame::mallocd, ast_frame::offset, ast_frame::samples, ast_frame::seqno, ast_frame::src, ast_frame::subclass, and ast_frame::ts.

00379 {
00380    struct ast_frame *out;
00381    void *newdata;
00382    
00383    if (!(fr->mallocd & AST_MALLOCD_HDR)) {
00384       /* Allocate a new header if needed */
00385       if (!(out = ast_frame_header_new()))
00386          return NULL;
00387       out->frametype = fr->frametype;
00388       out->subclass = fr->subclass;
00389       out->datalen = fr->datalen;
00390       out->samples = fr->samples;
00391       out->offset = fr->offset;
00392       out->data = fr->data;
00393       /* Copy the timing data */
00394       out->has_timing_info = fr->has_timing_info;
00395       if (fr->has_timing_info) {
00396          out->ts = fr->ts;
00397          out->len = fr->len;
00398          out->seqno = fr->seqno;
00399       }
00400    } else
00401       out = fr;
00402    
00403    if (!(fr->mallocd & AST_MALLOCD_SRC)) {
00404       if (fr->src) {
00405          if (!(out->src = ast_strdup(fr->src))) {
00406             if (out != fr)
00407                free(out);
00408             return NULL;
00409          }
00410       }
00411    } else
00412       out->src = fr->src;
00413    
00414    if (!(fr->mallocd & AST_MALLOCD_DATA))  {
00415       if (!(newdata = ast_malloc(fr->datalen + AST_FRIENDLY_OFFSET))) {
00416          if (out->src != fr->src)
00417             free((void *) out->src);
00418          if (out != fr)
00419             free(out);
00420          return NULL;
00421       }
00422       newdata += AST_FRIENDLY_OFFSET;
00423       out->offset = AST_FRIENDLY_OFFSET;
00424       out->datalen = fr->datalen;
00425       memcpy(newdata, fr->data, fr->datalen);
00426       out->data = newdata;
00427    }
00428 
00429    out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA;
00430    
00431    return out;
00432 }

struct ast_format_list* ast_get_format_list ( size_t *  size  )  [read]

Definition at line 521 of file frame.c.

00522 {
00523    *size = (sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]));
00524    return AST_FORMAT_LIST;
00525 }

struct ast_format_list* ast_get_format_list_index ( int  index  )  [read]

Definition at line 516 of file frame.c.

00517 {
00518    return &AST_FORMAT_LIST[index];
00519 }

int ast_getformatbyname ( const char *  name  ) 

Gets a format from a name.

Parameters:
name string of format
Returns:
This returns the form of the format in binary on success, 0 on error.

Definition at line 587 of file frame.c.

References ast_expand_codec_alias(), ast_format_list::bits, and format.

00588 {
00589    int x, all, format = 0;
00590 
00591    all = strcasecmp(name, "all") ? 0 : 1;
00592    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
00593       if(AST_FORMAT_LIST[x].visible && (all || 
00594            !strcasecmp(AST_FORMAT_LIST[x].name,name) ||
00595            !strcasecmp(AST_FORMAT_LIST[x].name,ast_expand_codec_alias(name)))) {
00596          format |= AST_FORMAT_LIST[x].bits;
00597          if(!all)
00598             break;
00599       }
00600    }
00601 
00602    return format;
00603 }

char* ast_getformatname ( int  format  ) 

Get the name of a format.

Parameters:
format id of format
Returns:
A static string containing the name of the format or "UNKN" if unknown.

Definition at line 527 of file frame.c.

References ast_format_list::bits, ast_format_list::name, and ast_format_list::visible.

00528 {
00529    int x;
00530    char *ret = "unknown";
00531    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
00532       if(AST_FORMAT_LIST[x].visible && AST_FORMAT_LIST[x].bits == format) {
00533          ret = AST_FORMAT_LIST[x].name;
00534          break;
00535       }
00536    }
00537    return ret;
00538 }

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

Get the names of a set of formats.

Parameters:
buf a buffer for the output string
size size of buf (bytes)
format the format (combined IDs of codecs) Prints a list of readable codec names corresponding to "format". ex: for format=AST_FORMAT_GSM|AST_FORMAT_SPEEX|AST_FORMAT_ILBC it will return "0x602 (GSM|SPEEX|ILBC)"
Returns:
The return value is buf.

Definition at line 540 of file frame.c.

References ast_format_list::bits, len, name, and ast_format_list::visible.

00541 {
00542    int x;
00543    unsigned len;
00544    char *start, *end = buf;
00545 
00546    if (!size)
00547       return buf;
00548    snprintf(end, size, "0x%x (", format);
00549    len = strlen(end);
00550    end += len;
00551    size -= len;
00552    start = end;
00553    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
00554       if (AST_FORMAT_LIST[x].visible && (AST_FORMAT_LIST[x].bits & format)) {
00555          snprintf(end, size,"%s|",AST_FORMAT_LIST[x].name);
00556          len = strlen(end);
00557          end += len;
00558          size -= len;
00559       }
00560    }
00561    if (start == end)
00562       snprintf(start, size, "nothing)");
00563    else if (size > 1)
00564       *(end -1) = ')';
00565    return buf;
00566 }

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.

Definition at line 1272 of file frame.c.

References ast_codec_pref_append(), ast_codec_pref_remove(), ast_codec_pref_setsize(), AST_FORMAT_AUDIO_MASK, ast_getformatbyname(), ast_log(), ast_strdupa, format, LOG_DEBUG, LOG_WARNING, option_debug, parse(), and strsep().

01273 {
01274    char *parse = NULL, *this = NULL, *psize = NULL;
01275    int format = 0, framems = 0;
01276 
01277    parse = ast_strdupa(list);
01278    while ((this = strsep(&parse, ","))) {
01279       framems = 0;
01280       if ((psize = strrchr(this, ':'))) {
01281          *psize++ = '\0';
01282          if (option_debug)
01283             ast_log(LOG_DEBUG,"Packetization for codec: %s is %s\n", this, psize);
01284          framems = atoi(psize);
01285          if (framems < 0)
01286             framems = 0;
01287       }
01288       if (!(format = ast_getformatbyname(this))) {
01289          ast_log(LOG_WARNING, "Cannot %s unknown format '%s'\n", allowing ? "allow" : "disallow", this);
01290          continue;
01291       }
01292 
01293       if (mask) {
01294          if (allowing)
01295             *mask |= format;
01296          else
01297             *mask &= ~format;
01298       }
01299 
01300       /* Set up a preference list for audio. Do not include video in preferences 
01301          since we can not transcode video and have to use whatever is offered
01302        */
01303       if (pref && (format & AST_FORMAT_AUDIO_MASK)) {
01304          if (strcasecmp(this, "all")) {
01305             if (allowing) {
01306                ast_codec_pref_append(pref, format);
01307                ast_codec_pref_setsize(pref, format, framems);
01308             }
01309             else
01310                ast_codec_pref_remove(pref, format);
01311          } else if (!allowing) {
01312             memset(pref, 0, sizeof(*pref));
01313          }
01314       }
01315    }
01316 }

void ast_smoother_free ( struct ast_smoother s  ) 

Definition at line 281 of file frame.c.

References free.

00282 {
00283    free(s);
00284 }

int ast_smoother_get_flags ( struct ast_smoother smoother  ) 

Definition at line 155 of file frame.c.

References ast_smoother::flags.

00156 {
00157    return s->flags;
00158 }

struct ast_smoother* ast_smoother_new ( int  bytes  )  [read]

Definition at line 145 of file frame.c.

References ast_malloc, ast_smoother_reset(), and s.

00146 {
00147    struct ast_smoother *s;
00148    if (size < 1)
00149       return NULL;
00150    if ((s = ast_malloc(sizeof(*s))))
00151       ast_smoother_reset(s, size);
00152    return s;
00153 }

struct ast_frame* ast_smoother_read ( struct ast_smoother s  )  [read]

Definition at line 231 of file frame.c.

References AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log(), AST_SMOOTHER_FLAG_G729, ast_tvadd(), ast_smoother::data, ast_frame::data, ast_frame::datalen, ast_smoother::delivery, ast_frame::delivery, ast_smoother::f, ast_smoother::flags, ast_smoother::format, ast_smoother::framedata, ast_frame::frametype, ast_smoother::len, len, LOG_WARNING, ast_frame::offset, ast_smoother::opt, ast_frame::samples, ast_smoother::samplesperbyte, ast_smoother::size, and ast_frame::subclass.

00232 {
00233    struct ast_frame *opt;
00234    int len;
00235 
00236    /* IF we have an optimization frame, send it */
00237    if (s->opt) {
00238       if (s->opt->offset < AST_FRIENDLY_OFFSET)
00239          ast_log(LOG_WARNING, "Returning a frame of inappropriate offset (%d).\n",
00240                      s->opt->offset);
00241       opt = s->opt;
00242       s->opt = NULL;
00243       return opt;
00244    }
00245 
00246    /* Make sure we have enough data */
00247    if (s->len < s->size) {
00248       /* Or, if this is a G.729 frame with VAD on it, send it immediately anyway */
00249       if (!((s->flags & AST_SMOOTHER_FLAG_G729) && (s->size % 10)))
00250          return NULL;
00251    }
00252    len = s->size;
00253    if (len > s->len)
00254       len = s->len;
00255    /* Make frame */
00256    s->f.frametype = AST_FRAME_VOICE;
00257    s->f.subclass = s->format;
00258    s->f.data = s->framedata + AST_FRIENDLY_OFFSET;
00259    s->f.offset = AST_FRIENDLY_OFFSET;
00260    s->f.datalen = len;
00261    /* Samples will be improper given VAD, but with VAD the concept really doesn't even exist */
00262    s->f.samples = len * s->samplesperbyte;   /* XXX rounding */
00263    s->f.delivery = s->delivery;
00264    /* Fill Data */
00265    memcpy(s->f.data, s->data, len);
00266    s->len -= len;
00267    /* Move remaining data to the front if applicable */
00268    if (s->len) {
00269       /* In principle this should all be fine because if we are sending
00270          G.729 VAD, the next timestamp will take over anyawy */
00271       memmove(s->data, s->data + len, s->len);
00272       if (!ast_tvzero(s->delivery)) {
00273          /* If we have delivery time, increment it, otherwise, leave it at 0 */
00274          s->delivery = ast_tvadd(s->delivery, ast_samp2tv(s->f.samples, 8000));
00275       }
00276    }
00277    /* Return frame */
00278    return &s->f;
00279 }

void ast_smoother_reset ( struct ast_smoother s,
int  bytes 
)

Definition at line 139 of file frame.c.

References ast_smoother::size.

00140 {
00141    memset(s, 0, sizeof(*s));
00142    s->size = size;
00143 }

void ast_smoother_set_flags ( struct ast_smoother smoother,
int  flags 
)

Definition at line 160 of file frame.c.

References ast_smoother::flags.

00161 {
00162    s->flags = flags;
00163 }

int ast_smoother_test_flag ( struct ast_smoother s,
int  flag 
)

Definition at line 165 of file frame.c.

References ast_smoother::flags.

00166 {
00167    return (s->flags & flag);
00168 }

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

Definition at line 505 of file frame.c.

00506 {
00507    int i;
00508    unsigned short *dst_s = dst;
00509    const unsigned short *src_s = src;
00510 
00511    for (i = 0; i < samples; i++)
00512       dst_s[i] = (src_s[i]<<8) | (src_s[i]>>8);
00513 }


Variable Documentation

struct ast_frame ast_null_frame

Queueing a null frame is fairly common, so we declare a global null frame object for this purpose instead of having to declare one on the stack

Definition at line 137 of file frame.c.


Generated on Wed Aug 15 01:25:11 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.3