Mon Mar 12 2012 21:39:40

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

Go to the source code of this file.

Defines

#define BUF_SIZE   80
#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 = 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 vox_f

Detailed Description

Flat, binary, ADPCM vox file format.

  • File name extensions: vox

Definition in file format_vox.c.


Define Documentation

#define BUF_SIZE   80

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 143 of file format_vox.c.

static void __unreg_module ( void  ) [static]

Definition at line 143 of file format_vox.c.

static int load_module ( void  ) [static]
static int unload_module ( void  ) [static]

Definition at line 134 of file format_vox.c.

References ast_format_unregister(), and ast_format::name.

static struct ast_frame* vox_read ( struct ast_filestream s,
int *  whennext 
) [static, read]

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.

{
   int res;

   /* Send a frame from the file to the appropriate channel */
   s->fr.frametype = AST_FRAME_VOICE;
   s->fr.subclass.codec = AST_FORMAT_ADPCM;
   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)) < 1) {
      if (res)
         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
      return NULL;
   }
   *whennext = s->fr.samples = res * 2;
   s->fr.datalen = res;
   return &s->fr;
}
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_filestream::f, ast_frame::offset, and SEEK_FORCECUR.

{
     off_t offset=0,min,cur,max,distance;
   
     min = 0;
     cur = ftello(fs->f);
     fseeko(fs->f, 0, SEEK_END);
    max = ftello(fs->f);
    
     /* have to fudge to frame here, so not fully to sample */
     distance = sample_offset/2;
     if(whence == SEEK_SET)
     offset = distance;
     else if(whence == SEEK_CUR || whence == SEEK_FORCECUR)
     offset = distance + cur;
     else if(whence == SEEK_END)
     offset = max - distance;
     if (whence != SEEK_FORCECUR) {
     offset = (offset > max)?max:offset;
     offset = (offset < min)?min:offset;
     }
     return fseeko(fs->f, offset, SEEK_SET);
}
static off_t vox_tell ( struct ast_filestream fs) [static]

Definition at line 108 of file format_vox.c.

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

{
     off_t offset;
     offset = ftello(fs->f) << 1;
     return offset; 
}
static int vox_trunc ( struct ast_filestream fs) [static]

Definition at line 103 of file format_vox.c.

References ast_filestream::f.

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

{
   int res;
   if (f->frametype != AST_FRAME_VOICE) {
      ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
      return -1;
   }
   if (f->subclass.codec != AST_FORMAT_ADPCM) {
      ast_log(LOG_WARNING, "Asked to write non-ADPCM frame (%s)!\n", ast_getformatname(f->subclass.codec));
      return -1;
   }
   if ((res = fwrite(f->data.ptr, 1, f->datalen, s->f)) != f->datalen) {
         ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
         return -1;
   }
   return 0;
}

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 = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_APP_DEPEND } [static]

Definition at line 143 of file format_vox.c.

Definition at line 143 of file format_vox.c.

struct ast_format vox_f [static]

Definition at line 115 of file format_vox.c.