formats/format_vox.c

   1 /*
   2  * Asterisk -- A telephony toolkit for Linux.
   3  *
   4  * Flat, binary, ADPCM vox file format.
   5  *
   6  * Copyright (C) 1999, Mark Spencer
   7  *
   8  * Mark Spencer <markster@linux-support.net>
   9  *
  10  * This program is free software, distributed under the terms of
  11  * the GNU General Public License
  12  */
  13
  14 #include <asterisk/lock.h>
  15 #include <asterisk/channel.h>
  16 #include <asterisk/file.h>
  17 #include <asterisk/logger.h>
  18 #include <asterisk/sched.h>
  19 #include <asterisk/module.h>
  20 #include <netinet/in.h>
  21 #include <arpa/inet.h>
  22 #include <stdlib.h>
  23 #include <sys/time.h>
  24 #include <stdio.h>
  25 #include <unistd.h>
  26 #include <errno.h>
  27 #include <string.h>
  28 #include <pthread.h>
  29 #ifdef __linux__
  30 #include <endian.h>
  31 #else
  32 #include <machine/endian.h>
  33 #endif
  34
  35 #define BUF_SIZE 80             /* 160 samples */
  36
  37 struct ast_filestream {
  38         void *reserved[AST_RESERVED_POINTERS];
  39         /* This is what a filestream means to us */
  40         int fd; /* Descriptor */
  41         struct ast_frame fr;                            /* Frame information */
  42         char waste[AST_FRIENDLY_OFFSET];        /* Buffer for sending frames, etc */
  43         char empty;                                                     /* Empty character */
  44         unsigned char buf[BUF_SIZE + 3];                                /* Output Buffer */
  45         int lasttimeout;
  46         struct timeval last;
  47         short signal;                                           /* Signal level (file side) */
  48         short ssindex;                                          /* Signal ssindex (file side) */
  49 };
  50
  51
  52 static ast_mutex_t vox_lock = AST_MUTEX_INITIALIZER;
  53 static int glistcnt = 0;
  54
  55 static char *name = "vox";
  56 static char *desc = "Dialogic VOX (ADPCM) File Format";
  57 static char *exts = "vox";
  58
  59 /*
  60  * Step size index shift table
  61  */
  62
  63 static short indsft[8] = { -1, -1, -1, -1, 2, 4, 6, 8 };
  64
  65 /*
  66  * Step size table, where stpsz[i]=floor[16*(11/10)^i]
  67  */
  68
  69 static short stpsz[49] = {
  70   16, 17, 19, 21, 23, 25, 28, 31, 34, 37, 41, 45, 50, 55, 60, 66, 73,
  71   80, 88, 97, 107, 118, 130, 143, 157, 173, 190, 209, 230, 253, 279,
  72   307, 337, 371, 408, 449, 494, 544, 598, 658, 724, 796, 876, 963,
  73   1060, 1166, 1282, 1411, 1552
  74 };
  75
  76 /*
  77  * Nibble to bit map
  78  */
  79
  80 static short nbl2bit[16][4] = {
  81   {1, 0, 0, 0}, {1, 0, 0, 1}, {1, 0, 1, 0}, {1, 0, 1, 1},
  82   {1, 1, 0, 0}, {1, 1, 0, 1}, {1, 1, 1, 0}, {1, 1, 1, 1},
  83   {-1, 0, 0, 0}, {-1, 0, 0, 1}, {-1, 0, 1, 0}, {-1, 0, 1, 1},
  84   {-1, 1, 0, 0}, {-1, 1, 0, 1}, {-1, 1, 1, 0}, {-1, 1, 1, 1}
  85 };
  86
  87 /*
  88  * Decode(encoded)
  89  *  Decodes the encoded nibble from the adpcm file.
  90  *
  91  * Results:
  92  *  Returns the encoded difference.
  93  *
  94  * Side effects:
  95  *  Sets the index to the step size table for the next encode.
  96  */
  97
  98 static inline short
  99 decode (unsigned char encoded, short *ssindex)
 100 {
 101   short diff, step;
 102   step = stpsz[*ssindex];
 103   diff = nbl2bit[encoded][0] * (step * nbl2bit[encoded][1] +
 104                                 (step >> 1) * nbl2bit[encoded][2] +
 105                                 (step >> 2) * nbl2bit[encoded][3] +
 106                                 (step >> 3));
 107   *ssindex = *ssindex + indsft[(encoded & 7)];
 108   if (*ssindex < 0)
 109     *ssindex = 0;
 110   else if (*ssindex > 48)
 111     *ssindex = 48;
 112   return (diff);
 113 }
 114
 115 /*
 116  * Adpcm
 117  *  Takes a signed linear signal and encodes it as ADPCM
 118  *  For more information see http://support.dialogic.com/appnotes/adpcm.pdf
 119  *
 120  * Results:
 121  *  Foo.
 122  *
 123  * Side effects:
 124  *  signal gets updated with each pass.
 125  */
 126
 127 static inline unsigned char
 128 adpcm (short csig, short *ssindex, short *signal)
 129 {
 130   short diff, step;
 131   unsigned char encoded;
 132   step = stpsz[*ssindex];
 133   /*
 134    * Clip csig if too large or too small
 135    */
 136
 137   csig >>= 4;
 138
 139   diff = csig - *signal;
 140
 141   if (diff < 0)
 142     {
 143       encoded = 8;
 144       diff = -diff;
 145     }
 146   else
 147     encoded = 0;
 148   if (diff >= step)
 149     {
 150       encoded |= 4;
 151       diff -= step;
 152     }
 153   step >>= 1;
 154   if (diff >= step)
 155     {
 156       encoded |= 2;
 157       diff -= step;
 158     }
 159   step >>= 1;
 160   if (diff >= step)
 161     encoded |= 1;
 162
 163   *signal += decode (encoded, ssindex);
 164   return (encoded);
 165 }
 166
 167 static struct ast_filestream *vox_open(int fd)
 168 {
 169         /* We don't have any header to read or anything really, but
 170            if we did, it would go here.  We also might want to check
 171            and be sure it's a valid file.  */
 172         struct ast_filestream *tmp;
 173         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
 174                 memset(tmp, 0, sizeof(struct ast_filestream));
 175                 if (ast_mutex_lock(&vox_lock)) {
 176                         ast_log(LOG_WARNING, "Unable to lock vox list\n");
 177                         free(tmp);
 178                         return NULL;
 179                 }
 180                 tmp->fd = fd;
 181                 tmp->fr.data = tmp->buf;
 182                 tmp->fr.frametype = AST_FRAME_VOICE;
 183                 tmp->fr.subclass = AST_FORMAT_ADPCM;
 184                 /* datalen will vary for each frame */
 185                 tmp->fr.src = name;
 186                 tmp->fr.mallocd = 0;
 187                 tmp->lasttimeout = -1;
 188                 glistcnt++;
 189                 ast_mutex_unlock(&vox_lock);
 190                 ast_update_use_count();
 191         }
 192         return tmp;
 193 }
 194
 195 static struct ast_filestream *vox_rewrite(int fd, char *comment)
 196 {
 197         /* We don't have any header to read or anything really, but
 198            if we did, it would go here.  We also might want to check
 199            and be sure it's a valid file.  */
 200         struct ast_filestream *tmp;
 201         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
 202                 memset(tmp, 0, sizeof(struct ast_filestream));
 203                 if (ast_mutex_lock(&vox_lock)) {
 204                         ast_log(LOG_WARNING, "Unable to lock vox list\n");
 205                         free(tmp);
 206                         return NULL;
 207                 }
 208                 tmp->fd = fd;
 209                 glistcnt++;
 210                 ast_mutex_unlock(&vox_lock);
 211                 ast_update_use_count();
 212         } else
 213                 ast_log(LOG_WARNING, "Out of memory\n");
 214         return tmp;
 215 }
 216
 217 static void vox_close(struct ast_filestream *s)
 218 {
 219         if (ast_mutex_lock(&vox_lock)) {
 220                 ast_log(LOG_WARNING, "Unable to lock vox list\n");
 221                 return;
 222         }
 223         glistcnt--;
 224         ast_mutex_unlock(&vox_lock);
 225         ast_update_use_count();
 226         close(s->fd);
 227         free(s);
 228         s = NULL;
 229 }
 230
 231 static struct ast_frame *vox_read(struct ast_filestream *s, int *whennext)
 232 {
 233         int res;
 234         int x;
 235         /* Send a frame from the file to the appropriate channel */
 236
 237         s->fr.frametype = AST_FRAME_VOICE;
 238         s->fr.subclass = AST_FORMAT_ADPCM;
 239         s->fr.offset = AST_FRIENDLY_OFFSET;
 240         s->fr.mallocd = 0;
 241         s->fr.data = s->buf;
 242         if ((res = read(s->fd, s->buf + 3, BUF_SIZE)) < 1) {
 243                 if (res)
 244                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
 245                 return NULL;
 246         }
 247         /* Store index, then signal */
 248         s->buf[0] = s->ssindex & 0xff;
 249         s->buf[1] = (s->signal >> 8) & 0xff;
 250         s->buf[2] = s->signal & 0xff;
 251         /* Do the decoder to be sure we get the right stuff in the signal and index fields. */
 252         for (x=3;x<res+3;x++) {
 253                 s->signal += decode(s->buf[x] >> 4, &s->ssindex);
 254                 s->signal += decode(s->buf[x] & 0xf, &s->ssindex);
 255         }
 256         s->fr.samples = res * 2;
 257         s->fr.datalen = res + 3;
 258         *whennext = s->fr.samples;
 259         return &s->fr;
 260 }
 261
 262 static int vox_write(struct ast_filestream *fs, struct ast_frame *f)
 263 {
 264         int res;
 265         if (f->frametype != AST_FRAME_VOICE) {
 266                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
 267                 return -1;
 268         }
 269         if (f->subclass != AST_FORMAT_ADPCM) {
 270                 ast_log(LOG_WARNING, "Asked to write non-ADPCM frame (%d)!\n", f->subclass);
 271                 return -1;
 272         }
 273         if (f->datalen < 3) {
 274                 ast_log(LOG_WARNING, "Invalid frame of data (< 3 bytes long) from %s\n", f->src);
 275                 return -1;
 276         }
 277         if ((res = write(fs->fd, f->data + 3, f->datalen - 3)) != f->datalen - 3) {
 278                         ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
 279                         return -1;
 280         }
 281         return 0;
 282 }
 283
 284 static char *vox_getcomment(struct ast_filestream *s)
 285 {
 286         return NULL;
 287 }
 288
 289 static int vox_seek(struct ast_filestream *fs, long sample_offset, int whence)
 290 {
 291         return -1;
 292 }
 293
 294 static int vox_trunc(struct ast_filestream *fs)
 295 {
 296         return -1;
 297 }
 298
 299 static long vox_tell(struct ast_filestream *fs)
 300 {
 301         return -1;
 302 }
 303
 304 int load_module()
 305 {
 306         return ast_format_register(name, exts, AST_FORMAT_ADPCM,
 307                                                                 vox_open,
 308                                                                 vox_rewrite,
 309                                                                 vox_write,
 310                                                                 vox_seek,
 311                                                                 vox_trunc,
 312                                                                 vox_tell,
 313                                                                 vox_read,
 314                                                                 vox_close,
 315                                                                 vox_getcomment);
 316
 317
 318 }
 319
 320 int unload_module()
 321 {
 322         return ast_format_unregister(name);
 323 }
 324
 325 int usecount()
 326 {
 327         int res;
 328         if (ast_mutex_lock(&vox_lock)) {
 329                 ast_log(LOG_WARNING, "Unable to lock vox list\n");
 330                 return -1;
 331         }
 332         res = glistcnt;
 333         ast_mutex_unlock(&vox_lock);
 334         return res;
 335 }
 336
 337 char *description()
 338 {
 339         return desc;
 340 }
 341
 342
 343 char *key()
 344 {
 345         return ASTERISK_GPL_KEY;
 346 }