Mon Mar 31 07:40:47 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_MP4_VIDEO   (1 << 22)
#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) }
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_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 Frees a frame.
int ast_frame_slinear_sum (struct ast_frame *f1, struct ast_frame *f2)
 Sums two frames of audio samples.
ast_frameast_frdup (const struct ast_frame *fr)
 Copies a frame.
ast_frameast_frisolate (struct ast_frame *fr)
 Makes a frame independent of any static storage.
ast_format_listast_get_format_list (size_t *size)
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)
ast_smootherast_smoother_new (int bytes)
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

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 240 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 236 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_generate(), zt_new(), zt_read(), and zt_write().

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

Maximum audio mask

Definition at line 258 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(), 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 254 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_format_rate(), convertcap(), and g722tolin_sample().

#define AST_FORMAT_G723_1   (1 << 0)

G.723.1 compression

Definition at line 230 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 252 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 238 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 246 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(), zap_framein(), and zap_translate().

#define AST_FORMAT_GSM   (1 << 1)

GSM compression

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

Referenced by codec_ast2skinny(), and codec_skinny2ast().

#define AST_FORMAT_H263   (1 << 19)

H.263 Video

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

#define AST_FORMAT_H264   (1 << 21)

H.264 Video

Definition at line 270 of file frame.h.

Referenced by h264_read(), and h264_write().

#define AST_FORMAT_ILBC   (1 << 10)

iLBC Free Compression

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(), ast_codec_interp_len(), convertcap(), ilbc_read(), ilbc_write(), and ilbctolin_sample().

#define AST_FORMAT_JPEG   (1 << 16)

JPEG Images

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

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

#define AST_FORMAT_MP4_VIDEO   (1 << 22)

MPEG4 Video

Definition at line 272 of file frame.h.

#define AST_FORMAT_PNG   (1 << 17)

PNG Images

Definition at line 262 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 242 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(), attempt_thread(), audio_audiohook_write_list(), audiohook_read_frame_both(), audiohook_read_frame_single(), background_detect_exec(), build_conf(), chanspy_exec(), conf_run(), connect_link(), dictate_exec(), do_waiting(), eagi_exec(), extenspy_exec(), fast_originate(), handle_recordfile(), iax_frame_wrap(), ices_exec(), isAnsweringMachine(), linear_alloc(), linear_generator(), lintoadpcm_sample(), lintoalaw_sample(), lintog722_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(), mp3_open(), mp3_read(), mwanalyze_exec(), nbs_request(), nbs_xwrite(), NBScat_exec(), nv_background_detect_exec(), nv_detectfax_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(), rxfax_exec(), send_waveform_to_channel(), silence_generator_generate(), slinear_read(), slinear_write(), sms_generate(), socket_process(), speech_background(), speech_create(), spy_generate(), tonepair_alloc(), txfax_exec(), wav_read(), wav_write(), zt_new(), zt_read(), and zt_write().

#define AST_FORMAT_SPEEX   (1 << 9)

SpeeX Free Compression

Definition at line 248 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 234 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 275 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 426 of file frame.h.

Referenced by ast_rtp_read(), and socket_process().

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

Definition at line 425 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 __adsi_transmit_messages(), __ast_play_and_record(), action_zapdialoffhook(), 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(), 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(), nv_background_detect_exec(), nv_detectfax_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(), 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 179 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 401 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_masq_park_call(), ast_queue_frame(), ast_recvtext(), ast_rtp_write(), ast_safe_sleep_conditional(), ast_send_image(), ast_slinfactory_destroy(), ast_slinfactory_feed(), 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(), 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_get_and_deliver(), measurenoise(), moh_files_generator(), monitor_dial(), mp3_exec(), mwanalyze_exec(), NBScat_exec(), nv_background_detect_exec(), nv_detectfax_exec(), receive_dtmf_digits(), recordthread(), rpt(), run_agi(), rxfax_exec(), send_tone_burst(), send_waveform_to_channel(), sendurl_exec(), speech_background(), spy_generate(), ss_thread(), txfax_exec(), wait_for_answer(), wait_for_hangup(), wait_for_winner(), waitforring_exec(), waitstream_core(), and zt_bridge().

#define AST_FRIENDLY_OFFSET   64

Definition at line 190 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(), mp3_read(), mwanalyze_exec(), NBScat_exec(), newpvt(), ogg_vorbis_read(), oss_read(), pcm_read(), phone_read(), process_rfc3389(), rxfax_exec(), send_tone_burst(), send_waveform_to_channel(), slinear_read(), sms_generate(), txfax_exec(), vox_read(), wav_read(), zap_frameout(), and zt_read().

