Frame and codec manipulation routines. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include "asterisk/lock.h"
#include "asterisk/frame.h"
#include "asterisk/channel.h"
#include "asterisk/cli.h"
#include "asterisk/term.h"
#include "asterisk/utils.h"
#include "asterisk/threadstorage.h"
#include "asterisk/linkedlists.h"
#include "asterisk/translate.h"
#include "asterisk/dsp.h"
#include "asterisk/file.h"

Include dependency graph for frame.c:

Go to the source code of this file.

Data Structures
struct	ast_frame_cache
struct	ast_frames
	This is just so ast_frames, a list head struct for holding a list of ast_frame structures, is defined. More...
struct	ast_smoother
Defines
#define	FRAME_CACHE_MAX_SIZE 10
	Maximum ast_frame cache size.
#define	SMOOTHER_SIZE 8000
#define	TYPE_MASK 0x3
Enumerations
enum	frame_type { TYPE_HIGH, TYPE_LOW, TYPE_SILENCE, TYPE_DONTSEND }
Functions
int	__ast_smoother_feed (struct ast_smoother s, struct ast_frame f, int swap)
static void	__frame_free (struct ast_frame *fr, int cache)
static void	__init_frame_cache (void)
	A per-thread cache of frame headers.
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.
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)
void	ast_frame_free (struct ast_frame *frame, int cache)
	Requests a frame to be allocated.
static struct ast_frame *	ast_frame_header_new (void)
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 *f)
	Copies a frame.
struct ast_frame *	ast_frisolate (struct ast_frame *fr)
	'isolates' a frame by duplicating non-malloc'ed components (header, src, data). On return all components are malloc'ed
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_smoother_free (struct ast_smoother *s)
int	ast_smoother_get_flags (struct ast_smoother *s)
struct ast_smoother *	ast_smoother_new (int size)
struct ast_frame *	ast_smoother_read (struct ast_smoother *s)
void	ast_smoother_reconfigure (struct ast_smoother *s, int bytes)
	Reconfigure an existing smoother to output a different number of bytes per frame.
void	ast_smoother_reset (struct ast_smoother *s, int bytes)
void	ast_smoother_set_flags (struct ast_smoother *s, int flags)
int	ast_smoother_test_flag (struct ast_smoother *s, int flag)
void	ast_swapcopy_samples (void dst, const void src, int samples)
static void	frame_cache_cleanup (void *data)
static int	g723_len (unsigned char buf)
static int	g723_samples (unsigned char *buf, int maxlen)
static unsigned char	get_n_bits_at (unsigned char *data, int n, int bit)
static int	smoother_frame_feed (struct ast_smoother s, struct ast_frame f, int swap)
static int	speex_get_wb_sz_at (unsigned char *data, int len, int bit)
static int	speex_samples (unsigned char *data, int len)
Variables
struct ast_frame	ast_null_frame = { AST_FRAME_NULL, }
static struct ast_threadstorage	frame_cache = { .once = PTHREAD_ONCE_INIT , .key_init = __init_frame_cache , .custom_init = NULL , }

Detailed Description

Frame and codec manipulation routines.

Author:: Mark Spencer <markster@digium.com>

Definition in file frame.c.

Define Documentation

#define FRAME_CACHE_MAX_SIZE 10

Maximum ast_frame cache size.

In most cases where the frame header cache will be useful, the size of the cache will stay very small. However, it is not always the case that the same thread that allocates the frame will be the one freeing them, so sometimes a thread will never have any frames in its cache, or the cache will never be pulled from. For the latter case, we limit the maximum size.

Definition at line 62 of file frame.c.

Referenced by __frame_free().

#define SMOOTHER_SIZE 8000

Definition at line 74 of file frame.c.

Referenced by __ast_smoother_feed().

#define TYPE_MASK 0x3

Definition at line 83 of file frame.c.

Referenced by g723_len().

Enumeration Type Documentation

enum frame_type

Enumerator:

TYPE_HIGH
TYPE_LOW
TYPE_SILENCE
TYPE_DONTSEND

Definition at line 76 of file frame.c.

                {
   TYPE_HIGH,     /* 0x0 */
   TYPE_LOW,      /* 0x1 */
   TYPE_SILENCE,  /* 0x2 */
   TYPE_DONTSEND  /* 0x3 */
};

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

static void __frame_free	(	struct ast_frame *	fr,
		int	cache
	)		`[static]`

Definition at line 309 of file frame.c.

References ast_free, AST_LIST_INSERT_HEAD, AST_MALLOCD_DATA, AST_MALLOCD_HDR, AST_MALLOCD_SRC, ast_threadstorage_get(), ast_frame::data, frame_cache, FRAME_CACHE_MAX_SIZE, frames, ast_frame_cache::list, ast_frame::mallocd, ast_frame::offset, ast_frame::ptr, ast_frame_cache::size, and ast_frame::src.

Referenced by ast_frame_free().

{
   if (!fr->mallocd)
      return;

#if !defined(LOW_MEMORY)
   if (cache && fr->mallocd == AST_MALLOCD_HDR) {
      /* Cool, only the header is malloc'd, let's just cache those for now
       * to keep things simple... */
      struct ast_frame_cache *frames;

      if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames))) &&
          (frames->size < FRAME_CACHE_MAX_SIZE)) {
         AST_LIST_INSERT_HEAD(&frames->list, fr, frame_list);
         frames->size++;
         return;
      }
   }
#endif

   if (fr->mallocd & AST_MALLOCD_DATA) {
      if (fr->data.ptr)
         ast_free(fr->data.ptr - fr->offset);
   }
   if (fr->mallocd & AST_MALLOCD_SRC) {
      if (fr->src)
         ast_free((void *) fr->src);
   }
   if (fr->mallocd & AST_MALLOCD_HDR) {
      ast_free(fr);
   }
}

static void __init_frame_cache ( void ) [static]

A per-thread cache of frame headers.

Definition at line 51 of file frame.c.

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

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

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

static struct ast_frame* ast_frame_header_new ( void ) [static, read]

Definition at line 267 of file frame.c.

References ast_calloc, ast_calloc_cache, AST_LIST_REMOVE_HEAD, AST_MALLOCD_HDR, ast_threadstorage_get(), f, frame_cache, frames, ast_frame_cache::list, ast_frame::mallocd, ast_frame::mallocd_hdr_len, and ast_frame_cache::size.

Referenced by ast_frisolate().

{
   struct ast_frame *f;

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

   if ((frames = ast_threadstorage_get(&frame_cache, sizeof(*frames)))) {
      if ((f = AST_LIST_REMOVE_HEAD(&frames->list, frame_list))) {
         size_t mallocd_len = f->mallocd_hdr_len;
         memset(f, 0, sizeof(*f));
         f->mallocd_hdr_len = mallocd_len;
         f->mallocd = AST_MALLOCD_HDR;
         frames->size--;
         return f;
      }
   }
   if (!(f = ast_calloc_cache(1, sizeof(*f))))
      return NULL;
#else
   if (!(f = ast_calloc(1, sizeof(*f))))
      return NULL;
#endif

   f->mallocd_hdr_len = sizeof(*f);

   return f;
}

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]

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

Makes a frame independent of any static storage.

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 * s )

Definition at line 161 of file frame.c.

References ast_smoother::flags.

{
   return s->flags;
}

struct ast_smoother* ast_smoother_new ( int size ) [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 *	s,
		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);
}

static void frame_cache_cleanup ( void * data ) [static]

Definition at line 297 of file frame.c.

References ast_free, AST_LIST_REMOVE_HEAD, f, frames, and ast_frame_cache::list.

{
   struct ast_frame_cache *frames = data;
   struct ast_frame *f;

   while ((f = AST_LIST_REMOVE_HEAD(&frames->list, frame_list)))
      ast_free(f);

   ast_free(frames);
}

static int g723_len ( unsigned char buf ) [static]

Definition at line 858 of file frame.c.

References ast_log(), LOG_WARNING, type, TYPE_DONTSEND, TYPE_HIGH, TYPE_LOW, TYPE_MASK, and TYPE_SILENCE.

Referenced by g723_samples().

{
   enum frame_type type = buf & TYPE_MASK;

   switch(type) {
   case TYPE_DONTSEND:
      return 0;
      break;
   case TYPE_SILENCE:
      return 4;
      break;
   case TYPE_HIGH:
      return 24;
      break;
   case TYPE_LOW:
      return 20;
      break;
   default:
      ast_log(LOG_WARNING, "Badly encoded frame (%d)\n", type);
   }
   return -1;
}

static int g723_samples	(	unsigned char *	buf,
		int	maxlen
	)		`[static]`

Definition at line 881 of file frame.c.

References g723_len().

Referenced by ast_codec_get_samples().

{
   int pos = 0;
   int samples = 0;
   int res;
   while(pos < maxlen) {
      res = g723_len(buf[pos]);
      if (res <= 0)
         break;
      samples += 240;
      pos += res;
   }
   return samples;
}

static unsigned char get_n_bits_at	(	unsigned char *	data,
		int	n,
		int	bit
	)		`[static]`

Definition at line 896 of file frame.c.

Referenced by speex_get_wb_sz_at(), and speex_samples().

{
   int byte = bit / 8;       /* byte containing first bit */
   int rem = 8 - (bit % 8);  /* remaining bits in first byte */
   unsigned char ret = 0;

   if (n <= 0 || n > 8)
      return 0;

   if (rem < n) {
      ret = (data[byte] << (n - rem));
      ret |= (data[byte + 1] >> (8 - n + rem));
   } else {
      ret = (data[byte] >> (rem - n));
   }

   return (ret & (0xff >> (8 - n)));
}

static int smoother_frame_feed	(	struct ast_smoother *	s,
		struct ast_frame *	f,
		int	swap
	)		`[static]`

Definition at line 101 of file frame.c.

References ast_log(), AST_SMOOTHER_FLAG_G729, ast_swapcopy_samples(), ast_tvzero(), ast_smoother::data, ast_frame::data, ast_frame::datalen, ast_smoother::delivery, ast_frame::delivery, ast_smoother::flags, ast_smoother::len, LOG_NOTICE, ast_frame::ptr, and ast_frame::samples.

Referenced by __ast_smoother_feed(), and ast_smoother_reconfigure().

{
   if (s->flags & AST_SMOOTHER_FLAG_G729) {
      if (s->len % 10) {
         ast_log(LOG_NOTICE, "Dropping extra frame of G.729 since we already have a VAD frame at the end\n");
         return 0;
      }
   }
   if (swap) {
      ast_swapcopy_samples(s->data + s->len, f->data.ptr, f->samples);
   } else {
      memcpy(s->data + s->len, f->data.ptr, f->datalen);
   }
   /* If either side is empty, reset the delivery time */
   if (!s->len || ast_tvzero(f->delivery) || ast_tvzero(s->delivery)) { /* XXX really ? */
      s->delivery = f->delivery;
   }
   s->len += f->datalen;

   return 0;
}

static int speex_get_wb_sz_at	(	unsigned char *	data,
		int	len,
		int	bit
	)		`[static]`

Definition at line 915 of file frame.c.

References ast_log(), get_n_bits_at(), and LOG_WARNING.

Referenced by speex_samples().

{
   static const int SpeexWBSubModeSz[] = {
      4, 36, 112, 192,
      352, 0, 0, 0 };
   int off = bit;
   unsigned char c;

   /* skip up to two wideband frames */
   if (((len * 8 - off) >= 5) &&
      get_n_bits_at(data, 1, off)) {
      c = get_n_bits_at(data, 3, off + 1);
      off += SpeexWBSubModeSz[c];

      if (((len * 8 - off) >= 5) &&
         get_n_bits_at(data, 1, off)) {
         c = get_n_bits_at(data, 3, off + 1);
         off += SpeexWBSubModeSz[c];

         if (((len * 8 - off) >= 5) &&
            get_n_bits_at(data, 1, off)) {
            ast_log(LOG_WARNING, "Encountered corrupt speex frame; too many wideband frames in a row.\n");
            return -1;
         }
      }

   }
   return off - bit;
}

static int speex_samples	(	unsigned char *	data,
		int	len
	)		`[static]`

Definition at line 945 of file frame.c.

References ast_log(), get_n_bits_at(), LOG_WARNING, and speex_get_wb_sz_at().

Referenced by ast_codec_get_samples().

{
   static const int SpeexSubModeSz[] = {
      5, 43, 119, 160,
      220, 300, 364, 492,
      79, 0, 0, 0,
      0, 0, 0, 0 };
   static const int SpeexInBandSz[] = {
      1, 1, 4, 4,
      4, 4, 4, 4,
      8, 8, 16, 16,
      32, 32, 64, 64 };
   int bit = 0;
   int cnt = 0;
   int off;
   unsigned char c;

   while ((len * 8 - bit) >= 5) {
      /* skip wideband frames */
      off = speex_get_wb_sz_at(data, len, bit);
      if (off < 0)  {
         ast_log(LOG_WARNING, "Had error while reading wideband frames for speex samples\n");
         break;
      }
      bit += off;

      if ((len * 8 - bit) < 5)
         break;

      /* get control bits */
      c = get_n_bits_at(data, 5, bit);
      bit += 5;

      if (c == 15) {
         /* terminator */
         break;
      } else if (c == 14) {
         /* in-band signal; next 4 bits contain signal id */
         c = get_n_bits_at(data, 4, bit);
         bit += 4;
         bit += SpeexInBandSz[c];
      } else if (c == 13) {
         /* user in-band; next 4 bits contain msg len */
         c = get_n_bits_at(data, 4, bit);
         bit += 4;
         /* after which it's 5-bit signal id + c bytes of data */
         bit += 5 + c * 8;
      } else if (c > 8) {
         /* unknown */
         ast_log(LOG_WARNING, "Unknown speex control frame %d\n", c);
         break;
      } else {
         /* skip number bits for submode (less the 5 control bits) */
         bit += SpeexSubModeSz[c] - 5;
         cnt += 160; /* new frame */
      }
   }
   return cnt;
}

Variable Documentation

struct ast_frame ast_null_frame = { AST_FRAME_NULL, }

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

struct ast_threadstorage frame_cache = { .once = PTHREAD_ONCE_INIT , .key_init = __init_frame_cache , .custom_init = NULL , } [static]

Definition at line 51 of file frame.c.

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

Asterisk developer's documentation

Data Structures

Defines

Enumerations

Functions

Variables

Detailed Description

Define Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation