include/asterisk/frame.h File Reference

Asterisk internal frame definitions. More...

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

Include dependency graph for include/asterisk/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...
struct	ast_frame_subclass
struct	ast_option_header
struct	oprmode

Macros
#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_frdup(fr)   __ast_frdup(fr, __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Copies a frame. More...
#define	ast_frfree(fr)   ast_frame_free(fr, 1)
#define	AST_FRIENDLY_OFFSET   64
	Offset into a frame's data buffer. More...
#define	ast_frisolate(fr)   __ast_frisolate(fr, __FILE__, __LINE__, __PRETTY_FUNCTION__)
	Makes a frame independent of any static storage. 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

Enumerations
enum	{ AST_FRFLAG_HAS_TIMING_INFO = (1 << 0), AST_FRFLAG_REQUEUED = (1 << 1), AST_FRFLAG_HAS_SEQUENCE_NUMBER = (1 << 2) }
enum	ast_control_frame_type {   AST_CONTROL_HANGUP = 1, AST_CONTROL_RING = 2, AST_CONTROL_RINGING = 3, AST_CONTROL_ANSWER = 4,   AST_CONTROL_BUSY = 5, AST_CONTROL_TAKEOFFHOOK = 6, AST_CONTROL_OFFHOOK = 7, AST_CONTROL_CONGESTION = 8,   AST_CONTROL_FLASH = 9, AST_CONTROL_WINK = 10, AST_CONTROL_OPTION = 11, AST_CONTROL_RADIO_KEY = 12,   AST_CONTROL_RADIO_UNKEY = 13, AST_CONTROL_PROGRESS = 14, AST_CONTROL_PROCEEDING = 15, AST_CONTROL_HOLD = 16,   AST_CONTROL_UNHOLD = 17, AST_CONTROL_VIDUPDATE = 18, _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, AST_CONTROL_MASQUERADE_NOTIFY = 34, AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE = 35, AST_CONTROL_STREAM_TOPOLOGY_CHANGED = 36,   AST_CONTROL_STREAM_TOPOLOGY_SOURCE_CHANGED = 37, AST_CONTROL_STREAM_STOP = 1000, AST_CONTROL_STREAM_SUSPEND = 1001, AST_CONTROL_STREAM_RESTART = 1002,   AST_CONTROL_STREAM_REVERSE = 1003, AST_CONTROL_STREAM_FORWARD = 1004, AST_CONTROL_RECORD_CANCEL = 1100, AST_CONTROL_RECORD_STOP = 1101,   AST_CONTROL_RECORD_SUSPEND = 1102, AST_CONTROL_RECORD_MUTE = 1103 }
	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, AST_FRAME_READ_ACTION_SEND_TEXT, AST_FRAME_READ_ACTION_SEND_TEXT_DATA }
	Actions to indicate to, and be handled on channel read. More...
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,   AST_FRAME_BRIDGE_ACTION, AST_FRAME_BRIDGE_ACTION_SYNC, AST_FRAME_RTCP, AST_FRAME_TEXT_DATA }
	Frame types. More...

Functions
struct ast_frame *	__ast_frdup (const struct ast_frame *fr, const char *file, int line, const char *func)
struct ast_frame *	__ast_frisolate (struct ast_frame *fr, const char *file, int line, const char *func)
	'isolates' a frame by duplicating non-malloc'ed components (header, src, data). On return all components are malloc'ed 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_adjust_volume_float (struct ast_frame *f, float 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_dtor (struct ast_frame *frame)
	NULL-safe wrapper for ast_frfree, good for RAII_VAR. More...
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. 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...
char *	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. More...
char *	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. More...
void	ast_swapcopy_samples (void *dst, const void *src, int samples)

Variables
struct ast_frame	ast_null_frame

Detailed Description

Asterisk internal frame definitions.

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

Definition in file include/asterisk/frame.h.

Macro Definition Documentation

ast_frame_byteswap_be

#define ast_frame_byteswap_be

(

fr

)

do { ; } while(0)

Definition at line 597 of file include/asterisk/frame.h.

Referenced by ast_rtp_interpret(), and socket_process_helper().

ast_frame_byteswap_le

#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 596 of file include/asterisk/frame.h.

Referenced by phone_read().

AST_FRAME_DTMF

#define AST_FRAME_DTMF   AST_FRAME_DTMF_END

Examples:

/usr/src/asterisk-18.5.0/main/app.c.

Definition at line 139 of file include/asterisk/frame.h.

Referenced by __adsi_transmit_messages(), __analog_ss_thread(), __ast_play_and_record(), action_atxfer(), action_cancel_atxfer(), action_dahdidialoffhook(), analog_ss_thread(), ast_audiohook_write_list(), ast_dsp_process(), ast_jb_put(), AST_TEST_DEFINE(), attended_transfer_exec(), background_detect_exec(), cb_events(), chan_pjsip_read_stream(), channel_spy(), cli_console_dial(), conf_run(), console_dial(), detect_callback(), dictate_exec(), disa_exec(), do_immediate_setup(), dtmf_info_incoming_request(), echo_exec(), eivr_comm(), fax_detect_framehook(), handle_incoming_request(), handle_recordfile(), handle_request(), handle_request_info(), handle_speechrecognize(), iax2_key_rotate(), keypad_cfg_read(), manager_play_dtmf(), mgcp_rtp_read(), misdn_write(), mp3_exec(), NBScat_exec(), ooh323_onReceivedDigit(), ooh323_rtp_read(), phone_exception(), process_ast_dsp(), read_mf_digits(), read_sf_digits(), receive_dtmf_digits(), record_exec(), send_waveform_to_channel(), sip_rtp_read(), speech_background(), stream_echo_perform(), unistim_do_senddigit(), volume_callback(), wait_exec(), wait_for_answer(), and wait_for_winner().

AST_FRAME_SET_BUFFER

#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 208 of file include/asterisk/frame.h.

Referenced by fax_generator_generate(), g719read(), g723_read(), g726_read(), g729_read(), generic_read(), gsm_read(), h263_read(), h264_read(), ilbc_read(), mp3_read(), ogg_speex_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().

ast_frdup

#define ast_frdup

(

fr

)

__ast_frdup(fr, __FILE__, __LINE__, __PRETTY_FUNCTION__)

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 585 of file include/asterisk/frame.h.

Referenced by __ast_queue_frame(), ast_bridge_channel_queue_frame(), ast_bridge_queue_action(), ast_indicate_data(), ast_jb_put(), ast_rtp_read(), ast_rtp_write(), ast_slinfactory_feed(), audiohook_read_frame_both(), audiohook_read_frame_single(), autoservice_run(), bridge_channel_write_frame(), generate_interpolated_slin(), hook_event_cb(), mock_channel_read(), multicast_rtp_write(), ooh323_rtp_read(), process_dtmf_rfc2833(), recordthread(), smart_bridge_operation(), and t38_parameters_task_data_alloc().

ast_frfree

#define ast_frfree

(

fr

)

ast_frame_free(fr, 1)

Examples:

/usr/src/asterisk-18.5.0/main/app.c.

Definition at line 556 of file include/asterisk/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(), analog_ss_thread(), ast_autoservice_stop(), ast_channel_clear_softhangup(), ast_channel_destructor(), ast_dsp_process(), ast_frame_dtor(), ast_framehook_attach(), ast_indicate_data(), ast_jb_destroy(), ast_jb_put(), ast_queue_cc_frame(), ast_readaudio_callback(), ast_readvideo_callback(), ast_recvtext(), ast_rtp_interpret(), ast_rtp_write(), ast_send_image(), ast_sendtext_data(), ast_slinfactory_destroy(), ast_slinfactory_feed(), ast_slinfactory_flush(), ast_slinfactory_read(), AST_TEST_DEFINE(), ast_tonepair(), ast_transfer_protocol(), ast_translate(), ast_waitfordigit_full(), ast_write_stream(), ast_writestream(), async_agi_read_frame(), audio_audiohook_write_list(), audiohook_read_frame_helper(), audiosocket_run(), autoservice_run(), background_detect_exec(), bridge_channel_destroy(), bridge_channel_queue_deferred_frames(), bridge_frame_free(), bridge_handle_actions(), chan_cleanup(), chan_pjsip_cng_tone_detected(), chan_pjsip_read_stream(), channel_spy(), conf_flush(), conf_free(), conf_run(), create_jb(), dahdi_read(), destroy_all_channels(), detect_callback(), dial_exec_full(), dictate_exec(), disa_exec(), disable_t38(), do_waiting(), echo_exec(), eivr_comm(), fax_detect_framehook(), fax_gateway_framehook(), find_cache(), framehook_detach(), gen_generate(), generate_computational_cost(), generic_fax_exec(), handle_cli_file_convert(), handle_recordfile(), handle_speechrecognize(), hold_intercept_framehook(), hook_event_cb(), iax2_key_rotate(), ices_exec(), isAnsweringMachine(), jack_exec(), jb_empty_and_reset_adaptive(), jb_empty_and_reset_fixed(), jb_framedata_destroy(), jb_get_and_deliver(), jingle_read(), load_stream_readqueue(), measurenoise(), milliwatt_generate(), moh_channel_thread(), moh_files_generator(), monitor_dial(), mp3_exec(), multicast_rtp_write(), NBScat_exec(), ooh323_rtp_read(), read_frame(), read_test(), receive_dtmf_digits(), receivefax_t38_init(), record_exec(), recordthread(), run_agi(), safe_sleep_conditional(), send_waveform_to_channel(), sendfax_t38_init(), sendurl_exec(), session_destroy(), sip_read(), sip_rtp_read(), sms_exec(), sms_generate(), softmix_translate_helper_cleanup(), softmix_translate_helper_free_entry(), spandsp_fax_gw_t30_gen(), speech_background(), spy_generate(), stream_echo_perform(), suppress_framehook_event_cb(), t38_parameters_task_data_destroy(), t38_tx_packet_handler(), test_read_frames(), transmit_audio(), transmit_t38(), wait_for_answer(), wait_for_hangup(), wait_for_winner(), waitforring_exec(), and waitstream_core().

AST_FRIENDLY_OFFSET

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

Examples:

/usr/src/asterisk-18.5.0/main/app.c.

Definition at line 229 of file include/asterisk/frame.h.

Referenced by __ast_frdup(), __ast_frisolate(), __get_from_jb(), adjust_frame_for_plc(), alsa_read(), ast_prod(), ast_rtcp_interpret(), ast_rtcp_read(), ast_rtp_interpret(), ast_rtp_read(), ast_smoother_read(), ast_udptl_read(), conf_run(), dahdi_read(), fax_generator_generate(), g719read(), g723_read(), g726_read(), g729_read(), generate_interpolated_slin(), generic_read(), gsm_read(), h263_read(), h264_read(), hook_event_cb(), iax_frame_wrap(), ilbc_read(), jb_get_and_deliver(), linear_generator(), mbl_read(), milliwatt_generate(), moh_generate(), mohalloc(), mp3_exec(), mp3_read(), NBScat_exec(), newpvt(), ogg_speex_read(), ogg_vorbis_read(), oss_read(), pcm_read(), phone_read(), playtones_generator(), process_cn_rfc3389(), send_waveform_to_channel(), siren14read(), siren7read(), sms_generate(), spandsp_fax_gw_t30_gen(), spandsp_fax_read(), tonepair_generator(), vox_read(), and wav_read().

ast_frisolate

#define ast_frisolate

(

fr

)

__ast_frisolate(fr, __FILE__, __LINE__, __PRETTY_FUNCTION__)

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 577 of file include/asterisk/frame.h.

Referenced by __ast_answer(), ast_audiosocket_receive_frame(), ast_dsp_process(), ast_rtp_interpret(), ast_slinfactory_feed(), ast_trans_frameout(), ast_write_stream(), autoservice_run(), create_test_frame(), dahdi_decoder_frameout(), dahdi_encoder_frameout(), detect_callback(), fax_gateway_framehook(), fax_gateway_request_t38(), hook_event_cb(), lintospeex_frameout(), read_frame(), safe_sleep_conditional(), spandsp_fax_gw_t30_gen(), spandsp_fax_read(), and t38_tx_packet_handler().

AST_HTML_BEGIN

#define AST_HTML_BEGIN   4

Beginning frame

Definition at line 251 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str().

AST_HTML_DATA

#define AST_HTML_DATA   2

Data frame

Definition at line 249 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str().

AST_HTML_END

#define AST_HTML_END   8

End frame

Definition at line 253 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str().

AST_HTML_LDCOMPLETE

#define AST_HTML_LDCOMPLETE   16

Load is complete

Definition at line 255 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str(), and sendurl_exec().

AST_HTML_LINKREJECT

#define AST_HTML_LINKREJECT   20

Reject link request

Definition at line 263 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str().

AST_HTML_LINKURL

#define AST_HTML_LINKURL   18

Send URL, and track

Definition at line 259 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str().

AST_HTML_NOSUPPORT

#define AST_HTML_NOSUPPORT   17

Peer is unable to support HTML

Definition at line 257 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str(), and sendurl_exec().

AST_HTML_UNLINK

#define AST_HTML_UNLINK   19

No more HTML linkage

Definition at line 261 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str().

AST_HTML_URL

#define AST_HTML_URL   1

Sending a URL

Definition at line 247 of file include/asterisk/frame.h.

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

AST_MALLOCD_DATA

#define AST_MALLOCD_DATA   (1 << 1)

Need the data be free'd?

Definition at line 235 of file include/asterisk/frame.h.

Referenced by __ast_frisolate(), __frame_free(), ast_audiosocket_receive_frame(), ast_cc_build_frame(), ast_sendtext_data(), and create_video_frame().

AST_MALLOCD_HDR

#define AST_MALLOCD_HDR   (1 << 0)

Need the header be free'd?

Examples:

/usr/src/asterisk-18.5.0/main/app.c.

Definition at line 233 of file include/asterisk/frame.h.

Referenced by __ast_frdup(), __ast_frisolate(), __frame_free(), create_video_frame(), and make_silence().

AST_MALLOCD_SRC

#define AST_MALLOCD_SRC   (1 << 2)

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

Definition at line 237 of file include/asterisk/frame.h.

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

AST_MIN_OFFSET

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

Definition at line 230 of file include/asterisk/frame.h.

Referenced by __ast_smoother_feed().

AST_MODEM_T38

#define AST_MODEM_T38   1

T.38 Fax-over-IP

Definition at line 241 of file include/asterisk/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().

AST_MODEM_V150

#define AST_MODEM_V150   2

V.150 Modem-over-IP

Definition at line 243 of file include/asterisk/frame.h.

Referenced by ast_frame_subclass2str().

AST_OPTION_AUDIO_MODE

#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 443 of file include/asterisk/frame.h.

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

AST_OPTION_CC_AGENT_TYPE

#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 510 of file include/asterisk/frame.h.

Referenced by ast_channel_get_cc_agent_type(), and dahdi_queryoption().

AST_OPTION_CHANNEL_WRITE

#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 474 of file include/asterisk/frame.h.

Referenced by ast_unreal_setoption(), and func_channel_write().

AST_OPTION_DEVICE_NAME

#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 506 of file include/asterisk/frame.h.

Referenced by ast_channel_get_device_name(), and sip_queryoption().

AST_OPTION_DIGIT_DETECT

#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 498 of file include/asterisk/frame.h.

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

AST_OPTION_ECHOCAN

#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 466 of file include/asterisk/frame.h.

Referenced by dahdi_setoption().

AST_OPTION_FAX_DETECT

#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 502 of file include/asterisk/frame.h.

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

AST_OPTION_FLAG_ACCEPT

#define AST_OPTION_FLAG_ACCEPT   1

Definition at line 422 of file include/asterisk/frame.h.

AST_OPTION_FLAG_ANSWER

#define AST_OPTION_FLAG_ANSWER   5

Definition at line 425 of file include/asterisk/frame.h.

AST_OPTION_FLAG_QUERY

#define AST_OPTION_FLAG_QUERY   4

Definition at line 424 of file include/asterisk/frame.h.

AST_OPTION_FLAG_REJECT

#define AST_OPTION_FLAG_REJECT   2

Definition at line 423 of file include/asterisk/frame.h.

AST_OPTION_FLAG_REQUEST

#define AST_OPTION_FLAG_REQUEST   0

Definition at line 421 of file include/asterisk/frame.h.

Referenced by bridge_channel_handle_control(), and iax2_setoption().

AST_OPTION_FLAG_WTF

#define AST_OPTION_FLAG_WTF   6

Definition at line 426 of file include/asterisk/frame.h.

AST_OPTION_FORMAT_READ

#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 484 of file include/asterisk/frame.h.

Referenced by sip_setoption().

AST_OPTION_FORMAT_WRITE

#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 488 of file include/asterisk/frame.h.

Referenced by sip_setoption().

AST_OPTION_MAKE_COMPATIBLE

#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 494 of file include/asterisk/frame.h.

AST_OPTION_OPRMODE

#define AST_OPTION_OPRMODE   7

Definition at line 459 of file include/asterisk/frame.h.

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

AST_OPTION_RELAXDTMF

#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 439 of file include/asterisk/frame.h.

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

AST_OPTION_RXGAIN

#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 453 of file include/asterisk/frame.h.

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

AST_OPTION_SECURE_MEDIA

#define AST_OPTION_SECURE_MEDIA   19

Definition at line 515 of file include/asterisk/frame.h.

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

AST_OPTION_SECURE_SIGNALING

#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 514 of file include/asterisk/frame.h.

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

AST_OPTION_T38_STATE

#define AST_OPTION_T38_STATE   10

Definition at line 480 of file include/asterisk/frame.h.

Referenced by ast_channel_get_t38_state(), ast_unreal_queryoption(), chan_pjsip_queryoption(), ooh323_queryoption(), and sip_queryoption().

AST_OPTION_TDD

#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 435 of file include/asterisk/frame.h.

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

AST_OPTION_TONE_VERIFY

#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 431 of file include/asterisk/frame.h.

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

AST_OPTION_TXGAIN

#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 448 of file include/asterisk/frame.h.

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

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
AST_FRFLAG_HAS_TIMING_INFO	This frame contains valid timing information
AST_FRFLAG_REQUEUED	This frame has been requeued
AST_FRFLAG_HAS_SEQUENCE_NUMBER	This frame contains a valid sequence number

Definition at line 141 of file include/asterisk/frame.h.

     {
   /*! This frame contains valid timing information */
   AST_FRFLAG_HAS_TIMING_INFO = (1 << 0),
   /*! This frame has been requeued */
   AST_FRFLAG_REQUEUED = (1 << 1),
   /*! This frame contains a valid sequence number */
   AST_FRFLAG_HAS_SEQUENCE_NUMBER = (1 << 2),
};

ast_control_frame_type

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
AST_CONTROL_MASQUERADE_NOTIFY	A masquerade is about to begin/end. (Never sent as a frame but directly with ast_indicate_data().)
AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE	Channel indication that a stream topology change has been requested
AST_CONTROL_STREAM_TOPOLOGY_CHANGED	Channel indication that a stream topology change has occurred
AST_CONTROL_STREAM_TOPOLOGY_SOURCE_CHANGED	Channel indication that one of the source streams has changed its source
AST_CONTROL_STREAM_STOP	Indicate to a channel in playback to stop the stream
AST_CONTROL_STREAM_SUSPEND	Indicate to a channel in playback to suspend the stream
AST_CONTROL_STREAM_RESTART	Indicate to a channel in playback to restart the stream
AST_CONTROL_STREAM_REVERSE	Indicate to a channel in playback to rewind
AST_CONTROL_STREAM_FORWARD	Indicate to a channel in playback to fast forward
AST_CONTROL_RECORD_CANCEL	Indicated to a channel in record to stop recording and discard the file
AST_CONTROL_RECORD_STOP	Indicated to a channel in record to stop recording
AST_CONTROL_RECORD_SUSPEND	Indicated to a channel in record to suspend/unsuspend recording
AST_CONTROL_RECORD_MUTE	Indicated to a channel in record to mute/unmute (i.e. write silence) recording

Definition at line 277 of file include/asterisk/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 */
   AST_CONTROL_MASQUERADE_NOTIFY = 34, /*!< A masquerade is about to begin/end. (Never sent as a frame but directly with ast_indicate_data().) */
   AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE = 35,    /*!< Channel indication that a stream topology change has been requested */
   AST_CONTROL_STREAM_TOPOLOGY_CHANGED = 36,           /*!< Channel indication that a stream topology change has occurred */
   AST_CONTROL_STREAM_TOPOLOGY_SOURCE_CHANGED = 37,    /*!< Channel indication that one of the source streams has changed its source */

   /*
    * 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
    */

   /* Control frames used to manipulate a stream on a channel. The values for these
    * must be greater than the allowed value for a 8-bit char, so that they avoid
    * conflicts with DTMF values. */
   AST_CONTROL_STREAM_STOP = 1000,     /*!< Indicate to a channel in playback to stop the stream */
   AST_CONTROL_STREAM_SUSPEND = 1001,  /*!< Indicate to a channel in playback to suspend the stream */
   AST_CONTROL_STREAM_RESTART = 1002,  /*!< Indicate to a channel in playback to restart the stream */
   AST_CONTROL_STREAM_REVERSE = 1003,  /*!< Indicate to a channel in playback to rewind */
   AST_CONTROL_STREAM_FORWARD = 1004,  /*!< Indicate to a channel in playback to fast forward */
   /* Control frames to manipulate recording on a channel. */
   AST_CONTROL_RECORD_CANCEL = 1100,   /*!< Indicated to a channel in record to stop recording and discard the file */
   AST_CONTROL_RECORD_STOP = 1101,  /*!< Indicated to a channel in record to stop recording */
   AST_CONTROL_RECORD_SUSPEND = 1102,  /*!< Indicated to a channel in record to suspend/unsuspend recording */
   AST_CONTROL_RECORD_MUTE = 1103,  /*!< Indicated to a channel in record to mute/unmute (i.e. write silence) recording */
};

ast_control_t38

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 370 of file include/asterisk/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 */
};

ast_control_t38_rate

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 379 of file include/asterisk/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,
};

ast_control_t38_rate_management

enum ast_control_t38_rate_management

Enumerator
AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF
AST_T38_RATE_MANAGEMENT_LOCAL_TCF

Definition at line 392 of file include/asterisk/frame.h.

                                     {
   AST_T38_RATE_MANAGEMENT_TRANSFERRED_TCF = 0,
   AST_T38_RATE_MANAGEMENT_LOCAL_TCF,
};

ast_control_transfer

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 408 of file include/asterisk/frame.h.

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

ast_frame_read_action

enum ast_frame_read_action

Actions to indicate to, and be handled on channel read.

The subtype to specify for an AST_CONTROL_READ_ACTION frame. These frames are then to be enacted on within a channel's read thread.

Enumerator
AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO
AST_FRAME_READ_ACTION_SEND_TEXT
AST_FRAME_READ_ACTION_SEND_TEXT_DATA

Definition at line 351 of file include/asterisk/frame.h.

                           {
   AST_FRAME_READ_ACTION_CONNECTED_LINE_MACRO,
   AST_FRAME_READ_ACTION_SEND_TEXT,
   AST_FRAME_READ_ACTION_SEND_TEXT_DATA,
};

ast_frame_type

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. The character data may not be zero-terminated, so care should be taken when passing it to functions that expect a zero-terminated string. The frame's datalen member should be used as it indicates the actual number of bytes available.
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
AST_FRAME_BRIDGE_ACTION	Internal bridge module action.
AST_FRAME_BRIDGE_ACTION_SYNC	Internal synchronous bridge module action. Synchronous bridge actions may be queued onto bridge channels, but they absolutely must not ever be written directly into bridges.
AST_FRAME_RTCP	RTCP feedback (the subclass will contain the payload type)
AST_FRAME_TEXT_DATA	Text message in an ast_msg_data structure

Definition at line 97 of file include/asterisk/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. The character data may not be zero-terminated, so
    * care should be taken when passing it to functions that expect a
    * zero-terminated string. The frame's datalen member should be used
    * as it indicates the actual number of bytes available. */
   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,
   /*! Internal bridge module action. */
   AST_FRAME_BRIDGE_ACTION,
   /*! Internal synchronous bridge module action.
    * Synchronous bridge actions may be queued onto bridge
    * channels, but they absolutely must not ever be written
    * directly into bridges.
    */
   AST_FRAME_BRIDGE_ACTION_SYNC,
   /*! RTCP feedback (the subclass will contain the payload type) */
   AST_FRAME_RTCP,
   /*! Text message in an ast_msg_data structure */
   AST_FRAME_TEXT_DATA,
};