#define AST_HTML_BEGIN   4

Beginning frame

Definition at line 214 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_DATA   2

Data frame

Definition at line 212 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_END   8

End frame

Definition at line 216 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_LDCOMPLETE   16

Load is complete

Definition at line 218 of file frame.h.

Referenced by ast_frame_dump(), and sendurl_exec().

#define AST_HTML_LINKREJECT   20

Reject link request

Definition at line 226 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_LINKURL   18

Send URL, and track

Definition at line 222 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_NOSUPPORT   17

Peer is unable to support HTML

Definition at line 220 of file frame.h.

Referenced by ast_frame_dump(), and sendurl_exec().

#define AST_HTML_UNLINK   19

No more HTML linkage

Definition at line 224 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_URL   1

Sending a URL

Definition at line 210 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 198 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 196 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 200 of file frame.h.

Referenced by ast_frame_free(), and ast_frisolate().

#define AST_MIN_OFFSET   32

Definition at line 193 of file frame.h.

Referenced by __ast_smoother_feed().

#define AST_MODEM_T38   1

T.38 Fax-over-IP

Definition at line 204 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 206 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 321 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 343 of file frame.h.

Referenced by zt_setoption().

#define AST_OPTION_FLAG_ACCEPT   1

Definition at line 304 of file frame.h.

#define AST_OPTION_FLAG_ANSWER   5

Definition at line 307 of file frame.h.

#define AST_OPTION_FLAG_QUERY   4

Definition at line 306 of file frame.h.

#define AST_OPTION_FLAG_REJECT   2

Definition at line 305 of file frame.h.

#define AST_OPTION_FLAG_REQUEST   0

Definition at line 303 of file frame.h.

Referenced by ast_bridge_call(), and iax2_setoption().

#define AST_OPTION_FLAG_WTF   6

Definition at line 308 of file frame.h.

#define AST_OPTION_OPRMODE   7

Definition at line 340 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 318 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 337 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 315 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 312 of file frame.h.

Referenced by conf_run(), rpt(), 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 329 of file frame.h.

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

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

Definition at line 488 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 490 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 491 of file frame.h.

#define AST_SMOOTHER_FLAG_BE   (1 << 1)

Definition at line 300 of file frame.h.

Referenced by ast_rtp_write().

#define AST_SMOOTHER_FLAG_G729   (1 << 0)

Definition at line 299 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.

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_TRANSLATOR = (1 << 1),
00134 };

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
AST_CONTROL_SRCUPDATE  Indicate source of media has changed

Definition at line 277 of file frame.h.

00277                             {
00278    AST_CONTROL_HANGUP = 1,    /*!< Other end has hungup */
00279    AST_CONTROL_RING = 2,      /*!< Local ring */
00280    AST_CONTROL_RINGING = 3,   /*!< Remote end is ringing */
00281    AST_CONTROL_ANSWER = 4,    /*!< Remote end has answered */
00282    AST_CONTROL_BUSY = 5,      /*!< Remote end is busy */
00283    AST_CONTROL_TAKEOFFHOOK = 6,  /*!< Make it go off hook */
00284    AST_CONTROL_OFFHOOK = 7,   /*!< Line is off hook */
00285    AST_CONTROL_CONGESTION = 8,   /*!< Congestion (circuits busy) */
00286    AST_CONTROL_FLASH = 9,     /*!< Flash hook */
00287    AST_CONTROL_WINK = 10,     /*!< Wink */
00288    AST_CONTROL_OPTION = 11,   /*!< Set a low-level option */
00289    AST_CONTROL_RADIO_KEY = 12,   /*!< Key Radio */
00290    AST_CONTROL_RADIO_UNKEY = 13, /*!< Un-Key Radio */
00291    AST_CONTROL_PROGRESS = 14, /*!< Indicate PROGRESS */
00292    AST_CONTROL_PROCEEDING = 15,  /*!< Indicate CALL PROCEEDING */
00293    AST_CONTROL_HOLD = 16,     /*!< Indicate call is placed on hold */
00294    AST_CONTROL_UNHOLD = 17,   /*!< Indicate call is left from hold */
00295    AST_CONTROL_VIDUPDATE = 18,   /*!< Indicate video frame update */
00296    AST_CONTROL_SRCUPDATE = 20,     /*!< Indicate source of media has changed */
00297 };

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

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


Function Documentation

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

Definition at line 172 of file frame.c.

References AST_FRAME_VOICE, ast_log(), AST_MIN_OFFSET, AST_SMOOTHER_FLAG_G729, ast_swapcopy_samples(), f, LOG_NOTICE, LOG_WARNING, s, and SMOOTHER_SIZE.

