Merged revisions 319083 via svnmerge from
[asterisk/asterisk.git] / formats / format_pcm.c
old mode 100755 (executable)
new mode 100644 (file)
index dc16935..ec628c5
@@ -1,7 +1,7 @@
 /*
  * Asterisk -- An open source telephony toolkit.
  *
- * Copyright (C) 1999 - 2005, Digium, Inc.
+ * Copyright (C) 1999 - 2006, Digium, Inc.
  *
  * Mark Spencer <markster@digium.com>
  *
  * at the top of the source tree.
  */
 
-/*
+/*! \file
  *
- * Flat, binary, ulaw PCM file format.
+ * \brief Flat, binary, ulaw PCM file format.
+ * \arg File name extension: alaw, al, alw, pcm, ulaw, ul, mu, ulw, g722, au
  * 
+ * \ingroup formats
  */
  
-#include <unistd.h>
-#include <netinet/in.h>
-#include <arpa/inet.h>
-#include <stdlib.h>
-#include <sys/time.h>
-#include <stdio.h>
-#include <errno.h>
-#include <string.h>
-
 #include "asterisk.h"
 
 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
 
-#include "asterisk/lock.h"
-#include "asterisk/channel.h"
-#include "asterisk/file.h"
-#include "asterisk/logger.h"
-#include "asterisk/sched.h"
+#include "asterisk/mod_format.h"
 #include "asterisk/module.h"
 #include "asterisk/endian.h"
+#include "asterisk/ulaw.h"
+#include "asterisk/alaw.h"
 
-#define BUF_SIZE 160           /* 160 samples */
-
-struct ast_filestream {
-       void *reserved[AST_RESERVED_POINTERS];
-       /* This is what a filestream means to us */
-       int fd; /* Descriptor */
-       struct ast_channel *owner;
-       struct ast_frame fr;                            /* Frame information */
-       char waste[AST_FRIENDLY_OFFSET];        /* Buffer for sending frames, etc */
-       char empty;                                                     /* Empty character */
-       unsigned char buf[BUF_SIZE];                            /* Output Buffer */
-       struct timeval last;
-};
+#define BUF_SIZE 160           /* 160 bytes, and same number of samples */
 
+static char ulaw_silence[BUF_SIZE];
+static char alaw_silence[BUF_SIZE];
 
-AST_MUTEX_DEFINE_STATIC(pcm_lock);
-static int glistcnt = 0;
+/* #define REALTIME_WRITE */   /* XXX does it work at all ? */
 
-static char *name = "pcm";
-static char *desc = "Raw uLaw 8khz Audio support (PCM)";
-static char *exts = "pcm|ulaw|ul|mu";
+#ifdef REALTIME_WRITE
+struct pcm_desc {
+       unsigned long start_time;
+};
 