Function Documentation

__ast_frdup()

struct ast_frame* __ast_frdup	(	const struct ast_frame *	fr,
		const char *	file,
		int	line,
		const char *	func
	)

Definition at line 305 of file main/frame.c.

References __ast_calloc(), ao2_bump, AST_CONTROL_ANSWER, ast_copy_flags, AST_FLAGS_ALL, AST_FRAME_CONTROL, AST_FRAME_IMAGE, AST_FRAME_TEXT, AST_FRAME_VIDEO, AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_MALLOCD_HDR, ast_threadstorage_get(), buf, ast_frame::data, ast_frame::datalen, ast_frame::delivery, ast_frame_subclass::format, frame_cache, frames, ast_frame::frametype, ast_frame_subclass::integer, ast_frame::len, len(), ast_frame_cache::list, ast_frame::mallocd, ast_frame::mallocd_hdr_len, NULL, ast_frame::offset, out, ast_frame::ptr, ast_frame::samples, ast_frame::seqno, ast_frame_cache::size, ast_frame::src, ast_frame::stream_num, ast_frame::subclass, ast_frame_subclass::topology, ast_frame::ts, and ast_frame::uint32.

Referenced by __ast_frisolate().

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

#if !defined(NO_FRAME_CACHE)
   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(NO_FRAME_CACHE)
   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(1, len, file, line, func)))
         return NULL;
      out = buf;
      out->mallocd_hdr_len = len;
   }

   out->frametype = f->frametype;
   out->subclass = f->subclass;
   if ((f->frametype == AST_FRAME_VOICE) || (f->frametype == AST_FRAME_VIDEO) ||
      (f->frametype == AST_FRAME_IMAGE)) {
      ao2_bump(out->subclass.format);
   } else if (f->frametype == AST_FRAME_CONTROL && f->subclass.integer == AST_CONTROL_ANSWER) {
      ao2_bump(out->subclass.topology);
   }

   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;
   /* Make sure that empty text frames have a valid data.ptr */
   if (out->datalen || f->frametype == AST_FRAME_TEXT) {
      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;
   out->stream_num = f->stream_num;
   return out;
}

__ast_frisolate()

