Wed Jan 8 2020 09:50:12

Asterisk developer's documentation


frame.h File Reference

Asterisk internal frame definitions. More...

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

Go to the source code of this file.

Data Structures

struct  ast_codec_pref
 
struct  ast_control_read_action_payload
 
struct  ast_control_t38_parameters
 
struct  ast_format_list
 Definition of supported media formats (codecs) More...
 
struct  ast_frame
 Data structure associated with a single frame of data. More...
 
union  ast_frame_subclass
 
struct  ast_option_header
 
struct  oprmode
 

Macros

#define AST_FORMAT_ADPCM   (1ULL << 5)
 
#define AST_FORMAT_ALAW   (1ULL << 3)
 
#define AST_FORMAT_AUDIO_MASK   0xFFFF0000FFFFULL
 
#define AST_FORMAT_FIRST_VIDEO_BIT   AST_FORMAT_H261
 
#define AST_FORMAT_G719   (1ULL << 32)
 
#define AST_FORMAT_G722   (1ULL << 12)
 
#define AST_FORMAT_G723_1   (1ULL << 0)
 
#define AST_FORMAT_G726   (1ULL << 11)
 
#define AST_FORMAT_G726_AAL2   (1ULL << 4)
 
#define AST_FORMAT_G729A   (1ULL << 8)
 
#define AST_FORMAT_GSM   (1ULL << 1)
 
#define AST_FORMAT_H261   (1ULL << 18)
 
#define AST_FORMAT_H263   (1ULL << 19)
 
#define AST_FORMAT_H263_PLUS   (1ULL << 20)
 
#define AST_FORMAT_H264   (1ULL << 21)
 
#define AST_FORMAT_ILBC   (1ULL << 10)
 
#define AST_FORMAT_JPEG   (1ULL << 16)
 
#define AST_FORMAT_LPC10   (1ULL << 7)
 
#define AST_FORMAT_MAX_TEXT   (1ULL << 28)
 
#define AST_FORMAT_MP4_VIDEO   (1ULL << 22)
 
#define AST_FORMAT_PNG   (1ULL << 17)
 
#define AST_FORMAT_RESERVED   (1ULL << 63)
 
#define AST_FORMAT_SIREN14   (1ULL << 14)
 
#define AST_FORMAT_SIREN7   (1ULL << 13)
 
#define AST_FORMAT_SLINEAR   (1ULL << 6)
 
#define AST_FORMAT_SLINEAR16   (1ULL << 15)
 
#define AST_FORMAT_SPEEX   (1ULL << 9)
 
#define AST_FORMAT_SPEEX16   (1ULL << 33)
 
#define AST_FORMAT_T140   (1ULL << 27)
 
#define AST_FORMAT_T140RED   (1ULL << 26)
 
#define AST_FORMAT_TESTLAW   (1ULL << 47)
 
#define AST_FORMAT_TEXT_MASK   (((1ULL << 30)-1) & ~(AST_FORMAT_AUDIO_MASK) & ~(AST_FORMAT_VIDEO_MASK))
 
#define AST_FORMAT_ULAW   (1ULL << 2)
 
#define AST_FORMAT_VIDEO_MASK   ((((1ULL << 25)-1) & ~(AST_FORMAT_AUDIO_MASK)) | 0x7FFF000000000000ULL)
 
#define ast_frame_byteswap_be(fr)   do { ; } while(0)
 
#define ast_frame_byteswap_le(fr)   do { struct ast_frame *__f = (fr); ast_swapcopy_samples(__f->data.ptr, __f->data.ptr, __f->samples); } 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
 Offset into a frame's data buffer. More...
 
#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 /*! Make sure we keep at least this much handy */
 
#define AST_MODEM_T38   1
 
#define AST_MODEM_V150   2
 
#define AST_OPTION_AUDIO_MODE   4
 
#define AST_OPTION_CC_AGENT_TYPE   17
 
#define AST_OPTION_CHANNEL_WRITE   9
 Handle channel write data If a channel needs to process the data from a func_channel write operation after func_channel_write executes, it can define the setoption callback and process this option. A pointer to an ast_chan_write_info_t will be passed. More...
 
#define AST_OPTION_DEVICE_NAME   16
 
#define AST_OPTION_DIGIT_DETECT   14
 
#define AST_OPTION_ECHOCAN   8
 
#define AST_OPTION_FAX_DETECT   15
 
#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_FORMAT_READ   11
 
#define AST_OPTION_FORMAT_WRITE   12
 
#define AST_OPTION_MAKE_COMPATIBLE   13
 
#define AST_OPTION_OPRMODE   7
 
#define AST_OPTION_RELAXDTMF   3
 
#define AST_OPTION_RXGAIN   6
 
#define AST_OPTION_SECURE_MEDIA   19
 
#define AST_OPTION_SECURE_SIGNALING   18
 
#define AST_OPTION_T38_STATE   10
 
#define AST_OPTION_TDD   2
 
#define AST_OPTION_TONE_VERIFY   1
 
#define AST_OPTION_TXGAIN   5
 
#define AST_SMOOTHER_FLAG_BE   (1 << 1)
 
#define AST_SMOOTHER_FLAG_G729   (1 << 0)
 

Enumerations

enum  { AST_FRFLAG_HAS_TIMING_INFO = (1 << 0) }
 
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, _XXX_AST_CONTROL_T38 = 19, AST_CONTROL_SRCUPDATE = 20,
  AST_CONTROL_TRANSFER = 21, AST_CONTROL_CONNECTED_LINE = 22, AST_CONTROL_REDIRECTING = 23, AST_CONTROL_T38_PARAMETERS = 24,
  AST_CONTROL_CC = 25, AST_CONTROL_SRCCHANGE = 26, AST_CONTROL_READ_ACTION = 27, AST_CONTROL_AOC = 28,
  AST_CONTROL_END_OF_Q = 29, AST_CONTROL_INCOMPLETE = 30, AST_CONTROL_UPDATE_RTP_PEER = 32
}
 Internal control frame subtype field values. More...
 
enum  ast_control_t38 {
  AST_T38_REQUEST_NEGOTIATE = 1, AST_T38_REQUEST_TERMINATE, AST_T38_NEGOTIATED, AST_T38_TERMINATED,
  AST_T38_REFUSED, AST_T38_REQUEST_PARMS
}
 
enum  ast_control_t38_rate {
  AST_T38_RATE_2400 = 1, AST_T38_RATE_4800, AST_T38_RATE_7200, AST_T38_RATE_9600,
  AST_T38_RATE_12000, AST_T38_RATE_14400 = 0
}
 
enum  ast_control_t38_rate_management { AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF = 0, AST_T38_RATE_MANAGEMENT_LOCAL_TCF }
 
enum  ast_control_transfer { AST_TRANSFER_SUCCESS = 0, AST_TRANSFER_FAILED }
 
enum  ast_frame_read_action { AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO }
 
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

char * ast_codec2str (format_t codec)
 Get a name from a format Gets a name from a format. More...
 
format_t ast_codec_choose (struct ast_codec_pref *pref, format_t 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. More...
 
int ast_codec_get_len (format_t format, int samples)
 Returns the number of bytes for the number of samples of the given format. More...
 
int ast_codec_get_samples (struct ast_frame *f)
 Returns the number of samples contained in the frame. More...
 
static int ast_codec_interp_len (format_t format)
 Gets duration in ms of interpolation frame for a format. More...
 
int ast_codec_pref_append (struct ast_codec_pref *pref, format_t format)
 Append a audio codec to a preference list, removing it first if it was already there. More...
 
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. More...
 
struct ast_format_list ast_codec_pref_getsize (struct ast_codec_pref *pref, format_t format)
 Get packet size for codec. More...
 
format_t ast_codec_pref_index (struct ast_codec_pref *pref, int index)
 Codec located at a particular place in the preference index. More...
 
void ast_codec_pref_init (struct ast_codec_pref *pref)
 Initialize an audio codec preference to "no preference". More...
 
void ast_codec_pref_prepend (struct ast_codec_pref *pref, format_t format, int only_if_existing)
 Prepend an audio codec to a preference list, removing it first if it was already there. More...
 
void ast_codec_pref_remove (struct ast_codec_pref *pref, format_t format)
 Remove audio a codec from a preference list. More...
 
int ast_codec_pref_setsize (struct ast_codec_pref *pref, format_t format, int framems)
 Set packet size for codec. More...
 
int ast_codec_pref_string (struct ast_codec_pref *pref, char *buf, size_t size)
 Dump audio codec preference list into a string. More...
 
static force_inline int ast_format_rate (format_t format)
 Get the sample rate for a given format. More...
 
int ast_frame_adjust_volume (struct ast_frame *f, int adjustment)
 Adjusts the volume of the audio samples contained in a frame. More...
 
int ast_frame_clear (struct ast_frame *frame)
 Clear all audio samples from an ast_frame. The frame must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR. More...
 
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. More...
 
void ast_frame_free (struct ast_frame *fr, int cache)
 Requests a frame to be allocated. More...
 
int ast_frame_slinear_sum (struct ast_frame *f1, struct ast_frame *f2)
 Sums two frames of audio samples. More...
 
struct ast_frameast_frdup (const struct ast_frame *fr)
 Copies a frame. More...
 
struct ast_frameast_frisolate (struct ast_frame *fr)
 Makes a frame independent of any static storage. More...
 
struct ast_format_listast_get_format_list (size_t *size)
 
struct ast_format_listast_get_format_list_index (int index)
 
format_t ast_getformatbyname (const char *name)
 Gets a format from a name. More...
 
char * ast_getformatname (format_t format)
 Get the name of a format. More...
 
char * ast_getformatname_multiple (char *buf, size_t size, format_t format)
 Get the names of a set of formats. More...
 
int ast_parse_allow_disallow (struct ast_codec_pref *pref, format_t *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. More...
 
void ast_swapcopy_samples (void *dst, const void *src, int samples)
 

Variables

struct ast_frame ast_null_frame
 

AST_Smoother

#define ast_smoother_feed(s, f)   __ast_smoother_feed(s, f, 0)
 
#define ast_smoother_feed_be(s, f)   __ast_smoother_feed(s, f, 0)
 
#define ast_smoother_feed_le(s, f)   __ast_smoother_feed(s, f, 1)
 
struct ast_smootherast_smoother_new (int bytes)
 
void ast_smoother_set_flags (struct ast_smoother *smoother, int flags)
 
int ast_smoother_get_flags (struct ast_smoother *smoother)
 
int ast_smoother_test_flag (struct ast_smoother *s, int flag)
 
void ast_smoother_free (struct ast_smoother *s)
 
void ast_smoother_reset (struct ast_smoother *s, int bytes)
 
void ast_smoother_reconfigure (struct ast_smoother *s, int bytes)
 Reconfigure an existing smoother to output a different number of bytes per frame. More...
 
int __ast_smoother_feed (struct ast_smoother *s, struct ast_frame *f, int swap)
 
struct ast_frameast_smoother_read (struct ast_smoother *s)
 

Detailed Description

Asterisk internal frame definitions.

Definition in file frame.h.

Macro Definition Documentation

#define AST_FORMAT_ADPCM   (1ULL << 5)

ADPCM (IMA)

Definition at line 252 of file frame.h.

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

#define AST_FORMAT_FIRST_VIDEO_BIT   AST_FORMAT_H261

Definition at line 281 of file frame.h.

Referenced by ast_openvstream().

#define AST_FORMAT_G719   (1ULL << 32)
#define AST_FORMAT_G722   (1ULL << 12)
#define AST_FORMAT_G726   (1ULL << 11)

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

Definition at line 264 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_rtp_codecs_payloads_set_rtpmap_type_rate(), g726_read(), g726_sample(), and g726_write().

#define AST_FORMAT_G726_AAL2   (1ULL << 4)
#define AST_FORMAT_GSM   (1ULL << 1)
#define AST_FORMAT_H261   (1ULL << 18)

H.261 Video

Definition at line 280 of file frame.h.

Referenced by codec_ast2skinny(), codec_skinny2ast(), and h261_encap().

#define AST_FORMAT_H263   (1ULL << 19)

H.263 Video

Definition at line 283 of file frame.h.

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

#define AST_FORMAT_H263_PLUS   (1ULL << 20)

H.263+ Video

Definition at line 285 of file frame.h.

Referenced by h263p_encap().

#define AST_FORMAT_H264   (1ULL << 21)

H.264 Video

Definition at line 287 of file frame.h.

Referenced by h264_encap(), h264_read(), and h264_write().

#define AST_FORMAT_ILBC   (1ULL << 10)
#define AST_FORMAT_JPEG   (1ULL << 16)

JPEG Images

Definition at line 276 of file frame.h.

Referenced by jpeg_read_image(), and jpeg_write_image().

#define AST_FORMAT_LPC10   (1ULL << 7)

LPC10, 180 samples/frame

Definition at line 256 of file frame.h.

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

#define AST_FORMAT_MAX_TEXT   (1ULL << 28)

Maximum text mask

Definition at line 296 of file frame.h.

#define AST_FORMAT_MP4_VIDEO   (1ULL << 22)

MPEG4 Video

Definition at line 289 of file frame.h.

Referenced by mpeg4_encap().

#define AST_FORMAT_PNG   (1ULL << 17)

PNG Images

Definition at line 278 of file frame.h.

Referenced by phone_read().

#define AST_FORMAT_RESERVED   (1ULL << 63)

Reserved bit - do not use

Definition at line 305 of file frame.h.

#define AST_FORMAT_SIREN14   (1ULL << 14)

G.722.1 Annex C (also known as Siren14, 48kbps assumed)

Definition at line 270 of file frame.h.

Referenced by add_codec_to_sdp(), ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_format_rate(), ast_rtp_write(), process_sdp_a_audio(), siren14read(), and siren14write().

#define AST_FORMAT_SIREN7   (1ULL << 13)

G.722.1 (also known as Siren7, 32kbps assumed)

Definition at line 268 of file frame.h.

Referenced by add_codec_to_sdp(), ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), ast_format_rate(), ast_rtp_write(), process_sdp_a_audio(), siren7read(), and siren7write().

#define AST_FORMAT_SLINEAR   (1ULL << 6)

Raw 16-bit Signed Linear (8000 Hz) PCM

Definition at line 254 of file frame.h.

Referenced by __ast_play_and_record(), _moh_class_malloc(), action_originate(), agent_new(), alsa_new(), alsa_read(), alsa_request(), ast_audiohook_read_frame(), ast_best_codec(), ast_channel_make_compatible_helper(), ast_channel_start_silence_generator(), ast_codec_get_len(), ast_codec_get_samples(), ast_dsp_call_progress(), ast_dsp_noise(), ast_dsp_process(), ast_dsp_silence(), ast_frame_adjust_volume(), ast_frame_slinear_sum(), ast_rtp_read(), ast_slinfactory_init(), ast_slinfactory_init_rate(), ast_speech_new(), ast_write(), audio_audiohook_write_list(), audiohook_read_frame_both(), audiohook_read_frame_single(), background_detect_exec(), bridge_request(), build_conf(), chanspy_exec(), conf_run(), dahdi_read(), dahdi_translate(), dahdi_write(), dahdiscan_exec(), dictate_exec(), do_notify(), do_waiting(), eagi_exec(), extenspy_exec(), fax_generator_generate(), find_transcoders(), generic_fax_exec(), generic_recall(), get_rate_change_result(), handle_jack_audio(), handle_recordfile(), handle_speechcreate(), handle_speechrecognize(), iax_frame_wrap(), ices_exec(), is_encoder(), isAnsweringMachine(), jack_exec(), jack_hook_callback(), linear_alloc(), linear_generator(), load_module(), load_moh_classes(), local_ast_moh_start(), measurenoise(), meetme_menu_admin_extended(), mixmonitor_thread(), mp3_exec(), nbs_request(), nbs_xwrite(), NBScat_exec(), new_outgoing(), ogg_vorbis_read(), ogg_vorbis_write(), oh323_rtp_read(), orig_app(), orig_exten(), originate_exec(), oss_new(), oss_read(), oss_request(), parkandannounce_exec(), phone_new(), phone_read(), phone_request(), phone_setup(), phone_write(), pitchshift_cb(), play_sound_file(), playtones_alloc(), playtones_generator(), record_exec(), send_waveform_to_channel(), silence_generator_generate(), slin8_sample(), slinear_read(), slinear_write(), socket_process(), softmix_bridge_join(), softmix_bridge_write(), spandsp_fax_read(), speech_background(), spy_generate(), tonepair_alloc(), tonepair_generator(), transmit_audio(), wav_read(), and wav_write().

#define AST_FORMAT_SPEEX   (1ULL << 9)

SpeeX Free Compression

Definition at line 260 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_samples(), ast_rtp_write(), and speex_sample().

#define AST_FORMAT_SPEEX16   (1ULL << 33)

SpeeX Wideband (16kHz) Free Compression

Definition at line 301 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_samples(), ast_format_rate(), ast_rtp_write(), and speex16_sample().

#define AST_FORMAT_T140   (1ULL << 27)

T.140 Text format - ITU T.140, RFC 4103

Definition at line 294 of file frame.h.

Referenced by add_tcodec_to_sdp(), ast_rtp_read(), and ast_write().

#define AST_FORMAT_T140RED   (1ULL << 26)

T.140 RED Text format RFC 4103

Definition at line 292 of file frame.h.

Referenced by add_tcodec_to_sdp(), ast_rtp_read(), process_sdp(), and rtp_red_init().

#define AST_FORMAT_TESTLAW   (1ULL << 47)

Raw mu-law data (G.711)

Definition at line 303 of file frame.h.

Referenced by ast_best_codec(), ast_codec_get_len(), ast_codec_get_samples(), and ast_dsp_process().

#define AST_FORMAT_TEXT_MASK   (((1ULL << 30)-1) & ~(AST_FORMAT_AUDIO_MASK) & ~(AST_FORMAT_VIDEO_MASK))

Definition at line 297 of file frame.h.

Referenced by add_sdp(), ast_request(), show_codecs(), sip_new(), and sip_rtp_read().

#define AST_FORMAT_VIDEO_MASK   ((((1ULL << 25)-1) & ~(AST_FORMAT_AUDIO_MASK)) | 0x7FFF000000000000ULL)
#define ast_frame_byteswap_be (   fr)    do { ; } while(0)

Definition at line 616 of file frame.h.

Referenced by ast_rtp_read(), and socket_process().

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

Definition at line 615 of file frame.h.

Referenced by phone_read().

#define AST_FRAME_SET_BUFFER (   fr,
  _base,
  _ofs,
  _datalen 
)
Value:
{ \
(fr)->data.ptr = (char *)_base + (_ofs); \
(fr)->offset = (_ofs); \
(fr)->datalen = (_datalen); \
}
int offset
Definition: frame.h:156
int datalen
Definition: frame.h:148
union ast_frame::@172 data

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

