Asterisk internal frame definitions. More...

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

Include dependency graph for frame.h:

Go to the source code of this file.

Data Structures
struct	ast_control_pvt_cause_code
struct	ast_control_read_action_payload
struct	ast_control_t38_parameters
struct	ast_frame
	Data structure associated with a single frame of data. More...
union	ast_frame_subclass
struct	ast_option_header
struct	oprmode
Defines
#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.
#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.
#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_MCID = 31, AST_CONTROL_UPDATE_RTP_PEER = 32, AST_CONTROL_PVT_CAUSE_CODE = 33 }
	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
int	ast_codec_get_len (struct ast_format *format, int samples)
	Returns the number of bytes for the number of samples of the given format.
int	ast_codec_get_samples (struct ast_frame *f)
	Returns the number of samples contained in the frame.
static int	ast_codec_interp_len (struct ast_format *format)
	Gets duration in ms of interpolation frame for a format.
int	ast_frame_adjust_volume (struct ast_frame *f, int adjustment)
	Adjusts the volume of the audio samples contained in a frame.
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.
void	ast_frame_dump (const char name, struct ast_frame f, char *prefix)
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.
int	ast_frame_slinear_sum (struct ast_frame f1, struct ast_frame f2)
	Sums two frames of audio samples.
void	ast_frame_subclass2str (struct ast_frame f, char subclass, size_t slen, char *moreinfo, size_t mlen)
	Copy the discription of a frame's subclass into the provided string.
void	ast_frame_type2str (enum ast_frame_type frame_type, char *ftype, size_t len)
	Copy the discription of a frame type into the provided string.
struct ast_frame *	ast_frdup (const struct ast_frame *fr)
	Copies a frame.
struct ast_frame *	ast_frisolate (struct ast_frame *fr)
	Makes a frame independent of any static storage.
int	ast_parse_allow_disallow (struct ast_codec_pref pref, struct ast_format_cap cap, const char *list, int allowing)
	Parse an "allow" or "deny" line in a channel or device configuration and update the capabilities and pref if provided. Video codecs are not added to codec preference lists, since we can not transcode.
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_smoother *	ast_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.
int	__ast_smoother_feed (struct ast_smoother s, struct ast_frame f, int swap)
struct ast_frame *	ast_smoother_read (struct ast_smoother *s)

Detailed Description

Asterisk internal frame definitions.

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

Definition in file frame.h.

Define Documentation

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

Definition at line 537 of file frame.h.

Referenced by ast_rtp_read(), and socket_process_helper().

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

Referenced by phone_read().

#define AST_FRAME_DTMF AST_FRAME_DTMF_END

Definition at line 124 of file frame.h.

Referenced by __adsi_transmit_messages(), __analog_ss_thread(), __ast_play_and_record(), action_atxfer(), action_dahdidialoffhook(), agent_ack_sleep(), analog_ss_thread(), ast_audiohook_write_list(), ast_dsp_process(), ast_generic_bridge(), ast_jb_put(), background_detect_exec(), cb_events(), channel_spy(), cli_console_dial(), conf_run(), console_dial(), dictate_exec(), disa_exec(), do_immediate_setup(), echo_exec(), eivr_comm(), fax_detect_framehook(), feature_request_and_dial(), gtalk_handle_dtmf(), handle_recordfile(), handle_request(), handle_request_info(), handle_speechrecognize(), iax2_bridge(), jingle_handle_dtmf(), keypad_digit(), mgcp_rtp_read(), misdn_bridge(), mp3_exec(), NBScat_exec(), oh323_rtp_read(), phone_exception(), pri_dchannel(), process_ast_dsp(), receive_dtmf_digits(), record_exec(), send_waveform_to_channel(), sip_rtp_read(), speech_background(), unistim_do_senddigit(), unistim_senddigit_end(), volume_callback(), wait_for_answer(), and wait_for_winner().

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

Value:

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

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

Definition at line 179 of file frame.h.

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

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

Definition at line 504 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_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(), audiohook_read_frame_helper(), autoservice_run(), background_detect_exec(), bridge_handle_dtmf(), 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(), fax_detect_framehook(), fax_gateway_framehook(), feature_request_and_dial(), find_cache(), framehook_detach_and_destroy(), gen_generate(), generate_computational_cost(), generic_fax_exec(), handle_cli_file_convert(), handle_recordfile(), handle_speechrecognize(), hook_event_cb(), iax2_bridge(), ices_exec(), isAnsweringMachine(), jack_exec(), jb_empty_and_reset_adaptive(), jb_empty_and_reset_fixed(), jb_framedata_destroy(), jb_get_and_deliver(), jingle_read(), 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(), softmix_translate_helper_cleanup(), softmix_translate_helper_free_entry(), spandsp_fax_gw_t30_gen(), speech_background(), spy_generate(), t38_tx_packet_handler(), 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 200 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(), generic_read(), gsm_read(), h263_read(), h264_read(), hook_event_cb(), 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(), sms_generate(), spandsp_fax_gw_t30_gen(), spandsp_fax_read(), tonepair_generator(), vox_read(), and wav_read().

#define AST_HTML_BEGIN 4

Beginning frame

Definition at line 222 of file frame.h.

Referenced by ast_frame_subclass2str().

#define AST_HTML_DATA 2

Data frame

Definition at line 220 of file frame.h.

Referenced by ast_frame_subclass2str().

#define AST_HTML_END 8

End frame

Definition at line 224 of file frame.h.

Referenced by ast_frame_subclass2str().

#define AST_HTML_LDCOMPLETE 16

Load is complete

Definition at line 226 of file frame.h.

Referenced by ast_frame_subclass2str(), and sendurl_exec().

#define AST_HTML_LINKREJECT 20

Reject link request

Definition at line 234 of file frame.h.

Referenced by ast_frame_subclass2str().

#define AST_HTML_LINKURL 18

Send URL, and track

Definition at line 230 of file frame.h.

Referenced by ast_frame_subclass2str().

#define AST_HTML_NOSUPPORT 17

Peer is unable to support HTML

Definition at line 228 of file frame.h.

Referenced by ast_frame_subclass2str(), and sendurl_exec().

#define AST_HTML_UNLINK 19

No more HTML linkage

Definition at line 232 of file frame.h.

Referenced by ast_frame_subclass2str().

#define AST_HTML_URL 1

Sending a URL

Definition at line 218 of file frame.h.

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

#define AST_MALLOCD_DATA (1 << 1)

Need the data be free'd?

Definition at line 206 of file frame.h.

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

#define AST_MALLOCD_HDR (1 << 0)