-static struct ast_filestream *pcm_open(int fd)
+/* Returns time in msec since system boot. */
+static unsigned long get_time(void)
 {
-       /* We don't have any header to read or anything really, but
-          if we did, it would go here.  We also might want to check
-          and be sure it's a valid file.  */
-       struct ast_filestream *tmp;
-       if ((tmp = malloc(sizeof(struct ast_filestream)))) {
-               memset(tmp, 0, sizeof(struct ast_filestream));
-               if (ast_mutex_lock(&pcm_lock)) {
-                       ast_log(LOG_WARNING, "Unable to lock pcm list\n");
-                       free(tmp);
-                       return NULL;
-               }
-               tmp->fd = fd;
-               tmp->fr.data = tmp->buf;
-               tmp->fr.frametype = AST_FRAME_VOICE;
-               tmp->fr.subclass = AST_FORMAT_ULAW;
-               /* datalen will vary for each frame */
-               tmp->fr.src = name;
-               tmp->fr.mallocd = 0;
-               glistcnt++;
-               ast_mutex_unlock(&pcm_lock);
-               ast_update_use_count();
-       }
-       return tmp;
-}
-
-static struct ast_filestream *pcm_rewrite(int fd, const char *comment)
-{
-       /* We don't have any header to read or anything really, but
-          if we did, it would go here.  We also might want to check
-          and be sure it's a valid file.  */
-       struct ast_filestream *tmp;
-       if ((tmp = malloc(sizeof(struct ast_filestream)))) {
-               memset(tmp, 0, sizeof(struct ast_filestream));
-               if (ast_mutex_lock(&pcm_lock)) {
-                       ast_log(LOG_WARNING, "Unable to lock pcm list\n");
-                       free(tmp);
-                       return NULL;
-               }
-               tmp->fd = fd;
-               glistcnt++;
-               ast_mutex_unlock(&pcm_lock);
-               ast_update_use_count();
-       } else
-               ast_log(LOG_WARNING, "Out of memory\n");
-       return tmp;
+       struct tms buf;
+       clock_t cur;
+
+       cur = times( &buf );
+       if( cur < 0 ) {
+               ast_log( LOG_WARNING, "Cannot get current time\n" );
+               return 0;
+       }
+       return cur * 1000 / sysconf( _SC_CLK_TCK );
 }
 
-static void pcm_close(struct ast_filestream *s)
+static int pcma_open(struct ast_filestream *s)
 {
-       if (ast_mutex_lock(&pcm_lock)) {
-               ast_log(LOG_WARNING, "Unable to lock pcm list\n");
-               return;
-       }
-       glistcnt--;
-       ast_mutex_unlock(&pcm_lock);
-       ast_update_use_count();
-       close(s->fd);
-       free(s);
-       s = NULL;
+       if (s->fmt->format == AST_FORMAT_ALAW)
+               pd->starttime = get_time();
+       return 0;
 }
 
+static int pcma_rewrite(struct ast_filestream *s, const char *comment)
+{
+       return pcma_open(s);
+}
+#endif
+
 static struct ast_frame *pcm_read(struct ast_filestream *s, int *whennext)
 {
        int res;
-       int delay;
+       
        /* Send a frame from the file to the appropriate channel */
 
        s->fr.frametype = AST_FRAME_VOICE;
-       s->fr.subclass = AST_FORMAT_ULAW;
-       s->fr.offset = AST_FRIENDLY_OFFSET;
+       ast_format_copy(&s->fr.subclass.format, &s->fmt->format);
        s->fr.mallocd = 0;
-       s->fr.data = s->buf;
-       if ((res = read(s->fd, s->buf, BUF_SIZE)) < 1) {
+       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;
        }
-       s->fr.samples = res;
        s->fr.datalen = res;
-       delay = s->fr.samples;
-       *whennext = delay;
+       if (s->fmt->format.id == AST_FORMAT_G722)
+               *whennext = s->fr.samples = res * 2;
+       else
+               *whennext = s->fr.samples = res;
        return &s->fr;
 }
 
