issue #5605
[asterisk/asterisk.git] / formats / format_pcm_alaw.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Flat, binary, alaw PCM file format.
22  * \arg File name extensions: alaw, al
23  * \ingroup formats
24  */
25  
26 #include <unistd.h>
27 #include <netinet/in.h>
28 #include <arpa/inet.h>
29 #include <stdlib.h>
30 #include <sys/time.h>
31 #include <sys/times.h>
32 #include <sys/types.h>
33 #include <stdio.h>
34 #include <errno.h>
35 #include <string.h>
36
37 #include "asterisk.h"
38
39 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
40
41 #include "asterisk/lock.h"
42 #include "asterisk/channel.h"
43 #include "asterisk/file.h"
44 #include "asterisk/logger.h"
45 #include "asterisk/sched.h"
46 #include "asterisk/module.h"
47 #include "asterisk/endian.h"
48
49 #define BUF_SIZE 160            /* 160 samples */
50
51 /* #define REALTIME_WRITE */
52
53 struct ast_filestream {
54         void *reserved[AST_RESERVED_POINTERS];
55         /* Believe it or not, we must decode/recode to account for the
56            weird MS format */
57         /* This is what a filestream means to us */
58         FILE *f; /* Descriptor */
59         struct ast_frame fr;                            /* Frame information */
60         char waste[AST_FRIENDLY_OFFSET];        /* Buffer for sending frames, etc */
61         char empty;                                                     /* Empty character */
62         unsigned char buf[BUF_SIZE];                            /* Output Buffer */
63 #ifdef REALTIME_WRITE
64         unsigned long start_time;
65 #endif
66 };
67
68
69 AST_MUTEX_DEFINE_STATIC(pcm_lock);
70 static int glistcnt = 0;
71
72 static char *name = "alaw";
73 static char *desc = "Raw aLaw 8khz PCM Audio support";
74 static char *exts = "alaw|al";
75
76
77 #if 0
78 /* Returns time in msec since system boot. */
79 static unsigned long get_time(void)
80 {
81         struct tms buf;
82         clock_t cur;
83
84         cur = times( &buf );
85         if( cur < 0 )
86         {
87                 ast_log( LOG_WARNING, "Cannot get current time\n" );
88                 return 0;
89         }
90         return cur * 1000 / sysconf( _SC_CLK_TCK );
91 }
92 #endif
93
94 static struct ast_filestream *pcm_open(FILE *f)
95 {
96         /* We don't have any header to read or anything really, but
97            if we did, it would go here.  We also might want to check
98            and be sure it's a valid file.  */
99         struct ast_filestream *tmp;
100         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
101                 memset(tmp, 0, sizeof(struct ast_filestream));
102                 if (ast_mutex_lock(&pcm_lock)) {
103                         ast_log(LOG_WARNING, "Unable to lock pcm list\n");
104                         free(tmp);
105                         return NULL;
106                 }
107                 tmp->f = f;
108                 tmp->fr.data = tmp->buf;
109                 tmp->fr.frametype = AST_FRAME_VOICE;
110                 tmp->fr.subclass = AST_FORMAT_ALAW;
111                 /* datalen will vary for each frame */
112                 tmp->fr.src = name;
113                 tmp->fr.mallocd = 0;
114 #ifdef REALTIME_WRITE
115                 tmp->start_time = get_time();
116 #endif
117                 glistcnt++;
118                 ast_mutex_unlock(&pcm_lock);
119                 ast_update_use_count();
120         }
121         return tmp;
122 }
123
124 static struct ast_filestream *pcm_rewrite(FILE *f, const char *comment)
125 {
126         /* We don't have any header to read or anything really, but
127            if we did, it would go here.  We also might want to check
128            and be sure it's a valid file.  */
129         struct ast_filestream *tmp;
130         if ((tmp = malloc(sizeof(struct ast_filestream)))) {
131                 memset(tmp, 0, sizeof(struct ast_filestream));
132                 if (ast_mutex_lock(&pcm_lock)) {
133                         ast_log(LOG_WARNING, "Unable to lock pcm list\n");
134                         free(tmp);
135                         return NULL;
136                 }
137                 tmp->f = f;
138 #ifdef REALTIME_WRITE
139                 tmp->start_time = get_time();
140 #endif
141                 glistcnt++;
142                 ast_mutex_unlock(&pcm_lock);
143                 ast_update_use_count();
144         } else
145                 ast_log(LOG_WARNING, "Out of memory\n");
146         return tmp;
147 }
148
149 static void pcm_close(struct ast_filestream *s)
150 {
151         if (ast_mutex_lock(&pcm_lock)) {
152                 ast_log(LOG_WARNING, "Unable to lock pcm list\n");
153                 return;
154         }
155         glistcnt--;
156         ast_mutex_unlock(&pcm_lock);
157         ast_update_use_count();
158         fclose(s->f);
159         free(s);
160         s = NULL;
161 }
162
163 static struct ast_frame *pcm_read(struct ast_filestream *s, int *whennext)
164 {
165         int res;
166         /* Send a frame from the file to the appropriate channel */
167
168         s->fr.frametype = AST_FRAME_VOICE;
169         s->fr.subclass = AST_FORMAT_ALAW;
170         s->fr.offset = AST_FRIENDLY_OFFSET;
171         s->fr.mallocd = 0;
172         s->fr.data = s->buf;
173         if ((res = fread(s->buf, 1, BUF_SIZE, s->f)) < 1) {
174                 if (res)
175                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
176                 return NULL;
177         }
178         s->fr.samples = res;
179         s->fr.datalen = res;
180         *whennext = s->fr.samples;
181         return &s->fr;
182 }
183
184 static int pcm_write(struct ast_filestream *fs, struct ast_frame *f)
185 {
186         int res;
187 #ifdef REALTIME_WRITE
188         unsigned long cur_time;
189         unsigned long fpos;
190         struct stat stat_buf;
191 #endif
192
193         if (f->frametype != AST_FRAME_VOICE) {
194                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
195                 return -1;
196         }
197         if (f->subclass != AST_FORMAT_ALAW) {
198                 ast_log(LOG_WARNING, "Asked to write non-alaw frame (%d)!\n", f->subclass);
199                 return -1;
200         }
201
202 #ifdef REALTIME_WRITE
203         cur_time = get_time();
204         fpos = ( cur_time - fs->start_time ) * 8;       /* 8 bytes per msec */
205         /* Check if we have written to this position yet. If we have, then increment pos by one frame
206         *  for some degree of protection against receiving packets in the same clock tick.
207         */
208         
209         fstat(fileno(fs->f), &stat_buf );
210         if (stat_buf.st_size > fpos ) {
211                 fpos += f->datalen;     /* Incrementing with the size of this current frame */
212         }
213
214         if (stat_buf.st_size < fpos) {
215                 /* fill the gap with 0x55 rather than 0. */
216                 char buf[ 512 ];
217                 unsigned long cur, to_write;
218
219                 cur = stat_buf.st_size;
220                 if (fseek(fs->f, cur, SEEK_SET) < 0) {
221                         ast_log( LOG_WARNING, "Cannot seek in file: %s\n", strerror(errno) );
222                         return -1;
223                 }
224                 memset(buf, 0x55, 512);
225                 while (cur < fpos) {
226                         to_write = fpos - cur;
227                         if (to_write > 512) {
228                                 to_write = 512;
229                         }
230                         fwrite(buf, 1, to_write, fs->f);
231                         cur += to_write;
232                 }
233         }
234
235
236         if (fseek(s->f, fpos, SEEK_SET) < 0) {
237                 ast_log( LOG_WARNING, "Cannot seek in file: %s\n", strerror(errno) );
238                 return -1;
239         }
240 #endif  /* REALTIME_WRITE */
241         
242         if ((res = fwrite(f->data, 1, f->datalen, fs->f)) != f->datalen) {
243                         ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
244                         return -1;
245         }
246         return 0;
247 }
248
249 static int pcm_seek(struct ast_filestream *fs, long sample_offset, int whence)
250 {
251         off_t offset=0,min,cur,max;
252
253         min = 0;
254         cur = ftell(fs->f);
255         fseek(fs->f, 0, SEEK_END);
256         max = ftell(fs->f);
257         if (whence == SEEK_SET)
258                 offset = sample_offset;
259         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
260                 offset = sample_offset + cur;
261         else if (whence == SEEK_END)
262                 offset = max - sample_offset;
263         if (whence != SEEK_FORCECUR) {
264                 offset = (offset > max)?max:offset;
265         }
266         /* Always protect against seeking past begining */
267         offset = (offset < min)?min:offset;
268         return fseek(fs->f, offset, SEEK_SET);
269 }
270
271 static int pcm_trunc(struct ast_filestream *fs)
272 {
273         return ftruncate(fileno(fs->f), ftell(fs->f));
274 }
275
276 static long pcm_tell(struct ast_filestream *fs)
277 {
278         off_t offset;
279         offset = ftell(fs->f);
280         return offset;
281 }
282
283
284 static char *pcm_getcomment(struct ast_filestream *s)
285 {
286         return NULL;
287 }
288
289 int load_module()
290 {
291         return ast_format_register(name, exts, AST_FORMAT_ALAW,
292                                                                 pcm_open,
293                                                                 pcm_rewrite,
294                                                                 pcm_write,
295                                                                 pcm_seek,
296                                                                 pcm_trunc,
297                                                                 pcm_tell,
298                                                                 pcm_read,
299                                                                 pcm_close,
300                                                                 pcm_getcomment);
301 }
302
303 int unload_module()
304 {
305         return ast_format_unregister(name);
306 }       
307
308 int usecount()
309 {
310         return glistcnt;
311 }
312
313 char *description()
314 {
315         return desc;
316 }
317
318
319 char *key()
320 {
321         return ASTERISK_GPL_KEY;
322 }