Need the header be free'd?

Definition at line 204 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 208 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 201 of file frame.h.

Referenced by __ast_smoother_feed().

#define AST_MODEM_T38 1

T.38 Fax-over-IP

Definition at line 212 of file frame.h.

Referenced by ast_frame_subclass2str(), ast_udptl_write(), fax_gateway_framehook(), generic_fax_exec(), spandsp_fax_gateway_process(), t38_tx_packet_handler(), transmit_t38(), and udptl_rx_packet().

#define AST_MODEM_V150 2

V.150 Modem-over-IP

Definition at line 214 of file frame.h.

Referenced by ast_frame_subclass2str().

#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 391 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 458 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 422 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 454 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 446 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 414 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 450 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 370 of file frame.h.

#define AST_OPTION_FLAG_ANSWER 5

Definition at line 373 of file frame.h.

#define AST_OPTION_FLAG_QUERY 4

Definition at line 372 of file frame.h.

#define AST_OPTION_FLAG_REJECT 2

Definition at line 371 of file frame.h.

#define AST_OPTION_FLAG_REQUEST 0

Definition at line 369 of file frame.h.

Referenced by ast_bridge_call(), and iax2_setoption().

#define AST_OPTION_FLAG_WTF 6

Definition at line 374 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 432 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 436 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 442 of file frame.h.

Referenced by ast_channel_make_compatible_helper(), and sip_setoption().

#define AST_OPTION_OPRMODE 7

Definition at line 407 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 387 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 401 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

Definition at line 463 of file frame.h.

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

#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 462 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 428 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 383 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 379 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 396 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 583 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 588 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 589 of file frame.h.

#define AST_SMOOTHER_FLAG_BE (1 << 1)

Definition at line 366 of file frame.h.

Referenced by ast_rtp_write(), and format_list_init().

#define AST_SMOOTHER_FLAG_G729 (1 << 0)

Definition at line 365 of file frame.h.

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

Enumeration Type Documentation

anonymous enum

Enumerator:

AST_FRFLAG_HAS_TIMING_INFO

This frame contains valid timing information

Definition at line 126 of file frame.h.

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

enum ast_control_frame_type

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_MCID	Indicate that the caller is being malicious.
AST_CONTROL_UPDATE_RTP_PEER	Interrupt the bridge and have it update the peer
AST_CONTROL_PVT_CAUSE_CODE	Contains an update to the protocol-specific cause-code stored for branching dials

Definition at line 248 of file frame.h.

                            {
   AST_CONTROL_HANGUP = 1,       /*!< Other end has hungup */
   AST_CONTROL_RING = 2,         /*!< Local ring */
   AST_CONTROL_RINGING = 3,      /*!< Remote end is ringing */
   AST_CONTROL_ANSWER = 4,       /*!< Remote end has answered */
   AST_CONTROL_BUSY = 5,         /*!< Remote end is busy */
   AST_CONTROL_TAKEOFFHOOK = 6,  /*!< Make it go off hook */
   AST_CONTROL_OFFHOOK = 7,      /*!< Line is off hook */
   AST_CONTROL_CONGESTION = 8,      /*!< Congestion (circuits busy) */
   AST_CONTROL_FLASH = 9,        /*!< Flash hook */
   AST_CONTROL_WINK = 10,        /*!< Wink */
   AST_CONTROL_OPTION = 11,      /*!< Set a low-level option */
   AST_CONTROL_RADIO_KEY = 12,      /*!< Key Radio */
   AST_CONTROL_RADIO_UNKEY = 13, /*!< Un-Key Radio */
   AST_CONTROL_PROGRESS = 14,    /*!< Indicate PROGRESS */
   AST_CONTROL_PROCEEDING = 15,  /*!< Indicate CALL PROCEEDING */
   AST_CONTROL_HOLD = 16,        /*!< Indicate call is placed on hold */
   AST_CONTROL_UNHOLD = 17,      /*!< Indicate call is left from hold */
   AST_CONTROL_VIDUPDATE = 18,      /*!< Indicate video frame update */
   _XXX_AST_CONTROL_T38 = 19,    /*!< T38 state change request/notification \deprecated This is no longer supported. Use AST_CONTROL_T38_PARAMETERS instead. */
   AST_CONTROL_SRCUPDATE = 20,      /*!< Indicate source of media has changed */
   AST_CONTROL_TRANSFER = 21,    /*!< Indicate status of a transfer request */
   AST_CONTROL_CONNECTED_LINE = 22,/*!< Indicate connected line has changed */
   AST_CONTROL_REDIRECTING = 23, /*!< Indicate redirecting id has changed */
   AST_CONTROL_T38_PARAMETERS = 24,/*!< T38 state change request/notification with parameters */
   AST_CONTROL_CC = 25,       /*!< Indication that Call completion service is possible */
   AST_CONTROL_SRCCHANGE = 26,      /*!< Media source has changed and requires a new RTP SSRC */
   AST_CONTROL_READ_ACTION = 27, /*!< Tell ast_read to take a specific action */
   AST_CONTROL_AOC = 28,         /*!< Advice of Charge with encoded generic AOC payload */
   AST_CONTROL_END_OF_Q = 29,    /*!< Indicate that this position was the end of the channel queue for a softhangup. */
   AST_CONTROL_INCOMPLETE = 30,  /*!< Indication that the extension dialed is incomplete */
   AST_CONTROL_MCID = 31,        /*!< Indicate that the caller is being malicious. */
   AST_CONTROL_UPDATE_RTP_PEER = 32, /*!< Interrupt the bridge and have it update the peer */
   AST_CONTROL_PVT_CAUSE_CODE = 33, /*!< Contains an update to the protocol-specific cause-code stored for branching dials */

   /*
    * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING 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.
    *
    * WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING WARNING
    */
};

enum ast_control_t38

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

                     {
   AST_T38_REQUEST_NEGOTIATE = 1,   /*!< 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 */
};

enum ast_control_t38_rate

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

                          {
   AST_T38_RATE_2400 = 1,
   AST_T38_RATE_4800,
   AST_T38_RATE_7200,
   AST_T38_RATE_9600,
   AST_T38_RATE_12000,
   /* Set to 0 so it's taken as default when unspecified.
    * See ITU-T T.38 Implementors' Guide (11 May 2012),
    * Table H.2: if the T38MaxBitRate attribute is omitted
    * it should use a default of 14400. */
   AST_T38_RATE_14400 = 0,
};

enum ast_control_t38_rate_management

Enumerator:

AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF
AST_T38_RATE_MANAGEMENT_LOCAL_TCF

Definition at line 337 of file frame.h.

                                     {
   AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF = 0,
   AST_T38_RATE_MANAGEMENT_LOCAL_TCF,
};

enum ast_control_transfer

Enumerator:

AST_TRANSFER_SUCCESS	Transfer request on the channel worked
AST_TRANSFER_FAILED	Transfer request on the channel failed

Definition at line 353 of file frame.h.

                          {
   AST_TRANSFER_SUCCESS = 0, /*!< Transfer request on the channel worked */
   AST_TRANSFER_FAILED,      /*!< Transfer request on the channel failed */
};

enum ast_frame_read_action

Enumerator:

AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO

Definition at line 298 of file frame.h.

                           {
   AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO,
};

enum ast_frame_type

Frame types.

Note:: It is important that the values of each frame type are never changed, because it will break backwards compatability with older versions. 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 97 of file frame.h.

                    {
   /*! DTMF end event, subclass is the digit */
   AST_FRAME_DTMF_END = 1,
   /*! Voice data, subclass is AST_FORMAT_* */
   AST_FRAME_VOICE,
   /*! Video frame, maybe?? :) */
   AST_FRAME_VIDEO,
   /*! A control frame, subclass is AST_CONTROL_* */
   AST_FRAME_CONTROL,
   /*! An empty, useless frame */
   AST_FRAME_NULL,
   /*! Inter Asterisk Exchange private frame type */
   AST_FRAME_IAX,
   /*! Text messages */
   AST_FRAME_TEXT,
   /*! Image Frames */
   AST_FRAME_IMAGE,
   /*! HTML Frame */
   AST_FRAME_HTML,
   /*! Comfort Noise frame (subclass is level of CNG in -dBov), 
       body may include zero or more 8-bit quantization coefficients */
   AST_FRAME_CNG,
   /*! Modem-over-IP data streams */
   AST_FRAME_MODEM,  
   /*! DTMF begin event, subclass is the digit */
   AST_FRAME_DTMF_BEGIN,
};

Function Documentation

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

Definition at line 176 of file frame.c.

References ast_format_cmp(), AST_FORMAT_CMP_NOT_EQUAL, ast_format_copy(), AST_FRAME_VOICE, ast_getformatname(), ast_log(), AST_MIN_OFFSET, AST_SMOOTHER_FLAG_G729, ast_swapcopy_samples(), ast_frame::data, ast_frame::datalen, f, ast_smoother::flags, ast_smoother::format, ast_frame_subclass::format, ast_frame::frametype, ast_format::id, 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.

{
   if (f->frametype != AST_FRAME_VOICE) {
      ast_log(LOG_WARNING, "Huh?  Can't smooth a non-voice frame!\n");
      return -1;
   }
   if (!s->format.id) {
      ast_format_copy(&s->format, &f->subclass.format);
      s->samplesperbyte = (float)f->samples / (float)f->datalen;
   } else if (ast_format_cmp(&s->format, &f->subclass.format) == AST_FORMAT_CMP_NOT_EQUAL) {
      ast_log(LOG_WARNING, "Smoother was working on %s format frames, now trying to feed %s?\n",
         ast_getformatname(&s->format), ast_getformatname(&f->subclass.format));
      return -1;
   }
   if (s->len + f->datalen > SMOOTHER_SIZE) {
      ast_log(LOG_WARNING, "Out of smoother space\n");
      return -1;
   }
   if (((f->datalen == s->size) ||
        ((f->datalen < 10) && (s->flags & AST_SMOOTHER_FLAG_G729))) &&
       !s->opt &&
       !s->len &&
       (f->offset >= AST_MIN_OFFSET)) {
      /* Optimize by sending the frame we just got
         on the next read, thus eliminating the douple
         copy */
      if (swap)
         ast_swapcopy_samples(f->data.ptr, f->data.ptr, f->samples);
      s->opt = f;
      s->opt_needs_swap = swap ? 1 : 0;
      return 0;
   }

   return smoother_frame_feed(s, f, swap);
}

int ast_codec_get_len	(	struct ast_format *	format,
		int	samples
	)

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

Definition at line 1092 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(), ast_format::id, len(), and LOG_WARNING.

Referenced by moh_generate(), and monmp3thread().

{
   int len = 0;

   /* XXX Still need speex, and lpc10 XXX */
   switch(format->id) {
   case AST_FORMAT_G723_1:
      len = (samples / 240) * 20;
      break;
   case AST_FORMAT_ILBC:
      len = (samples / 240) * 50;
      break;
   case AST_FORMAT_GSM:
      len = (samples / 160) * 33;
      break;
   case AST_FORMAT_G729A:
      len = samples / 8;
      break;
   case AST_FORMAT_SLINEAR:
   case AST_FORMAT_SLINEAR16:
      len = samples * 2;
      break;
   case AST_FORMAT_ULAW:
   case AST_FORMAT_ALAW:
   case AST_FORMAT_TESTLAW:
      len = samples;
      break;
   case AST_FORMAT_G722:
   case AST_FORMAT_ADPCM:
   case AST_FORMAT_G726:
   case AST_FORMAT_G726_AAL2:
      len = samples / 2;
      break;
   case AST_FORMAT_SIREN7:
      /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
      len = samples / (16000 / 4000);
      break;
   case AST_FORMAT_SIREN14:
      /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
      len = (int) samples / ((float) 32000 / 6000);
      break;
   case AST_FORMAT_G719:
      /* 48,000 samples per second at 64kbps is 8,000 bytes per second */
      len = (int) samples / ((float) 48000 / 8000);
      break;
   default:
      ast_log(LOG_WARNING, "Unable to calculate sample length for format %s\n", ast_getformatname(format));
   }

   return len;
}

int ast_codec_get_samples ( struct ast_frame * f )

Returns the number of samples contained in the frame.

Definition at line 1005 of file frame.c.

References AST_FORMAT_ADPCM, AST_FORMAT_ALAW, AST_FORMAT_ATTR_END, AST_FORMAT_CELT, 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_isset(), AST_FORMAT_LPC10, ast_format_rate(), AST_FORMAT_SILK, AST_FORMAT_SIREN14, AST_FORMAT_SIREN7, AST_FORMAT_SLINEAR, AST_FORMAT_SLINEAR16, AST_FORMAT_SPEEX, AST_FORMAT_SPEEX16, AST_FORMAT_SPEEX32, AST_FORMAT_TESTLAW, AST_FORMAT_ULAW, ast_getformatname(), ast_log(), ast_frame::data, ast_frame::datalen, ast_frame_subclass::format, g723_samples(), ast_format::id, LOG_WARNING, ast_frame::ptr, SILK_ATTR_KEY_SAMP_RATE, SILK_ATTR_VAL_SAMP_12KHZ, SILK_ATTR_VAL_SAMP_16KHZ, SILK_ATTR_VAL_SAMP_24KHZ, speex_samples(), and ast_frame::subclass.

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

{
   int samples = 0;

   switch (f->subclass.format.id) {
   case AST_FORMAT_SPEEX:
      samples = speex_samples(f->data.ptr, f->datalen);
      break;
   case AST_FORMAT_SPEEX16:
      samples = 2 * speex_samples(f->data.ptr, f->datalen);
      break;
   case AST_FORMAT_SPEEX32:
      samples = 4 * speex_samples(f->data.ptr, f->datalen);
      break;
   case AST_FORMAT_G723_1:
      samples = g723_samples(f->data.ptr, f->datalen);
      break;
   case AST_FORMAT_ILBC:
      samples = 240 * (f->datalen / 50);
      break;
   case AST_FORMAT_GSM:
      samples = 160 * (f->datalen / 33);
      break;
   case AST_FORMAT_G729A:
      samples = f->datalen * 8;
      break;
   case AST_FORMAT_SLINEAR:
   case AST_FORMAT_SLINEAR16:
      samples = f->datalen / 2;
      break;
   case AST_FORMAT_LPC10:
      /* assumes that the RTP packet contains one LPC10 frame */
      samples = 22 * 8;
      samples += (((char *)(f->data.ptr))[7] & 0x1) * 8;
      break;
   case AST_FORMAT_ULAW:
   case AST_FORMAT_ALAW:
   case AST_FORMAT_TESTLAW:
      samples = f->datalen;
      break;
   case AST_FORMAT_G722:
   case AST_FORMAT_ADPCM:
   case AST_FORMAT_G726:
   case AST_FORMAT_G726_AAL2:
      samples = f->datalen * 2;
      break;
   case AST_FORMAT_SIREN7:
      /* 16,000 samples per second at 32kbps is 4,000 bytes per second */
      samples = f->datalen * (16000 / 4000);
      break;
   case AST_FORMAT_SIREN14:
      /* 32,000 samples per second at 48kbps is 6,000 bytes per second */
      samples = (int) f->datalen * ((float) 32000 / 6000);
      break;
   case AST_FORMAT_G719:
      /* 48,000 samples per second at 64kbps is 8,000 bytes per second */
      samples = (int) f->datalen * ((float) 48000 / 8000);
      break;
   case AST_FORMAT_SILK:
      if (!(ast_format_isset(&f->subclass.format,
         SILK_ATTR_KEY_SAMP_RATE,
         SILK_ATTR_VAL_SAMP_24KHZ,
         AST_FORMAT_ATTR_END))) {
         return 480;
      } else if (!(ast_format_isset(&f->subclass.format,
         SILK_ATTR_KEY_SAMP_RATE,
         SILK_ATTR_VAL_SAMP_16KHZ,
         AST_FORMAT_ATTR_END))) {
         return 320;
      } else if (!(ast_format_isset(&f->subclass.format,
         SILK_ATTR_KEY_SAMP_RATE,
         SILK_ATTR_VAL_SAMP_12KHZ,
         AST_FORMAT_ATTR_END))) {
         return 240;
      } else {
         return 160;
      }
   case AST_FORMAT_CELT:
      /* TODO The assumes 20ms delivery right now, which is incorrect */
      samples = ast_format_rate(&f->subclass.format) / 50;
      break;
   default:
      ast_log(LOG_WARNING, "Unable to calculate samples for format %s\n", ast_getformatname(&f->subclass.format));
   }
   return samples;
}

static int ast_codec_interp_len ( struct ast_format * format ) [inline, static]

Gets duration in ms of interpolation frame for a format.

Definition at line 606 of file frame.h.

References AST_FORMAT_ILBC, and ast_format::id.

Referenced by __get_from_jb(), and jb_get_and_deliver().

{ 
   return (format->id == AST_FORMAT_ILBC) ? 30 : 20;
}

int ast_frame_adjust_volume	(	struct ast_frame *	f,
		int	adjustment
	)

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

Parameters:

f	The frame containing the samples (must be AST_FRAME_VOICE and AST_FORMAT_SLINEAR)
adjustment	The number of dB to adjust up or down.

Returns:: 0 for success, non-zero for an error

Definition at line 1144 of file frame.c.

References ast_format_is_slinear(), AST_FRAME_VOICE, ast_slinear_saturated_divide(), ast_slinear_saturated_multiply(), ast_frame::data, ast_frame_subclass::format, 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().

{
   int count;
   short *fdata = f->data.ptr;
   short adjust_value = abs(adjustment);

   if ((f->frametype != AST_FRAME_VOICE) || !(ast_format_is_slinear(&f->subclass.format))) {
      return -1;
   }

   if (!adjustment) {
      return 0;
   }

   for (count = 0; count < f->samples; count++) {
      if (adjustment > 0) {
         ast_slinear_saturated_multiply(&fdata[count], &adjust_value);
      } else if (adjustment < 0) {
         ast_slinear_saturated_divide(&fdata[count], &adjust_value);
      }
   }

   return 0;
}

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

{
   struct ast_frame *next;

   for (next = AST_LIST_NEXT(frame, frame_list);
       frame;
       frame = next, next = frame ? AST_LIST_NEXT(frame, frame_list) : NULL) {
      memset(frame->data.ptr, 0, frame->datalen);
   }
   return 0;
}

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

Dump a frame for debugging purposes

Definition at line 741 of file frame.c.

References ast_frame_subclass2str(), ast_frame_type2str(), AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_strlen_zero(), ast_verb, COLOR_BLACK, COLOR_BRCYAN, COLOR_BRGREEN, COLOR_BRMAGENTA, COLOR_BRRED, COLOR_YELLOW, ast_frame::frametype, ast_frame_subclass::integer, ast_frame::subclass, and term_color().

Referenced by __ast_read(), and ast_write().