00173 {
00174    if (f->frametype != AST_FRAME_VOICE) {
00175       ast_log(LOG_WARNING, "Huh?  Can't smooth a non-voice frame!\n");
00176       return -1;
00177    }
00178    if (!s->format) {
00179       s->format = f->subclass;
00180       s->samplesperbyte = (float)f->samples / (float)f->datalen;
00181    } else if (s->format != f->subclass) {
00182       ast_log(LOG_WARNING, "Smoother was working on %d format frames, now trying to feed %d?\n", s->format, f->subclass);
00183       return -1;
00184    }
00185    if (s->len + f->datalen > SMOOTHER_SIZE) {
00186       ast_log(LOG_WARNING, "Out of smoother space\n");
00187       return -1;
00188    }
00189    if (((f->datalen == s->size) || ((f->datalen < 10) && (s->flags & AST_SMOOTHER_FLAG_G729)))
00190              && !s->opt && (f->offset >= AST_MIN_OFFSET)) {
00191       if (!s->len) {
00192          /* Optimize by sending the frame we just got
00193             on the next read, thus eliminating the douple
00194             copy */
00195          if (swap)
00196             ast_swapcopy_samples(f->data, f->data, f->samples);
00197          s->opt = f;
00198          return 0;
00199       }
00200    }
00201    if (s->flags & AST_SMOOTHER_FLAG_G729) {
00202       if (s->len % 10) {
00203          ast_log(LOG_NOTICE, "Dropping extra frame of G.729 since we already have a VAD frame at the end\n");
00204          return 0;
00205       }
00206    }
00207    if (swap)
00208       ast_swapcopy_samples(s->data+s->len, f->data, f->samples);
00209    else
00210       memcpy(s->data + s->len, f->data, f->datalen);
00211    /* If either side is empty, reset the delivery time */
00212    if (!s->len || ast_tvzero(f->delivery) || ast_tvzero(s->delivery))   /* XXX really ? */
00213       s->delivery = f->delivery;
00214    s->len += f->datalen;
00215    return 0;
00216 }

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 599 of file frame.c.

References AST_FORMAT_LIST, and desc.

Referenced by moh_alloc(), show_codec_n(), show_codec_n_deprecated(), show_codecs(), and show_codecs_deprecated().

00600 {
00601    int x;
00602    char *ret = "unknown";
00603    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
00604       if(AST_FORMAT_LIST[x].visible && AST_FORMAT_LIST[x].bits == codec) {
00605          ret = AST_FORMAT_LIST[x].desc;
00606          break;
00607       }
00608    }
00609    return ret;
00610 }

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 1271 of file frame.c.

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

Referenced by __oh323_new(), gtalk_new(), process_sdp(), sip_new(), and socket_process().

01272 {
01273    int x, ret = 0, slot;
01274 
01275    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01276       slot = pref->order[x];
01277 
01278       if (!slot)
01279          break;
01280       if (formats & AST_FORMAT_LIST[slot-1].bits) {
01281          ret = AST_FORMAT_LIST[slot-1].bits;
01282          break;
01283       }
01284    }
01285    if(ret & AST_FORMAT_AUDIO_MASK)
01286       return ret;
01287 
01288    if (option_debug > 3)
01289       ast_log(LOG_DEBUG, "Could not find preferred codec - %s\n", find_best ? "Going for the best codec" : "Returning zero codec");
01290 
01291       return find_best ? ast_best_codec(formats) : 0;
01292 }

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 1530 of file frame.c.

References AST_FORMAT_ADPCM, AST_FORMAT_ALAW, AST_FORMAT_G722, 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.

Referenced by moh_generate(), and monmp3thread().

01531 {
01532    int len = 0;
01533 
01534    /* XXX Still need speex, g723, and lpc10 XXX */ 
01535    switch(format) {
01536    case AST_FORMAT_ILBC:
01537       len = (samples / 240) * 50;
01538       break;
01539    case AST_FORMAT_GSM:
01540       len = (samples / 160) * 33;
01541       break;
01542    case AST_FORMAT_G729A:
01543       len = samples / 8;
01544       break;
01545    case AST_FORMAT_SLINEAR:
01546       len = samples * 2;
01547       break;
01548    case AST_FORMAT_ULAW:
01549    case AST_FORMAT_ALAW:
01550       len = samples;
01551       break;
01552    case AST_FORMAT_G722:
01553    case AST_FORMAT_ADPCM:
01554    case AST_FORMAT_G726:
01555    case AST_FORMAT_G726_AAL2:
01556       len = samples / 2;
01557       break;
01558    default:
01559       ast_log(LOG_WARNING, "Unable to calculate sample length for format %s\n", ast_getformatname(format));
01560    }
01561 
01562    return len;
01563 }