Definition at line 183 of file frame.h.

Referenced by fax_generator_generate(), g719read(), g723_read(), g726_read(), g729_read(), gsm_read(), h263_read(), h264_read(), ilbc_read(), ogg_vorbis_read(), pcm_read(), siren14read(), siren7read(), slinear_read(), spandsp_fax_read(), t38_tx_packet_handler(), vox_read(), and wav_read().

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

Definition at line 583 of file frame.h.

Referenced by __adsi_transmit_messages(), __analog_ss_thread(), __ast_answer(), __ast_play_and_record(), __ast_queue_frame(), __ast_read(), __ast_request_and_dial(), adsi_careful_send(), agent_ack_sleep(), agent_read(), analog_ss_thread(), ast_audiohook_read_frame(), ast_autoservice_stop(), ast_bridge_call(), ast_bridge_handle_trip(), ast_channel_clear_softhangup(), ast_channel_destructor(), ast_dsp_process(), ast_framehook_attach(), ast_generic_bridge(), ast_indicate_data(), ast_jb_destroy(), ast_jb_put(), ast_queue_cc_frame(), ast_readaudio_callback(), ast_readvideo_callback(), ast_recvtext(), ast_rtp_write(), ast_safe_sleep_conditional(), ast_send_image(), ast_slinfactory_destroy(), ast_slinfactory_feed(), ast_slinfactory_flush(), ast_slinfactory_read(), ast_tonepair(), ast_transfer(), ast_translate(), ast_udptl_bridge(), ast_waitfordigit_full(), ast_write(), ast_writestream(), async_agi_read_frame(), async_wait(), audio_audiohook_write_list(), autoservice_run(), background_detect_exec(), bridge_handle_dtmf(), calc_cost(), channel_spy(), check_bridge(), conf_flush(), conf_free(), conf_run(), create_jb(), dahdi_accept_r2_call_exec(), dahdi_bridge(), dahdi_read(), dial_exec_full(), dictate_exec(), disa_exec(), disable_t38(), do_idle_thread(), do_waiting(), echo_exec(), eivr_comm(), feature_request_and_dial(), find_cache(), framehook_detach_and_destroy(), gen_generate(), generic_fax_exec(), handle_cli_file_convert(), handle_recordfile(), handle_speechrecognize(), iax2_bridge(), ices_exec(), isAnsweringMachine(), jack_exec(), jb_empty_and_reset_adaptive(), jb_empty_and_reset_fixed(), jb_get_and_deliver(), local_bridge_loop(), manage_parked_call(), measurenoise(), moh_files_generator(), monitor_dial(), mp3_exec(), multicast_rtp_write(), NBScat_exec(), read_frame(), receive_dtmf_digits(), receivefax_t38_init(), record_exec(), recordthread(), remote_bridge_loop(), run_agi(), send_tone_burst(), send_waveform_to_channel(), sendfax_t38_init(), sendurl_exec(), session_destroy(), sip_read(), sip_rtp_read(), speech_background(), spy_generate(), transmit_audio(), transmit_t38(), wait_for_answer(), wait_for_hangup(), wait_for_winner(), waitforring_exec(), and waitstream_core().

#define AST_FRIENDLY_OFFSET   64

Offset into a frame's data buffer.

By providing some "empty" space prior to the actual data of an ast_frame, this gives any consumer of the frame ample space to prepend other necessary information without having to create a new buffer.

As an example, RTP can use the data from an ast_frame and simply prepend the RTP header information into the space provided by AST_FRIENDLY_OFFSET instead of having to create a new buffer with the necessary space allocated.

Definition at line 204 of file frame.h.

Referenced by __get_from_jb(), adjust_frame_for_plc(), 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(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), dahdi_read(), fax_generator_generate(), g719read(), 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_cn_rfc3389(), send_tone_burst(), send_waveform_to_channel(), siren14read(), siren7read(), slinear_read(), sms_generate(), spandsp_fax_read(), tonepair_generator(), vox_read(), and wav_read().

#define AST_HTML_BEGIN   4

Beginning frame

Definition at line 226 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_DATA   2

Data frame

Definition at line 224 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_END   8

End frame

Definition at line 228 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_LDCOMPLETE   16

Load is complete

Definition at line 230 of file frame.h.

Referenced by ast_frame_dump(), and sendurl_exec().

#define AST_HTML_LINKREJECT   20

Reject link request

Definition at line 238 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_LINKURL   18

Send URL, and track

Definition at line 234 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_NOSUPPORT   17

Peer is unable to support HTML

Definition at line 232 of file frame.h.

Referenced by ast_frame_dump(), and sendurl_exec().

#define AST_HTML_UNLINK   19

No more HTML linkage

Definition at line 236 of file frame.h.

Referenced by ast_frame_dump().

#define AST_HTML_URL   1

Sending a URL

Definition at line 222 of file frame.h.

Referenced by ast_channel_sendurl(), ast_frame_dump(), and sip_sendhtml().

#define AST_MALLOCD_DATA   (1 << 1)

Need the data be free'd?

Definition at line 210 of file frame.h.

Referenced by __frame_free(), ast_cc_build_frame(), ast_frisolate(), and create_video_frame().

#define AST_MALLOCD_HDR   (1 << 0)

Need the header be free'd?

Definition at line 208 of file frame.h.

Referenced by __frame_free(), ast_frame_header_new(), ast_frdup(), ast_frisolate(), and create_video_frame().

#define AST_MALLOCD_SRC   (1 << 2)

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

Definition at line 212 of file frame.h.

Referenced by __frame_free(), ast_frisolate(), and speex_callback().

#define AST_MIN_OFFSET   32 /*! Make sure we keep at least this much handy */

Definition at line 205 of file frame.h.

Referenced by __ast_smoother_feed().

#define AST_MODEM_T38   1

T.38 Fax-over-IP

Definition at line 216 of file frame.h.

Referenced by ast_frame_dump(), ast_udptl_write(), generic_fax_exec(), t38_tx_packet_handler(), transmit_t38(), and udptl_rx_packet().

#define AST_MODEM_V150   2

V.150 Modem-over-IP

Definition at line 218 of file frame.h.

Referenced by ast_frame_dump().

#define AST_OPTION_AUDIO_MODE   4

Set (or clear) Audio (Not-Clear) Mode Option data is a single signed char value 0 or 1

Definition at line 453 of file frame.h.

Referenced by ast_bridge_call(), dahdi_hangup(), dahdi_setoption(), and iax2_setoption().

#define AST_OPTION_CC_AGENT_TYPE   17

Get the CC agent type from the channel (Read only) Option data is a character buffer of suitable length

Definition at line 520 of file frame.h.

Referenced by ast_channel_get_cc_agent_type(), and dahdi_queryoption().

#define AST_OPTION_CHANNEL_WRITE   9

Handle channel write data If a channel needs to process the data from a func_channel write operation after func_channel_write executes, it can define the setoption callback and process this option. A pointer to an ast_chan_write_info_t will be passed.

Note
This option should never be passed over the network.

Definition at line 484 of file frame.h.

Referenced by func_channel_write(), and local_setoption().

#define AST_OPTION_DEVICE_NAME   16

Get the device name from the channel (Read only) Option data is a character buffer of suitable length

Definition at line 516 of file frame.h.

Referenced by ast_channel_get_device_name(), and sip_queryoption().

#define AST_OPTION_DIGIT_DETECT   14

Get or set the digit detection state of the channel Option data is a single signed char value 0 or 1

Definition at line 508 of file frame.h.

Referenced by ast_bridge_call(), dahdi_queryoption(), dahdi_setoption(), iax2_setoption(), rcvfax_exec(), sip_queryoption(), sip_setoption(), and sndfax_exec().

#define AST_OPTION_ECHOCAN   8

Explicitly enable or disable echo cancelation for the given channel Option data is a single signed char value 0 or 1

Note
This option appears to be unused in the code. It is handled, but never set or queried.

Definition at line 476 of file frame.h.

Referenced by dahdi_setoption().

#define AST_OPTION_FAX_DETECT   15

Get or set the fax tone detection state of the channel Option data is a single signed char value 0 or 1

Definition at line 512 of file frame.h.

Referenced by ast_bridge_call(), dahdi_queryoption(), dahdi_setoption(), iax2_setoption(), rcvfax_exec(), and sndfax_exec().

#define AST_OPTION_FLAG_ACCEPT   1

Definition at line 432 of file frame.h.

#define AST_OPTION_FLAG_ANSWER   5

Definition at line 435 of file frame.h.

#define AST_OPTION_FLAG_QUERY   4

Definition at line 434 of file frame.h.

#define AST_OPTION_FLAG_REJECT   2

Definition at line 433 of file frame.h.

#define AST_OPTION_FLAG_REQUEST   0

Definition at line 431 of file frame.h.

Referenced by ast_bridge_call(), and iax2_setoption().

#define AST_OPTION_FLAG_WTF   6

Definition at line 436 of file frame.h.

#define AST_OPTION_FORMAT_READ   11

Request that the channel driver deliver frames in a specific format Option data is a format_t

Definition at line 494 of file frame.h.

Referenced by set_format(), and sip_setoption().

#define AST_OPTION_FORMAT_WRITE   12

Request that the channel driver be prepared to accept frames in a specific format Option data is a format_t

Definition at line 498 of file frame.h.

Referenced by set_format(), and sip_setoption().

#define AST_OPTION_MAKE_COMPATIBLE   13

Request that the channel driver make two channels of the same tech type compatible if possible Option data is an ast_channel

Note
This option should never be passed over the network

Definition at line 504 of file frame.h.

Referenced by ast_channel_make_compatible_helper(), and sip_setoption().

#define AST_OPTION_OPRMODE   7

Definition at line 469 of file frame.h.

Referenced by dahdi_setoption(), dial_exec_full(), and iax2_setoption().

#define AST_OPTION_RELAXDTMF   3

Relax the parameters for DTMF reception (mainly for radio use) Option data is a single signed char value 0 or 1

Definition at line 449 of file frame.h.

Referenced by ast_bridge_call(), dahdi_setoption(), and iax2_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 463 of file frame.h.

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

#define AST_OPTION_SECURE_MEDIA   19
#define AST_OPTION_SECURE_SIGNALING   18

Get or set the security options on a channel Option data is an integer value of 0 or 1

Definition at line 524 of file frame.h.

Referenced by iax2_queryoption(), iax2_setoption(), set_security_requirements(), sip_queryoption(), and sip_setoption().

#define AST_OPTION_T38_STATE   10

Definition at line 490 of file frame.h.

Referenced by ast_channel_get_t38_state(), local_queryoption(), and sip_queryoption().

#define AST_OPTION_TDD   2

Put a compatible channel into TDD (TTY for the hearing-impared) mode Option data is a single signed char value 0 or 1

Definition at line 445 of file frame.h.

Referenced by analog_hangup(), ast_bridge_call(), dahdi_hangup(), dahdi_setoption(), handle_tddmode(), and iax2_setoption().

#define AST_OPTION_TONE_VERIFY   1

Verify touchtones by muting audio transmission (and reception) and verify the tone is still present Option data is a single signed char value 0 or 1

Definition at line 441 of file frame.h.

Referenced by analog_hangup(), ast_bridge_call(), conf_run(), dahdi_hangup(), dahdi_setoption(), iax2_setoption(), and try_calling().

#define AST_OPTION_TXGAIN   5

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

Definition at line 458 of file frame.h.

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

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

Definition at line 686 of file frame.h.

Referenced by ast_rtp_write(), and generic_fax_exec().

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

Definition at line 691 of file frame.h.

Referenced by ast_rtp_write().

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

Definition at line 692 of file frame.h.

#define AST_SMOOTHER_FLAG_BE   (1 << 1)

Definition at line 428 of file frame.h.

Referenced by ast_rtp_write().

#define AST_SMOOTHER_FLAG_G729   (1 << 0)

Definition at line 427 of file frame.h.

Referenced by __ast_smoother_feed(), ast_smoother_read(), and smoother_frame_feed().

Enumeration Type Documentation

anonymous enum
Enumerator
AST_FRFLAG_HAS_TIMING_INFO 

This frame contains valid timing information

Definition at line 130 of file frame.h.

130  {
131  /*! This frame contains valid timing information */
132  AST_FRFLAG_HAS_TIMING_INFO = (1 << 0),
133 };

Internal control frame subtype field values.

Warning
IAX2 sends these values out over the wire. To prevent future incompatibilities, pick the next value in the enum from whatever is on the current trunk. If you lose the merge race you need to fix the previous branches to match what is on trunk. In addition you need to change chan_iax2 to explicitly allow the control frame over the wire if it makes sense for the frame to be passed to another Asterisk instance.
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

_XXX_AST_CONTROL_T38 

T38 state change request/notification

Deprecated:
This is no longer supported. Use AST_CONTROL_T38_PARAMETERS instead.
AST_CONTROL_SRCUPDATE 

Indicate source of media has changed

AST_CONTROL_TRANSFER 

Indicate status of a transfer request

AST_CONTROL_CONNECTED_LINE 

Indicate connected line has changed

AST_CONTROL_REDIRECTING 

Indicate redirecting id has changed

AST_CONTROL_T38_PARAMETERS 

T38 state change request/notification with parameters

AST_CONTROL_CC 

Indication that Call completion service is possible

AST_CONTROL_SRCCHANGE 

Media source has changed and requires a new RTP SSRC

AST_CONTROL_READ_ACTION 

Tell ast_read to take a specific action

AST_CONTROL_AOC 

Advice of Charge with encoded generic AOC payload

AST_CONTROL_END_OF_Q 

Indicate that this position was the end of the channel queue for a softhangup.

AST_CONTROL_INCOMPLETE 

Indication that the extension dialed is incomplete

AST_CONTROL_UPDATE_RTP_PEER 

Interrupt the bridge and have it update the peer

Definition at line 319 of file frame.h.

319  {
320  AST_CONTROL_HANGUP = 1, /*!< Other end has hungup */
321  AST_CONTROL_RING = 2, /*!< Local ring */
322  AST_CONTROL_RINGING = 3, /*!< Remote end is ringing */
323  AST_CONTROL_ANSWER = 4, /*!< Remote end has answered */
324  AST_CONTROL_BUSY = 5, /*!< Remote end is busy */
325  AST_CONTROL_TAKEOFFHOOK = 6, /*!< Make it go off hook */
326  AST_CONTROL_OFFHOOK = 7, /*!< Line is off hook */
327  AST_CONTROL_CONGESTION = 8, /*!< Congestion (circuits busy) */
328  AST_CONTROL_FLASH = 9, /*!< Flash hook */
329  AST_CONTROL_WINK = 10, /*!< Wink */
330  AST_CONTROL_OPTION = 11, /*!< Set a low-level option */
331  AST_CONTROL_RADIO_KEY = 12, /*!< Key Radio */
332  AST_CONTROL_RADIO_UNKEY = 13, /*!< Un-Key Radio */
333  AST_CONTROL_PROGRESS = 14, /*!< Indicate PROGRESS */
334  AST_CONTROL_PROCEEDING = 15, /*!< Indicate CALL PROCEEDING */
335  AST_CONTROL_HOLD = 16, /*!< Indicate call is placed on hold */
336  AST_CONTROL_UNHOLD = 17, /*!< Indicate call is left from hold */
337  AST_CONTROL_VIDUPDATE = 18, /*!< Indicate video frame update */
338  _XXX_AST_CONTROL_T38 = 19, /*!< T38 state change request/notification \deprecated This is no longer supported. Use AST_CONTROL_T38_PARAMETERS instead. */
339  AST_CONTROL_SRCUPDATE = 20, /*!< Indicate source of media has changed */
340  AST_CONTROL_TRANSFER = 21, /*!< Indicate status of a transfer request */
341  AST_CONTROL_CONNECTED_LINE = 22,/*!< Indicate connected line has changed */
342  AST_CONTROL_REDIRECTING = 23, /*!< Indicate redirecting id has changed */
343  AST_CONTROL_T38_PARAMETERS = 24,/*!< T38 state change request/notification with parameters */
344  AST_CONTROL_CC = 25, /*!< Indication that Call completion service is possible */
345  AST_CONTROL_SRCCHANGE = 26, /*!< Media source has changed and requires a new RTP SSRC */
346  AST_CONTROL_READ_ACTION = 27, /*!< Tell ast_read to take a specific action */
347  AST_CONTROL_AOC = 28, /*!< Advice of Charge with encoded generic AOC payload */
348  AST_CONTROL_END_OF_Q = 29, /*!< Indicate that this position was the end of the channel queue for a softhangup. */
349  AST_CONTROL_INCOMPLETE = 30, /*!< Indication that the extension dialed is incomplete */
350  AST_CONTROL_UPDATE_RTP_PEER = 32, /*!< Interrupt the bridge and have it update the peer */
351 
352  /*
353  * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
354  *
355  * IAX2 sends these values out over the wire. To prevent future
356  * incompatibilities, pick the next value in the enum from whatever
357  * is on the current trunk. If you lose the merge race you need to
358  * fix the previous branches to match what is on trunk. In addition
359  * you need to change chan_iax2 to explicitly allow the control
360  * frame over the wire if it makes sense for the frame to be passed
361  * to another Asterisk instance.
362  *
363  * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
364  */
365 };
Enumerator
AST_T38_REQUEST_NEGOTIATE 

Request T38 on a channel (voice to fax)

AST_T38_REQUEST_TERMINATE 

Terminate T38 on a channel (fax to voice)

AST_T38_NEGOTIATED 

T38 negotiated (fax mode)

AST_T38_TERMINATED 

T38 terminated (back to voice)

AST_T38_REFUSED 

T38 refused for some reason (usually rejected by remote end)

AST_T38_REQUEST_PARMS 

request far end T.38 parameters for a channel in 'negotiating' state

Definition at line 384 of file frame.h.

384  {
385  AST_T38_REQUEST_NEGOTIATE = 1, /*!< Request T38 on a channel (voice to fax) */
386  AST_T38_REQUEST_TERMINATE, /*!< Terminate T38 on a channel (fax to voice) */
387  AST_T38_NEGOTIATED, /*!< T38 negotiated (fax mode) */
388  AST_T38_TERMINATED, /*!< T38 terminated (back to voice) */
389  AST_T38_REFUSED, /*!< T38 refused for some reason (usually rejected by remote end) */
390  AST_T38_REQUEST_PARMS, /*!< request far end T.38 parameters for a channel in 'negotiating' state */
391 };
Enumerator
AST_T38_RATE_2400 
AST_T38_RATE_4800 
AST_T38_RATE_7200 
AST_T38_RATE_9600 
AST_T38_RATE_12000 
AST_T38_RATE_14400 

Definition at line 393 of file frame.h.

393  {
394  AST_T38_RATE_2400 = 1,
399  /* Set to 0 so it's taken as default when unspecified.
400  * See ITU-T T.38 Implementors' Guide (11 May 2012),
401  * Table H.2: if the T38MaxBitRate attribute is omitted
402  * it should use a default of 14400. */
403  AST_T38_RATE_14400 = 0,
404 };
Enumerator
AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF 
AST_T38_RATE_MANAGEMENT_LOCAL_TCF 

Definition at line 406 of file frame.h.

Enumerator
AST_TRANSFER_SUCCESS 

Transfer request on the channel worked

AST_TRANSFER_FAILED 

Transfer request on the channel failed

Definition at line 422 of file frame.h.

422  {
423  AST_TRANSFER_SUCCESS = 0, /*!< Transfer request on the channel worked */
424  AST_TRANSFER_FAILED, /*!< Transfer request on the channel failed */
425 };
Enumerator
AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO 

Definition at line 367 of file frame.h.

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. This is because these constants are transmitted directly over IAX2.
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 101 of file frame.h.

101  {
102  /*! DTMF end event, subclass is the digit */
103  AST_FRAME_DTMF_END = 1,
104  /*! Voice data, subclass is AST_FORMAT_* */
106  /*! Video frame, maybe?? :) */
108  /*! A control frame, subclass is AST_CONTROL_* */
110  /*! An empty, useless frame */
112  /*! Inter Asterisk Exchange private frame type */
114  /*! Text messages */
116  /*! Image Frames */
118  /*! HTML Frame */
120  /*! Comfort Noise frame (subclass is level of CNG in -dBov),
121  body may include zero or more 8-bit quantization coefficients */
123  /*! Modem-over-IP data streams */
125  /*! DTMF begin event, subclass is the digit */
127 };

Function Documentation

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

Definition at line 208 of file frame.c.

References AST_FRAME_VOICE, ast_getformatname(), ast_log(), AST_MIN_OFFSET, AST_SMOOTHER_FLAG_G729, ast_swapcopy_samples(), ast_frame_subclass::codec, ast_frame::data, ast_frame::datalen, f, ast_smoother::flags, ast_smoother::format, ast_frame::frametype, ast_smoother::len, LOG_WARNING, ast_frame::offset, ast_smoother::opt, ast_smoother::opt_needs_swap, ast_frame::ptr, ast_frame::samples, ast_smoother::samplesperbyte, ast_smoother::size, smoother_frame_feed(), SMOOTHER_SIZE, and ast_frame::subclass.

209 {
210  if (f->frametype != AST_FRAME_VOICE) {
211  ast_log(LOG_WARNING, "Huh? Can't smooth a non-voice frame!\n");
212  return -1;
213  }
214  if (!s->format) {
215  s->format = f->subclass.codec;
216  s->samplesperbyte = (float)f->samples / (float)f->datalen;
217  } else if (s->format != f->subclass.codec) {
218  ast_log(LOG_WARNING, "Smoother was working on %s format frames, now trying to feed %s?\n",
220  return -1;
221  }
222  if (s->len + f->datalen > SMOOTHER_SIZE) {
223  ast_log(LOG_WARNING, "Out of smoother space\n");
224  return -1;
225  }
226  if (((f->datalen == s->size) ||
227  ((f->datalen < 10) && (s->flags & AST_SMOOTHER_FLAG_G729))) &&
228  !s->opt &&
229  !s->len &&
230  (f->offset >= AST_MIN_OFFSET)) {
231  /* Optimize by sending the frame we just got
232  on the next read, thus eliminating the douple
233  copy */
234  if (swap)
236  s->opt = f;
237  s->opt_needs_swap = swap ? 1 : 0;
238  return 0;
239  }
240 
241  return smoother_frame_feed(s, f, swap);
242 }
format_t format
Definition: frame.c:87
union ast_frame_subclass subclass
Definition: frame.h:146
#define SMOOTHER_SIZE
Definition: frame.c:74
int offset
Definition: frame.h:156
void * ptr
Definition: frame.h:160
#define LOG_WARNING
Definition: logger.h:144
format_t codec
Definition: frame.h:137
int datalen
Definition: frame.h:148
static int smoother_frame_feed(struct ast_smoother *s, struct ast_frame *f, int swap)
Definition: frame.c:133
int size
Definition: frame.c:86
char * ast_getformatname(format_t format)
Get the name of a format.
Definition: frame.c:578
float samplesperbyte
Definition: frame.c:89
int len
Definition: frame.c:96
#define AST_SMOOTHER_FLAG_G729
Definition: frame.h:427
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
struct ast_frame * opt
Definition: frame.c:95
static struct ast_format f[]
Definition: format_g726.c:181
unsigned int opt_needs_swap
Definition: frame.c:90
enum ast_frame_type frametype
Definition: frame.h:144
void ast_swapcopy_samples(void *dst, const void *src, int samples)
Definition: frame.c:556
union ast_frame::@172 data
int flags
Definition: frame.c:88
#define AST_MIN_OFFSET
Definition: frame.h:205
int samples
Definition: frame.h:150
char* ast_codec2str ( format_t  codec)

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

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

Definition at line 660 of file frame.c.

References ARRAY_LEN, and ast_format_list::desc.

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

661 {
662  int x;
663  char *ret = "unknown";
664  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
665  if (AST_FORMAT_LIST[x].bits == codec) {
666  ret = AST_FORMAT_LIST[x].desc;
667  break;
668  }
669  }
670  return ret;
671 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char * desc
Definition: frame.h:554
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
format_t ast_codec_choose ( struct ast_codec_pref pref,
format_t  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.

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 ARRAY_LEN, ast_best_codec(), ast_debug, AST_FORMAT_AUDIO_MASK, ast_format_list::bits, and ast_codec_pref::order.

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

1250 {
1251  int x, slot;
1252  format_t ret = 0;
1253 
1254  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1255  slot = pref->order[x];
1256 
1257  if (!slot)
1258  break;
1259  if (formats & AST_FORMAT_LIST[slot-1].bits) {
1260  ret = AST_FORMAT_LIST[slot-1].bits;
1261  break;
1262  }
1263  }
1264  if (ret & AST_FORMAT_AUDIO_MASK)
1265  return ret;
1266 
1267  ast_debug(4, "Could not find preferred codec - %s\n", find_best ? "Going for the best codec" : "Returning zero codec");
1268 
1269  return find_best ? ast_best_codec(formats) : 0;
1270 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char order[sizeof(format_t)*8]
Definition: frame.h:39
format_t ast_best_codec(format_t fmts)
Pick the best audio codec.
Definition: channel.c:1062
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:236
static struct callattempt * find_best(struct callattempt *outgoing)
find the entry with the best metric, or NULL
Definition: app_queue.c:3540
int64_t format_t
Definition: frame_defs.h:32
Definition: file.c:65
#define AST_FORMAT_AUDIO_MASK
Definition: frame.h:274
format_t bits
Definition: frame.h:551
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
int ast_codec_get_len ( format_t  format,
int  samples 
)

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

Definition at line 1532 of file frame.c.

References AST_FORMAT_ADPCM, AST_FORMAT_ALAW, AST_FORMAT_G719, 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_SIREN14, AST_FORMAT_SIREN7, AST_FORMAT_SLINEAR, AST_FORMAT_SLINEAR16, AST_FORMAT_TESTLAW, AST_FORMAT_ULAW, ast_getformatname(), ast_log(), len(), and LOG_WARNING.

Referenced by moh_generate(), and monmp3thread().

1533 {
1534  int len = 0;
1535 
1536  /* XXX Still need speex, and lpc10 XXX */
1537  switch(format) {
1538  case AST_FORMAT_G723_1:
1539  len = (samples / 240) * 20;
1540  break;
1541  case AST_FORMAT_ILBC:
1542  len = (samples / 240) * 50;
1543  break;
1544  case AST_FORMAT_GSM:
1545  len = (samples / 160) * 33;
1546  break;
1547  case AST_FORMAT_G729A:
1548  len = samples / 8;
1549  break;
1550  case AST_FORMAT_SLINEAR:
1551  case AST_FORMAT_SLINEAR16:
1552  len = samples * 2;
1553  break;
1554  case AST_FORMAT_ULAW:
1555  case AST_FORMAT_ALAW:
1556  case AST_FORMAT_TESTLAW:
1557  len = samples;
1558  break;
1559  case AST_FORMAT_G722:
1560  case AST_FORMAT_ADPCM:
1561  case AST_FORMAT_G726:
1562  case AST_FORMAT_G726_AAL2:
1563  len = samples / 2;
1564  break;
1565  case AST_FORMAT_SIREN7:
1566  /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
1567  len = samples / (16000 / 4000);
1568  break;
1569  case AST_FORMAT_SIREN14:
1570  /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
1571  len = (int) samples / ((float) 32000 / 6000);
1572  break;
1573  case AST_FORMAT_G719:
1574  /* 48,000 samples per second at 64kbps is 8,000 bytes per second */
1575  len = (int) samples / ((float) 48000 / 8000);
1576  break;
1577  default:
1578  ast_log(LOG_WARNING, "Unable to calculate sample length for format %s\n", ast_getformatname(format));
1579  }
1580 
1581  return len;
1582 }
#define AST_FORMAT_G723_1
Definition: frame.h:242
#define LOG_WARNING
Definition: logger.h:144
#define AST_FORMAT_G729A
Definition: frame.h:258
#define AST_FORMAT_ALAW
Definition: frame.h:248
#define AST_FORMAT_G726
Definition: frame.h:264
#define AST_FORMAT_G726_AAL2
Definition: frame.h:250
#define AST_FORMAT_SLINEAR16
Definition: frame.h:272
char * ast_getformatname(format_t format)
Get the name of a format.
Definition: frame.c:578
#define AST_FORMAT_SIREN7
Definition: frame.h:268
#define AST_FORMAT_ULAW
Definition: frame.h:246
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
#define AST_FORMAT_TESTLAW
Definition: frame.h:303
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
#define AST_FORMAT_SIREN14
Definition: frame.h:270
#define AST_FORMAT_SLINEAR
Definition: frame.h:254
#define AST_FORMAT_G719
Definition: frame.h:299
#define AST_FORMAT_ADPCM
Definition: frame.h:252
#define AST_FORMAT_G722
Definition: frame.h:266
static snd_pcm_format_t format
Definition: chan_alsa.c:93
#define AST_FORMAT_ILBC
Definition: frame.h:262
#define AST_FORMAT_GSM
Definition: frame.h:244
int samples
Definition: frame.h:150
int ast_codec_get_samples ( struct ast_frame f)

Returns the number of samples contained in the frame.

Definition at line 1470 of file frame.c.

References AST_FORMAT_ADPCM, AST_FORMAT_ALAW, AST_FORMAT_G719, 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_SIREN14, AST_FORMAT_SIREN7, AST_FORMAT_SLINEAR, AST_FORMAT_SLINEAR16, AST_FORMAT_SPEEX, AST_FORMAT_SPEEX16, AST_FORMAT_TESTLAW, AST_FORMAT_ULAW, ast_getformatname_multiple(), ast_log(), ast_frame_subclass::codec, ast_frame::data, ast_frame::datalen, g723_samples(), LOG_WARNING, ast_frame::ptr, speex_samples(), and ast_frame::subclass.

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

1471 {
1472  int samples = 0;
1473  char tmp[64];
1474 
1475  switch (f->subclass.codec) {
1476  case AST_FORMAT_SPEEX:
1477  samples = speex_samples(f->data.ptr, f->datalen);
1478  break;
1479  case AST_FORMAT_SPEEX16:
1480  samples = 2 * speex_samples(f->data.ptr, f->datalen);
1481  break;
1482  case AST_FORMAT_G723_1:
1483  samples = g723_samples(f->data.ptr, f->datalen);
1484  break;
1485  case AST_FORMAT_ILBC:
1486  samples = 240 * (f->datalen / 50);
1487  break;
1488  case AST_FORMAT_GSM:
1489  samples = 160 * (f->datalen / 33);
1490  break;
1491  case AST_FORMAT_G729A:
1492  samples = f->datalen * 8;
1493  break;
1494  case AST_FORMAT_SLINEAR:
1495  case AST_FORMAT_SLINEAR16:
1496  samples = f->datalen / 2;
1497  break;
1498  case AST_FORMAT_LPC10:
1499  /* assumes that the RTP packet contains one LPC10 frame */
1500  samples = 22 * 8;
1501  samples += (((char *)(f->data.ptr))[7] & 0x1) * 8;
1502  break;
1503  case AST_FORMAT_ULAW:
1504  case AST_FORMAT_ALAW:
1505  case AST_FORMAT_TESTLAW:
1506  samples = f->datalen;
1507  break;
1508  case AST_FORMAT_G722:
1509  case AST_FORMAT_ADPCM:
1510  case AST_FORMAT_G726:
1511  case AST_FORMAT_G726_AAL2:
1512  samples = f->datalen * 2;
1513  break;
1514  case AST_FORMAT_SIREN7:
1515  /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
1516  samples = f->datalen * (16000 / 4000);
1517  break;
1518  case AST_FORMAT_SIREN14:
1519  /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
1520  samples = (int) f->datalen * ((float) 32000 / 6000);
1521  break;
1522  case AST_FORMAT_G719:
1523  /* 48,000 samples per second at 64kbps is 8,000 bytes per second */
1524  samples = (int) f->datalen * ((float) 48000 / 8000);
1525  break;
1526  default:
1527  ast_log(LOG_WARNING, "Unable to calculate samples for format %s\n", ast_getformatname_multiple(tmp, sizeof(tmp), f->subclass.codec));
1528  }
1529  return samples;
1530 }
union ast_frame_subclass subclass
Definition: frame.h:146
#define AST_FORMAT_G723_1
Definition: frame.h:242
void * ptr
Definition: frame.h:160
#define LOG_WARNING
Definition: logger.h:144
static int g723_samples(unsigned char *buf, int maxlen)
Definition: frame.c:1346
format_t codec
Definition: frame.h:137
#define AST_FORMAT_G729A
Definition: frame.h:258
#define AST_FORMAT_LPC10
Definition: frame.h:256
#define AST_FORMAT_ALAW
Definition: frame.h:248
#define AST_FORMAT_SPEEX
Definition: frame.h:260
int datalen
Definition: frame.h:148
#define AST_FORMAT_G726
Definition: frame.h:264
#define AST_FORMAT_G726_AAL2
Definition: frame.h:250
#define AST_FORMAT_SLINEAR16
Definition: frame.h:272
#define AST_FORMAT_SIREN7
Definition: frame.h:268
#define AST_FORMAT_ULAW
Definition: frame.h:246
#define AST_FORMAT_TESTLAW
Definition: frame.h:303
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
#define AST_FORMAT_SIREN14
Definition: frame.h:270
static int speex_samples(unsigned char *data, int len)
Definition: frame.c:1410
#define AST_FORMAT_SLINEAR
Definition: frame.h:254
#define AST_FORMAT_G719
Definition: frame.h:299
#define AST_FORMAT_ADPCM
Definition: frame.h:252
char * ast_getformatname_multiple(char *buf, size_t size, format_t format)
Get the names of a set of formats.
Definition: frame.c:591
#define AST_FORMAT_G722
Definition: frame.h:266
union ast_frame::@172 data
#define AST_FORMAT_ILBC
Definition: frame.h:262
#define AST_FORMAT_GSM
Definition: frame.h:244
int samples
Definition: frame.h:150
#define AST_FORMAT_SPEEX16
Definition: frame.h:301
static int ast_codec_interp_len ( format_t  format)
inlinestatic

Gets duration in ms of interpolation frame for a format.

Definition at line 782 of file frame.h.

References AST_FORMAT_ILBC.

Referenced by __get_from_jb(), and jb_get_and_deliver().

783 {
784  return (format == AST_FORMAT_ILBC) ? 30 : 20;
785 }
static snd_pcm_format_t format
Definition: chan_alsa.c:93
#define AST_FORMAT_ILBC
Definition: frame.h:262
int ast_codec_pref_append ( struct ast_codec_pref pref,
format_t  format 
)

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

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

Definition at line 1099 of file frame.c.

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

Referenced by ast_parse_allow_disallow().

1100 {
1101  int x, newindex = 0;
1102 
1104 
1105  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1106  if (AST_FORMAT_LIST[x].bits == format) {
1107  newindex = x + 1;
1108  break;
1109  }
1110  }
1111 
1112  if (newindex) {
1113  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1114  if (!pref->order[x]) {
1115  pref->order[x] = newindex;
1116  break;
1117  }
1118  }
1119  }
1120 
1121  return x;
1122 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char order[sizeof(format_t)*8]
Definition: frame.h:39
void ast_codec_pref_remove(struct ast_codec_pref *pref, format_t format)
Remove audio a codec from a preference list.
Definition: frame.c:1073
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
static snd_pcm_format_t format
Definition: chan_alsa.c:93
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.

Note
Due to a misunderstanding in how codec preferences are stored, this list starts at 'B', not 'A'. For backwards compatibility reasons, this cannot change.
Parameters
prefA codec preference list structure
bufA string denoting codec preference, appropriate for use in line transmission
sizeSize of buf
rightBoolean: if 0, convert from buf to pref; if 1, convert from pref to buf.

Definition at line 1002 of file frame.c.

References ast_codec_pref::order.

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

1003 {
1004  int x, differential = (int) 'A', mem;
1005  char *from, *to;
1006 
1007  if (right) {
1008  from = pref->order;
1009  to = buf;
1010  mem = size;
1011  } else {
1012  to = pref->order;
1013  from = buf;
1014  mem = sizeof(format_t) * 8;
1015  }
1016 
1017  memset(to, 0, mem);
1018  for (x = 0; x < sizeof(format_t) * 8; x++) {
1019  if (!from[x])
1020  break;
1021  to[x] = right ? (from[x] + differential) : (from[x] - differential);
1022  }
1023 }
char order[sizeof(format_t)*8]
Definition: frame.h:39
int64_t format_t
Definition: frame_defs.h:32
struct ast_format_list ast_codec_pref_getsize ( struct ast_codec_pref pref,
format_t  format 
)

Get packet size for codec.

Definition at line 1205 of file frame.c.

References ARRAY_LEN, ast_getformatname(), ast_log(), AST_LOG_WARNING, 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.

Referenced by add_codec_to_sdp(), ast_rtp_instance_bridge(), ast_rtp_write(), handle_open_receive_channel_ack_message(), skinny_set_rtp_peer(), and transmit_connect().

1206 {
1207  int x, idx = -1, framems = 0;
1208  struct ast_format_list fmt = { 0, };
1209 
1210  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1211  if (AST_FORMAT_LIST[x].bits == format) {
1212  fmt = AST_FORMAT_LIST[x];
1213  idx = x;
1214  break;
1215  }
1216  }
1217 
1218  if (idx < 0) {
1219  ast_log(AST_LOG_WARNING, "Format %s unknown; unable to get preferred codec packet size\n", ast_getformatname(format));
1220  return fmt;
1221  }
1222 
1223  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1224  if (pref->order[x] == (idx + 1)) {
1225  framems = pref->framing[x];
1226  break;
1227  }
1228  }
1229 
1230  /* size validation */
1231  if (!framems)
1232  framems = AST_FORMAT_LIST[idx].def_ms;
1233 
1234  if (AST_FORMAT_LIST[idx].inc_ms && framems % AST_FORMAT_LIST[idx].inc_ms) /* avoid division by zero */
1235  framems -= framems % AST_FORMAT_LIST[idx].inc_ms;
1236 
1237  if (framems < AST_FORMAT_LIST[idx].min_ms)
1238  framems = AST_FORMAT_LIST[idx].min_ms;
1239 
1240  if (framems > AST_FORMAT_LIST[idx].max_ms)
1241  framems = AST_FORMAT_LIST[idx].max_ms;
1242 
1243  fmt.cur_ms = framems;
1244 
1245  return fmt;
1246 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char order[sizeof(format_t)*8]
Definition: frame.h:39
#define AST_LOG_WARNING
Definition: logger.h:149
Definition of supported media formats (codecs)
Definition: frame.h:550
char * ast_getformatname(format_t format)
Get the name of a format.
Definition: frame.c:578
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
int framing[64]
Definition: frame.h:40
format_t bits
Definition: frame.h:551
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
static snd_pcm_format_t format
Definition: chan_alsa.c:93
format_t ast_codec_pref_index ( struct ast_codec_pref pref,
int  index 
)