{
   const char noname[] = "unknown";
   char ftype[40] = "Unknown Frametype";
   char cft[80];
   char subclass[40] = "Unknown Subclass";
   char csub[80];
   char moreinfo[40] = "";
   char cn[60];
   char cp[40];
   char cmn[40];

   if (!name) {
      name = noname;
   }

   if (!f) {
      ast_verb(-1, "%s [ %s (NULL) ] [%s]\n",
         term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
         term_color(cft, "HANGUP", COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
         term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
      return;
   }
   /* XXX We should probably print one each of voice and video when the format changes XXX */
   if (f->frametype == AST_FRAME_VOICE) {
      return;
   }
   if (f->frametype == AST_FRAME_VIDEO) {
      return;
   }

   ast_frame_type2str(f->frametype, ftype, sizeof(ftype));
   ast_frame_subclass2str(f, subclass, sizeof(subclass), moreinfo, sizeof(moreinfo));

   if (!ast_strlen_zero(moreinfo))
      ast_verb(-1, "%s [ TYPE: %s (%d) SUBCLASS: %s (%d) '%s' ] [%s]\n",
             term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
             term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
             f->frametype,
             term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
             f->subclass.integer,
             term_color(cmn, moreinfo, COLOR_BRGREEN, COLOR_BLACK, sizeof(cmn)),
             term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
   else
      ast_verb(-1, "%s [ TYPE: %s (%d) SUBCLASS: %s (%d) ] [%s]\n",
             term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
             term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
             f->frametype,
             term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
             f->subclass.integer,
             term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
}

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

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

void ast_frame_free	(	struct ast_frame *	fr,
		int	cache
	)

Requests a frame to be allocated.

Parameters:

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

Frees a frame or list of frames

Parameters:

fr	Frame to free, or head of list to free
cache	Whether to consider this frame for frame caching

Definition at line 343 of file frame.c.

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

Referenced by mixmonitor_thread().

{
   struct ast_frame *next;

   for (next = AST_LIST_NEXT(frame, frame_list);
        frame;
        frame = next, next = frame ? AST_LIST_NEXT(frame, frame_list) : NULL) {
      __frame_free(frame, cache);
   }
}

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

Sums two frames of audio samples.

Parameters:

f1	The first frame (which will contain the result)
f2	The second frame

Returns:: 0 for success, non-zero for an error

The frames must be AST_FRAME_VOICE and must contain AST_FORMAT_SLINEAR samples, and must contain the same number of samples.

Definition at line 1169 of file frame.c.

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

{
   int count;
   short *data1, *data2;

   if ((f1->frametype != AST_FRAME_VOICE) || (f1->subclass.format.id != AST_FORMAT_SLINEAR))
      return -1;

   if ((f2->frametype != AST_FRAME_VOICE) || (f2->subclass.format.id != AST_FORMAT_SLINEAR))
      return -1;

   if (f1->samples != f2->samples)
      return -1;

   for (count = 0, data1 = f1->data.ptr, data2 = f2->data.ptr;
        count < f1->samples;
        count++, data1++, data2++)
      ast_slinear_saturated_add(data1, data2);

   return 0;
}

void ast_frame_subclass2str	(	struct ast_frame *	f,
		char *	subclass,
		size_t	slen,
		char *	moreinfo,
		size_t	mlen
	)

Copy the discription of a frame's subclass into the provided string.

Parameters:

f	The frame to get the information from
subclass	Buffer to fill with subclass information
slen	Length of subclass buffer
moreinfo	Buffer to fill with additional information
mlen	Length of moreinfo buffer

Since:: 11

Definition at line 534 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_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_T38_NEGOTIATED, AST_T38_REFUSED, AST_T38_REQUEST_NEGOTIATE, AST_T38_REQUEST_TERMINATE, AST_T38_TERMINATED, ast_frame::data, ast_frame::datalen, ast_frame_subclass::format, ast_frame::frametype, ast_frame_subclass::integer, ast_frame::ptr, ast_control_t38_parameters::request_response, and ast_frame::subclass.

Referenced by ast_frame_dump().

{
   switch(f->frametype) {
   case AST_FRAME_DTMF_BEGIN:
      if (slen > 1) {
         subclass[0] = f->subclass.integer;
         subclass[1] = '\0';
      }
      break;
   case AST_FRAME_DTMF_END:
      if (slen > 1) {
         subclass[0] = f->subclass.integer;
         subclass[1] = '\0';
      }
      break;
   case AST_FRAME_CONTROL:
      switch (f->subclass.integer) {
      case AST_CONTROL_HANGUP:
         ast_copy_string(subclass, "Hangup", slen);
         break;
      case AST_CONTROL_RING:
         ast_copy_string(subclass, "Ring", slen);
         break;
      case AST_CONTROL_RINGING:
         ast_copy_string(subclass, "Ringing", slen);
         break;
      case AST_CONTROL_ANSWER:
         ast_copy_string(subclass, "Answer", slen);
         break;
      case AST_CONTROL_BUSY:
         ast_copy_string(subclass, "Busy", slen);
         break;
      case AST_CONTROL_TAKEOFFHOOK:
         ast_copy_string(subclass, "Take Off Hook", slen);
         break;
      case AST_CONTROL_OFFHOOK:
         ast_copy_string(subclass, "Line Off Hook", slen);
         break;
      case AST_CONTROL_CONGESTION:
         ast_copy_string(subclass, "Congestion", slen);
         break;
      case AST_CONTROL_FLASH:
         ast_copy_string(subclass, "Flash", slen);
         break;
      case AST_CONTROL_WINK:
         ast_copy_string(subclass, "Wink", slen);
         break;
      case AST_CONTROL_OPTION:
         ast_copy_string(subclass, "Option", slen);
         break;
      case AST_CONTROL_RADIO_KEY:
         ast_copy_string(subclass, "Key Radio", slen);
         break;
      case AST_CONTROL_RADIO_UNKEY:
         ast_copy_string(subclass, "Unkey Radio", slen);
         break;
      case AST_CONTROL_HOLD:
         ast_copy_string(subclass, "Hold", slen);
         break;
      case AST_CONTROL_UNHOLD:
         ast_copy_string(subclass, "Unhold", slen);
         break;
      case AST_CONTROL_T38_PARAMETERS: {
         char *message = "Unknown";
         if (f->datalen != sizeof(struct ast_control_t38_parameters)) {
            message = "Invalid";
         } else {
            struct ast_control_t38_parameters *parameters = f->data.ptr;
            enum ast_control_t38 state = parameters->request_response;
            if (state == AST_T38_REQUEST_NEGOTIATE)
               message = "Negotiation Requested";
            else if (state == AST_T38_REQUEST_TERMINATE)
               message = "Negotiation Request Terminated";
            else if (state == AST_T38_NEGOTIATED)
               message = "Negotiated";
            else if (state == AST_T38_TERMINATED)
               message = "Terminated";
            else if (state == AST_T38_REFUSED)
               message = "Refused";
         }
         snprintf(subclass, slen, "T38_Parameters/%s", message);
         break;
      }
      case -1:
         ast_copy_string(subclass, "Stop generators", slen);
         break;
      default:
         snprintf(subclass, slen, "Unknown control '%d'", f->subclass.integer);
      }
      break;
   case AST_FRAME_NULL:
      ast_copy_string(subclass, "N/A", slen);
      break;
   case AST_FRAME_IAX:
      /* Should never happen */
      snprintf(subclass, slen, "IAX Frametype %d", f->subclass.integer);
      break;
   case AST_FRAME_TEXT:
      ast_copy_string(subclass, "N/A", slen);
      if (moreinfo) {
         ast_copy_string(moreinfo, f->data.ptr, mlen);
      }
      break;
   case AST_FRAME_IMAGE:
      snprintf(subclass, slen, "Image format %s\n", ast_getformatname(&f->subclass.format));
      break;
   case AST_FRAME_HTML:
      switch (f->subclass.integer) {
      case AST_HTML_URL:
         ast_copy_string(subclass, "URL", slen);
         if (moreinfo) {
            ast_copy_string(moreinfo, f->data.ptr, mlen);
         }
         break;
      case AST_HTML_DATA:
         ast_copy_string(subclass, "Data", slen);
         break;
      case AST_HTML_BEGIN:
         ast_copy_string(subclass, "Begin", slen);
         break;
      case AST_HTML_END:
         ast_copy_string(subclass, "End", slen);
         break;
      case AST_HTML_LDCOMPLETE:
         ast_copy_string(subclass, "Load Complete", slen);
         break;
      case AST_HTML_NOSUPPORT:
         ast_copy_string(subclass, "No Support", slen);
         break;
      case AST_HTML_LINKURL:
         ast_copy_string(subclass, "Link URL", slen);
         if (moreinfo) {
            ast_copy_string(moreinfo, f->data.ptr, mlen);
         }
         break;
      case AST_HTML_UNLINK:
         ast_copy_string(subclass, "Unlink", slen);
         break;
      case AST_HTML_LINKREJECT:
         ast_copy_string(subclass, "Link Reject", slen);
         break;
      default:
         snprintf(subclass, slen, "Unknown HTML frame '%d'\n", f->subclass.integer);
         break;
      }
      break;
   case AST_FRAME_MODEM:
      switch (f->subclass.integer) {
      case AST_MODEM_T38:
         ast_copy_string(subclass, "T.38", slen);
         break;
      case AST_MODEM_V150:
         ast_copy_string(subclass, "V.150", slen);
         break;
      default:
         snprintf(subclass, slen, "Unknown MODEM frame '%d'\n", f->subclass.integer);
         break;
      }
      break;
   default:
      ast_copy_string(subclass, "Unknown Subclass", slen);
   }
}

void ast_frame_type2str	(	enum ast_frame_type	frame_type,
		char *	ftype,
		size_t	len
	)

Copy the discription of a frame type into the provided string.

Parameters:

frame_type	The frame type to be described
ftype	Buffer to fill with frame type description
len	Length of subclass buffer

Since:: 11

Definition at line 698 of file frame.c.

References 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, and AST_FRAME_VOICE.

Referenced by ast_frame_dump().

{
   switch (frame_type) {
   case AST_FRAME_DTMF_BEGIN:
      ast_copy_string(ftype, "DTMF Begin", len);
      break;
   case AST_FRAME_DTMF_END:
      ast_copy_string(ftype, "DTMF End", len);
      break;
   case AST_FRAME_CONTROL:
      ast_copy_string(ftype, "Control", len);
      break;
   case AST_FRAME_NULL:
      ast_copy_string(ftype, "Null Frame", len);
      break;
   case AST_FRAME_IAX:
      /* Should never happen */
      ast_copy_string(ftype, "IAX Specific", len);
      break;
   case AST_FRAME_TEXT:
      ast_copy_string(ftype, "Text", len);
      break;
   case AST_FRAME_IMAGE:
      ast_copy_string(ftype, "Image", len);
      break;
   case AST_FRAME_HTML:
      ast_copy_string(ftype, "HTML", len);
      break;
   case AST_FRAME_MODEM:
      ast_copy_string(ftype, "Modem", len);
      break;
   case AST_FRAME_VOICE:
      ast_copy_string(ftype, "Voice", len);
      break;
   case AST_FRAME_VIDEO:
      ast_copy_string(ftype, "Video", len);
      break;
   default:
      snprintf(ftype, len, "Unknown Frametype '%d'", frame_type);
   }
}

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

Copies a frame.

Parameters:

fr	frame to copy Duplicates a frame -- should only rarely be used, typically frisolate is good enough

Returns:: Returns a frame on success, NULL on error

Definition at line 442 of file frame.c.

References ast_calloc_cache, ast_copy_flags, AST_FLAGS_ALL, ast_format_copy(), 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::data, ast_frame::datalen, ast_frame::delivery, ast_frame_subclass::format, 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(), hook_event_cb(), multicast_rtp_write(), process_dtmf_rfc2833(), and recordthread().

{
   struct ast_frame *out = NULL;
   int len, srclen = 0;
   void *buf = NULL;

#if !defined(LOW_MEMORY)
   struct ast_frame_cache *frames;
#endif

   /* Start with standard stuff */
   len = sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
   /* If we have a source, add space for it */
   /*
    * XXX Watch out here - if we receive a src which is not terminated
    * properly, we can be easily attacked. Should limit the size we deal with.
    */
   if (f->src)
      srclen = strlen(f->src);
   if (srclen > 0)
      len += srclen + 1;

#if !defined(LOW_MEMORY)
   if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames)))) {
      AST_LIST_TRAVERSE_SAFE_BEGIN(&frames->list, out, frame_list) {
         if (out->mallocd_hdr_len >= len) {
            size_t mallocd_len = out->mallocd_hdr_len;

            AST_LIST_REMOVE_CURRENT(frame_list);
            memset(out, 0, sizeof(*out));
            out->mallocd_hdr_len = mallocd_len;
            buf = out;
            frames->size--;
            break;
         }
      }
      AST_LIST_TRAVERSE_SAFE_END;
   }
#endif

   if (!buf) {
      if (!(buf = ast_calloc_cache(1, len)))
         return NULL;
      out = buf;
      out->mallocd_hdr_len = len;
   }

   out->frametype = f->frametype;
   ast_format_copy(&out->subclass.format, &f->subclass.format);
   out->datalen = f->datalen;
   out->samples = f->samples;
   out->delivery = f->delivery;
   /* Even though this new frame was allocated from the heap, we can't mark it
    * with AST_MALLOCD_HDR, AST_MALLOCD_DATA and AST_MALLOCD_SRC, because that
    * would cause ast_frfree() to attempt to individually free each of those
    * under the assumption that they were separately allocated. Since this frame
    * was allocated in a single allocation, we'll only mark it as if the header
    * was heap-allocated; this will result in the entire frame being properly freed.
    */
   out->mallocd = AST_MALLOCD_HDR;
   out->offset = AST_FRIENDLY_OFFSET;
   if (out->datalen) {
      out->data.ptr = buf + sizeof(*out) + AST_FRIENDLY_OFFSET;
      memcpy(out->data.ptr, f->data.ptr, out->datalen);
   } else {
      out->data.uint32 = f->data.uint32;
   }
   if (srclen > 0) {
      /* This may seem a little strange, but it's to avoid a gcc (4.2.4) compiler warning */
      char *src;
      out->src = buf + sizeof(*out) + AST_FRIENDLY_OFFSET + f->datalen;
      src = (char *) out->src;
      /* Must have space since we allocated for it */
      strcpy(src, f->src);
   }
   ast_copy_flags(out, f, AST_FLAGS_ALL);
   out->ts = f->ts;
   out->len = f->len;
   out->seqno = f->seqno;
   return out;
}

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