+static int pcm_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
+{
+       off_t cur, max, offset = 0;
+       int ret = -1;   /* assume error */
+
+       cur = ftello(fs->f);
+       fseeko(fs->f, 0, SEEK_END);
+       max = ftello(fs->f);
+
+       switch (whence) {
+       case SEEK_SET:
+               offset = sample_offset;
+               break;
+       case SEEK_END:
+               offset = max - sample_offset;
+               break;
+       case SEEK_CUR:
+       case SEEK_FORCECUR:
+               offset = cur + sample_offset;
+               break;
+       default:
+               ast_log(LOG_WARNING, "invalid whence %d, assuming SEEK_SET\n", whence);
+               offset = sample_offset;
+       }
+       if (offset < 0) {
+               ast_log(LOG_WARNING, "negative offset %ld, resetting to 0\n", (long) offset);
+               offset = 0;
+       }
+       if (whence == SEEK_FORCECUR && offset > max) { /* extend the file */
+               size_t left = offset - max;
+               const char *src = (fs->fmt->format.id == AST_FORMAT_ALAW) ? alaw_silence : ulaw_silence;
+
+               while (left) {
+                       size_t written = fwrite(src, 1, (left > BUF_SIZE) ? BUF_SIZE : left, fs->f);
+                       if (written == -1)
+                               break;  /* error */
+                       left -= written;
+               }
+               ret = 0; /* successful */
+       } else {
+               if (offset > max) {
+                       ast_log(LOG_WARNING, "offset too large %ld, truncating to %ld\n", (long) offset, (long) max);
+                       offset = max;
+               }
+               ret = fseeko(fs->f, offset, SEEK_SET);
+       }
+       return ret;
+}
+
+static int pcm_trunc(struct ast_filestream *fs)
+{
+       return ftruncate(fileno(fs->f), ftello(fs->f));
+}
+
+static off_t pcm_tell(struct ast_filestream *fs)
+{
+       return ftello(fs->f);
+}
+
 static int pcm_write(struct ast_filestream *fs, struct ast_frame *f)
 {
        int res;
+
        if (f->frametype != AST_FRAME_VOICE) {
                ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
                return -1;
        }
-       if (f->subclass != AST_FORMAT_ULAW) {
-               ast_log(LOG_WARNING, "Asked to write non-ulaw frame (%d)!\n", f->subclass);
+       if (ast_format_cmp(&f->subclass.format, &fs->fmt->format) == AST_FORMAT_CMP_NOT_EQUAL) {
+               ast_log(LOG_WARNING, "Asked to write incompatible format frame (%s)!\n", ast_getformatname(&f->subclass.format));
                return -1;
        }
-       if ((res = write(fs->fd, f->data, f->datalen)) != f->datalen) {
-                       ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
+
+#ifdef REALTIME_WRITE
+       if (s->fmt->format == AST_FORMAT_ALAW) {
+               struct pcm_desc *pd = (struct pcm_desc *)fs->_private;
+               struct stat stat_buf;
+               unsigned long cur_time = get_time();
+               unsigned long fpos = ( cur_time - pd->start_time ) * 8; /* 8 bytes per msec */
+               /* Check if we have written to this position yet. If we have, then increment pos by one frame
+               *  for some degree of protection against receiving packets in the same clock tick.
+               */
+               
+               fstat(fileno(fs->f), &stat_buf );
+               if (stat_buf.st_size > fpos )
+                       fpos += f->datalen;     /* Incrementing with the size of this current frame */
+
+               if (stat_buf.st_size < fpos) {
+                       /* fill the gap with 0x55 rather than 0. */
+                       char buf[1024];
+                       unsigned long cur, to_write;
+
+                       cur = stat_buf.st_size;
+                       if (fseek(fs->f, cur, SEEK_SET) < 0) {
+                               ast_log( LOG_WARNING, "Cannot seek in file: %s\n", strerror(errno) );
+                               return -1;
+                       }
+                       memset(buf, 0x55, 512);
+                       while (cur < fpos) {
+                               to_write = fpos - cur;
+                               if (to_write > sizeof(buf))
+                                       to_write = sizeof(buf);
+                               fwrite(buf, 1, to_write, fs->f);
+                               cur += to_write;
+                       }
+               }
+
+               if (fseek(s->f, fpos, SEEK_SET) < 0) {
+                       ast_log( LOG_WARNING, "Cannot seek in file: %s\n", strerror(errno) );
                        return -1;
+               }
+       }
+#endif /* REALTIME_WRITE */
+       
+       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 pcm_seek(struct ast_filestream *fs, long sample_offset, int whence)
+/* SUN .au support routines */
+
+#define AU_HEADER_SIZE         24
+#define AU_HEADER(var)         uint32_t var[6]
+
+#define AU_HDR_MAGIC_OFF       0
+#define AU_HDR_HDR_SIZE_OFF    1
+#define AU_HDR_DATA_SIZE_OFF   2
+#define AU_HDR_ENCODING_OFF    3
+#define AU_HDR_SAMPLE_RATE_OFF 4
+#define AU_HDR_CHANNELS_OFF    5
+
+#define AU_ENC_8BIT_ULAW       1
+
+#define AU_MAGIC 0x2e736e64
+#if __BYTE_ORDER == __BIG_ENDIAN
+#define htoll(b) (b)
+#define htols(b) (b)
+#define ltohl(b) (b)
+#define ltohs(b) (b)
+#else
+#if __BYTE_ORDER == __LITTLE_ENDIAN
+#define htoll(b)  \
+          (((((b)      ) & 0xFF) << 24) | \
+              ((((b) >>  8) & 0xFF) << 16) | \
+                  ((((b) >> 16) & 0xFF) <<  8) | \
+                  ((((b) >> 24) & 0xFF)      ))
+#define htols(b) \
+          (((((b)      ) & 0xFF) << 8) | \
+                  ((((b) >> 8) & 0xFF)      ))
+#define ltohl(b) htoll(b)
+#define ltohs(b) htols(b)
+#else
+#error "Endianess not defined"
+#endif
+#endif
+
+static int check_header(FILE *f)
 {
-       off_t offset=0,min,cur,max;
+       AU_HEADER(header);
+       uint32_t magic;
+       uint32_t hdr_size;
+       uint32_t data_size;
+       uint32_t encoding;
+       uint32_t sample_rate;
+       uint32_t channels;
 
-       min = 0;
-       cur = lseek(fs->fd, 0, SEEK_CUR);
-       max = lseek(fs->fd, 0, SEEK_END);
-       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;
+       if (fread(header, 1, AU_HEADER_SIZE, f) != AU_HEADER_SIZE) {
+               ast_log(LOG_WARNING, "Read failed (header)\n");
+               return -1;
+       }
+       magic = ltohl(header[AU_HDR_MAGIC_OFF]);
+       if (magic != (uint32_t) AU_MAGIC) {
+               ast_log(LOG_WARNING, "Bad magic: 0x%x\n", magic);
        }
-       /* always protect against seeking past begining. */
-       offset = (offset < min)?min:offset;
-       return lseek(fs->fd, offset, SEEK_SET);
+       hdr_size = ltohl(header[AU_HDR_HDR_SIZE_OFF]);
+       if (hdr_size < AU_HEADER_SIZE) {
+               hdr_size = AU_HEADER_SIZE;
+       }
+/*     data_size = ltohl(header[AU_HDR_DATA_SIZE_OFF]); */
+       encoding = ltohl(header[AU_HDR_ENCODING_OFF]);
+       if (encoding != AU_ENC_8BIT_ULAW) {
+               ast_log(LOG_WARNING, "Unexpected format: %d. Only 8bit ULAW allowed (%d)\n", encoding, AU_ENC_8BIT_ULAW);
+               return -1;
+       }
+       sample_rate = ltohl(header[AU_HDR_SAMPLE_RATE_OFF]);
+       if (sample_rate != DEFAULT_SAMPLE_RATE) {
+               ast_log(LOG_WARNING, "Sample rate can only be 8000 not %d\n", sample_rate);
+               return -1;
+       }
+       channels = ltohl(header[AU_HDR_CHANNELS_OFF]);
+       if (channels != 1) {
+               ast_log(LOG_WARNING, "Not in mono: channels=%d\n", channels);
+               return -1;
+       }
+       /* Skip to data */
+       fseek(f, 0, SEEK_END);
+       data_size = ftell(f) - hdr_size;
+       if (fseek(f, hdr_size, SEEK_SET) == -1 ) {
+               ast_log(LOG_WARNING, "Failed to skip to data: %d\n", hdr_size);
+               return -1;
+       }
+       return data_size;
 }
 
-static int pcm_trunc(struct ast_filestream *fs)
+static int update_header(FILE *f)
 {
-       return ftruncate(fs->fd, lseek(fs->fd,0,SEEK_CUR));
+       off_t cur, end;
+       uint32_t datalen;
+       int bytes;
+
+       cur = ftell(f);
+       fseek(f, 0, SEEK_END);
+       end = ftell(f);
+       /* data starts 24 bytes in */
+       bytes = end - AU_HEADER_SIZE;
+       datalen = htoll(bytes);
+
+       if (cur < 0) {
+               ast_log(LOG_WARNING, "Unable to find our position\n");
+               return -1;
+       }
+       if (fseek(f, AU_HDR_DATA_SIZE_OFF * sizeof(uint32_t), SEEK_SET)) {
+               ast_log(LOG_WARNING, "Unable to set our position\n");
+               return -1;
+       }
+       if (fwrite(&datalen, 1, sizeof(datalen), f) != sizeof(datalen)) {
+               ast_log(LOG_WARNING, "Unable to set write file size\n");
+               return -1;
+       }
+       if (fseek(f, cur, SEEK_SET)) {
+               ast_log(LOG_WARNING, "Unable to return to position\n");
+               return -1;
+       }
+       return 0;
 }
 
-static long pcm_tell(struct ast_filestream *fs)
+static int write_header(FILE *f)
 {
-       off_t offset;
-       offset = lseek(fs->fd, 0, SEEK_CUR);
-       return offset;
+       AU_HEADER(header);
+
+       header[AU_HDR_MAGIC_OFF] = htoll((uint32_t) AU_MAGIC);
+       header[AU_HDR_HDR_SIZE_OFF] = htoll(AU_HEADER_SIZE);
+       header[AU_HDR_DATA_SIZE_OFF] = 0;
+       header[AU_HDR_ENCODING_OFF] = htoll(AU_ENC_8BIT_ULAW);
+       header[AU_HDR_SAMPLE_RATE_OFF] = htoll(DEFAULT_SAMPLE_RATE);
+       header[AU_HDR_CHANNELS_OFF] = htoll(1);
+
+       /* Write an au header, ignoring sizes which will be filled in later */
+       fseek(f, 0, SEEK_SET);
+       if (fwrite(header, 1, AU_HEADER_SIZE, f) != AU_HEADER_SIZE) {
+               ast_log(LOG_WARNING, "Unable to write header\n");
+               return -1;
+       }
+       return 0;
 }
 
-static char *pcm_getcomment(struct ast_filestream *s)
+static int au_open(struct ast_filestream *s)
 {
-       return NULL;
+       if (check_header(s->f) < 0)
+               return -1;
+       return 0;
 }
 
-int load_module()
+static int au_rewrite(struct ast_filestream *s, const char *comment)
 {
-       return ast_format_register(name, exts, AST_FORMAT_ULAW,
-                                                               pcm_open,
-                                                               pcm_rewrite,
-                                                               pcm_write,
-                                                               pcm_seek,
-                                                               pcm_trunc,
-                                                               pcm_tell,
-                                                               pcm_read,
-                                                               pcm_close,
-                                                               pcm_getcomment);
-                                                               
-                                                               
+       if (write_header(s->f))
+               return -1;
+       return 0;
 }
 
-int unload_module()
+/* XXX check this, probably incorrect */
+static int au_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
 {
-       return ast_format_unregister(name);
-}      
+       off_t min, max, cur;
+       long offset = 0, bytes;
+
+       if (fs->fmt->format.id == AST_FORMAT_G722)
+               bytes = sample_offset / 2;
+       else
+               bytes = sample_offset;
+
+       min = AU_HEADER_SIZE;
+       cur = ftello(fs->f);
+       fseek(fs->f, 0, SEEK_END);
+       max = ftello(fs->f);
+
+       if (whence == SEEK_SET)
+               offset = bytes + min;
+       else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
+               offset = bytes + cur;
+       else if (whence == SEEK_END)
+               offset = max - bytes;
+
+       if (whence != SEEK_FORCECUR) {
+               offset = (offset > max) ? max : offset;
+       }
+
+       /* always protect the header space. */
+       offset = (offset < min) ? min : offset;
+
+       return fseeko(fs->f, offset, SEEK_SET);
+}
 
-int usecount()
+static int au_trunc(struct ast_filestream *fs)
 {
-       return glistcnt;
+       if (ftruncate(fileno(fs->f), ftell(fs->f)))
+               return -1;
+       return update_header(fs->f);
 }
 
-char *description()
+static off_t au_tell(struct ast_filestream *fs)
 {
-       return desc;
+       off_t offset = ftello(fs->f);
+       return offset - AU_HEADER_SIZE;
 }
 
+static struct ast_format_def alaw_f = {
+       .name = "alaw",
+       .exts = "alaw|al|alw",
+       .write = pcm_write,
+       .seek = pcm_seek,
+       .trunc = pcm_trunc,
+       .tell = pcm_tell,
+       .read = pcm_read,
+       .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
+#ifdef REALTIME_WRITE
+       .open = pcma_open,
+       .rewrite = pcma_rewrite,
+       .desc_size = sizeof(struct pcm_desc),
+#endif
+};
+
+static struct ast_format_def pcm_f = {
+       .name = "pcm",
+       .exts = "pcm|ulaw|ul|mu|ulw",
+       .write = pcm_write,
+       .seek = pcm_seek,
+       .trunc = pcm_trunc,
+       .tell = pcm_tell,
+       .read = pcm_read,
+       .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
+};
+
+static struct ast_format_def g722_f = {
+       .name = "g722",
+       .exts = "g722",
+       .write = pcm_write,
+       .seek = pcm_seek,
+       .trunc = pcm_trunc,
+       .tell = pcm_tell,
+       .read = pcm_read,
+       .buf_size = (BUF_SIZE * 2) + AST_FRIENDLY_OFFSET,
+};
+
+static struct ast_format_def au_f = {
+       .name = "au",
+       .exts = "au",
+       .open = au_open,
+       .rewrite = au_rewrite,
+       .write = pcm_write,
+       .seek = au_seek,
+       .trunc = au_trunc,
+       .tell = au_tell,
+       .read = pcm_read,
+       .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,     /* this many shorts */
+};
 
-char *key()
+static int load_module(void)
 {
-       return ASTERISK_GPL_KEY;
+       int i;
+
+       /* XXX better init ? */
+       for (i = 0; i < ARRAY_LEN(ulaw_silence); i++)
+               ulaw_silence[i] = AST_LIN2MU(0);
+       for (i = 0; i < ARRAY_LEN(alaw_silence); i++)
+               alaw_silence[i] = AST_LIN2A(0);
+
+       ast_format_set(&pcm_f.format, AST_FORMAT_ULAW, 0);
+       ast_format_set(&alaw_f.format, AST_FORMAT_ALAW, 0);
+       ast_format_set(&au_f.format, AST_FORMAT_ULAW, 0);
+       ast_format_set(&g722_f.format, AST_FORMAT_G722, 0);
+       if ( ast_format_def_register(&pcm_f)
+               || ast_format_def_register(&alaw_f)
+               || ast_format_def_register(&au_f)
+               || ast_format_def_register(&g722_f) )
+               return AST_MODULE_LOAD_FAILURE;
+       return AST_MODULE_LOAD_SUCCESS;
 }
+
+static int unload_module(void)
+{
+       return ast_format_def_unregister(pcm_f.name)
+               || ast_format_def_unregister(alaw_f.name)
+               || ast_format_def_unregister(au_f.name)
+               || ast_format_def_unregister(g722_f.name);
+}
+
+AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Raw/Sun uLaw/ALaw 8KHz (PCM,PCMA,AU), G.722 16Khz",
+       .load = load_module,
+       .unload = unload_module,
+       .load_pri = AST_MODPRI_APP_DEPEND
+);