Codec located at a particular place in the preference index.

Definition at line 1061 of file frame.c.

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

Referenced by _sip_show_peer(), _skinny_show_line(), add_sdp(), ast_codec_pref_string(), function_iaxpeer(), function_sippeer(), gtalk_invite(), handle_cli_iax2_show_peer(), jingle_accept_call(), print_codec_to_cli(), and socket_process().

1062 {
1063  int slot = 0;
1064 
1065  if ((idx >= 0) && (idx < sizeof(pref->order))) {
1066  slot = pref->order[idx];
1067  }
1068 
1069  return slot ? AST_FORMAT_LIST[slot - 1].bits : 0;
1070 }
char order[sizeof(format_t)*8]
Definition: frame.h:39
format_t bits
Definition: frame.h:551
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
void ast_codec_pref_init ( struct ast_codec_pref pref)

Initialize an audio codec preference to "no preference".

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

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

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

Definition at line 1125 of file frame.c.

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

Referenced by create_addr().

1126 {
1127  int x, newindex = 0;
1128 
1129  /* First step is to get the codecs "index number" */
1130  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1131  if (AST_FORMAT_LIST[x].bits == format) {
1132  newindex = x + 1;
1133  break;
1134  }
1135  }
1136  /* Done if its unknown */
1137  if (!newindex)
1138  return;
1139 
1140  /* Now find any existing occurrence, or the end */
1141  for (x = 0; x < sizeof(format_t) * 8; x++) {
1142  if (!pref->order[x] || pref->order[x] == newindex)
1143  break;
1144  }
1145 
1146  /* If we failed to find any occurrence, set to the end */
1147  if (x == sizeof(format_t) * 8) {
1148  --x;
1149  }
1150 
1151  if (only_if_existing && !pref->order[x])
1152  return;
1153 
1154  /* Move down to make space to insert - either all the way to the end,
1155  or as far as the existing location (which will be overwritten) */
1156  for (; x > 0; x--) {
1157  pref->order[x] = pref->order[x - 1];
1158  pref->framing[x] = pref->framing[x - 1];
1159  }
1160 
1161  /* And insert the new entry */
1162  pref->order[0] = newindex;
1163  pref->framing[0] = 0; /* ? */
1164 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char order[sizeof(format_t)*8]
Definition: frame.h:39
int64_t format_t
Definition: frame_defs.h:32
int framing[64]
Definition: frame.h:40
format_t bits
Definition: frame.h:551
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
static snd_pcm_format_t format
Definition: chan_alsa.c:93
void ast_codec_pref_remove ( struct ast_codec_pref pref,
format_t  format 
)

Remove audio a codec from a preference list.

Remove audio a codec from a preference list.

Definition at line 1073 of file frame.c.

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

Referenced by ast_codec_pref_append(), and ast_parse_allow_disallow().

1074 {
1075  struct ast_codec_pref oldorder;
1076  int x, y = 0;
1077  int slot;
1078  int size;
1079 
1080  if (!pref->order[0])
1081  return;
1082 
1083  memcpy(&oldorder, pref, sizeof(oldorder));
1084  memset(pref, 0, sizeof(*pref));
1085 
1086  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1087  slot = oldorder.order[x];
1088  size = oldorder.framing[x];
1089  if (! slot)
1090  break;
1091  if (AST_FORMAT_LIST[slot-1].bits != format) {
1092  pref->order[y] = slot;
1093  pref->framing[y++] = size;
1094  }
1095  }
1096 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char order[sizeof(format_t)*8]
Definition: frame.h:39
int framing[64]
Definition: frame.h:40
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
static snd_pcm_format_t format
Definition: chan_alsa.c:93
int ast_codec_pref_setsize ( struct ast_codec_pref pref,
format_t  format,
int  framems 
)

Set packet size for codec.

Definition at line 1167 of file frame.c.

References ARRAY_LEN, 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.

Referenced by ast_parse_allow_disallow(), and process_sdp_a_audio().

1168 {
1169  int x, idx = -1;
1170 
1171  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1172  if (AST_FORMAT_LIST[x].bits == format) {
1173  idx = x;
1174  break;
1175  }
1176  }
1177 
1178  if (idx < 0)
1179  return -1;
1180 
1181  /* size validation */
1182  if (!framems)
1183  framems = AST_FORMAT_LIST[idx].def_ms;
1184 
1185  if (AST_FORMAT_LIST[idx].inc_ms && framems % AST_FORMAT_LIST[idx].inc_ms) /* avoid division by zero */
1186  framems -= framems % AST_FORMAT_LIST[idx].inc_ms;
1187 
1188  if (framems < AST_FORMAT_LIST[idx].min_ms)
1189  framems = AST_FORMAT_LIST[idx].min_ms;
1190 
1191  if (framems > AST_FORMAT_LIST[idx].max_ms)
1192  framems = AST_FORMAT_LIST[idx].max_ms;
1193 
1194  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
1195  if (pref->order[x] == (idx + 1)) {
1196  pref->framing[x] = framems;
1197  break;
1198  }
1199  }
1200 
1201  return x;
1202 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char order[sizeof(format_t)*8]
Definition: frame.h:39
int framing[64]
Definition: frame.h:40
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
static snd_pcm_format_t format
Definition: chan_alsa.c:93
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 1025 of file frame.c.

References ast_codec_pref_index(), and ast_getformatname().

Referenced by dump_prefs(), and socket_process().

1026 {
1027  int x;
1028  format_t codec;
1029  size_t total_len, slen;
1030  char *formatname;
1031 
1032  memset(buf, 0, size);
1033  total_len = size;
1034  buf[0] = '(';
1035  total_len--;
1036  for (x = 0; x < sizeof(format_t) * 8; x++) {
1037  if (total_len <= 0)
1038  break;
1039  if (!(codec = ast_codec_pref_index(pref,x)))
1040  break;
1041  if ((formatname = ast_getformatname(codec))) {
1042  slen = strlen(formatname);
1043  if (slen > total_len)
1044  break;
1045  strncat(buf, formatname, total_len - 1); /* safe */
1046  total_len -= slen;
1047  }
1048  if (total_len && x < sizeof(format_t) * 8 - 1 && ast_codec_pref_index(pref, x + 1)) {
1049  strncat(buf, "|", total_len - 1); /* safe */
1050  total_len--;
1051  }
1052  }
1053  if (total_len) {
1054  strncat(buf, ")", total_len - 1); /* safe */
1055  total_len--;
1056  }
1057 
1058  return size - total_len;
1059 }
format_t ast_codec_pref_index(struct ast_codec_pref *pref, int index)
Codec located at a particular place in the preference index.
Definition: frame.c:1061
char * ast_getformatname(format_t format)
Get the name of a format.
Definition: frame.c:578
int64_t format_t
Definition: frame_defs.h:32
static force_inline int ast_format_rate ( format_t  format)
static

Get the sample rate for a given format.

Definition at line 809 of file frame.h.

References AST_FORMAT_G719, AST_FORMAT_G722, AST_FORMAT_SIREN14, AST_FORMAT_SIREN7, AST_FORMAT_SLINEAR16, and AST_FORMAT_SPEEX16.

Referenced by __ast_read(), __get_from_jb(), ast_read_generator_actions(), ast_readaudio_callback(), ast_readvideo_callback(), ast_rtp_read(), ast_smoother_read(), ast_translate(), ast_translator_best_choice(), ast_write(), calc_cost(), calc_timestamp(), generator_force(), get_rate_change_result(), handle_cli_core_show_translation(), pitch_shift(), rtp_get_rate(), and schedule_delivery().

810 {
811  switch (format) {
812  case AST_FORMAT_G722:
814  case AST_FORMAT_SIREN7:
815  case AST_FORMAT_SPEEX16:
816  return 16000;
817  case AST_FORMAT_SIREN14:
818  return 32000;
819  case AST_FORMAT_G719:
820  return 48000;
821  default:
822  return 8000;
823  }
824 }
#define AST_FORMAT_SLINEAR16
Definition: frame.h:272
#define AST_FORMAT_SIREN7
Definition: frame.h:268
#define AST_FORMAT_SIREN14
Definition: frame.h:270
#define AST_FORMAT_G719
Definition: frame.h:299
#define AST_FORMAT_G722
Definition: frame.h:266
static snd_pcm_format_t format
Definition: chan_alsa.c:93
#define AST_FORMAT_SPEEX16
Definition: frame.h:301
int ast_frame_adjust_volume ( struct ast_frame f,
int  adjustment 
)

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

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

Definition at line 1584 of file frame.c.

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

Referenced by audiohook_read_frame_single(), audiohook_volume_callback(), conf_run(), and volume_callback().

1585 {
1586  int count;
1587  short *fdata = f->data.ptr;
1588  short adjust_value = abs(adjustment);
1589 
1591  return -1;
1592 
1593  if (!adjustment)
1594  return 0;
1595 
1596  for (count = 0; count < f->samples; count++) {
1597  if (adjustment > 0) {
1598  ast_slinear_saturated_multiply(&fdata[count], &adjust_value);
1599  } else if (adjustment < 0) {
1600  ast_slinear_saturated_divide(&fdata[count], &adjust_value);
1601  }
1602  }
1603 
1604  return 0;
1605 }
union ast_frame_subclass subclass
Definition: frame.h:146
void * ptr
Definition: frame.h:160
format_t codec
Definition: frame.h:137
static force_inline void ast_slinear_saturated_multiply(short *input, short *value)
Definition: utils.h:338
static force_inline void ast_slinear_saturated_divide(short *input, short *value)
Definition: utils.h:351
#define AST_FORMAT_SLINEAR
Definition: frame.h:254
enum ast_frame_type frametype
Definition: frame.h:144
union ast_frame::@172 data
int samples
Definition: frame.h:150
int ast_frame_clear ( struct ast_frame frame)

Clear all audio samples from an ast_frame. The frame must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR.

Definition at line 1629 of file frame.c.

References AST_LIST_NEXT, ast_frame::data, ast_frame::datalen, ast_frame::next, and ast_frame::ptr.