Makes a frame independent of any static storage.

Parameters:

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

Returns:: Returns a frame on success, NULL on error

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

Definition at line 359 of file frame.c.

References ast_copy_flags, AST_FLAGS_ALL, ast_format_copy(), 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::data, ast_frame::datalen, ast_frame_subclass::format, 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(), fax_gateway_framehook(), fax_gateway_request_t38(), feature_request_and_dial(), hook_event_cb(), jpeg_read_image(), read_frame(), spandsp_fax_gw_t30_gen(), spandsp_fax_read(), and t38_tx_packet_handler().

{
   struct ast_frame *out;
   void *newdata;

   /* if none of the existing frame is malloc'd, let ast_frdup() do it
      since it is more efficient
   */
   if (fr->mallocd == 0) {
      return ast_frdup(fr);
   }

   /* if everything is already malloc'd, we are done */
   if ((fr->mallocd & (AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA)) ==
       (AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA)) {
      return fr;
   }

   if (!(fr->mallocd & AST_MALLOCD_HDR)) {
      /* Allocate a new header if needed */
      if (!(out = ast_frame_header_new())) {
         return NULL;
      }
      out->frametype = fr->frametype;
      ast_format_copy(&out->subclass.format, &fr->subclass.format);
      out->datalen = fr->datalen;
      out->samples = fr->samples;
      out->offset = fr->offset;
      /* Copy the timing data */
      ast_copy_flags(out, fr, AST_FLAGS_ALL);
      if (ast_test_flag(fr, AST_FRFLAG_HAS_TIMING_INFO)) {
         out->ts = fr->ts;
         out->len = fr->len;
         out->seqno = fr->seqno;
      }
   } else {
      out = fr;
   }

   if (!(fr->mallocd & AST_MALLOCD_SRC) && fr->src) {
      if (!(out->src = ast_strdup(fr->src))) {
         if (out != fr) {
            ast_free(out);
         }
         return NULL;
      }
   } else {
      out->src = fr->src;
      fr->src = NULL;
      fr->mallocd &= ~AST_MALLOCD_SRC;
   }

   if (!(fr->mallocd & AST_MALLOCD_DATA))  {
      if (!fr->datalen) {
         out->data.uint32 = fr->data.uint32;
         out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC;
         return out;
      }
      if (!(newdata = ast_malloc(fr->datalen + AST_FRIENDLY_OFFSET))) {
         if (out->src != fr->src) {
            ast_free((void *) out->src);
         }
         if (out != fr) {
            ast_free(out);
         }
         return NULL;
      }
      newdata += AST_FRIENDLY_OFFSET;
      out->offset = AST_FRIENDLY_OFFSET;
      out->datalen = fr->datalen;
      memcpy(newdata, fr->data.ptr, fr->datalen);
      out->data.ptr = newdata;
   } else {
      out->data = fr->data;
      memset(&fr->data, 0, sizeof(fr->data));
      fr->mallocd &= ~AST_MALLOCD_DATA;
   }

   out->mallocd = AST_MALLOCD_HDR | AST_MALLOCD_SRC | AST_MALLOCD_DATA;

   return out;
}