int ast_codec_get_samples ( struct ast_frame f  ) 

Returns the number of samples contained in the frame.

Definition at line 1487 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(), f, g723_samples(), LOG_WARNING, and speex_samples().

Referenced by ast_rtp_read(), isAnsweringMachine(), moh_generate(), schedule_delivery(), and socket_process().

01488 {
01489    int samples=0;
01490    switch(f->subclass) {
01491    case AST_FORMAT_SPEEX:
01492       samples = speex_samples(f->data, f->datalen);
01493       break;
01494    case AST_FORMAT_G723_1:
01495                 samples = g723_samples(f->data, f->datalen);
01496       break;
01497    case AST_FORMAT_ILBC:
01498       samples = 240 * (f->datalen / 50);
01499       break;
01500    case AST_FORMAT_GSM:
01501       samples = 160 * (f->datalen / 33);
01502       break;
01503    case AST_FORMAT_G729A:
01504       samples = f->datalen * 8;
01505       break;
01506    case AST_FORMAT_SLINEAR:
01507       samples = f->datalen / 2;
01508       break;
01509    case AST_FORMAT_LPC10:
01510                 /* assumes that the RTP packet contains one LPC10 frame */
01511       samples = 22 * 8;
01512       samples += (((char *)(f->data))[7] & 0x1) * 8;
01513       break;
01514    case AST_FORMAT_ULAW:
01515    case AST_FORMAT_ALAW:
01516       samples = f->datalen;
01517       break;
01518    case AST_FORMAT_G722:
01519    case AST_FORMAT_ADPCM:
01520    case AST_FORMAT_G726:
01521    case AST_FORMAT_G726_AAL2:
01522       samples = f->datalen * 2;
01523       break;
01524    default:
01525       ast_log(LOG_WARNING, "Unable to calculate samples for format %s\n", ast_getformatname(f->subclass));
01526    }
01527    return samples;
01528 }

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

Gets duration in ms of interpolation frame for a format.

Definition at line 565 of file frame.h.

References AST_FORMAT_ILBC.

Referenced by __get_from_jb(), and jb_get_and_deliver().

00566 { 
00567    return (format == AST_FORMAT_ILBC) ? 30 : 20;
00568 }

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 1130 of file frame.c.

References ast_codec_pref_remove(), AST_FORMAT_LIST, and ast_codec_pref::order.

Referenced by ast_parse_allow_disallow().

01131 {
01132    int x, newindex = 0;
01133 
01134    ast_codec_pref_remove(pref, format);
01135 
01136    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01137       if(AST_FORMAT_LIST[x].bits == format) {
01138          newindex = x + 1;
01139          break;
01140       }
01141    }
01142 
01143    if(newindex) {
01144       for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01145          if(!pref->order[x]) {
01146             pref->order[x] = newindex;
01147             break;
01148          }
01149       }
01150    }
01151 
01152    return x;
01153 }

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 1032 of file frame.c.

References ast_codec_pref::order.

Referenced by check_access(), create_addr(), dump_prefs(), and socket_process().

01033 {
01034    int x, differential = (int) 'A', mem;
01035    char *from, *to;
01036 
01037    if(right) {
01038       from = pref->order;
01039       to = buf;
01040       mem = size;
01041    } else {
01042       to = pref->order;
01043       from = buf;
01044       mem = 32;
01045    }
01046 
01047    memset(to, 0, mem);
01048    for (x = 0; x < 32 ; x++) {
01049       if(!from[x])
01050          break;
01051       to[x] = right ? (from[x] + differential) : (from[x] - differential);
01052    }
01053 }

struct ast_format_list ast_codec_pref_getsize ( struct ast_codec_pref pref,
int  format 
)

Get packet size for codec.

Definition at line 1232 of file frame.c.

References AST_FORMAT_LIST, ast_format_list::bits, fmt, and format.

Referenced by add_codec_to_sdp(), ast_rtp_bridge(), ast_rtp_write(), handle_open_receive_channel_ack_message(), and transmit_connect().

