Wed Jan 8 2020 09:50:12

Asterisk developer's documentation


format_siren14.c File Reference

ITU G.722.1 Annex C (Siren14, licensed from Polycom) format, 48kbps bitrate only. More...

#include "asterisk.h"
#include "asterisk/mod_format.h"
#include "asterisk/module.h"
#include "asterisk/endian.h"

Go to the source code of this file.

Macros

#define BUF_SIZE   120 /* 20 milliseconds == 120 bytes, 640 samples */
 
#define BYTES_TO_SAMPLES(x)   ((typeof(x)) x * ((float) 640 / 120))
 
#define SAMPLES_TO_BYTES(x)   ((typeof(x)) x / ((float) 640 / 120))
 

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
static int load_module (void)
 
static struct ast_framesiren14read (struct ast_filestream *s, int *whennext)
 
static int siren14seek (struct ast_filestream *fs, off_t sample_offset, int whence)
 
static off_t siren14tell (struct ast_filestream *fs)
 
static int siren14trunc (struct ast_filestream *fs)
 
static int siren14write (struct ast_filestream *fs, struct ast_frame *f)
 
static int unload_module (void)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "ITU G.722.1 Annex C (Siren14, licensed from Polycom)" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND }
 
static struct ast_module_infoast_module_info = &__mod_info
 
static struct ast_format siren14_f
 

Detailed Description

ITU G.722.1 Annex C (Siren14, licensed from Polycom) format, 48kbps bitrate only.

  • File name extensions: siren14

Definition in file format_siren14.c.

Macro Definition Documentation

#define BUF_SIZE   120 /* 20 milliseconds == 120 bytes, 640 samples */

Definition at line 38 of file format_siren14.c.

Referenced by siren14read().

#define BYTES_TO_SAMPLES (   x)    ((typeof(x)) x * ((float) 640 / 120))

Definition at line 40 of file format_siren14.c.

Referenced by siren14read(), and siren14tell().

#define SAMPLES_TO_BYTES (   x)    ((typeof(x)) x / ((float) 640 / 120))

Definition at line 39 of file format_siren14.c.

Referenced by siren14seek().

Function Documentation

static void __reg_module ( void  )
static

Definition at line 167 of file format_siren14.c.

static void __unreg_module ( void  )
static

Definition at line 167 of file format_siren14.c.

static int load_module ( void  )
static

Definition at line 150 of file format_siren14.c.

References ast_format_register, AST_MODULE_LOAD_DECLINE, and AST_MODULE_LOAD_SUCCESS.

151 {
154 
156 }
#define ast_format_register(f)
Definition: mod_format.h:131
static struct ast_format siren14_f
static struct ast_frame* siren14read ( struct ast_filestream s,
int *  whennext 
)
static

Definition at line 42 of file format_siren14.c.

References AST_FORMAT_SIREN14, AST_FRAME_SET_BUFFER, AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log(), ast_filestream::buf, BUF_SIZE, BYTES_TO_SAMPLES, ast_frame_subclass::codec, ast_frame::data, ast_frame::datalen, errno, ast_filestream::f, ast_filestream::fr, ast_frame::frametype, LOG_WARNING, ast_frame::mallocd, ast_frame::ptr, ast_frame::samples, and ast_frame::subclass.

43 {
44  int res;
45  /* Send a frame from the file to the appropriate channel */
46 
49  s->fr.mallocd = 0;
51  if ((res = fread(s->fr.data.ptr, 1, s->fr.datalen, s->f)) != s->fr.datalen) {
52  if (res)
53  ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
54  return NULL;
55  }
56  *whennext = s->fr.samples = BYTES_TO_SAMPLES(res);
57  return &s->fr;
58 }
union ast_frame_subclass subclass
Definition: frame.h:146
void * ptr
Definition: frame.h:160
#define LOG_WARNING
Definition: logger.h:144
format_t codec
Definition: frame.h:137
#define AST_FRAME_SET_BUFFER(fr, _base, _ofs, _datalen)
Definition: frame.h:183
#define BYTES_TO_SAMPLES(x)
#define AST_FRIENDLY_OFFSET
Offset into a frame's data buffer.
Definition: frame.h:204
int datalen
Definition: frame.h:148
struct ast_frame fr
Definition: mod_format.h:117
#define BUF_SIZE
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
int errno
#define AST_FORMAT_SIREN14
Definition: frame.h:270
int mallocd
Definition: frame.h:152
enum ast_frame_type frametype
Definition: frame.h:144
union ast_frame::@172 data
int samples
Definition: frame.h:150
static int siren14seek ( struct ast_filestream fs,
off_t  sample_offset,
int  whence 
)
static

Definition at line 79 of file format_siren14.c.

References ast_log(), AST_LOG_WARNING, errno, ast_filestream::f, ast_frame::offset, SAMPLES_TO_BYTES, and SEEK_FORCECUR.

