Wed Jan 8 2020 09:50:12

Asterisk developer's documentation


format_vox.c File Reference

Flat, binary, ADPCM vox file format. 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   80 /* 80 bytes, 160 samples */
 
#define VOX_SAMPLES   160
 

Functions

static void __reg_module (void)
 
static void __unreg_module (void)
 
static int load_module (void)
 
static int unload_module (void)
 
static struct ast_framevox_read (struct ast_filestream *s, int *whennext)
 
static int vox_seek (struct ast_filestream *fs, off_t sample_offset, int whence)
 
static off_t vox_tell (struct ast_filestream *fs)
 
static int vox_trunc (struct ast_filestream *fs)
 
static int vox_write (struct ast_filestream *s, struct ast_frame *f)
 

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Dialogic VOX (ADPCM) File Format" , .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 vox_f
 

Detailed Description

Flat, binary, ADPCM vox file format.

  • File name extensions: vox

Definition in file format_vox.c.

Macro Definition Documentation

#define BUF_SIZE   80 /* 80 bytes, 160 samples */

Definition at line 39 of file format_vox.c.

Referenced by vox_read().

#define VOX_SAMPLES   160

Definition at line 40 of file format_vox.c.

Function Documentation

static void __reg_module ( void  )
static

Definition at line 165 of file format_vox.c.

static void __unreg_module ( void  )
static

Definition at line 165 of file format_vox.c.

static int load_module ( void  )
static

Definition at line 149 of file format_vox.c.

References ast_format_register, AST_MODULE_LOAD_FAILURE, and AST_MODULE_LOAD_SUCCESS.

150 {
154 }
#define ast_format_register(f)
Definition: mod_format.h:131
static struct ast_format vox_f
Definition: format_vox.c:137
static int unload_module ( void  )
static

Definition at line 156 of file format_vox.c.

References ast_format_unregister(), and ast_format::name.

157 {
159 }
int ast_format_unregister(const char *name)
Unregisters a file format.
Definition: file.c:104
static struct ast_format vox_f
Definition: format_vox.c:137
char name[80]
Definition: mod_format.h:44
static struct ast_frame* vox_read ( struct ast_filestream s,
int *  whennext 
)
static

Definition at line 42 of file format_vox.c.

References AST_FORMAT_ADPCM, AST_FRAME_SET_BUFFER, AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log(), ast_filestream::buf, BUF_SIZE, 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 
46  /* Send a frame from the file to the appropriate channel */
49  s->fr.mallocd = 0;
51  if ((res = fread(s->fr.data.ptr, 1, s->fr.datalen, s->f)) < 1) {
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 = res * 2;
57  s->fr.datalen = res;
58  return &s->fr;
59 }
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 AST_FRIENDLY_OFFSET
Offset into a frame&#39;s data buffer.
Definition: frame.h:204
int datalen
Definition: frame.h:148
struct ast_frame fr
Definition: mod_format.h:117
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
int mallocd
Definition: frame.h:152
#define AST_FORMAT_ADPCM
Definition: frame.h:252
enum ast_frame_type frametype
Definition: frame.h:144
union ast_frame::@172 data
#define BUF_SIZE
Definition: format_vox.c:39
int samples
Definition: frame.h:150
static int vox_seek ( struct ast_filestream fs,
off_t  sample_offset,
int  whence 
)
static

Definition at line 79 of file format_vox.c.

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

80 {
81  off_t offset = 0, min = 0, cur, max, distance;
82 
83  if ((cur = ftello(fs->f)) < 0) {
84  ast_log(AST_LOG_WARNING, "Unable to determine current position in g719 filestream %p: %s\n", fs, strerror(errno));
85  return -1;
86  }
87 
88  if (fseeko(fs->f, 0, SEEK_END) < 0) {
89  ast_log(AST_LOG_WARNING, "Unable to seek to end of g719 filestream %p: %s\n", fs, strerror(errno));
90  return -1;
91  }
92 
93  if ((max = ftello(fs->f)) < 0) {
94  ast_log(AST_LOG_WARNING, "Unable to determine max position in g719 filestream %p: %s\n", fs, strerror(errno));
95  return -1;
96  }
97 
98  /* have to fudge to frame here, so not fully to sample */
99  distance = sample_offset/2;
100  if (whence == SEEK_SET) {
101  offset = distance;
102  } else if (whence == SEEK_CUR || whence == SEEK_FORCECUR) {
103  offset = distance + cur;
104  } else if (whence == SEEK_END) {
105  offset = max - distance;
106  }
107  if (whence != SEEK_FORCECUR) {
108  offset = (offset > max)?max:offset;
109  offset = (offset < min)?min:offset;
110  }
111  return fseeko(fs->f, offset, SEEK_SET);
112 }
#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 vox_tell ( struct ast_filestream fs)
static

Definition at line 130 of file format_vox.c.

References ast_filestream::f, and ast_frame::offset.

131 {
132  off_t offset;
133  offset = ftello(fs->f) << 1;
134  return offset;
135 }
static int vox_trunc ( struct ast_filestream fs)
static

Definition at line 114 of file format_vox.c.

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

115 {
116  int fd;
117  off_t cur;
118 
119  if ((fd = fileno(fs->f)) < 0) {
120  ast_log(AST_LOG_WARNING, "Unable to determine file descriptor for vox filestream %p: %s\n", fs, strerror(errno));
121  return -1;
122  }
123  if ((cur = ftello(fs->f)) < 0) {
124  ast_log(AST_LOG_WARNING, "Unable to determine current position in vox filestream %p: %s\n", fs, strerror(errno));
125  return -1;
126  }
127  /* Truncate file to current length */
128  return ftruncate(fd, cur);}
#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 vox_write ( struct ast_filestream s,
struct ast_frame f 
)
static

Definition at line 61 of file format_vox.c.

References AST_FORMAT_ADPCM, 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.

62 {
63  int res;
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_ADPCM) {
69  ast_log(LOG_WARNING, "Asked to write non-ADPCM frame (%s)!\n", ast_getformatname(f->subclass.codec));
70  return -1;
71  }
72  if ((res = fwrite(f->data.ptr, 1, f->datalen, s->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_ADPCM
Definition: frame.h:252
enum ast_frame_type frametype
Definition: frame.h:144
union ast_frame::@172 data

Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Dialogic VOX (ADPCM) File Format" , .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 165 of file format_vox.c.

Definition at line 165 of file format_vox.c.

struct ast_format vox_f
static

Definition at line 137 of file format_vox.c.