01233 {
01234    int x, index = -1, framems = 0;
01235    struct ast_format_list fmt = {0};
01236 
01237    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01238       if(AST_FORMAT_LIST[x].bits == format) {
01239          fmt = AST_FORMAT_LIST[x];
01240          index = x;
01241          break;
01242       }
01243    }
01244 
01245    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01246       if(pref->order[x] == (index + 1)) {
01247          framems = pref->framing[x];
01248          break;
01249       }
01250    }
01251 
01252    /* size validation */
01253    if(!framems)
01254       framems = AST_FORMAT_LIST[index].def_ms;
01255 
01256    if(AST_FORMAT_LIST[index].inc_ms && framems % AST_FORMAT_LIST[index].inc_ms) /* avoid division by zero */
01257       framems -= framems % AST_FORMAT_LIST[index].inc_ms;
01258 
01259    if(framems < AST_FORMAT_LIST[index].min_ms)
01260       framems = AST_FORMAT_LIST[index].min_ms;
01261 
01262    if(framems > AST_FORMAT_LIST[index].max_ms)
01263       framems = AST_FORMAT_LIST[index].max_ms;
01264 
01265    fmt.cur_ms = framems;
01266 
01267    return fmt;
01268 }

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 1090 of file frame.c.

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

Referenced by _sip_show_peer(), add_sdp(), ast_codec_pref_string(), function_iaxpeer(), function_sippeer(), gtalk_invite(), iax2_show_peer(), print_codec_to_cli(), and socket_process().

01091 {
01092    int slot = 0;
01093 
01094    
01095    if((index >= 0) && (index < sizeof(pref->order))) {
01096       slot = pref->order[index];
01097    }
01098 
01099    return slot ? AST_FORMAT_LIST[slot-1].bits : 0;
01100 }

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.

Definition at line 1156 of file frame.c.

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

Referenced by create_addr().

01157 {
01158    int x, newindex = 0;
01159 
01160    /* First step is to get the codecs "index number" */
01161    for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
01162       if (AST_FORMAT_LIST[x].bits == format) {
01163          newindex = x + 1;
01164          break;
01165       }
01166    }
01167    /* Done if its unknown */
01168    if (!newindex)
01169       return;
01170 
01171    /* Now find any existing occurrence, or the end */
01172    for (x = 0; x < 32; x++) {
01173       if (!pref->order[x] || pref->order[x] == newindex)
01174          break;
01175    }
01176 
01177    if (only_if_existing && !pref->order[x])
01178       return;
01179 
01180    /* Move down to make space to insert - either all the way to the end,
01181       or as far as the existing location (which will be overwritten) */
01182    for (; x > 0; x--) {
01183       pref->order[x] = pref->order[x - 1];
01184       pref->framing[x] = pref->framing[x - 1];
01185    }
01186 
01187    /* And insert the new entry */
01188    pref->order[0] = newindex;
01189    pref->framing[0] = 0; /* ? */
01190 }

void ast_codec_pref_remove ( struct ast_codec_pref pref,
int  format 
)

Remove audio a codec from a preference list.

Definition at line 1103 of file frame.c.

References AST_FORMAT_LIST, and ast_codec_pref::order.

Referenced by ast_codec_pref_append(), and ast_parse_allow_disallow().

01104 {
01105    struct ast_codec_pref oldorder;
01106    int x, y = 0;
01107    int slot;
01108    int size;
01109 
01110    if(!pref->order[0])
01111       return;
01112 
01113    memcpy(&oldorder, pref, sizeof(oldorder));
01114    memset(pref, 0, sizeof(*pref));
01115 
01116    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01117       slot = oldorder.order[x];
01118       size = oldorder.framing[x];
01119       if(! slot)
01120          break;
01121       if(AST_FORMAT_LIST[slot-1].bits != format) {
01122          pref->order[y] = slot;
01123          pref->framing[y++] = size;
01124       }
01125    }
01126    
01127 }

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

Set packet size for codec.

Definition at line 1193 of file frame.c.

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

Referenced by ast_parse_allow_disallow(), and process_sdp().

01194 {
01195    int x, index = -1;
01196 
01197    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01198       if(AST_FORMAT_LIST[x].bits == format) {
01199          index = x;
01200          break;
01201       }
01202    }
01203 
01204    if(index < 0)
01205       return -1;
01206 
01207    /* size validation */
01208    if(!framems)
01209       framems = AST_FORMAT_LIST[index].def_ms;
01210 
01211    if(AST_FORMAT_LIST[index].inc_ms && framems % AST_FORMAT_LIST[index].inc_ms) /* avoid division by zero */
01212       framems -= framems % AST_FORMAT_LIST[index].inc_ms;
01213 
01214    if(framems < AST_FORMAT_LIST[index].min_ms)
01215       framems = AST_FORMAT_LIST[index].min_ms;
01216 
01217    if(framems > AST_FORMAT_LIST[index].max_ms)
01218       framems = AST_FORMAT_LIST[index].max_ms;
01219 
01220 
01221    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
01222       if(pref->order[x] == (index + 1)) {
01223          pref->framing[x] = framems;
01224          break;
01225       }
01226    }
01227 
01228    return x;
01229 }

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 1055 of file frame.c.

