Asterisk - The Open Source Telephony Project  21.4.1
Data Structures | Macros | Functions | Variables
main/frame.c File Reference

Frame and codec manipulation routines. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include "asterisk/lock.h"
#include "asterisk/frame.h"
#include "asterisk/format_cache.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 <math.h>

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

Macros

#define FRAME_CACHE_MAX_SIZE   10
 Maximum ast_frame cache size. More...
 

Functions

struct ast_frame__ast_frdup (const struct ast_frame *f, 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
 
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_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.
 
void ast_frame_dtor (struct ast_frame *f)
 NULL-safe wrapper for ast_frfree, good for RAII_VAR. More...
 
void ast_frame_dump (const char *name, struct ast_frame *f, char *prefix)
 
void ast_frame_free (struct ast_frame *frame, int cache)
 Frees a frame or list of frames. More...
 
static struct ast_frameast_frame_header_new (const char *file, int line, const char *func)
 
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)
 
static void frame_cache_cleanup (void *data)
 

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 marks.nosp@m.ter@.nosp@m.digiu.nosp@m.m.co.nosp@m.m

Definition in file main/frame.c.

Macro Definition 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 67 of file main/frame.c.

Function Documentation

int ast_frame_adjust_volume ( struct ast_frame f,
int  adjustment 
)

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

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

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

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

Referenced by audiohook_volume_callback().

788 {
789  int count;
790  short *fdata = f->data.ptr;
791  short adjust_value = abs(adjustment);
792 
794  return -1;
795  }
796 
797  if (!adjustment) {
798  return 0;
799  }
800 
801  for (count = 0; count < f->samples; count++) {
802  if (adjustment > 0) {
803  ast_slinear_saturated_multiply(&fdata[count], &adjust_value);
804  } else if (adjustment < 0) {
805  ast_slinear_saturated_divide(&fdata[count], &adjust_value);
806  }
807  }
808 
809  return 0;
810 }
struct ast_frame_subclass subclass
int ast_format_cache_is_slinear(struct ast_format *format)
Determines if a format is one of the cached slin formats.
Definition: format_cache.c:534
union ast_frame::@224 data
enum ast_frame_type frametype
struct ast_format * format
int ast_frame_adjust_volume_float ( struct ast_frame f,
float  adjustment 
)

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

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

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

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

813 {
814  int count;
815  short *fdata = f->data.ptr;
816  float adjust_value = fabs(adjustment);
817 
819  return -1;
820  }
821 
822  if (!adjustment) {
823  return 0;
824  }
825 
826  for (count = 0; count < f->samples; count++) {
827  if (adjustment > 0) {
828  ast_slinear_saturated_multiply_float(&fdata[count], &adjust_value);
829  } else if (adjustment < 0) {
830  ast_slinear_saturated_divide_float(&fdata[count], &adjust_value);
831  }
832  }
833 
834  return 0;
835 }
struct ast_frame_subclass subclass
int ast_format_cache_is_slinear(struct ast_format *format)
Determines if a format is one of the cached slin formats.
Definition: format_cache.c:534
union ast_frame::@224 data
enum ast_frame_type frametype
struct ast_format * format
void ast_frame_dtor ( struct ast_frame frame)

NULL-safe wrapper for ast_frfree, good for RAII_VAR.

Parameters
frameFrame to free, or head of list to free.

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

Referenced by __ast_play_and_record(), and stasis_app_exec().

188 {
189  ast_frfree(f);
190 }
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_frame::frametype, ast_frame_subclass::integer, ast_frame::subclass, and term_color().

Referenced by __ast_read(), and ast_write_stream().

732 {
733  const char noname[] = "unknown";
734  char ftype[40] = "Unknown Frametype";
735  char cft[80];
736  char subclass[40] = "Unknown Subclass";
737  char csub[80];
738  char moreinfo[40] = "";
739  char cn[60];
740  char cp[40];
741  char cmn[40];
742 
743  if (!name) {
744  name = noname;
745  }
746 
747  if (!f) {
748  ast_verb(-1, "%s [ %s (NULL) ] [%s]\n",
749  term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
750  term_color(cft, "HANGUP", COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
751  term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
752  return;
753  }
754  /* XXX We should probably print one each of voice and video when the format changes XXX */
755  if (f->frametype == AST_FRAME_VOICE) {
756  return;
757  }
758  if (f->frametype == AST_FRAME_VIDEO) {
759  return;
760  }
761  if (f->frametype == AST_FRAME_RTCP) {
762  return;
763  }
764 
765  ast_frame_type2str(f->frametype, ftype, sizeof(ftype));
766  ast_frame_subclass2str(f, subclass, sizeof(subclass), moreinfo, sizeof(moreinfo));
767 
768  if (!ast_strlen_zero(moreinfo))
769  ast_verb(-1, "%s [ TYPE: %s (%u) SUBCLASS: %s (%d) '%s' ] [%s]\n",
770  term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
771  term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
772  f->frametype,
773  term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
774  f->subclass.integer,
775  term_color(cmn, moreinfo, COLOR_BRGREEN, COLOR_BLACK, sizeof(cmn)),
776  term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
777  else
778  ast_verb(-1, "%s [ TYPE: %s (%u) SUBCLASS: %s (%d) ] [%s]\n",
779  term_color(cp, prefix, COLOR_BRMAGENTA, COLOR_BLACK, sizeof(cp)),
780  term_color(cft, ftype, COLOR_BRRED, COLOR_BLACK, sizeof(cft)),
781  f->frametype,
782  term_color(csub, subclass, COLOR_BRCYAN, COLOR_BLACK, sizeof(csub)),
783  f->subclass.integer,
784  term_color(cn, name, COLOR_YELLOW, COLOR_BLACK, sizeof(cn)));
785 }
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.
Definition: main/frame.c:671
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.
Definition: main/frame.c:406
struct ast_frame_subclass subclass
char * term_color(char *outbuf, const char *inbuf, int fgcolor, int bgcolor, int maxout)
Colorize a specified string by adding terminal color codes.
Definition: term.c:235
enum ast_frame_type frametype
void ast_frame_free ( struct ast_frame frame,
int  cache 
)

Frees a frame or list of frames.

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

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

References AST_LIST_NEXT.

Referenced by __ast_frisolate(), and ast_rtp_read().

177 {
178  struct ast_frame *next;
179 
180  while (frame) {
181  next = AST_LIST_NEXT(frame, frame_list);
182  __frame_free(frame, cache);
183  frame = next;
184  }
185 }
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition: linkedlists.h:439
Data structure associated with a single frame of data.
static struct sorcery_test_caching cache
Global scope caching structure for testing.
Definition: test_sorcery.c:178
int ast_frame_slinear_sum ( struct ast_frame f1,
struct ast_frame f2 
)

Sums two frames of audio samples.

Parameters
f1The first frame (which will contain the result)
f2The second frame
Returns
0 for success, non-zero for an error

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

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

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

838 {
839  int count;
840  short *data1, *data2;
841 
843  return -1;
844 
846  return -1;
847 
848  if (f1->samples != f2->samples)
849  return -1;
850 
851  for (count = 0, data1 = f1->data.ptr, data2 = f2->data.ptr;
852  count < f1->samples;
853  count++, data1++, data2++)
854  ast_slinear_saturated_add(data1, data2);
855 
856  return 0;
857 }
struct ast_frame_subclass subclass
enum ast_format_cmp_res ast_format_cmp(const struct ast_format *format1, const struct ast_format *format2)
Compare two formats.
Definition: format.c:201
union ast_frame::@224 data
enum ast_frame_type frametype
struct ast_format * format
struct ast_format * ast_format_slin
Built-in cached signed linear 8kHz format.
Definition: format_cache.c:41
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
fThe frame to get the information from
subclassBuffer to fill with subclass information
slenLength of subclass buffer
moreinfoBuffer to fill with additional information
mlenLength 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_control_t38_parameters::request_response, and ast_frame::subclass.

Referenced by ast_frame_dump(), and chan_pjsip_indicate().

407 {
408  switch(f->frametype) {
410  if (slen > 1) {
411  subclass[0] = f->subclass.integer;
412  subclass[1] = '\0';
413  }
414  break;
415  case AST_FRAME_DTMF_END:
416  if (slen > 1) {
417  subclass[0] = f->subclass.integer;
418  subclass[1] = '\0';
419  }
420  break;
421  case AST_FRAME_CONTROL:
422  switch (f->subclass.integer) {
423  case AST_CONTROL_HANGUP:
424  ast_copy_string(subclass, "Hangup", slen);
425  break;
426  case AST_CONTROL_RING:
427  ast_copy_string(subclass, "Ring", slen);
428  break;
429  case AST_CONTROL_RINGING:
430  ast_copy_string(subclass, "Ringing", slen);
431  break;
432  case AST_CONTROL_ANSWER:
433  ast_copy_string(subclass, "Answer", slen);
434  break;
435  case AST_CONTROL_BUSY:
436  ast_copy_string(subclass, "Busy", slen);
437  break;
439  ast_copy_string(subclass, "Take Off Hook", slen);
440  break;
441  case AST_CONTROL_OFFHOOK:
442  ast_copy_string(subclass, "Line Off Hook", slen);
443  break;
445  ast_copy_string(subclass, "Congestion", slen);
446  break;
447  case AST_CONTROL_FLASH:
448  ast_copy_string(subclass, "Flash", slen);
449  break;
450  case AST_CONTROL_WINK:
451  ast_copy_string(subclass, "Wink", slen);
452  break;
453  case AST_CONTROL_OPTION:
454  ast_copy_string(subclass, "Option", slen);
455  break;
457  ast_copy_string(subclass, "Key Radio", slen);
458  break;
460  ast_copy_string(subclass, "Unkey Radio", slen);
461  break;
463  ast_copy_string(subclass, "Progress", slen);
464  break;
466  ast_copy_string(subclass, "Proceeding", slen);
467  break;
468  case AST_CONTROL_HOLD:
469  ast_copy_string(subclass, "Hold", slen);
470  break;
471  case AST_CONTROL_UNHOLD:
472  ast_copy_string(subclass, "Unhold", slen);
473  break;
475  ast_copy_string(subclass, "Video Update", slen);
476  break;
478  char *message = "Unknown";
479  if (f->datalen != sizeof(struct ast_control_t38_parameters)) {
480  message = "Invalid";
481  } else {
482  struct ast_control_t38_parameters *parameters = f->data.ptr;
483  enum ast_control_t38 state = parameters->request_response;
484  if (state == AST_T38_REQUEST_NEGOTIATE)
485  message = "Negotiation Requested";
486  else if (state == AST_T38_REQUEST_TERMINATE)
487  message = "Negotiation Request Terminated";
488  else if (state == AST_T38_NEGOTIATED)
489  message = "Negotiated";
490  else if (state == AST_T38_TERMINATED)
491  message = "Terminated";
492  else if (state == AST_T38_REFUSED)
493  message = "Refused";
494  }
495  snprintf(subclass, slen, "T38_Parameters/%s", message);
496  break;
497  }
498 
500  ast_copy_string(subclass, "Stop stream", slen);
501  break;
503  ast_copy_string(subclass, "Suspend stream", slen);
504  break;
506  ast_copy_string(subclass, "Restart stream", slen);
507  break;
509  ast_copy_string(subclass, "Reverse stream", slen);
510  break;
512  ast_copy_string(subclass, "Forward stream", slen);
513  break;
515  ast_copy_string(subclass, "Cancel stream", slen);
516  break;
518  ast_copy_string(subclass, "Record stop", slen);
519  break;
521  ast_copy_string(subclass, "Record suspend", slen);
522  break;
524  ast_copy_string(subclass, "Record mute", slen);
525  break;
527  ast_copy_string(subclass, "Media source update", slen);
528  break;
530  ast_copy_string(subclass, "Transfer", slen);
531  break;
533  ast_copy_string(subclass, "Connected line update", slen);
534  break;
536  ast_copy_string(subclass, "Redirect", slen);
537  break;
538  case AST_CONTROL_CC:
539  ast_copy_string(subclass, "CC", slen);
540  break;
542  ast_copy_string(subclass, "Media SSRC change", slen);
543  break;
545  ast_copy_string(subclass, "Read action", slen);
546  break;
547  case AST_CONTROL_AOC:
548  ast_copy_string(subclass, "AOC", slen);
549  break;
551  ast_copy_string(subclass, "Endof Q", slen);
552  break;
554  ast_copy_string(subclass, "Incomplete", slen);
555  break;
556  case AST_CONTROL_MCID:
557  ast_copy_string(subclass, "MCID", slen);
558  break;
560  ast_copy_string(subclass, "Update RTP peer", slen);
561  break;
563  ast_copy_string(subclass, "Private Cause Code", slen);
564  break;
566  ast_copy_string(subclass, "Masquerade notify", slen);
567  break;
569  ast_copy_string(subclass, "Stream topology request change", slen);
570  break;
572  ast_copy_string(subclass, "Stream topology changed", slen);
573  break;
575  ast_copy_string(subclass, "Stream topology source changed", slen);
576  break;
577  case -1:
578  ast_copy_string(subclass, "Stop generators", slen);
579  break;
580  default:
581  snprintf(subclass, slen, "Unknown control '%d'", f->subclass.integer);
582  }
583  break;
584  case AST_FRAME_NULL:
585  ast_copy_string(subclass, "N/A", slen);
586  break;
587  case AST_FRAME_IAX:
588  /* Should never happen */
589  snprintf(subclass, slen, "IAX Frametype %d", f->subclass.integer);
590  break;
592  /* Should never happen */
593  snprintf(subclass, slen, "Bridge Frametype %d", f->subclass.integer);
594  break;
596  /* Should never happen */
597  snprintf(subclass, slen, "Synchronous Bridge Frametype %d", f->subclass.integer);
598  break;
599  case AST_FRAME_TEXT:
600  ast_copy_string(subclass, "N/A", slen);
601  if (moreinfo) {
602  ast_copy_string(moreinfo, f->data.ptr, mlen);
603  }
604  break;
605  case AST_FRAME_IMAGE:
606  snprintf(subclass, slen, "Image format %s\n", ast_format_get_name(f->subclass.format));
607  break;
608  case AST_FRAME_HTML:
609  switch (f->subclass.integer) {
610  case AST_HTML_URL:
611  ast_copy_string(subclass, "URL", slen);
612  if (moreinfo) {
613  ast_copy_string(moreinfo, f->data.ptr, mlen);
614  }
615  break;
616  case AST_HTML_DATA:
617  ast_copy_string(subclass, "Data", slen);
618  break;
619  case AST_HTML_BEGIN:
620  ast_copy_string(subclass, "Begin", slen);
621  break;
622  case AST_HTML_END:
623  ast_copy_string(subclass, "End", slen);
624  break;
625  case AST_HTML_LDCOMPLETE:
626  ast_copy_string(subclass, "Load Complete", slen);
627  break;
628  case AST_HTML_NOSUPPORT:
629  ast_copy_string(subclass, "No Support", slen);
630  break;
631  case AST_HTML_LINKURL:
632  ast_copy_string(subclass, "Link URL", slen);
633  if (moreinfo) {
634  ast_copy_string(moreinfo, f->data.ptr, mlen);
635  }
636  break;
637  case AST_HTML_UNLINK:
638  ast_copy_string(subclass, "Unlink", slen);
639  break;
640  case AST_HTML_LINKREJECT:
641  ast_copy_string(subclass, "Link Reject", slen);
642  break;
643  default:
644  snprintf(subclass, slen, "Unknown HTML frame '%d'\n", f->subclass.integer);
645  break;
646  }
647  break;
648  case AST_FRAME_MODEM:
649  switch (f->subclass.integer) {
650  case AST_MODEM_T38:
651  ast_copy_string(subclass, "T.38", slen);
652  break;
653  case AST_MODEM_V150:
654  ast_copy_string(subclass, "V.150", slen);
655  break;
656  default:
657  snprintf(subclass, slen, "Unknown MODEM frame '%d'\n", f->subclass.integer);
658  break;
659  }
660  break;
661  case AST_FRAME_RTCP:
662  ast_copy_string(subclass, "RTCP", slen);
663  default:
664  ast_copy_string(subclass, "Unknown Subclass", slen);
665  break;
666  }
667 
668  return subclass;
669 }
#define AST_HTML_LINKURL
#define AST_MODEM_V150
#define AST_HTML_NOSUPPORT
#define AST_HTML_LDCOMPLETE
#define AST_HTML_LINKREJECT
enum ast_control_t38 request_response
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition: format.c:334
#define AST_HTML_DATA
struct ast_frame_subclass subclass
#define AST_HTML_UNLINK
#define AST_HTML_BEGIN
union ast_frame::@224 data
#define AST_HTML_URL
#define AST_HTML_END
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:425
#define AST_MODEM_T38
enum ast_frame_type frametype
struct ast_format * format
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_typeThe frame type to be described
ftypeBuffer to fill with frame type description
lenLength 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().

672 {
673  switch (frame_type) {
675  ast_copy_string(ftype, "DTMF Begin", len);
676  break;
677  case AST_FRAME_DTMF_END:
678  ast_copy_string(ftype, "DTMF End", len);
679  break;
680  case AST_FRAME_CONTROL:
681  ast_copy_string(ftype, "Control", len);
682  break;
683  case AST_FRAME_NULL:
684  ast_copy_string(ftype, "Null Frame", len);
685  break;
686  case AST_FRAME_IAX:
687  /* Should never happen */
688  ast_copy_string(ftype, "IAX Specific", len);
689  break;
691  /* Should never happen */
692  ast_copy_string(ftype, "Bridge Specific", len);
693  break;
695  /* Should never happen */
696  ast_copy_string(ftype, "Bridge Specific", len);
697  break;
698  case AST_FRAME_TEXT:
699  ast_copy_string(ftype, "Text", len);
700  break;
701  case AST_FRAME_TEXT_DATA:
702  ast_copy_string(ftype, "Text Data", len);
703  break;
704  case AST_FRAME_IMAGE:
705  ast_copy_string(ftype, "Image", len);
706  break;
707  case AST_FRAME_HTML:
708  ast_copy_string(ftype, "HTML", len);
709  break;
710  case AST_FRAME_MODEM:
711  ast_copy_string(ftype, "Modem", len);
712  break;
713  case AST_FRAME_VOICE:
714  ast_copy_string(ftype, "Voice", len);
715  break;
716  case AST_FRAME_VIDEO:
717  ast_copy_string(ftype, "Video", len);
718  break;
719  case AST_FRAME_RTCP:
720  ast_copy_string(ftype, "RTCP", len);
721  break;
722  default:
723  snprintf(ftype, len, "Unknown Frametype '%u'", frame_type);
724  break;
725  }
726 
727  return ftype;
728 }
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:425

Variable Documentation

struct ast_frame ast_null_frame = { AST_FRAME_NULL, }