more doxygenification (issue #5513)
[asterisk/asterisk.git] / formats / format_g723.c
index e93ed04..e046b6b 100755 (executable)
@@ -1,29 +1,47 @@
 /*
- * Asterisk -- A telephony toolkit for Linux.
+ * Asterisk -- An open source telephony toolkit.
  *
- * Old-style G.723 frame/timestamp format.
- * 
- * Copyright (C) 1999, Mark Spencer
+ * Copyright (C) 1999 - 2005, Digium, Inc.
+ *
+ * Mark Spencer <markster@digium.com>
  *
- * Mark Spencer <markster@linux-support.net>
+ * 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 Old-style G.723 frame/timestamp format.
+ * 
  */
  
-#include <asterisk/channel.h>
-#include <asterisk/file.h>
-#include <asterisk/logger.h>
-#include <asterisk/sched.h>
-#include <asterisk/module.h>
+#include <unistd.h>
+#include <netinet/in.h>
 #include <arpa/inet.h>
 #include <stdlib.h>
 #include <stdio.h>
-#include <unistd.h>
 #include <errno.h>
 #include <string.h>
-#include <pthread.h>
 #include <sys/time.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/module.h"
+
 #include "../channels/adtranvofr.h"
 
 
@@ -33,9 +51,7 @@ struct ast_filestream {
        /* First entry MUST be reserved for the channel type */
        void *reserved[AST_RESERVED_POINTERS];
        /* This is what a filestream means to us */
-       int fd; /* Descriptor */
-       u_int32_t lasttimeout;  /* Last amount of timeout */
-       struct ast_channel *owner;
+       FILE *f; /* Descriptor */
        struct ast_filestream *next;
        struct ast_frame *fr;   /* Frame representation of buf */
        struct timeval orig;    /* Original frame time */
@@ -43,30 +59,27 @@ struct ast_filestream {
 };
 
 
-static struct ast_filestream *glist = NULL;
-static pthread_mutex_t g723_lock = PTHREAD_MUTEX_INITIALIZER;
+AST_MUTEX_DEFINE_STATIC(g723_lock);
 static int glistcnt = 0;
 
 static char *name = "g723sf";
 static char *desc = "G.723.1 Simple Timestamp File Format";
-static char *exts = "g723";
+static char *exts = "g723|g723sf";
 
-static struct ast_filestream *g723_open(int fd)
+static struct ast_filestream *g723_open(FILE *f)
 {
        /* 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)))) {
-               if (ast_pthread_mutex_lock(&g723_lock)) {
+               memset(tmp, 0, sizeof(struct ast_filestream));
+               if (ast_mutex_lock(&g723_lock)) {
                        ast_log(LOG_WARNING, "Unable to lock g723 list\n");
                        free(tmp);
                        return NULL;
                }
-               tmp->next = glist;
-               glist = tmp;
-               tmp->fd = fd;
-               tmp->owner = NULL;
+               tmp->f = f;
                tmp->fr = (struct ast_frame *)tmp->buf;
                tmp->fr->data = tmp->buf + sizeof(struct ast_frame);
                tmp->fr->frametype = AST_FRAME_VOICE;
@@ -74,123 +87,67 @@ static struct ast_filestream *g723_open(int fd)
                /* datalen will vary for each frame */
                tmp->fr->src = name;
                tmp->fr->mallocd = 0;
-               tmp->lasttimeout = -1;
-               tmp->orig.tv_usec = 0;
-               tmp->orig.tv_sec = 0;
                glistcnt++;
-               ast_pthread_mutex_unlock(&g723_lock);
+               ast_mutex_unlock(&g723_lock);
                ast_update_use_count();
        }
        return tmp;
 }
 
-static struct ast_filestream *g723_rewrite(int fd, char *comment)
+static struct ast_filestream *g723_rewrite(FILE *f, 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)))) {
-               if (ast_pthread_mutex_lock(&g723_lock)) {
+               memset(tmp, 0, sizeof(struct ast_filestream));
+               if (ast_mutex_lock(&g723_lock)) {
                        ast_log(LOG_WARNING, "Unable to lock g723 list\n");
                        free(tmp);
                        return NULL;
                }
-               tmp->next = glist;
-               glist = tmp;
-               tmp->fd = fd;
-               tmp->owner = NULL;
-               tmp->fr = NULL;
-               tmp->lasttimeout = -1;
-               tmp->orig.tv_usec = 0;
-               tmp->orig.tv_sec = 0;
+               tmp->f = f;
                glistcnt++;
-               ast_pthread_mutex_unlock(&g723_lock);
+               ast_mutex_unlock(&g723_lock);
                ast_update_use_count();
        } else
                ast_log(LOG_WARNING, "Out of memory\n");
        return tmp;
 }
 