struct ast_frame* __ast_frisolate	(	struct ast_frame *	fr,
		const char *	file,
		int	line,
		const char *	func
	)

'isolates' a frame by duplicating non-malloc'ed components (header, src, data). On return all components are malloc'ed

Definition at line 197 of file main/frame.c.

References __ast_frdup(), ao2_bump, AST_CONTROL_ANSWER, ast_copy_flags, AST_FLAGS_ALL, ast_frame_free(), ast_frame_header_new(), AST_FRAME_IMAGE, AST_FRAME_TEXT, AST_FRAME_VIDEO, AST_FRAME_VOICE, 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_subclass::integer, ast_frame::len, ast_frame::mallocd, NULL, ast_frame::offset, out, ast_frame::ptr, ast_frame::samples, ast_frame::seqno, ast_frame::src, ast_frame::stream_num, ast_frame::subclass, ast_frame_subclass::topology, ast_frame::ts, and ast_frame::uint32.

{
   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, file, line, func);
   }

   /* 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(file, line, func))) {
         return NULL;
      }
      out->frametype = fr->frametype;
      out->subclass = fr->subclass;
      if ((fr->frametype == AST_FRAME_VOICE) || (fr->frametype == AST_FRAME_VIDEO) ||
         (fr->frametype == AST_FRAME_IMAGE)) {
         ao2_bump(out->subclass.format);
      } else if (fr->frametype == AST_FRAME_VOICE && fr->subclass.integer == AST_CONTROL_ANSWER) {
         ao2_bump(out->subclass.topology);
      }
      out->datalen = fr->datalen;
      out->samples = fr->samples;
      out->mallocd = AST_MALLOCD_HDR;
      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;
      }
      out->stream_num = fr->stream_num;
   } else {
      out = fr;
   }

   if (fr->src) {
      /* The original frame has a source string */
      if (!(fr->mallocd & AST_MALLOCD_SRC)) {
         /*
          * The original frame has a non-malloced source string.
          *
          * Duplicate the string and put it into the isolated frame
          * which may also be the original frame.
          */
         newdata = ast_strdup(fr->src);
         if (!newdata) {
            if (out != fr) {
               ast_frame_free(out, 0);
            }
            return NULL;
         }
         out->src = newdata;
         out->mallocd |= AST_MALLOCD_SRC;
      } else if (out != fr) {
         /* Steal the source string from the original frame. */
         out->src = fr->src;
         fr->src = NULL;
         fr->mallocd &= ~AST_MALLOCD_SRC;
         out->mallocd |= AST_MALLOCD_SRC;
      }
   }

   if (!(fr->mallocd & AST_MALLOCD_DATA))  {
      /* The original frame has a non-malloced data buffer. */
      if (!fr->datalen && fr->frametype != AST_FRAME_TEXT) {
         /* Actually it's just an int so we can simply copy it. */
         out->data.uint32 = fr->data.uint32;
         return out;
      }
      /*
       * Duplicate the data buffer and put it into the isolated frame
       * which may also be the original frame.
       */
      newdata = ast_malloc(fr->datalen + AST_FRIENDLY_OFFSET);
      if (!newdata) {
         if (out != fr) {
            ast_frame_free(out, 0);
         }
         return NULL;
      }
      newdata += AST_FRIENDLY_OFFSET;
      out->offset = AST_FRIENDLY_OFFSET;
      memcpy(newdata, fr->data.ptr, fr->datalen);
      out->data.ptr = newdata;
      out->mallocd |= AST_MALLOCD_DATA;
   } else if (out != fr) {
      /* Steal the data buffer from the original frame. */
      out->data = fr->data;
      memset(&fr->data, 0, sizeof(fr->data));
      fr->mallocd &= ~AST_MALLOCD_DATA;
      out->mallocd |= AST_MALLOCD_DATA;
   }

   return out;
}

ast_frame_adjust_volume()

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 787 of file main/frame.c.

References abs, ast_format_cache_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(), and conf_run().

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

   if ((f->frametype != AST_FRAME_VOICE) || !(ast_format_cache_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;
}

ast_frame_adjust_volume_float()

int ast_frame_adjust_volume_float	(	struct ast_frame *	f,
		float	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 812 of file main/frame.c.

References ast_format_cache_is_slinear(), AST_FRAME_VOICE, ast_slinear_saturated_divide_float(), ast_slinear_saturated_multiply_float(), ast_frame::data, ast_frame_subclass::format, ast_frame::frametype, ast_frame::ptr, ast_frame::samples, and ast_frame::subclass.

Referenced by volume_callback().

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

   if ((f->frametype != AST_FRAME_VOICE) || !(ast_format_cache_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_float(&fdata[count], &adjust_value);
      } else if (adjustment < 0) {
         ast_slinear_saturated_divide_float(&fdata[count], &adjust_value);
      }
   }

   return 0;
}

ast_frame_clear()

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 859 of file main/frame.c.

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

Referenced by audiohook_read_frame_single().

{
   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;
}

ast_frame_dtor()

void ast_frame_dtor

(

struct ast_frame *

frame

)

NULL-safe wrapper for ast_frfree, good for RAII_VAR.

Parameters

frame

Frame to free, or head of list to free.

Examples:

/usr/src/asterisk-18.5.0/main/app.c.

Definition at line 187 of file main/frame.c.

References ast_frfree.

Referenced by __ast_play_and_record(), snoop_read(), and stasis_app_exec().

{
   ast_frfree(f);
}

ast_frame_dump()

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

Dump a frame for debugging purposes

Definition at line 731 of file main/frame.c.

References AST_FRAME_RTCP, 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_stream().

{
   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;
   }
   if (f->frametype == AST_FRAME_RTCP) {
      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 (%u) 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 (%u) 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)));
}

ast_frame_enqueue()

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.

ast_frame_free()

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 176 of file main/frame.c.

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

Referenced by __ast_frisolate(), ast_rtp_read(), and mixmonitor_thread().

{
   struct ast_frame *next;

   while (frame) {
      next = AST_LIST_NEXT(frame, frame_list);
      __frame_free(frame, cache);
      frame = next;
   }
}

ast_frame_slinear_sum()

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 837 of file main/frame.c.

References ast_format_cmp(), AST_FORMAT_CMP_NOT_EQUAL, ast_format_slin, AST_FRAME_VOICE, ast_slinear_saturated_add(), ast_frame::data, ast_frame_subclass::format, ast_frame::frametype, ast_frame::ptr, ast_frame::samples, and ast_frame::subclass.

{
   int count;
   short *data1, *data2;

   if ((f1->frametype != AST_FRAME_VOICE) || (ast_format_cmp(f1->subclass.format, ast_format_slin) != AST_FORMAT_CMP_NOT_EQUAL))
      return -1;

   if ((f2->frametype != AST_FRAME_VOICE) || (ast_format_cmp(f2->subclass.format, ast_format_slin) != AST_FORMAT_CMP_NOT_EQUAL))
      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;
}

ast_frame_subclass2str()

char* 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

Returns

Pointer to subclass

Since

11

Definition at line 406 of file main/frame.c.

References AST_CONTROL_ANSWER, AST_CONTROL_AOC, AST_CONTROL_BUSY, AST_CONTROL_CC, AST_CONTROL_CONGESTION, AST_CONTROL_CONNECTED_LINE, AST_CONTROL_END_OF_Q, AST_CONTROL_FLASH, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_INCOMPLETE, AST_CONTROL_MASQUERADE_NOTIFY, AST_CONTROL_MCID, AST_CONTROL_OFFHOOK, AST_CONTROL_OPTION, AST_CONTROL_PROCEEDING, AST_CONTROL_PROGRESS, AST_CONTROL_PVT_CAUSE_CODE, AST_CONTROL_RADIO_KEY, AST_CONTROL_RADIO_UNKEY, AST_CONTROL_READ_ACTION, AST_CONTROL_RECORD_CANCEL, AST_CONTROL_RECORD_MUTE, AST_CONTROL_RECORD_STOP, AST_CONTROL_RECORD_SUSPEND, AST_CONTROL_REDIRECTING, AST_CONTROL_RING, AST_CONTROL_RINGING, AST_CONTROL_SRCCHANGE, AST_CONTROL_SRCUPDATE, AST_CONTROL_STREAM_FORWARD, AST_CONTROL_STREAM_RESTART, AST_CONTROL_STREAM_REVERSE, AST_CONTROL_STREAM_STOP, AST_CONTROL_STREAM_SUSPEND, AST_CONTROL_STREAM_TOPOLOGY_CHANGED, AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE, AST_CONTROL_STREAM_TOPOLOGY_SOURCE_CHANGED, AST_CONTROL_T38_PARAMETERS, AST_CONTROL_TAKEOFFHOOK, AST_CONTROL_TRANSFER, AST_CONTROL_UNHOLD, AST_CONTROL_UPDATE_RTP_PEER, AST_CONTROL_VIDUPDATE, AST_CONTROL_WINK, ast_copy_string(), ast_format_get_name(), AST_FRAME_BRIDGE_ACTION, AST_FRAME_BRIDGE_ACTION_SYNC, 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_RTCP, AST_FRAME_TEXT, 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(), and chan_pjsip_indicate().

{
   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_PROGRESS:
         ast_copy_string(subclass, "Progress", slen);
         break;
      case AST_CONTROL_PROCEEDING:
         ast_copy_string(subclass, "Proceeding", 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_VIDUPDATE:
         ast_copy_string(subclass, "Video Update", 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 AST_CONTROL_STREAM_STOP:
         ast_copy_string(subclass, "Stop stream", slen);
         break;
      case AST_CONTROL_STREAM_SUSPEND:
         ast_copy_string(subclass, "Suspend stream", slen);
         break;
      case AST_CONTROL_STREAM_RESTART:
         ast_copy_string(subclass, "Restart stream", slen);
         break;
      case AST_CONTROL_STREAM_REVERSE:
         ast_copy_string(subclass, "Reverse stream", slen);
         break;
      case AST_CONTROL_STREAM_FORWARD:
         ast_copy_string(subclass, "Forward stream", slen);
         break;
      case AST_CONTROL_RECORD_CANCEL:
         ast_copy_string(subclass, "Cancel stream", slen);
         break;
      case AST_CONTROL_RECORD_STOP:
         ast_copy_string(subclass, "Record stop", slen);
         break;
      case AST_CONTROL_RECORD_SUSPEND:
         ast_copy_string(subclass, "Record suspend", slen);
         break;
      case AST_CONTROL_RECORD_MUTE:
         ast_copy_string(subclass, "Record mute", slen);
         break;
      case AST_CONTROL_SRCUPDATE:
         ast_copy_string(subclass, "Media source update", slen);
         break;
      case AST_CONTROL_TRANSFER:
         ast_copy_string(subclass, "Transfer", slen);
         break;
      case AST_CONTROL_CONNECTED_LINE:
         ast_copy_string(subclass, "Connected line update", slen);
         break;
      case AST_CONTROL_REDIRECTING:
         ast_copy_string(subclass, "Redirect", slen);
         break;
      case AST_CONTROL_CC:
         ast_copy_string(subclass, "CC", slen);
         break;
      case AST_CONTROL_SRCCHANGE:
         ast_copy_string(subclass, "Media SSRC change", slen);
         break;
      case AST_CONTROL_READ_ACTION:
         ast_copy_string(subclass, "Read action", slen);
         break;
      case AST_CONTROL_AOC:
         ast_copy_string(subclass, "AOC", slen);
         break;
      case AST_CONTROL_END_OF_Q:
         ast_copy_string(subclass, "Endof Q", slen);
         break;
      case AST_CONTROL_INCOMPLETE:
         ast_copy_string(subclass, "Incomplete", slen);
         break;
      case AST_CONTROL_MCID:
         ast_copy_string(subclass, "MCID", slen);
         break;
      case AST_CONTROL_UPDATE_RTP_PEER:
         ast_copy_string(subclass, "Update RTP peer", slen);
         break;
      case AST_CONTROL_PVT_CAUSE_CODE:
         ast_copy_string(subclass, "Private Cause Code", slen);
         break;
      case AST_CONTROL_MASQUERADE_NOTIFY:
         ast_copy_string(subclass, "Masquerade notify", slen);
         break;
      case AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE:
         ast_copy_string(subclass, "Stream topology request change", slen);
         break;
      case AST_CONTROL_STREAM_TOPOLOGY_CHANGED:
         ast_copy_string(subclass, "Stream topology changed", slen);
         break;
      case AST_CONTROL_STREAM_TOPOLOGY_SOURCE_CHANGED:
         ast_copy_string(subclass, "Stream topology source changed", slen);
         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_BRIDGE_ACTION:
      /* Should never happen */
      snprintf(subclass, slen, "Bridge Frametype %d", f->subclass.integer);
      break;
   case AST_FRAME_BRIDGE_ACTION_SYNC:
      /* Should never happen */
      snprintf(subclass, slen, "Synchronous Bridge 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_format_get_name(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;
   case AST_FRAME_RTCP:
      ast_copy_string(subclass, "RTCP", slen);
   default:
      ast_copy_string(subclass, "Unknown Subclass", slen);
      break;
   }

   return subclass;
}

ast_frame_type2str()

char* 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

Returns

Pointer to ftype

Since

11

Definition at line 671 of file main/frame.c.

References ast_copy_string(), AST_FRAME_BRIDGE_ACTION, AST_FRAME_BRIDGE_ACTION_SYNC, 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_RTCP, AST_FRAME_TEXT, AST_FRAME_TEXT_DATA, AST_FRAME_VIDEO, and AST_FRAME_VOICE.

Referenced by ast_frame_dump(), softmix_bridge_write_text(), and stream_echo_write_error().

{
   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_BRIDGE_ACTION:
      /* Should never happen */
      ast_copy_string(ftype, "Bridge Specific", len);
      break;
   case AST_FRAME_BRIDGE_ACTION_SYNC:
      /* Should never happen */
      ast_copy_string(ftype, "Bridge Specific", len);
      break;
   case AST_FRAME_TEXT:
      ast_copy_string(ftype, "Text", len);
      break;
   case AST_FRAME_TEXT_DATA:
      ast_copy_string(ftype, "Text Data", 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;
   case AST_FRAME_RTCP:
      ast_copy_string(ftype, "RTCP", len);
      break;
   default:
      snprintf(ftype, len, "Unknown Frametype '%u'", frame_type);
      break;
   }

   return ftype;
}

ast_swapcopy_samples()

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

Definition at line 396 of file main/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

ast_null_frame

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 79 of file main/frame.c.

Referenced by __analog_handle_event(), __ast_read(), apply_negotiated_sdp_stream(), ast_audiosocket_receive_frame(), ast_channel_set_unbridged_nolock(), ast_channel_setwhentohangup_tv(), ast_rtcp_interpret(), ast_rtcp_read(), ast_rtp_interpret(), ast_rtp_read(), ast_softhangup_nolock(), AST_TEST_DEFINE(), ast_translate(), ast_udptl_read(), ast_unreal_read(), bridge_channel_internal_push_full(), bridge_channel_poke(), chan_msg_read(), chan_pjsip_cng_tone_detected(), chan_pjsip_read_stream(), channel_do_masquerade(), conf_run(), console_read(), create_dtmf_frame(), dahdi_handle_event(), dahdi_read(), fake_read(), fax_detect_framehook(), fax_gateway_detect_t38(), fax_gateway_framehook(), handle_negotiated_sdp(), handle_request_invite(), handle_response_invite(), hold_intercept_framehook(), hook_event_cb(), iax2_read(), jb_get_adaptive(), jb_get_fixed(), jingle_read(), mbl_read(), media_session_rtcp_read_callback(), media_session_rtp_read_callback(), media_session_udptl_read_callback(), mgcp_rtp_read(), multicast_rtp_read(), nbs_xread(), ooh323_rtp_read(), parking_test_read(), process_sdp(), rec_read(), rtp_read(), set_interval_hook(), sip_read(), sip_rtp_read(), skinny_rtp_read(), snoop_read(), spandsp_fax_read(), stream_periodic_frames(), suppress_framehook_event_cb(), test_sip_rtpqos_1_read(), test_vm_api_mock_channel_read(), unistim_rtp_read(), and wakeup_sub().