Sat Apr 26 2014 22:02:50

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"
Include dependency graph for format_siren14.c:

Go to the source code of this file.

Defines

#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 = AST_BUILDOPT_SUM, .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_def 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.


Define 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 struct ast_frame* siren14read ( struct ast_filestream s,
int *  whennext 
) [static, read]

Definition at line 42 of file format_siren14.c.

References ast_format_set(), 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::data, ast_frame::datalen, errno, ast_filestream::f, ast_frame_subclass::format, ast_filestream::fr, ast_frame::frametype, LOG_WARNING, ast_frame::mallocd, ast_frame::ptr, ast_frame::samples, and ast_frame::subclass.

{
   int res;
   /* Send a frame from the file to the appropriate channel */

   s->fr.frametype = AST_FRAME_VOICE;
   ast_format_set(&s->fr.subclass.format, AST_FORMAT_SIREN14, 0);
   s->fr.mallocd = 0;
   AST_FRAME_SET_BUFFER(&s->fr, s->buf, AST_FRIENDLY_OFFSET, BUF_SIZE);
   if ((res = fread(s->fr.data.ptr, 1, s->fr.datalen, s->f)) != s->fr.datalen) {
      if (res)
         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
      return NULL;
   }
   *whennext = s->fr.samples = BYTES_TO_SAMPLES(res);
   return &s->fr;
}
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.

{
   off_t offset = 0, min = 0, cur, max;

   sample_offset = SAMPLES_TO_BYTES(sample_offset);

   if ((cur = ftello(fs->f)) < 0) {
      ast_log(AST_LOG_WARNING, "Unable to determine current position in siren14 filestream %p: %s\n", fs, strerror(errno));
      return -1;
   }

   if (fseeko(fs->f, 0, SEEK_END) < 0) {
      ast_log(AST_LOG_WARNING, "Unable to seek to end of siren14 filestream %p: %s\n", fs, strerror(errno));
      return -1;
   }

   if ((max = ftello(fs->f)) < 0) {
      ast_log(AST_LOG_WARNING, "Unable to determine max position in siren14 filestream %p: %s\n", fs, strerror(errno));
      return -1;
   }

   if (whence == SEEK_SET)
      offset = sample_offset;
   else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
      offset = sample_offset + cur;
   else if (whence == SEEK_END)
      offset = max - sample_offset;

   if (whence != SEEK_FORCECUR)
      offset = (offset > max) ? max : offset;

   /* always protect against seeking past begining. */
   offset = (offset < min) ? min : offset;

   return fseeko(fs->f, offset, SEEK_SET);
}
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.

{
   return BYTES_TO_SAMPLES(ftello(fs->f));
}
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.

{
   int fd;
   off_t cur;

   if ((fd = fileno(fs->f)) < 0) {
      ast_log(AST_LOG_WARNING, "Unable to determine file descriptor for siren14 filestream %p: %s\n", fs, strerror(errno));
      return -1;
   }
   if ((cur = ftello(fs->f)) < 0) {
      ast_log(AST_LOG_WARNING, "Unable to determine current position in siren14 filestream %p: %s\n", fs, strerror(errno));
      return -1;
   }
   /* Truncate file to current length */
   return ftruncate(fd, cur);
}
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::data, ast_frame::datalen, errno, ast_filestream::f, ast_frame_subclass::format, ast_frame::frametype, ast_format::id, LOG_WARNING, ast_frame::ptr, and ast_frame::subclass.

{
   int res;

   if (f->frametype != AST_FRAME_VOICE) {
      ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
      return -1;
   }
   if (f->subclass.format.id != AST_FORMAT_SIREN14) {
      ast_log(LOG_WARNING, "Asked to write non-Siren14 frame (%s)!\n", ast_getformatname(&f->subclass.format));
      return -1;
   }
   if ((res = fwrite(f->data.ptr, 1, f->datalen, fs->f)) != f->datalen) {
      ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
      return -1;
   }
   return 0;
}
static int unload_module ( void  ) [static]

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 = AST_BUILDOPT_SUM, .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_def siren14_f [static]

Definition at line 138 of file format_siren14.c.