int ast_parse_allow_disallow	(	struct ast_codec_pref *	pref,
		struct ast_format_cap *	cap,
		const char *	list,
		int	allowing
	)

Parse an "allow" or "deny" line in a channel or device configuration and update the capabilities 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 794 of file frame.c.

References ast_codec_pref_append(), ast_codec_pref_remove(), ast_codec_pref_setsize(), ast_debug, ast_format_cap_add(), ast_format_cap_add_all(), ast_format_cap_remove(), ast_format_cap_remove_all(), ast_getformatbyname(), ast_log(), LOG_WARNING, and parse().

Referenced by action_originate(), apply_outgoing(), build_peer(), codec_handler_fn(), config_parse_variables(), gtalk_create_member(), gtalk_load_config(), h323_parse_allow_disallow(), iax2_parse_allow_disallow(), jingle_create_member(), jingle_load_config(), reload_config(), and skinny_unregister().

{
   int errors = 0, framems = 0, all = 0, iter_allowing;
   char *parse = NULL, *this = NULL, *psize = NULL;
   struct ast_format format;

   parse = ast_strdupa(list);
   while ((this = strsep(&parse, ","))) {
      iter_allowing = allowing;
      framems = 0;
      if (*this == '!') {
         this++;
         iter_allowing = !allowing;
      }
      if ((psize = strrchr(this, ':'))) {
         *psize++ = '\0';
         ast_debug(1, "Packetization for codec: %s is %s\n", this, psize);
         framems = atoi(psize);
         if (framems < 0) {
            framems = 0;
            errors++;
            ast_log(LOG_WARNING, "Bad packetization value for codec %s\n", this);
         }
      }
      all = strcasecmp(this, "all") ? 0 : 1;

      if (!all && !ast_getformatbyname(this, &format)) {
         ast_log(LOG_WARNING, "Cannot %s unknown format '%s'\n", iter_allowing ? "allow" : "disallow", this);
         errors++;
         continue;
      }

      if (cap) {
         if (iter_allowing) {
            if (all) {
               ast_format_cap_add_all(cap);
            } else {
               ast_format_cap_add(cap, &format);
            }
         } else {
            if (all) {
               ast_format_cap_remove_all(cap);
            } else {
               ast_format_cap_remove(cap, &format);
            }
         }
      }

      if (pref) {
         if (!all) {
            if (iter_allowing) {
               ast_codec_pref_append(pref, &format);
               ast_codec_pref_setsize(pref, &format, framems);
            } else {
               ast_codec_pref_remove(pref, &format);
            }
         } else if (!iter_allowing) {
            memset(pref, 0, sizeof(*pref));
         }
      }
   }
   return errors;
}