80 {
81  off_t offset = 0, min = 0, cur, max;
82 
83  sample_offset = SAMPLES_TO_BYTES(sample_offset);
84 
85  if ((cur = ftello(fs->f)) < 0) {
86  ast_log(AST_LOG_WARNING, "Unable to determine current position in siren14 filestream %p: %s\n", fs, strerror(errno));
87  return -1;
88  }
89 
90  if (fseeko(fs->f, 0, SEEK_END) < 0) {
91  ast_log(AST_LOG_WARNING, "Unable to seek to end of siren14 filestream %p: %s\n", fs, strerror(errno));
92  return -1;
93  }
94 
95  if ((max = ftello(fs->f)) < 0) {
96  ast_log(AST_LOG_WARNING, "Unable to determine max position in siren14 filestream %p: %s\n", fs, strerror(errno));
97  return -1;
98  }
99 
100  if (whence == SEEK_SET)
101  offset = sample_offset;
102  else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
103  offset = sample_offset + cur;
104  else if (whence == SEEK_END)
105  offset = max - sample_offset;
106 
107  if (whence != SEEK_FORCECUR)
108  offset = (offset > max) ? max : offset;
109 
110  /* always protect against seeking past begining. */
111  offset = (offset < min) ? min : offset;
112 
113  return fseeko(fs->f, offset, SEEK_SET);
114 }
#define SAMPLES_TO_BYTES(x)
#define AST_LOG_WARNING
Definition: logger.h:149
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
int errno
#define SEEK_FORCECUR
Definition: file.h:50
static off_t siren14tell ( struct ast_filestream fs)
static

Definition at line 133 of file format_siren14.c.

References BYTES_TO_SAMPLES, and ast_filestream::f.

134 {
135  return BYTES_TO_SAMPLES(ftello(fs->f));
136 }
#define BYTES_TO_SAMPLES(x)
static int siren14trunc ( struct ast_filestream fs)
static

Definition at line 116 of file format_siren14.c.

References ast_log(), AST_LOG_WARNING, errno, and ast_filestream::f.

117 {
118  int fd;
119  off_t cur;
120 
121  if ((fd = fileno(fs->f)) < 0) {
122  ast_log(AST_LOG_WARNING, "Unable to determine file descriptor for siren14 filestream %p: %s\n", fs, strerror(errno));
123  return -1;
124  }
125  if ((cur = ftello(fs->f)) < 0) {
126  ast_log(AST_LOG_WARNING, "Unable to determine current position in siren14 filestream %p: %s\n", fs, strerror(errno));
127  return -1;
128  }
129  /* Truncate file to current length */
130  return ftruncate(fd, cur);
131 }
#define AST_LOG_WARNING
Definition: logger.h:149
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
int errno
static int siren14write ( struct ast_filestream fs,
struct ast_frame f 
)
static

Definition at line 60 of file format_siren14.c.

References AST_FORMAT_SIREN14, AST_FRAME_VOICE, ast_getformatname(), ast_log(), ast_frame_subclass::codec, ast_frame::data, ast_frame::datalen, errno, ast_filestream::f, ast_frame::frametype, LOG_WARNING, ast_frame::ptr, and ast_frame::subclass.

61 {
62  int res;
63 
64  if (f->frametype != AST_FRAME_VOICE) {
65  ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
66  return -1;
67  }
68  if (f->subclass.codec != AST_FORMAT_SIREN14) {
69  ast_log(LOG_WARNING, "Asked to write non-Siren14 frame (%s)!\n", ast_getformatname(f->subclass.codec));
70  return -1;
71  }
72  if ((res = fwrite(f->data.ptr, 1, f->datalen, fs->f)) != f->datalen) {
73  ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
74  return -1;
75  }
76  return 0;
77 }
union ast_frame_subclass subclass
Definition: frame.h:146
void * ptr
Definition: frame.h:160
#define LOG_WARNING
Definition: logger.h:144
format_t codec
Definition: frame.h:137
int datalen
Definition: frame.h:148
char * ast_getformatname(format_t format)
Get the name of a format.
Definition: frame.c:578
void ast_log(int level, const char *file, int line, const char *function, const char *fmt,...)
Used for sending a log message This is the standard logger function. Probably the only way you will i...
Definition: logger.c:1207
int errno
#define AST_FORMAT_SIREN14
Definition: frame.h:270
enum ast_frame_type frametype
Definition: frame.h:144
union ast_frame::@172 data
static int unload_module ( void  )
static

Definition at line 158 of file format_siren14.c.

References ast_format_unregister(), and ast_format::name.

159 {
161 }
int ast_format_unregister(const char *name)
Unregisters a file format.
Definition: file.c:104
char name[80]
Definition: mod_format.h:44
static struct ast_format siren14_f

Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "ITU G.722.1 Annex C (Siren14, licensed from Polycom)" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "ac1f6a56484a8820659555499174e588" , .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND }
static

Definition at line 167 of file format_siren14.c.

Definition at line 167 of file format_siren14.c.

struct ast_format siren14_f
static

Definition at line 138 of file format_siren14.c.