Referenced by ast_audiohook_write_frame(), and mute_callback().

1630 {
1631  struct ast_frame *next;
1632 
1633  for (next = AST_LIST_NEXT(frame, frame_list);
1634  frame;
1635  frame = next, next = frame ? AST_LIST_NEXT(frame, frame_list) : NULL) {
1636  memset(frame->data.ptr, 0, frame->datalen);
1637  }
1638  return 0;
1639 }
void * ptr
Definition: frame.h:160
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:438
int datalen
Definition: frame.h:148
struct ast_frame * next
Definition: frame.h:164
Data structure associated with a single frame of data.
Definition: frame.h:142
union ast_frame::@172 data
void ast_frame_dump ( const char *  name,
struct ast_frame f,
char *  prefix 
)

Dump a frame for debugging purposes

Definition at line 778 of file frame.c.

References AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_FLASH, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_OFFHOOK, AST_CONTROL_OPTION, AST_CONTROL_RADIO_KEY, AST_CONTROL_RADIO_UNKEY, AST_CONTROL_RING, AST_CONTROL_RINGING, AST_CONTROL_T38_PARAMETERS, AST_CONTROL_TAKEOFFHOOK, AST_CONTROL_UNHOLD, AST_CONTROL_WINK, ast_copy_string(), 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_T38_NEGOTIATED, AST_T38_REFUSED, AST_T38_REQUEST_NEGOTIATE, AST_T38_REQUEST_TERMINATE, AST_T38_TERMINATED, ast_verbose(), ast_frame_subclass::codec, COLOR_BLACK, COLOR_BRCYAN, COLOR_BRGREEN, COLOR_BRMAGENTA, COLOR_BRRED, COLOR_YELLOW, ast_frame::data, ast_frame::datalen, ast_frame::frametype, ast_frame_subclass::integer, ast_frame::ptr, ast_control_t38_parameters::request_response, ast_frame::subclass, and term_color().

Referenced by __ast_read(), and ast_write().

779 {
780  const char noname[] = "unknown";
781  char ftype[40] = "Unknown Frametype";
782  char cft[80];
783  char subclass[40] = "Unknown Subclass";
784  char csub[80];
785  char moreinfo[40] = "";
786  char cn[60];
787  char cp[40];
788  char cmn[40];
789  const char *message = "Unknown";
790 
791  if (!name)
792  name = noname;
793 
794 
795  if (!f) {
796  ast_verbose("%s [ %s (NULL) ] [%s]\n",
797  term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
798  term_color(cft, "HANGUP", COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
799  term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
800  return;
801  }
802  /* XXX We should probably print one each of voice and video when the format changes XXX */
803  if (f->frametype == AST_FRAME_VOICE)
804  return;
805  if (f->frametype == AST_FRAME_VIDEO)
806  return;
807  switch(f->frametype) {
809  strcpy(ftype, "DTMF Begin");
810  subclass[0] = f->subclass.integer;
811  subclass[1] = '\0';
812  break;
813  case AST_FRAME_DTMF_END:
814  strcpy(ftype, "DTMF End");
815  subclass[0] = f->subclass.integer;
816  subclass[1] = '\0';
817  break;
818  case AST_FRAME_CONTROL:
819  strcpy(ftype, "Control");
820  switch (f->subclass.integer) {
821  case AST_CONTROL_HANGUP:
822  strcpy(subclass, "Hangup");
823  break;
824  case AST_CONTROL_RING:
825  strcpy(subclass, "Ring");
826  break;
827  case AST_CONTROL_RINGING:
828  strcpy(subclass, "Ringing");
829  break;
830  case AST_CONTROL_ANSWER:
831  strcpy(subclass, "Answer");
832  break;
833  case AST_CONTROL_BUSY:
834  strcpy(subclass, "Busy");
835  break;
837  strcpy(subclass, "Take Off Hook");
838  break;
839  case AST_CONTROL_OFFHOOK:
840  strcpy(subclass, "Line Off Hook");
841  break;
843  strcpy(subclass, "Congestion");
844  break;
845  case AST_CONTROL_FLASH:
846  strcpy(subclass, "Flash");
847  break;
848  case AST_CONTROL_WINK:
849  strcpy(subclass, "Wink");
850  break;
851  case AST_CONTROL_OPTION:
852  strcpy(subclass, "Option");
853  break;
855  strcpy(subclass, "Key Radio");
856  break;
858  strcpy(subclass, "Unkey Radio");
859  break;
860  case AST_CONTROL_HOLD:
861  strcpy(subclass, "Hold");
862  break;
863  case AST_CONTROL_UNHOLD:
864  strcpy(subclass, "Unhold");
865  break;
867  if (f->datalen != sizeof(struct ast_control_t38_parameters)) {
868  message = "Invalid";
869  } else {
870  struct ast_control_t38_parameters *parameters = f->data.ptr;
871  enum ast_control_t38 state = parameters->request_response;
872  if (state == AST_T38_REQUEST_NEGOTIATE)
873  message = "Negotiation Requested";
874  else if (state == AST_T38_REQUEST_TERMINATE)
875  message = "Negotiation Request Terminated";
876  else if (state == AST_T38_NEGOTIATED)
877  message = "Negotiated";
878  else if (state == AST_T38_TERMINATED)
879  message = "Terminated";
880  else if (state == AST_T38_REFUSED)
881  message = "Refused";
882  }
883  snprintf(subclass, sizeof(subclass), "T38_Parameters/%s", message);
884  break;
885  case -1:
886  strcpy(subclass, "Stop generators");
887  break;
888  default:
889  snprintf(subclass, sizeof(subclass), "Unknown control '%d'", f->subclass.integer);
890  }
891  break;
892  case AST_FRAME_NULL:
893  strcpy(ftype, "Null Frame");
894  strcpy(subclass, "N/A");
895  break;
896  case AST_FRAME_IAX:
897  /* Should never happen */
898  strcpy(ftype, "IAX Specific");
899  snprintf(subclass, sizeof(subclass), "IAX Frametype %d", f->subclass.integer);
900  break;
901  case AST_FRAME_TEXT:
902  strcpy(ftype, "Text");
903  strcpy(subclass, "N/A");
904  ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
905  break;
906  case AST_FRAME_IMAGE:
907  strcpy(ftype, "Image");
908  snprintf(subclass, sizeof(subclass), "Image format %s\n", ast_getformatname(f->subclass.codec));
909  break;
910  case AST_FRAME_HTML:
911  strcpy(ftype, "HTML");
912  switch (f->subclass.integer) {
913  case AST_HTML_URL:
914  strcpy(subclass, "URL");
915  ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
916  break;
917  case AST_HTML_DATA:
918  strcpy(subclass, "Data");
919  break;
920  case AST_HTML_BEGIN:
921  strcpy(subclass, "Begin");
922  break;
923  case AST_HTML_END:
924  strcpy(subclass, "End");
925  break;
926  case AST_HTML_LDCOMPLETE:
927  strcpy(subclass, "Load Complete");
928  break;
929  case AST_HTML_NOSUPPORT:
930  strcpy(subclass, "No Support");
931  break;
932  case AST_HTML_LINKURL:
933  strcpy(subclass, "Link URL");
934  ast_copy_string(moreinfo, f->data.ptr, sizeof(moreinfo));
935  break;
936  case AST_HTML_UNLINK:
937  strcpy(subclass, "Unlink");
938  break;
939  case AST_HTML_LINKREJECT:
940  strcpy(subclass, "Link Reject");
941  break;
942  default:
943  snprintf(subclass, sizeof(subclass), "Unknown HTML frame '%d'\n", f->subclass.integer);
944  break;
945  }
946  break;
947  case AST_FRAME_MODEM:
948  strcpy(ftype, "Modem");
949  switch (f->subclass.integer) {
950  case AST_MODEM_T38:
951  strcpy(subclass, "T.38");
952  break;
953  case AST_MODEM_V150:
954  strcpy(subclass, "V.150");
955  break;
956  default:
957  snprintf(subclass, sizeof(subclass), "Unknown MODEM frame '%d'\n", f->subclass.integer);
958  break;
959  }
960  break;
961  default:
962  snprintf(ftype, sizeof(ftype), "Unknown Frametype '%u'", f->frametype);
963  }
964  if (!ast_strlen_zero(moreinfo))
965  ast_verbose("%s [ TYPE: %s (%u) SUBCLASS: %s (%d) '%s' ] [%s]\n",
966  term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
967  term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
968  f->frametype,
969  term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
970  f->subclass.integer,
971  term_color(cmn, moreinfo, COLOR_BRGREEN, COLOR_BLACK, sizeof(cmn)),
972  term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
973  else
974  ast_verbose("%s [ TYPE: %s (%u) SUBCLASS: %s (%d) ] [%s]\n",
975  term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
976  term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
977  f->frametype,
978  term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
979  f->subclass.integer,
980  term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
981 }
union ast_frame_subclass subclass
Definition: frame.h:146
void * ptr
Definition: frame.h:160
#define AST_HTML_BEGIN
Definition: frame.h:226
#define COLOR_YELLOW
Definition: term.h:54
void ast_verbose(const char *fmt,...)
Definition: logger.c:1568
enum ast_control_t38 request_response
Definition: frame.h:412
#define AST_MODEM_T38
Definition: frame.h:216
#define AST_HTML_END
Definition: frame.h:228
format_t codec
Definition: frame.h:137
#define AST_HTML_URL
Definition: frame.h:222
#define COLOR_BRCYAN
Definition: term.h:60
#define COLOR_BRRED
Definition: term.h:50
#define AST_HTML_DATA
Definition: frame.h:224
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:63
int datalen
Definition: frame.h:148
#define COLOR_BRGREEN
Definition: term.h:52
char * term_color(char *outbuf, const char *inbuf, int fgcolor, int bgcolor, int maxout)
Definition: term.c:184
#define COLOR_BRMAGENTA
Definition: term.h:58
#define COLOR_BLACK
Definition: term.h:47
char * ast_getformatname(format_t format)
Get the name of a format.
Definition: frame.c:578
#define AST_HTML_LDCOMPLETE
Definition: frame.h:230
#define AST_HTML_LINKURL
Definition: frame.h:234
static const char name[]
#define AST_HTML_NOSUPPORT
Definition: frame.h:232
#define AST_MODEM_V150
Definition: frame.h:218
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:223
#define AST_HTML_UNLINK
Definition: frame.h:236
enum ast_frame_type frametype
Definition: frame.h:144
#define AST_HTML_LINKREJECT
Definition: frame.h:238
union ast_frame::@172 data
ast_control_t38
Definition: frame.h:384
static char prefix[MAX_PREFIX]
Definition: http.c:107
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.

Parameters
sourceRequest 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 or list of frames

Parameters
frFrame to free, or head of list to free
cacheWhether to consider this frame for frame caching

Definition at line 375 of file frame.c.

References __frame_free(), AST_LIST_NEXT, and ast_frame::next.

Referenced by mixmonitor_thread().

376 {
377  struct ast_frame *next;
378 
379  for (next = AST_LIST_NEXT(frame, frame_list);
380  frame;
381  frame = next, next = frame ? AST_LIST_NEXT(frame, frame_list) : NULL) {
382  __frame_free(frame, cache);
383  }
384 }
static void __frame_free(struct ast_frame *fr, int cache)
Definition: frame.c:341
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:438
struct ao2_container * cache
Definition: pbx_realtime.c:78
struct ast_frame * next
Definition: frame.h:164
Data structure associated with a single frame of data.
Definition: frame.h:142
int ast_frame_slinear_sum ( struct ast_frame f1,
struct ast_frame f2 
)

Sums two frames of audio samples.

Parameters
f1The first frame (which will contain the result)
f2The 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 1607 of file frame.c.

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

1608 {
1609  int count;
1610  short *data1, *data2;
1611 
1612  if ((f1->frametype != AST_FRAME_VOICE) || (f1->subclass.codec != AST_FORMAT_SLINEAR))
1613  return -1;
1614 
1615  if ((f2->frametype != AST_FRAME_VOICE) || (f2->subclass.codec != AST_FORMAT_SLINEAR))
1616  return -1;
1617 
1618  if (f1->samples != f2->samples)
1619  return -1;
1620 
1621  for (count = 0, data1 = f1->data.ptr, data2 = f2->data.ptr;
1622  count < f1->samples;
1623  count++, data1++, data2++)
1624  ast_slinear_saturated_add(data1, data2);
1625 
1626  return 0;
1627 }
union ast_frame_subclass subclass
Definition: frame.h:146
void * ptr
Definition: frame.h:160
format_t codec
Definition: frame.h:137
static force_inline void ast_slinear_saturated_add(short *input, short *value)
Definition: utils.h:312
#define AST_FORMAT_SLINEAR
Definition: frame.h:254
enum ast_frame_type frametype
Definition: frame.h:144
union ast_frame::@172 data
int samples
Definition: frame.h:150
struct ast_frame* ast_frdup ( const struct ast_frame fr)

Copies a frame.

Parameters
frframe 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 474 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_threadstorage_get(), ast_frame_subclass::codec, ast_frame::data, ast_frame::datalen, ast_frame::delivery, frame_cache, frames, ast_frame::frametype, ast_frame::len, len(), ast_frame_cache::list, ast_frame::mallocd, ast_frame::mallocd_hdr_len, ast_frame::offset, ast_frame::ptr, ast_frame::samples, ast_frame::seqno, ast_frame_cache::size, ast_frame::src, ast_frame::subclass, ast_frame::ts, and ast_frame::uint32.

Referenced by __ast_queue_frame(), ast_frisolate(), ast_indicate_data(), ast_jb_put(), ast_rtp_write(), ast_slinfactory_feed(), audiohook_read_frame_both(), audiohook_read_frame_single(), autoservice_run(), multicast_rtp_write(), process_dtmf_rfc2833(), and recordthread().

475 {
476  struct ast_frame *out = NULL;
477  int len, srclen = 0;
478  void *buf = NULL;
479 
480 #if !defined(LOW_MEMORY)
481  struct ast_frame_cache *frames;
482 #endif
483 
484  /* Start with standard stuff */
485  len = sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
486  /* If we have a source, add space for it */
487  /*
488  * XXX Watch out here - if we receive a src which is not terminated
489  * properly, we can be easily attacked. Should limit the size we deal with.
490  */
491  if (f->src)
492  srclen = strlen(f->src);
493  if (srclen > 0)
494  len += srclen + 1;
495 
496 #if !defined(LOW_MEMORY)
497  if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames)))) {
499  if (out->mallocd_hdr_len >= len) {
500  size_t mallocd_len = out->mallocd_hdr_len;
501 
503  memset(out, 0, sizeof(*out));
504  out->mallocd_hdr_len = mallocd_len;
505  buf = out;
506  frames->size--;
507  break;
508  }
509  }
511  }
512 #endif
513 
514  if (!buf) {
515  if (!(buf = ast_calloc_cache(1, len)))
516  return NULL;
517  out = buf;
518  out->mallocd_hdr_len = len;
519  }
520 
521  out->frametype = f->frametype;
522  out->subclass.codec = f->subclass.codec;
523  out->datalen = f->datalen;
524  out->samples = f->samples;
525  out->delivery = f->delivery;
526  /* Even though this new frame was allocated from the heap, we can't mark it
527  * with AST_MALLOCD_HDR, AST_MALLOCD_DATA and AST_MALLOCD_SRC, because that
528  * would cause ast_frfree() to attempt to individually free each of those
529  * under the assumption that they were separately allocated. Since this frame
530  * was allocated in a single allocation, we'll only mark it as if the header
531  * was heap-allocated; this will result in the entire frame being properly freed.
532  */
533  out->mallocd = AST_MALLOCD_HDR;
535  if (out->datalen) {
536  out->data.ptr = buf + sizeof(*out) + AST_FRIENDLY_OFFSET;
537  memcpy(out->data.ptr, f->data.ptr, out->datalen);
538  } else {
539  out->data.uint32 = f->data.uint32;
540  }
541  if (srclen > 0) {
542  /* This may seem a little strange, but it's to avoid a gcc (4.2.4) compiler warning */
543  char *src;
544  out->src = buf + sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
545  src = (char *) out->src;
546  /* Must have space since we allocated for it */
547  strcpy(src, f->src);
548  }
550  out->ts = f->ts;
551  out->len = f->len;
552  out->seqno = f->seqno;
553  return out;
554 }
union ast_frame_subclass subclass
Definition: frame.h:146
int offset
Definition: frame.h:156
void * ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size)
Retrieve thread storage.
int seqno
Definition: frame.h:172
void * ptr
Definition: frame.h:160
long ts
Definition: frame.h:168
struct ast_frames list
Definition: frame.c:69
#define ast_copy_flags(dest, src, flagz)
Definition: utils.h:84
format_t codec
Definition: frame.h:137
#define AST_LIST_TRAVERSE_SAFE_END
Closes a safe loop traversal block.
Definition: linkedlists.h:600
static int frames
Definition: iax2-parser.c:49
static struct ast_threadstorage frame_cache
Definition: frame.c:51
#define AST_FRIENDLY_OFFSET
Offset into a frame&#39;s data buffer.
Definition: frame.h:204
const char * src
Definition: frame.h:158
int datalen
Definition: frame.h:148
#define AST_LIST_REMOVE_CURRENT(field)
Removes the current entry from a list during a traversal.
Definition: linkedlists.h:554
size_t mallocd_hdr_len
Definition: frame.h:154
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
static struct ast_format f[]
Definition: format_g726.c:181
#define AST_MALLOCD_HDR
Definition: frame.h:208
struct timeval delivery
Definition: frame.h:162
int mallocd
Definition: frame.h:152
Data structure associated with a single frame of data.
Definition: frame.h:142
uint32_t uint32
Definition: frame.h:160
#define AST_LIST_TRAVERSE_SAFE_BEGIN(head, var, field)
Loops safely over (traverses) the entries in a list.
Definition: linkedlists.h:528
enum ast_frame_type frametype
Definition: frame.h:144
size_t size
Definition: frame.c:70
union ast_frame::@172 data
long len
Definition: frame.h:170
int samples
Definition: frame.h:150
#define ast_calloc_cache(a, b)
Definition: astmm.h:85
struct ast_frame* ast_frisolate ( struct ast_frame fr)

Makes a frame independent of any static storage.

Parameters
frframe 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
Note
This function may modify the frame passed to it, so you must not assume the frame will be intact after the isolated frame has been produced. In other words, calling this function on a frame should be the last operation you do with that frame before freeing it (or exiting the block, if the frame is on the stack.)

Makes a frame independent of any static storage.

Definition at line 391 of file frame.c.

References ast_copy_flags, ast_frame_header_new(), ast_frdup(), ast_free, 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_subclass::codec, ast_frame::data, ast_frame::datalen, ast_frame::frametype, ast_frame::len, ast_frame::mallocd, ast_frame::offset, ast_frame::ptr, ast_frame::samples, ast_frame::seqno, ast_frame::src, ast_frame::subclass, ast_frame::ts, and ast_frame::uint32.

Referenced by __ast_answer(), ast_dsp_process(), ast_rtp_read(), ast_safe_sleep_conditional(), ast_slinfactory_feed(), ast_trans_frameout(), ast_write(), autoservice_run(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), feature_request_and_dial(), jpeg_read_image(), read_frame(), spandsp_fax_read(), and t38_tx_packet_handler().

392 {
393  struct ast_frame *out;
394  void *newdata;
395 
396  /* if none of the existing frame is malloc'd, let ast_frdup() do it
397  since it is more efficient
398  */
399  if (fr->mallocd == 0) {
400  return ast_frdup(fr);
401  }
402 
403  /* if everything is already malloc'd, we are done */
406  return fr;
407  }
408 
409  if (!(fr->mallocd & AST_MALLOCD_HDR)) {
410  /* Allocate a new header if needed */
411  if (!(out = ast_frame_header_new())) {
412  return NULL;
413  }
414  out->frametype = fr->frametype;
415  out->subclass.codec = fr->subclass.codec;
416  out->datalen = fr->datalen;
417  out->samples = fr->samples;
418  out->offset = fr->offset;
419  /* Copy the timing data */
422  out->ts = fr->ts;
423  out->len = fr->len;
424  out->seqno = fr->seqno;
425  }
426  } else {
427  out = fr;
428  }
429 
430  if (!(fr->mallocd & AST_MALLOCD_SRC) && fr->src) {
431  if (!(out->src = ast_strdup(fr->src))) {
432  if (out != fr) {
433  ast_free(out);
434  }
435  return NULL;
436  }
437  } else {
438  out->src = fr->src;
439  fr->src = NULL;
440  fr->mallocd &= ~AST_MALLOCD_SRC;
441  }
442 
443  if (!(fr->mallocd & AST_MALLOCD_DATA)) {
444  if (!fr->datalen) {
445  out->data.uint32 = fr->data.uint32;
447  return out;
448  }
449  if (!(newdata = ast_malloc(fr->datalen + AST_FRIENDLY_OFFSET))) {
450  if (out->src != fr->src) {
451  ast_free((void *) out->src);
452  }
453  if (out != fr) {
454  ast_free(out);
455  }
456  return NULL;
457  }
458  newdata += AST_FRIENDLY_OFFSET;
460  out->datalen = fr->datalen;
461  memcpy(newdata, fr->data.ptr, fr->datalen);
462  out->data.ptr = newdata;
463  } else {
464  out->data = fr->data;
465  memset(&fr->data, 0, sizeof(fr->data));
466  fr->mallocd &= ~AST_MALLOCD_DATA;
467  }
468 
470 
471  return out;
472 }
union ast_frame_subclass subclass
Definition: frame.h:146
int offset
Definition: frame.h:156
int seqno
Definition: frame.h:172
#define ast_strdup(a)
Definition: astmm.h:109
#define ast_test_flag(p, flag)
Definition: utils.h:63
void * ptr
Definition: frame.h:160
long ts
Definition: frame.h:168
#define ast_copy_flags(dest, src, flagz)
Definition: utils.h:84
format_t codec
Definition: frame.h:137
static struct ast_frame * ast_frame_header_new(void)
Definition: frame.c:299
#define AST_FRIENDLY_OFFSET
Offset into a frame&#39;s data buffer.
Definition: frame.h:204
const char * src
Definition: frame.h:158
int datalen
Definition: frame.h:148
#define AST_MALLOCD_SRC
Definition: frame.h:212
#define ast_free(a)
Definition: astmm.h:97
#define AST_MALLOCD_HDR
Definition: frame.h:208
int mallocd
Definition: frame.h:152
Data structure associated with a single frame of data.
Definition: frame.h:142
uint32_t uint32
Definition: frame.h:160
enum ast_frame_type frametype
Definition: frame.h:144
#define ast_malloc(a)
Definition: astmm.h:91
union ast_frame::@172 data
long len
Definition: frame.h:170
struct ast_frame * ast_frdup(const struct ast_frame *fr)
Copies a frame.
Definition: frame.c:474
int samples
Definition: frame.h:150
#define AST_MALLOCD_DATA
Definition: frame.h:210
struct ast_format_list* ast_get_format_list ( size_t *  size)

Definition at line 572 of file frame.c.

References ARRAY_LEN, and AST_FORMAT_LIST.

Referenced by ast_data_add_codecs(), complete_trans_path_choice(), and handle_cli_core_show_translation().