void ast_smoother_free ( struct ast_smoother * s )

Definition at line 262 of file frame.c.

References ast_free.

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

{
   ast_free(s);
}

int ast_smoother_get_flags ( struct ast_smoother * smoother )

Definition at line 161 of file frame.c.

References ast_smoother::flags.

{
   return s->flags;
}

struct ast_smoother* ast_smoother_new ( int bytes ) [read]

Definition at line 151 of file frame.c.

References ast_malloc, and ast_smoother_reset().

Referenced by ast_rtp_write(), and generic_fax_exec().

{
   struct ast_smoother *s;
   if (size < 1)
      return NULL;
   if ((s = ast_malloc(sizeof(*s))))
      ast_smoother_reset(s, size);
   return s;
}

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

Definition at line 212 of file frame.c.

References ast_format_copy(), ast_format_rate(), AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log(), ast_samp2tv(), AST_SMOOTHER_FLAG_G729, ast_tvadd(), ast_tvzero(), 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_frame_subclass::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().

{
   struct ast_frame *opt;
   int len;

   /* IF we have an optimization frame, send it */
   if (s->opt) {
      if (s->opt->offset < AST_FRIENDLY_OFFSET)
         ast_log(LOG_WARNING, "Returning a frame of inappropriate offset (%d).\n",
                     s->opt->offset);
      opt = s->opt;
      s->opt = NULL;
      return opt;
   }

   /* Make sure we have enough data */
   if (s->len < s->size) {
      /* Or, if this is a G.729 frame with VAD on it, send it immediately anyway */
      if (!((s->flags & AST_SMOOTHER_FLAG_G729) && (s->len % 10)))
         return NULL;
   }
   len = s->size;
   if (len > s->len)
      len = s->len;
   /* Make frame */
   s->f.frametype = AST_FRAME_VOICE;
   ast_format_copy(&s->f.subclass.format, &s->format);
   s->f.data.ptr = s->framedata + AST_FRIENDLY_OFFSET;
   s->f.offset = AST_FRIENDLY_OFFSET;
   s->f.datalen = len;
   /* Samples will be improper given VAD, but with VAD the concept really doesn't even exist */
   s->f.samples = len * s->samplesperbyte;   /* XXX rounding */
   s->f.delivery = s->delivery;
   /* Fill Data */
   memcpy(s->f.data.ptr, s->data, len);
   s->len -= len;
   /* Move remaining data to the front if applicable */
   if (s->len) {
      /* In principle this should all be fine because if we are sending
         G.729 VAD, the next timestamp will take over anyawy */
      memmove(s->data, s->data + len, s->len);
      if (!ast_tvzero(s->delivery)) {
         /* If we have delivery time, increment it, otherwise, leave it at 0 */
         s->delivery = ast_tvadd(s->delivery, ast_samp2tv(s->f.samples, ast_format_rate(&s->format)));
      }
   }
   /* Return frame */
   return &s->f;
}

void ast_smoother_reconfigure	(	struct ast_smoother *	s,
		int	bytes
	)

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

Parameters:

s	the smoother to reconfigure
bytes	the desired number of bytes per output frame

Returns:: nothing

Definition at line 129 of file frame.c.

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

{
   /* if there is no change, then nothing to do */
   if (s->size == bytes) {
      return;
   }
   /* set the new desired output size */
   s->size = bytes;
   /* if there is no 'optimized' frame in the smoother,
    *   then there is nothing left to do
    */
   if (!s->opt) {
      return;
   }
   /* there is an 'optimized' frame here at the old size,
    * but it must now be put into the buffer so the data
    * can be extracted at the new size
    */
   smoother_frame_feed(s, s->opt, s->opt_needs_swap);
   s->opt = NULL;
}

void ast_smoother_reset	(	struct ast_smoother *	s,
		int	bytes
	)

Definition at line 123 of file frame.c.

References ast_smoother::size.

Referenced by ast_smoother_new().

{
   memset(s, 0, sizeof(*s));
   s->size = bytes;
}

void ast_smoother_set_flags	(	struct ast_smoother *	smoother,
		int	flags
	)

Definition at line 166 of file frame.c.

References ast_smoother::flags.

Referenced by ast_rtp_write().

{
   s->flags = flags;
}

int ast_smoother_test_flag	(	struct ast_smoother *	s,
		int	flag
	)

Definition at line 171 of file frame.c.

References ast_smoother::flags.

Referenced by ast_rtp_write().

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

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

Definition at line 524 of file frame.c.

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

{
   int i;
   unsigned short *dst_s = dst;
   const unsigned short *src_s = src;

   for (i = 0; i < samples; i++)
      dst_s[i] = (src_s[i]<<8) | (src_s[i]>>8);
}

Variable Documentation

struct ast_frame ast_null_frame

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

Definition at line 99 of file frame.c.

Referenced by __analog_handle_event(), __ast_channel_masquerade(), __ast_read(), __oh323_rtp_create(), __oh323_update_info(), agent_read(), agent_request(), ast_channel_setwhentohangup_tv(), ast_do_masquerade(), ast_rtcp_read(), ast_rtp_read(), ast_softhangup_nolock(), ast_udptl_read(), bridge_read(), chan_msg_read(), conf_run(), conf_stop_record(), console_read(), create_dtmf_frame(), dahdi_handle_event(), dahdi_read(), fax_detect_framehook(), fax_gateway_detect_t38(), fax_gateway_framehook(), gtalk_rtp_read(), handle_request_invite(), handle_response_invite(), hook_event_cb(), iax2_read(), jingle_read(), jingle_rtp_read(), local_read(), mgcp_rtp_read(), multicast_rtp_read(), oh323_read(), oh323_rtp_read(), process_sdp(), rec_read(), sig_pri_handle_subcmds(), sip_read(), sip_rtp_read(), skinny_rtp_read(), spandsp_fax_read(), unistim_rtp_read(), and wakeup_sub().

Asterisk developer's documentation

Data Structures

Defines

Enumerations

Functions

Variables

AST_Smoother

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation