Merged revisions 61863 via svnmerge from
[asterisk/asterisk.git] / formats / format_gsm.c
old mode 100755 (executable)
new mode 100644 (file)
index 0906a94..f997af1
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Save to raw, headerless GSM data.
- * 
- * Copyright (C) 1999, Mark Spencer
+ * Copyright (C) 1999 - 2005, Digium, Inc.
  *
- * Mark Spencer <markster@linux-support.net>
+ * Mark Spencer <markster@digium.com>
+ *
+ * See http://www.asterisk.org for more information about
+ * the Asterisk project. Please do not directly contact
+ * any of the maintainers of this project for assistance;
+ * the project provides a web site, mailing lists and IRC
+ * channels for your use.
  *
  * This program is free software, distributed under the terms of
- * the GNU General Public License
+ * the GNU General Public License Version 2. See the LICENSE file
+ * at the top of the source tree.
+ */
+
+/*! \file
+ *
+ * \brief Save to raw, headerless GSM data.
+ * \arg File name extension: gsm
+ * \ingroup formats
  */
  
-#include <asterisk/channel.h>
-#include <asterisk/file.h>
-#include <asterisk/logger.h>
-#include <asterisk/sched.h>
-#include <asterisk/module.h>
+#include "asterisk.h"
+
+ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
+
+#include <unistd.h>
+#include <netinet/in.h>
 #include <arpa/inet.h>
 #include <stdlib.h>
 #include <sys/time.h>
 #include <stdio.h>
-#include <unistd.h>
 #include <errno.h>
 #include <string.h>
-#include <pthread.h>
-#include <endian.h>
 
-/* Some Ideas for this code came from makegsme.c by Jeffery Chilton */
-
-/* Portions of the conversion code are by guido@sienanet.it */
-
-struct ast_filestream {
-       void *reserved[AST_RESERVED_POINTERS];
-       /* Believe it or not, we must decode/recode to account for the
-          weird MS format */
-       /* 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 gsm[33];                          /* Two Real GSM Frames */
-       int lasttimeout;
-       struct timeval last;
-       int adj;
-       struct ast_filestream *next;
-};
+#include "asterisk/lock.h"
+#include "asterisk/channel.h"
+#include "asterisk/file.h"
+#include "asterisk/logger.h"
+#include "asterisk/sched.h"
+#include "asterisk/module.h"
+#include "asterisk/endian.h"
 
+#include "msgsm.h"
 
-static struct ast_filestream *glist = NULL;
-static pthread_mutex_t gsm_lock = PTHREAD_MUTEX_INITIALIZER;
-static int glistcnt = 0;
+/* Some Ideas for this code came from makegsme.c by Jeffrey Chilton */
 
-static char *name = "gsm";
-static char *desc = "Raw GSM data";
-static char *exts = "gsm";
-
-static struct ast_filestream *gsm_open(int fd)
-{
-       /* 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 (pthread_mutex_lock(&gsm_lock)) {
-                       ast_log(LOG_WARNING, "Unable to lock gsm list\n");
-                       free(tmp);
-                       return NULL;
-               }
-               tmp->next = glist;
-               glist = tmp;
-               tmp->fd = fd;
-               tmp->owner = NULL;
-               tmp->fr.data = tmp->gsm;
-               tmp->fr.frametype = AST_FRAME_VOICE;
-               tmp->fr.subclass = AST_FORMAT_GSM;
-               /* datalen will vary for each frame */
-               tmp->fr.src = name;
-               tmp->fr.mallocd = 0;
-               tmp->lasttimeout = -1;
-               glistcnt++;
-               pthread_mutex_unlock(&gsm_lock);
-               ast_update_use_count();
-       }
-       return tmp;
-}
+/* Portions of the conversion code are by guido@sienanet.it */
 
-static struct ast_filestream *gsm_rewrite(int fd, 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 (pthread_mutex_lock(&gsm_lock)) {
-                       ast_log(LOG_WARNING, "Unable to lock gsm list\n");
-                       free(tmp);
-                       return NULL;
-               }
-               tmp->next = glist;
-               glist = tmp;
-               tmp->fd = fd;
-               tmp->owner = NULL;
-               tmp->lasttimeout = -1;
-               glistcnt++;
-               pthread_mutex_unlock(&gsm_lock);
-               ast_update_use_count();
-       } else
-               ast_log(LOG_WARNING, "Out of memory\n");
-       return tmp;
-}
+#define        GSM_FRAME_SIZE  33
+#define        GSM_SAMPLES     160
 
-static struct ast_frame *gsm_read(struct ast_filestream *s)
-{
-       return NULL;
-}
+/* silent gsm frame */
+/* begin binary data: */
+char gsm_silence[] = /* 33 */
+{0xD8,0x20,0xA2,0xE1,0x5A,0x50,0x00,0x49,0x24,0x92,0x49,0x24,0x50,0x00,0x49
+,0x24,0x92,0x49,0x24,0x50,0x00,0x49,0x24,0x92,0x49,0x24,0x50,0x00,0x49,0x24
+,0x92,0x49,0x24};
+/* end binary data. size = 33 bytes */
 
-static void gsm_close(struct ast_filestream *s)
+static struct ast_frame *gsm_read(struct ast_filestream *s, int *whennext)
 {
-       struct ast_filestream *tmp, *tmpl = NULL;
-       if (pthread_mutex_lock(&gsm_lock)) {
-               ast_log(LOG_WARNING, "Unable to lock gsm list\n");
-               return;
-       }
-       tmp = glist;
-       while(tmp) {
-               if (tmp == s) {
-                       if (tmpl)
-                               tmpl->next = tmp->next;
-                       else
-                               glist = tmp->next;
-                       break;
-               }
-               tmpl = tmp;
-               tmp = tmp->next;
-       }
-       glistcnt--;
-       if (s->owner) {
-               s->owner->stream = NULL;
-               if (s->owner->streamid > -1)
-                       ast_sched_del(s->owner->sched, s->owner->streamid);
-               s->owner->streamid = -1;
-       }
-       pthread_mutex_unlock(&gsm_lock);
-       ast_update_use_count();
-       if (!tmp) 
-               ast_log(LOG_WARNING, "Freeing a filestream we don't seem to own\n");
-       close(s->fd);
-       free(s);
-}
-
-static int ast_read_callback(void *data)
-{
-       int retval = 0;
        int res;
-       int delay = 20;
-       struct ast_filestream *s = data;
-       struct timeval tv;
-       /* Send a frame from the file to the appropriate channel */
 
        s->fr.frametype = AST_FRAME_VOICE;
        s->fr.subclass = AST_FORMAT_GSM;
-       s->fr.offset = AST_FRIENDLY_OFFSET;
-       s->fr.timelen = 20;
-       s->fr.datalen = 33;
+       AST_FRAME_SET_BUFFER(&(s->fr), s->buf, AST_FRIENDLY_OFFSET, GSM_FRAME_SIZE)
        s->fr.mallocd = 0;
-       s->fr.data = s->gsm;
-       if ((res = read(s->fd, s->gsm, 33)) != 33) {
+       if ((res = fread(s->fr.data, 1, GSM_FRAME_SIZE, s->f)) != GSM_FRAME_SIZE) {
                if (res)
                        ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
-               s->owner->streamid = -1;
-               return 0;
-       }
-       /* Lastly, process the frame */
-       if (ast_write(s->owner, &s->fr)) {
-               ast_log(LOG_WARNING, "Failed to write frame\n");
-               s->owner->streamid = -1;
-               return 0;
+               return NULL;
        }
-       if (s->last.tv_usec || s->last.tv_usec) {
-               int ms;
-               gettimeofday(&tv, NULL);
-               ms = 1000 * (tv.tv_sec - s->last.tv_sec) + 
-                       (tv.tv_usec - s->last.tv_usec) / 1000;
-               s->last.tv_sec = tv.tv_sec;
-               s->last.tv_usec = tv.tv_usec;
-               if ((ms - delay) * (ms - delay) > 4) {
-                       /* Compensate if we're more than 2 ms off */
-                       s->adj -= (ms - delay);
-               }
-#if 0
-               fprintf(stdout, "Delay is %d, adjustment is %d, last was %d\n", delay, s->adj, ms);
-#endif
-               delay += s->adj;
-               if (delay < 1)
-                       delay = 1;
-       } else
-               gettimeofday(&s->last, NULL);
-       if (s->lasttimeout != delay) {
-               /* We'll install the next timeout now. */
-               s->owner->streamid = ast_sched_add(s->owner->sched,
-                               delay, ast_read_callback, s); 
-               s->lasttimeout = delay;
-       } else {
-               /* Just come back again at the same time */
-               retval = -1;
-       }
-       return retval;
-}
-
-static int gsm_apply(struct ast_channel *c, struct ast_filestream *s)
-{
-       /* Select our owner for this stream, and get the ball rolling. */
-       s->owner = c;
-       ast_read_callback(s);
-       return 0;
+       *whennext = s->fr.samples = GSM_SAMPLES;
+       return &s->fr;
 }
 
 static int gsm_write(struct ast_filestream *fs, struct ast_frame *f)
 {
        int res;
+       unsigned char gsm[2*GSM_FRAME_SIZE];
+
        if (f->frametype != AST_FRAME_VOICE) {
                ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
                return -1;
@@ -230,74 +91,91 @@ static int gsm_write(struct ast_filestream *fs, struct ast_frame *f)
                ast_log(LOG_WARNING, "Asked to write non-GSM frame (%d)!\n", f->subclass);
                return -1;
        }
-       if (f->datalen % 33) {
-               ast_log(LOG_WARNING, "Invalid data length, %d, should be multiple of 33\n", f->datalen);
-               return -1;
-       }
-       if ((res = write(fs->fd, f->data, f->datalen)) != f->datalen) {
-                       ast_log(LOG_WARNING, "Bad write (%d/33): %s\n", res, strerror(errno));
+       if (!(f->datalen % 65)) {
+               /* This is in MSGSM format, need to be converted */
+               int len=0;
+               while(len < f->datalen) {
+                       conv65(f->data + len, gsm);
+                       if ((res = fwrite(gsm, 1, 2*GSM_FRAME_SIZE, fs->f)) != 2*GSM_FRAME_SIZE) {
+                               ast_log(LOG_WARNING, "Bad write (%d/66): %s\n", res, strerror(errno));
+                               return -1;
+                       }
+                       len += 65;
+               }
+       } else {
+               if (f->datalen % GSM_FRAME_SIZE) {
+                       ast_log(LOG_WARNING, "Invalid data length, %d, should be multiple of 33\n", f->datalen);
                        return -1;
+               }
+               if ((res = fwrite(f->data, 1, f->datalen, fs->f)) != f->datalen) {
+                               ast_log(LOG_WARNING, "Bad write (%d/33): %s\n", res, strerror(errno));
+                               return -1;
+               }
        }
        return 0;
 }
 
-static char *gsm_getcomment(struct ast_filestream *s)
+static int gsm_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
 {
-       return NULL;
+       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/GSM_SAMPLES) * GSM_FRAME_SIZE;
+       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;
+       /* Always protect against seeking past the begining. */
+       offset = (offset < min)?min:offset;
+       if (whence != SEEK_FORCECUR) {
+               offset = (offset > max)?max:offset;
+       } else if (offset > max) {
+               int i;
+               fseeko(fs->f, 0, SEEK_END);
+               for (i=0; i< (offset - max) / GSM_FRAME_SIZE; i++) {
+                       fwrite(gsm_silence, 1, GSM_FRAME_SIZE, fs->f);
+               }
+       }
+       return fseeko(fs->f, offset, SEEK_SET);
 }
 
-int load_module()
+static int gsm_trunc(struct ast_filestream *fs)
 {
-       return ast_format_register(name, exts, AST_FORMAT_GSM,
-                                                               gsm_open,
-                                                               gsm_rewrite,
-                                                               gsm_apply,
-                                                               gsm_write,
-                                                               gsm_read,
-                                                               gsm_close,
-                                                               gsm_getcomment);
-                                                               
-                                                               
+       return ftruncate(fileno(fs->f), ftello(fs->f));
 }
 
-int unload_module()
+static off_t gsm_tell(struct ast_filestream *fs)
 {
-       struct ast_filestream *tmp, *tmpl;
-       if (pthread_mutex_lock(&gsm_lock)) {
-               ast_log(LOG_WARNING, "Unable to lock gsm list\n");
-               return -1;
-       }
-       tmp = glist;
-       while(tmp) {
-               if (tmp->owner)
-                       ast_softhangup(tmp->owner);
-               tmpl = tmp;
-               tmp = tmp->next;
-               free(tmpl);
-       }
-       pthread_mutex_unlock(&gsm_lock);
-       return ast_format_unregister(name);
-}      
-
-int usecount()
-{
-       int res;
-       if (pthread_mutex_lock(&gsm_lock)) {
-               ast_log(LOG_WARNING, "Unable to lock gsm list\n");
-               return -1;
-       }
-       res = glistcnt;
-       pthread_mutex_unlock(&gsm_lock);
-       return res;
+       off_t offset = ftello(fs->f);
+       return (offset/GSM_FRAME_SIZE)*GSM_SAMPLES;
 }
 
-char *description()
+static const struct ast_format gsm_f = {
+       .name = "gsm",
+       .exts = "gsm",
+       .format = AST_FORMAT_GSM,
+       .write = gsm_write,
+       .seek = gsm_seek,
+       .trunc = gsm_trunc,
+       .tell = gsm_tell,
+       .read = gsm_read,
+       .buf_size = 2*GSM_FRAME_SIZE + AST_FRIENDLY_OFFSET,     /* 2 gsm frames */
+};
+
+static int load_module(void)
 {
-       return desc;
+       return ast_format_register(&gsm_f);
 }
 
-
-char *key()
+static int unload_module(void)
 {
-       return ASTERISK_GPL_KEY;
-}
+       return ast_format_unregister(gsm_f.name);
+}      
+
+AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Raw GSM data");