573 {
574  *size = ARRAY_LEN(AST_FORMAT_LIST);
575  return AST_FORMAT_LIST;
576 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
struct ast_format_list* ast_get_format_list_index ( int  index)

Definition at line 567 of file frame.c.

568 {
569  return &AST_FORMAT_LIST[idx];
570 }
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
format_t ast_getformatbyname ( const char *  name)

Gets a format from a name.

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

Definition at line 641 of file frame.c.

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

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

642 {
643  int x, all;
644  format_t format = 0;
645 
646  all = strcasecmp(name, "all") ? 0 : 1;
647  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
648  if (all ||
649  !strcasecmp(AST_FORMAT_LIST[x].name,name) ||
650  !strcasecmp(AST_FORMAT_LIST[x].name, ast_expand_codec_alias(name))) {
651  format |= AST_FORMAT_LIST[x].bits;
652  if (!all)
653  break;
654  }
655  }
656 
657  return format;
658 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static const char * ast_expand_codec_alias(const char *in)
Definition: frame.c:630
int64_t format_t
Definition: frame_defs.h:32
static const char name[]
format_t bits
Definition: frame.h:551
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
static snd_pcm_format_t format
Definition: chan_alsa.c:93
char* ast_getformatname ( format_t  format)

Get the name of a format.

Parameters
formatid of format
Returns
A static string containing the name of the format or "unknown" if unknown.

Definition at line 578 of file frame.c.

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

Referenced by __ast_play_and_record(), __ast_read(), __ast_register_translator(), __ast_smoother_feed(), _sip_show_peer(), _skinny_show_line(), add_codec_to_answer(), add_codec_to_sdp(), add_sdp(), add_tcodec_to_sdp(), add_vcodec_to_sdp(), agent_call(), ast_channel_make_compatible_helper(), ast_codec_get_len(), ast_codec_pref_getsize(), ast_codec_pref_string(), ast_do_masquerade(), ast_dsp_process(), ast_frame_dump(), ast_openvstream(), ast_rtp_instance_bridge(), ast_rtp_write(), ast_slinfactory_feed(), ast_stopstream(), ast_streamfile(), ast_translate_path_to_str(), ast_translator_build_path(), ast_unregister_translator(), ast_write(), ast_writestream(), background_detect_exec(), bridge_channel_join(), bridge_make_compatible(), conf_run(), dahdi_read(), dahdi_write(), do_waiting(), dump_versioned_codec(), eagi_exec(), func_channel_read(), function_iaxpeer(), function_sippeer(), g719write(), g726_write(), g729_write(), gsm_write(), gtalk_rtp_read(), gtalk_show_channels(), gtalk_write(), h263_write(), h264_write(), handle_cli_core_show_file_formats(), handle_cli_core_show_translation(), handle_cli_iax2_show_channels(), handle_cli_iax2_show_peer(), handle_cli_moh_show_classes(), handle_core_show_image_formats(), handle_open_receive_channel_ack_message(), iax2_request(), iax_show_provisioning(), ilbc_write(), isAnsweringMachine(), jack_hook_callback(), jingle_rtp_read(), jingle_show_channels(), jingle_write(), login_exec(), mgcp_rtp_read(), mgcp_write(), misdn_write(), moh_files_release(), moh_release(), nbs_request(), nbs_xwrite(), ogg_vorbis_write(), oh323_rtp_read(), oh323_write(), pcm_write(), phone_setup(), phone_write(), print_codec_to_cli(), print_frame(), process_sdp_a_audio(), rebuild_matrix(), register_translator(), remote_bridge_loop(), set_format(), set_local_capabilities(), set_peer_capabilities(), setup_rtp_connection(), show_codecs(), sip_request_call(), sip_rtp_read(), sip_write(), siren14write(), siren7write(), skinny_new(), skinny_rtp_read(), skinny_set_rtp_peer(), skinny_write(), slinear_write(), socket_process(), start_rtp(), unistim_new(), unistim_request(), unistim_rtp_read(), unistim_write(), vox_write(), and wav_write().

579 {
580  int x;
581  char *ret = "unknown";
582  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
583  if (AST_FORMAT_LIST[x].bits == format) {
584  ret = AST_FORMAT_LIST[x].name;
585  break;
586  }
587  }
588  return ret;
589 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
char * name
Definition: frame.h:552
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
static snd_pcm_format_t format
Definition: chan_alsa.c:93
char* ast_getformatname_multiple ( char *  buf,
size_t  size,
format_t  format 
)

Get the names of a set of formats.

Parameters
bufa buffer for the output string
sizesize of buf (bytes)
formatthe 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 591 of file frame.c.

References ARRAY_LEN, ast_copy_string(), ast_format_list::bits, len(), and name.

Referenced by __ast_read(), _sip_show_peer(), _skinny_show_device(), _skinny_show_line(), add_sdp(), alsa_request(), ast_best_codec(), ast_codec_get_samples(), ast_request(), ast_streamfile(), ast_write(), bridge_make_compatible(), console_request(), function_iaxpeer(), function_sippeer(), gtalk_is_answered(), gtalk_newcall(), gtalk_write(), handle_capabilities_res_message(), handle_cli_core_show_channeltype(), handle_cli_iax2_show_peer(), handle_showchan(), iax2_bridge(), jingle_write(), mgcp_request(), mgcp_write(), oh323_request(), oh323_write(), oss_request(), phone_request(), process_sdp(), serialize_showchan(), set_format(), setup_rtp_connection(), show_channels_cb(), sip_new(), sip_request_call(), sip_show_channel(), sip_show_settings(), sip_write(), skinny_new(), skinny_request(), skinny_write(), socket_process(), start_rtp(), unistim_new(), unistim_request(), and unistim_write().

592 {
593  int x;
594  unsigned len;
595  char *start, *end = buf;
596 
597  if (!size)
598  return buf;
599  snprintf(end, size, "0x%llx (", (unsigned long long) format);
600  len = strlen(end);
601  end += len;
602  size -= len;
603  start = end;
604  for (x = 0; x < ARRAY_LEN(AST_FORMAT_LIST); x++) {
605  if (AST_FORMAT_LIST[x].bits & format) {
606  snprintf(end, size, "%s|", AST_FORMAT_LIST[x].name);
607  len = strlen(end);
608  end += len;
609  size -= len;
610  }
611  }
612  if (start == end)
613  ast_copy_string(start, "nothing)", size);
614  else if (size > 1)
615  *(end - 1) = ')';
616  return buf;
617 }
#define ARRAY_LEN(a)
Definition: isdn_lib.c:42
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
static const char name[]
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:223
static struct ast_format_list AST_FORMAT_LIST[]
Definition of supported media formats (codecs)
Definition: frame.c:100
static snd_pcm_format_t format
Definition: chan_alsa.c:93
int ast_parse_allow_disallow ( struct ast_codec_pref pref,
format_t 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.

Returns
Returns number of errors encountered during parsing

Definition at line 1272 of file frame.c.

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

Referenced by action_originate(), apply_outgoing(), build_peer(), build_user(), config_parse_variables(), gtalk_create_member(), gtalk_load_config(), jingle_create_member(), jingle_load_config(), reload_config(), set_config(), skinny_unregister(), and update_common_options().

1273 {
1274  int errors = 0, framems = 0;
1275  char *parse = NULL, *this = NULL, *psize = NULL;
1276  format_t format = 0;
1277 
1278  parse = ast_strdupa(list);
1279  while ((this = strsep(&parse, ","))) {
1280  framems = 0;
1281  if ((psize = strrchr(this, ':'))) {
1282  *psize++ = '\0';
1283  ast_debug(1, "Packetization for codec: %s is %s\n", this, psize);
1284  framems = atoi(psize);
1285  if (framems < 0) {
1286  framems = 0;
1287  errors++;
1288  ast_log(LOG_WARNING, "Bad packetization value for codec %s\n", this);
1289  }
1290  }
1291  if (!(format = ast_getformatbyname(this))) {
1292  ast_log(LOG_WARNING, "Cannot %s unknown format '%s'\n", allowing ? "allow" : "disallow", this);
1293  errors++;
1294  continue;
1295  }
1296 
1297  if (mask) {
1298  if (allowing)
1299  *mask |= format;
1300  else
1301  *mask &= ~format;
1302  }
1303 
1304  /* Set up a preference list for audio. Do not include video in preferences
1305  since we can not transcode video and have to use whatever is offered
1306  */
1307  if (pref && (format & AST_FORMAT_AUDIO_MASK)) {
1308  if (strcasecmp(this, "all")) {
1309  if (allowing) {
1310  ast_codec_pref_append(pref, format);
1311  ast_codec_pref_setsize(pref, format, framems);
1312  }
1313  else
1314  ast_codec_pref_remove(pref, format);
1315  } else if (!allowing) {
1316  memset(pref, 0, sizeof(*pref));
1317  }
1318  }
1319  }
1320  return errors;
1321 }
char * strsep(char **str, const char *delims)
int ast_codec_pref_setsize(struct ast_codec_pref *pref, format_t format, int framems)
Set packet size for codec.
Definition: frame.c:1167
#define LOG_WARNING
Definition: logger.h:144
int ast_codec_pref_append(struct ast_codec_pref *pref, format_t format)
Append a audio codec to a preference list, removing it first if it was already there.
Definition: frame.c:1099
#define ast_debug(level,...)
Log a DEBUG message.
Definition: logger.h:236
void ast_codec_pref_remove(struct ast_codec_pref *pref, format_t format)
Remove audio a codec from a preference list.
Definition: frame.c:1073
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition: utils.h:663
format_t ast_getformatbyname(const char *name)
Gets a format from a name.
Definition: frame.c:641
int64_t format_t
Definition: frame_defs.h:32
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
static void parse(struct mgcp_request *req)
Definition: chan_mgcp.c:1858
#define AST_FORMAT_AUDIO_MASK
Definition: frame.h:274
static snd_pcm_format_t format
Definition: chan_alsa.c:93
void ast_smoother_free ( struct ast_smoother s)

Definition at line 294 of file frame.c.

References ast_free.

Referenced by ast_rtp_destroy(), ast_rtp_write(), destroy_session(), and generic_fax_exec().

295 {
296  ast_free(s);
297 }
#define ast_free(a)
Definition: astmm.h:97
int ast_smoother_get_flags ( struct ast_smoother smoother)

Definition at line 193 of file frame.c.

References ast_smoother::flags.

194 {
195  return s->flags;
196 }
struct ast_smoother* ast_smoother_new ( int  bytes)

Definition at line 183 of file frame.c.

References ast_malloc, and ast_smoother_reset().

Referenced by ast_rtp_write(), and generic_fax_exec().

184 {
185  struct ast_smoother *s;
186  if (size < 1)
187  return NULL;
188  if ((s = ast_malloc(sizeof(*s))))
190  return s;
191 }
void ast_smoother_reset(struct ast_smoother *s, int bytes)
Definition: frame.c:155
int size
Definition: frame.c:86
#define ast_malloc(a)
Definition: astmm.h:91
struct ast_frame* ast_smoother_read ( struct ast_smoother s)

Definition at line 244 of file frame.c.

References ast_format_rate(), AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log(), ast_samp2tv(), AST_SMOOTHER_FLAG_G729, ast_tvadd(), ast_tvzero(), ast_frame_subclass::codec, 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::ptr, ast_frame::samples, ast_smoother::samplesperbyte, ast_smoother::size, and ast_frame::subclass.

Referenced by ast_rtp_write(), and generic_fax_exec().

245 {
246  struct ast_frame *opt;
247  int len;
248 
249  /* IF we have an optimization frame, send it */
250  if (s->opt) {
251  if (s->opt->offset < AST_FRIENDLY_OFFSET)
252  ast_log(LOG_WARNING, "Returning a frame of inappropriate offset (%d).\n",
253  s->opt->offset);
254  opt = s->opt;
255  s->opt = NULL;
256  return opt;
257  }
258 
259  /* Make sure we have enough data */
260  if (s->len < s->size) {
261  /* Or, if this is a G.729 frame with VAD on it, send it immediately anyway */
262  if (!((s->flags & AST_SMOOTHER_FLAG_G729) && (s->len % 10)))
263  return NULL;
264  }
265  len = s->size;
266  if (len > s->len)
267  len = s->len;
268  /* Make frame */
270  s->f.subclass.codec = s->format;
273  s->f.datalen = len;
274  /* Samples will be improper given VAD, but with VAD the concept really doesn't even exist */
275  s->f.samples = len * s->samplesperbyte; /* XXX rounding */
276  s->f.delivery = s->delivery;
277  /* Fill Data */
278  memcpy(s->f.data.ptr, s->data, len);
279  s->len -= len;
280  /* Move remaining data to the front if applicable */
281  if (s->len) {
282  /* In principle this should all be fine because if we are sending
283  G.729 VAD, the next timestamp will take over anyawy */
284  memmove(s->data, s->data + len, s->len);
285  if (!ast_tvzero(s->delivery)) {
286  /* If we have delivery time, increment it, otherwise, leave it at 0 */
288  }
289  }
290  /* Return frame */
291  return &s->f;
292 }
format_t format
Definition: frame.c:87
union ast_frame_subclass subclass
Definition: frame.h:146
int offset
Definition: frame.h:156
void * ptr
Definition: frame.h:160
#define LOG_WARNING
Definition: logger.h:144
int ast_tvzero(const struct timeval t)
Returns true if the argument is 0,0.
Definition: time.h:100
static force_inline int ast_format_rate(format_t format)
Get the sample rate for a given format.
Definition: frame.h:809
format_t codec
Definition: frame.h:137
struct ast_frame f
Definition: frame.c:91
#define AST_FRIENDLY_OFFSET
Offset into a frame&#39;s data buffer.
Definition: frame.h:204
int datalen
Definition: frame.h:148
struct timeval ast_samp2tv(unsigned int _nsamp, unsigned int _rate)
Returns a timeval corresponding to the duration of n samples at rate r. Useful to convert samples to ...
Definition: time.h:191
char data[SMOOTHER_SIZE]
Definition: frame.c:93
int size
Definition: frame.c:86
float samplesperbyte
Definition: frame.c:89
int len
Definition: frame.c:96
#define AST_SMOOTHER_FLAG_G729
Definition: frame.h:427
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
struct timeval delivery
Definition: frame.c:92
struct timeval ast_tvadd(struct timeval a, struct timeval b)
Returns the sum of two timevals a + b.
Definition: utils.c:1587
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
struct ast_frame * opt
Definition: frame.c:95
struct timeval delivery
Definition: frame.h:162
Data structure associated with a single frame of data.
Definition: frame.h:142
char framedata[SMOOTHER_SIZE+AST_FRIENDLY_OFFSET]
Definition: frame.c:94
enum ast_frame_type frametype
Definition: frame.h:144
union ast_frame::@172 data
int flags
Definition: frame.c:88
int samples
Definition: frame.h:150
void ast_smoother_reconfigure ( struct ast_smoother s,
int  bytes 
)

Reconfigure an existing smoother to output a different number of bytes per frame.

Parameters
sthe smoother to reconfigure
bytesthe desired number of bytes per output frame
Returns
nothing

Definition at line 161 of file frame.c.

References ast_smoother::opt, ast_smoother::opt_needs_swap, ast_smoother::size, and smoother_frame_feed().

162 {
163  /* if there is no change, then nothing to do */
164  if (s->size == bytes) {
165  return;
166  }
167  /* set the new desired output size */
168  s->size = bytes;
169  /* if there is no 'optimized' frame in the smoother,
170  * then there is nothing left to do
171  */
172  if (!s->opt) {
173  return;
174  }
175  /* there is an 'optimized' frame here at the old size,
176  * but it must now be put into the buffer so the data
177  * can be extracted at the new size
178  */
180  s->opt = NULL;
181 }
static int smoother_frame_feed(struct ast_smoother *s, struct ast_frame *f, int swap)
Definition: frame.c:133
int size
Definition: frame.c:86
struct ast_frame * opt
Definition: frame.c:95
unsigned int opt_needs_swap
Definition: frame.c:90
void ast_smoother_reset ( struct ast_smoother s,
int  bytes 
)

Definition at line 155 of file frame.c.

References ast_smoother::size.

Referenced by ast_smoother_new().

156 {
157  memset(s, 0, sizeof(*s));
158  s->size = bytes;
159 }
int size
Definition: frame.c:86
void ast_smoother_set_flags ( struct ast_smoother smoother,
int  flags 
)

Definition at line 198 of file frame.c.

References ast_smoother::flags.

Referenced by ast_rtp_write().

199 {
200  s->flags = flags;
201 }
unsigned int flags
Definition: frame.h:166
int ast_smoother_test_flag ( struct ast_smoother s,
int  flag 
)

Definition at line 203 of file frame.c.

References ast_smoother::flags.

Referenced by ast_rtp_write().

204 {
205  return (s->flags & flag);
206 }
int flags
Definition: frame.c:88
void ast_swapcopy_samples ( void *  dst,
const void *  src,
int  samples 
)

Definition at line 556 of file frame.c.

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

557 {
558  int i;
559  unsigned short *dst_s = dst;
560  const unsigned short *src_s = src;
561 
562  for (i = 0; i < samples; i++)
563  dst_s[i] = (src_s[i]<<8) | (src_s[i]>>8);
564 }
const char * src
Definition: frame.h:158
int samples
Definition: frame.h:150

Variable Documentation