-static struct ast_frame *g723_read(struct ast_filestream *s)
-{
-       return NULL;
-}
-
-static void g723_close(struct ast_filestream *s)
+static struct ast_frame *g723_read(struct ast_filestream *s, int *whennext)
 {
-       struct ast_filestream *tmp, *tmpl = NULL;
-       if (ast_pthread_mutex_lock(&g723_lock)) {
-               ast_log(LOG_WARNING, "Unable to lock g723 list\n");
-               return;
+       unsigned short size;
+       int res;
+       int delay;
+       /* Read the delay for the next packet, and schedule again if necessary */
+       if (fread(&delay, 1, 4, s->f) == 4) 
+               delay = ntohl(delay);
+       else
+               delay = -1;
+       if (fread(&size, 1, 2, s->f) != 2) {
+               /* Out of data, or the file is no longer valid.  In any case
+                  go ahead and stop the stream */
+               return NULL;
        }
-       tmp = glist;
-       while(tmp) {
-               if (tmp == s) {
-                       if (tmpl)
-                               tmpl->next = tmp->next;
-                       else
-                               glist = tmp->next;
-                       break;
-               }
-               tmpl = tmp;
-               tmp = tmp->next;
+       /* Looks like we have a frame to read from here */
+       size = ntohs(size);
+       if (size > G723_MAX_SIZE - sizeof(struct ast_frame)) {
+               ast_log(LOG_WARNING, "Size %d is invalid\n", size);
+               /* The file is apparently no longer any good, as we
+                  shouldn't ever get frames even close to this 
+                  size.  */
+               return NULL;
        }
-       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;
+       /* Read the data into the buffer */
+       s->fr->offset = AST_FRIENDLY_OFFSET;
+       s->fr->datalen = size;
+       s->fr->data = s->buf + sizeof(struct ast_frame) + AST_FRIENDLY_OFFSET;
+       if ((res = fread(s->fr->data, 1, size, s->f)) != size) {
+               ast_log(LOG_WARNING, "Short read (%d of %d bytes) (%s)!\n", res, size, strerror(errno));
+               return NULL;
        }
-       ast_pthread_mutex_unlock(&g723_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)
-{
-       u_int16_t size;
-       u_int32_t delay = -1;
-       int looper = 1;
-       int retval = 0;
-       int res;
-       struct ast_filestream *s = data;
-       /* Send a frame from the file to the appropriate channel */
-       while(looper) {
-               if (read(s->fd, &size, 2) != 2) {
-                       /* Out of data, or the file is no longer valid.  In any case
-                          go ahead and stop the stream */
-                       s->owner->streamid = -1;
-                       return 0;
-               }
-               /* Looks like we have a frame to read from here */
-               size = ntohs(size);
-               if (size > G723_MAX_SIZE - sizeof(struct ast_frame)) {
-                       ast_log(LOG_WARNING, "Size %d is invalid\n", size);
-                       /* The file is apparently no longer any good, as we
-                          shouldn't ever get frames even close to this 
-                          size.  */
-                       s->owner->streamid = -1;
-                       return 0;
-               }
-               /* Read the data into the buffer */
-               s->fr->offset = AST_FRIENDLY_OFFSET;
-               s->fr->datalen = size;
-               s->fr->data = s->buf + sizeof(struct ast_frame) + AST_FRIENDLY_OFFSET;
-               if ((res = read(s->fd, s->fr->data , size)) != size) {
-                       ast_log(LOG_WARNING, "Short read (%d of %d bytes) (%s)!\n", res, size, strerror(errno));
-                       s->owner->streamid = -1;
-                       return 0;
-               }
-               /* Read the delay for the next packet, and schedule again if necessary */
-               if (read(s->fd, &delay, 4) == 4) 
-                       delay = ntohl(delay);
-               else
-                       delay = -1;
 #if 0
                /* Average out frames <= 50 ms */
                if (delay < 50)
@@ -198,51 +155,29 @@ static int ast_read_callback(void *data)
                else
                        s->fr->timelen = delay;
 #else
-               s->fr->timelen = 30;
+               s->fr->samples = 240;
 #endif
-               /* Unless there is no delay, we're going to exit out as soon as we
-                  have processed the current frame. */
-               if (delay > VOFR_FUDGE) {
-                       looper = 0;
-                       /* If there is a delay, lets schedule the next event */
-                       if (delay != s->lasttimeout) {
-                               /* We'll install the next timeout now. */
-                               s->owner->streamid = ast_sched_add(s->owner->sched, 
-                                                                                                         delay - VOFR_FUDGE, 
-                                                                                                         ast_read_callback, s);
-                               
-                               s->lasttimeout = delay;
-                       } else
-                               /* Just come back again at the same time */
-                               retval = -1;
-               }
-               /* 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 retval;
+       *whennext = s->fr->samples;
+       return s->fr;
 }
 
-static int g723_apply(struct ast_channel *c, struct ast_filestream *s)
+static void g723_close(struct ast_filestream *s)
 {
-       u_int32_t delay;
-       /* Select our owner for this stream, and get the ball rolling. */
-       s->owner = c;
-       /* Read and ignore the first delay */
-       if (read(s->fd, &delay, 4) != 4) {
-               /* Empty file */
-               return 0;
+       if (ast_mutex_lock(&g723_lock)) {
+               ast_log(LOG_WARNING, "Unable to lock g723 list\n");
+               return;
        }
-       ast_read_callback(s);
-       return 0;
+       glistcnt--;
+       ast_mutex_unlock(&g723_lock);
+       ast_update_use_count();
+       fclose(s->f);
+       free(s);
+       s = NULL;
 }
 
+
 static int g723_write(struct ast_filestream *fs, struct ast_frame *f)
 {
-       struct timeval now;
        u_int32_t delay;
        u_int16_t size;
        int res;
@@ -258,43 +193,45 @@ static int g723_write(struct ast_filestream *fs, struct ast_frame *f)
                ast_log(LOG_WARNING, "Asked to write non-g723 frame!\n");
                return -1;
        }
-       if (!(fs->orig.tv_usec || fs->orig.tv_sec)) {
-               /* First frame should have zeros for delay */
-               delay = 0;
-               if (gettimeofday(&fs->orig, NULL)) {
-                       ast_log(LOG_WARNING, "gettimeofday() failed??  What is this?  Y2k?\n");
-                       return -1;
-               }
-       } else {
-               if (gettimeofday(&now, NULL)) {
-                       ast_log(LOG_WARNING, "gettimeofday() failed??  What is this?  Y2k?\n");
-                       return -1;
-               }
-               delay = (now.tv_sec - fs->orig.tv_sec) * 1000 + (now.tv_usec - fs->orig.tv_usec) / 1000;
-               delay = htonl(delay);
-               fs->orig.tv_sec = now.tv_sec;
-               fs->orig.tv_usec = now.tv_usec;
-       }
+       delay = 0;
        if (f->datalen <= 0) {
                ast_log(LOG_WARNING, "Short frame ignored (%d bytes long?)\n", f->datalen);
                return 0;
        }
-       if ((res = write(fs->fd, &delay, 4)) != 4) {
+       if ((res = fwrite(&delay, 1, 4, fs->f)) != 4) {
                ast_log(LOG_WARNING, "Unable to write delay: res=%d (%s)\n", res, strerror(errno));
                return -1;
        }
        size = htons(f->datalen);
-       if ((res =write(fs->fd, &size, 2)) != 2) {
+       if ((res = fwrite(&size, 1, 2, fs->f)) != 2) {
                ast_log(LOG_WARNING, "Unable to write size: res=%d (%s)\n", res, strerror(errno));
                return -1;
        }
-       if ((res = write(fs->fd, f->data, f->datalen)) != f->datalen) {
+       if ((res = fwrite(f->data, 1, f->datalen, fs->f)) != f->datalen) {
                ast_log(LOG_WARNING, "Unable to write frame: res=%d (%s)\n", res, strerror(errno));
                return -1;
        }       
        return 0;
 }
 
+static int g723_seek(struct ast_filestream *fs, long sample_offset, int whence)
+{
+       return -1;
+}
+
+static int g723_trunc(struct ast_filestream *fs)
+{
+       /* Truncate file to current length */
+       if (ftruncate(fileno(fs->f), ftell(fs->f)) < 0)
+               return -1;
+       return 0;
+}
+
+static long g723_tell(struct ast_filestream *fs)
+{
+       return -1;
+}
+
 static char *g723_getcomment(struct ast_filestream *s)
 {
        return NULL;
@@ -305,8 +242,10 @@ int load_module()
        return ast_format_register(name, exts, AST_FORMAT_G723_1,
                                                                g723_open,
                                                                g723_rewrite,
-                                                               g723_apply,
                                                                g723_write,
+                                                               g723_seek,
+                                                               g723_trunc,
+                                                               g723_tell,
                                                                g723_read,
                                                                g723_close,
                                                                g723_getcomment);
@@ -316,33 +255,12 @@ int load_module()
 
 int unload_module()
 {
-       struct ast_filestream *tmp, *tmpl;
-       if (ast_pthread_mutex_lock(&g723_lock)) {
-               ast_log(LOG_WARNING, "Unable to lock g723 list\n");
-               return -1;
-       }
-       tmp = glist;
-       while(tmp) {
-               if (tmp->owner)
-                       ast_softhangup(tmp->owner);
-               tmpl = tmp;
-               tmp = tmp->next;
-               free(tmpl);
-       }
-       ast_pthread_mutex_unlock(&g723_lock);
        return ast_format_unregister(name);
 }      
 
 int usecount()
 {
-       int res;
-       if (ast_pthread_mutex_lock(&g723_lock)) {
-               ast_log(LOG_WARNING, "Unable to lock g723 list\n");
-               return -1;
-       }
-       res = glistcnt;
-       ast_pthread_mutex_unlock(&g723_lock);
-       return res;
+       return glistcnt;
 }
 
 char *description()