References ast_codec_pref_index(), and ast_getformatname().

Referenced by dump_prefs(), and socket_process().

01056 {
01057    int x, codec; 
01058    size_t total_len, slen;
01059    char *formatname;
01060    
01061    memset(buf,0,size);
01062    total_len = size;
01063    buf[0] = '(';
01064    total_len--;
01065    for(x = 0; x < 32 ; x++) {
01066       if(total_len <= 0)
01067          break;
01068       if(!(codec = ast_codec_pref_index(pref,x)))
01069          break;
01070       if((formatname = ast_getformatname(codec))) {
01071          slen = strlen(formatname);
01072          if(slen > total_len)
01073             break;
01074          strncat(buf, formatname, total_len - 1); /* safe */
01075          total_len -= slen;
01076       }
01077       if(total_len && x < 31 && ast_codec_pref_index(pref , x + 1)) {
01078          strncat(buf, "|", total_len - 1); /* safe */
01079          total_len--;
01080       }
01081    }
01082    if(total_len) {
01083       strncat(buf, ")", total_len - 1); /* safe */
01084       total_len--;
01085    }
01086 
01087    return size - total_len;
01088 }

static force_inline int ast_format_rate ( int  format  )  [static]

Get the sample rate for a given format.

Definition at line 592 of file frame.h.

References AST_FORMAT_G722.

Referenced by ast_rtp_read(), ast_translate(), and calc_cost().

00593 {
00594    if (format == AST_FORMAT_G722)
00595       return 16000;
00596 
00597    return 8000;
00598 }

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 1565 of file frame.c.

References AST_FORMAT_SLINEAR, AST_FRAME_VOICE, ast_slinear_saturated_divide(), ast_slinear_saturated_multiply(), and f.

Referenced by audiohook_read_frame_single(), and conf_run().

01566 {
01567    int count;
01568    short *fdata = f->data;
01569    short adjust_value = abs(adjustment);
01570 
01571    if ((f->frametype != AST_FRAME_VOICE) || (f->subclass != AST_FORMAT_SLINEAR))
01572       return -1;
01573 
01574    if (!adjustment)
01575       return 0;
01576 
01577    for (count = 0; count < f->samples; count++) {
01578       if (adjustment > 0) {
01579          ast_slinear_saturated_multiply(&fdata[count], &adjust_value);
01580       } else if (adjustment < 0) {
01581          ast_slinear_saturated_divide(&fdata[count], &adjust_value);
01582       }
01583    }
01584 
01585    return 0;
01586 }

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

Dump a frame for debugging purposes

Definition at line 753 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_log(), AST_MODEM_T38, AST_MODEM_V150, ast_strlen_zero(), f, and LOG_DEBUG.

Referenced by __ast_read(), ast_write(), and sip_write().

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

struct 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.

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

Definition at line 321 of file frame.c.

References AST_FRFLAG_FROM_TRANSLATOR, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_UNLOCK, AST_MALLOCD_DATA, AST_MALLOCD_HDR, AST_MALLOCD_SRC, ast_test_flag, ast_translate_frame_freed(), FRAME_CACHE_MAX_SIZE, frames, and free.

Referenced by mixmonitor_thread().

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

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 1588 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.

01589 {
01590    int count;
01591    short *data1, *data2;
01592 
01593    if ((f1->frametype != AST_FRAME_VOICE) || (f1->subclass != AST_FORMAT_SLINEAR))
01594       return -1;
01595 
01596    if ((f2->frametype != AST_FRAME_VOICE) || (f2->subclass != AST_FORMAT_SLINEAR))
01597       return -1;
01598 
01599    if (f1->samples != f2->samples)
01600       return -1;
01601 
01602    for (count = 0, data1 = f1->data, data2 = f2->data;
01603         count < f1->samples;
01604         count++, data1++, data2++)
01605       ast_slinear_saturated_add(data1, data2);
01606 
01607    return 0;
01608 }

struct ast_frame* ast_frdup ( const struct ast_frame fr  ) 

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 428 of file frame.c.

References ast_calloc_cache, ast_copy_flags, AST_FRFLAG_HAS_TIMING_INFO, 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, f, frames, ast_frame::frametype, ast_frame::len, len, ast_frame::mallocd, ast_frame::mallocd_hdr_len, ast_frame::offset, ast_frame::samples, ast_frame::seqno, ast_frame::src, ast_frame::subclass, and ast_frame::ts.

Referenced by ast_jb_put(), ast_queue_frame(), ast_rtp_write(), ast_slinfactory_feed(), audiohook_read_frame_single(), defer_frame(), recordthread(), and rpt().

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

struct ast_frame* ast_frisolate ( struct ast_frame fr  ) 

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 370 of file frame.c.

References ast_clear_flag, ast_copy_flags, ast_frame_header_new(), AST_FRFLAG_FROM_TRANSLATOR, AST_FRFLAG_HAS_TIMING_INFO, AST_FRIENDLY_OFFSET, ast_malloc, AST_MALLOCD_DATA, AST_MALLOCD_HDR, AST_MALLOCD_SRC, ast_strdup, ast_test_flag, ast_frame::data, ast_frame::datalen, ast_frame::frametype, free, 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.

Referenced by jpeg_read_image().

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

struct ast_format_list* ast_get_format_list ( size_t *  size  ) 

Definition at line 515 of file frame.c.

References AST_FORMAT_LIST.

00516 {
00517    *size = (sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]));
00518    return AST_FORMAT_LIST;
00519 }

struct ast_format_list* ast_get_format_list_index ( int  index  ) 

Definition at line 510 of file frame.c.

References AST_FORMAT_LIST.

00511 {
00512    return &AST_FORMAT_LIST[index];
00513 }

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 581 of file frame.c.

References ast_expand_codec_alias(), AST_FORMAT_LIST, and format.

Referenced by ast_parse_allow_disallow(), iax_template_parse(), load_moh_classes(), reload_config(), and try_suggested_sip_codec().

00582 {
00583    int x, all, format = 0;
00584 
00585    all = strcasecmp(name, "all") ? 0 : 1;
00586    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
00587       if(AST_FORMAT_LIST[x].visible && (all || 
00588            !strcasecmp(AST_FORMAT_LIST[x].name,name) ||
00589            !strcasecmp(AST_FORMAT_LIST[x].name,ast_expand_codec_alias(name)))) {
00590          format |= AST_FORMAT_LIST[x].bits;
00591          if(!all)
00592             break;
00593       }
00594    }
00595 
00596    return format;
00597 }

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 "unknown" if unknown.

Definition at line 521 of file frame.c.

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

Referenced by __ast_play_and_record(), __ast_read(), __ast_register_translator(), __login_exec(), _sip_show_peer(), add_codec_to_answer(), add_codec_to_sdp(), agent_call(), ast_channel_getformatname(), ast_codec_get_len(), ast_codec_get_samples(), ast_codec_pref_string(), ast_dsp_process(), ast_frame_dump(), ast_openvstream(), ast_rtp_write(), ast_slinfactory_feed(), ast_streamfile(), ast_translator_build_path(), ast_unregister_translator(), ast_writestream(), background_detect_exec(), do_waiting(), eagi_exec(), func_channel_read(), function_iaxpeer(), function_sippeer(), gtalk_show_channels(), iax2_request(), iax2_show_channels(), iax2_show_peer(), iax_show_provisioning(), moh_classes_show(), moh_release(), nv_background_detect_exec(), nv_detectfax_exec(), oh323_rtp_read(), phone_setup(), print_codec_to_cli(), rebuild_matrix(), register_translator(), set_format(), set_peer_capabilities(), show_codecs(), show_codecs_deprecated(), show_file_formats(), show_file_formats_deprecated(), show_image_formats(), show_image_formats_deprecated(), show_translation(), show_translation_deprecated(), sip_request_call(), sip_rtp_read(), socket_process(), and zt_read().

00522 {
00523    int x;
00524    char *ret = "unknown";
00525    for (x = 0; x < sizeof(AST_FORMAT_LIST) / sizeof(AST_FORMAT_LIST[0]); x++) {
00526       if(AST_FORMAT_LIST[x].visible && AST_FORMAT_LIST[x].bits == format) {
00527          ret = AST_FORMAT_LIST[x].name;
00528          break;
00529       }
00530    }
00531    return ret;
00532 }

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 534 of file frame.c.

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

Referenced by __sip_show_channels(), _sip_show_peer(), add_sdp(), ast_channel_getformatname_multiple(), ast_streamfile(), function_iaxpeer(), function_sippeer(), handle_showchan(), handle_showchan_deprecated(), iax2_show_peer(), process_sdp(), serialize_showchan(), sip_new(), sip_request_call(), sip_show_channel(), sip_show_settings(), and sip_write().

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

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 1294 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().

Referenced by build_device(), build_peer(), build_user(), gtalk_create_member(), gtalk_load_config(), reload_config(), set_config(), and update_common_options().

01295 {
01296    char *parse = NULL, *this = NULL, *psize = NULL;
01297    int format = 0, framems = 0;
01298 
01299    parse = ast_strdupa(list);
01300    while ((this = strsep(&parse, ","))) {
01301       framems = 0;
01302       if ((psize = strrchr(this, ':'))) {
01303          *psize++ = '\0';
01304          if (option_debug)
01305             ast_log(LOG_DEBUG,"Packetization for codec: %s is %s\n", this, psize);
01306          framems = atoi(psize);
01307          if (framems < 0)
01308             framems = 0;
01309       }
01310       if (!(format = ast_getformatbyname(this))) {
01311          ast_log(LOG_WARNING, "Cannot %s unknown format '%s'\n", allowing ? "allow" : "disallow", this);
01312          continue;
01313       }
01314 
01315       if (mask) {
01316          if (allowing)
01317             *mask |= format;
01318          else
01319             *mask &= ~format;
01320       }
01321 
01322       /* Set up a preference list for audio. Do not include video in preferences 
01323          since we can not transcode video and have to use whatever is offered
01324        */
01325       if (pref && (format & AST_FORMAT_AUDIO_MASK)) {
01326          if (strcasecmp(this, "all")) {
01327             if (allowing) {
01328                ast_codec_pref_append(pref, format);
01329                ast_codec_pref_setsize(pref, format, framems);
01330             }
01331             else
01332                ast_codec_pref_remove(pref, format);
01333          } else if (!allowing) {
01334             memset(pref, 0, sizeof(*pref));
01335          }
01336       }
01337    }
01338 }

void ast_smoother_free ( struct ast_smoother s  ) 

Definition at line 268 of file frame.c.

References free, and s.

Referenced by ast_rtp_codec_setpref(), ast_rtp_destroy(), and ast_rtp_write().

00269 {
00270    free(s);
00271 }

int ast_smoother_get_flags ( struct ast_smoother smoother  ) 

Definition at line 157 of file frame.c.

References s.

00158 {
00159    return s->flags;
00160 }

struct ast_smoother* ast_smoother_new ( int  bytes  ) 

Definition at line 147 of file frame.c.

References ast_malloc, ast_smoother_reset(), and s.

Referenced by ast_rtp_write().

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

struct ast_frame* ast_smoother_read ( struct ast_smoother s  ) 

Definition at line 218 of file frame.c.

References AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log(), AST_SMOOTHER_FLAG_G729, ast_tvadd(), len, LOG_WARNING, and s.

Referenced by ast_rtp_write().

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

void ast_smoother_reset ( struct ast_smoother s,
int  bytes 
)

Definition at line 141 of file frame.c.

References s.

Referenced by ast_smoother_new().

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

void ast_smoother_set_flags ( struct ast_smoother smoother,
int  flags 
)

Definition at line 162 of file frame.c.

References s.

Referenced by ast_rtp_write().

00163 {
00164    s->flags = flags;
00165 }

int ast_smoother_test_flag ( struct ast_smoother s,
int  flag 
)

Definition at line 167 of file frame.c.

References s.

Referenced by ast_rtp_write().

00168 {
00169    return (s->flags & flag);
00170 }

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

Definition at line 499 of file frame.c.

Referenced by __ast_smoother_feed(), iax_frame_wrap(), and phone_write_buf().

00500 {
00501    int i;
00502    unsigned short *dst_s = dst;
00503    const unsigned short *src_s = src;
00504 
00505    for (i = 0; i < samples; i++)
00506       dst_s[i] = (src_s[i]<<8) | (src_s[i]>>8);
00507 }


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 139 of file frame.c.

Referenced by __ast_read(), __oh323_rtp_create(), __oh323_update_info(), agent_new(), agent_read(), ast_channel_masquerade(), ast_channel_setwhentohangup(), ast_do_masquerade(), ast_rtcp_read(), ast_rtp_read(), ast_softhangup_nolock(), ast_udptl_read(), conf_run(), features_read(), gtalk_rtp_read(), handle_request_invite(), handle_response_invite(), iax2_read(), local_read(), mgcp_rtp_read(), oh323_read(), oh323_rtp_read(), process_rfc2833(), process_sdp(), send_dtmf(), sip_rtp_read(), skinny_rtp_read(), and wakeup_sub().


Generated on Mon Mar 31 07:40:49 2008 for Asterisk - the Open Source PBX by  doxygen 1.5.1