Add alw as a valid file extension for alaw and ulw as a valid file extension for...
[asterisk/asterisk.git] / formats / format_pcm.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, 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, ulaw PCM file format.
22  * \arg File name extension: pcm, ulaw, ul, mu
23  * 
24  * \ingroup formats
25  */
26  
27 #include "asterisk.h"
28
29 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
30
31 #include "asterisk/mod_format.h"
32 #include "asterisk/module.h"
33 #include "asterisk/endian.h"
34 #include "asterisk/ulaw.h"
35 #include "asterisk/alaw.h"
36
37 #define BUF_SIZE 160            /* 160 bytes, and same number of samples */
38
39 static char ulaw_silence[BUF_SIZE];
40 static char alaw_silence[BUF_SIZE];
41
42 /* #define REALTIME_WRITE */    /* XXX does it work at all ? */
43
44 #ifdef REALTIME_WRITE
45 struct pcm_desc {
46         unsigned long start_time;
47 };
48
49 /* Returns time in msec since system boot. */
50 static unsigned long get_time(void)
51 {
52         struct tms buf;
53         clock_t cur;
54
55         cur = times( &buf );
56         if( cur < 0 ) {
57                 ast_log( LOG_WARNING, "Cannot get current time\n" );
58                 return 0;
59         }
60         return cur * 1000 / sysconf( _SC_CLK_TCK );
61 }
62
63 static int pcma_open(struct ast_filestream *s)
64 {
65         if (s->fmt->format == AST_FORMAT_ALAW)
66                 pd->starttime = get_time();
67         return 0;
68 }
69
70 static int pcma_rewrite(struct ast_filestream *s, const char *comment)
71 {
72         return pcma_open(s);
73 }
74 #endif
75
76 static struct ast_frame *pcm_read(struct ast_filestream *s, int *whennext)
77 {
78         int res;
79         
80         /* Send a frame from the file to the appropriate channel */
81
82         s->fr.frametype = AST_FRAME_VOICE;
83         s->fr.subclass = s->fmt->format;
84         s->fr.mallocd = 0;
85         AST_FRAME_SET_BUFFER(&s->fr, s->buf, AST_FRIENDLY_OFFSET, BUF_SIZE);
86         if ((res = fread(s->fr.data.ptr, 1, s->fr.datalen, s->f)) < 1) {
87                 if (res)
88                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
89                 return NULL;
90         }
91         s->fr.datalen = res;
92         if (s->fmt->format == AST_FORMAT_G722)
93                 *whennext = s->fr.samples = res * 2;
94         else
95                 *whennext = s->fr.samples = res;
96         return &s->fr;
97 }
98
99 static int pcm_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
100 {
101         off_t cur, max, offset = 0;
102         int ret = -1;   /* assume error */
103
104         cur = ftello(fs->f);
105         fseeko(fs->f, 0, SEEK_END);
106         max = ftello(fs->f);
107
108         switch (whence) {
109         case SEEK_SET:
110                 offset = sample_offset;
111                 break;
112         case SEEK_END:
113                 offset = max - sample_offset;
114                 break;
115         case SEEK_CUR:
116         case SEEK_FORCECUR:
117                 offset = cur + sample_offset;
118                 break;
119         default:
120                 ast_log(LOG_WARNING, "invalid whence %d, assuming SEEK_SET\n", whence);
121                 offset = sample_offset;
122         }
123         if (offset < 0) {
124                 ast_log(LOG_WARNING, "negative offset %ld, resetting to 0\n", (long) offset);
125                 offset = 0;
126         }
127         if (whence == SEEK_FORCECUR && offset > max) { /* extend the file */
128                 size_t left = offset - max;
129                 const char *src = (fs->fmt->format == AST_FORMAT_ALAW) ? alaw_silence : ulaw_silence;
130
131                 while (left) {
132                         size_t written = fwrite(src, 1, (left > BUF_SIZE) ? BUF_SIZE : left, fs->f);
133                         if (written == -1)
134                                 break;  /* error */
135                         left -= written;
136                 }
137                 ret = 0; /* successful */
138         } else {
139                 if (offset > max) {
140                         ast_log(LOG_WARNING, "offset too large %ld, truncating to %ld\n", (long) offset, (long) max);
141                         offset = max;
142                 }
143                 ret = fseeko(fs->f, offset, SEEK_SET);
144         }
145         return ret;
146 }
147
148 static int pcm_trunc(struct ast_filestream *fs)
149 {
150         return ftruncate(fileno(fs->f), ftello(fs->f));
151 }
152
153 static off_t pcm_tell(struct ast_filestream *fs)
154 {
155         return ftello(fs->f);
156 }
157
158 static int pcm_write(struct ast_filestream *fs, struct ast_frame *f)
159 {
160         int res;
161
162         if (f->frametype != AST_FRAME_VOICE) {
163                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
164                 return -1;
165         }
166         if (f->subclass != fs->fmt->format) {
167                 ast_log(LOG_WARNING, "Asked to write incompatible format frame (%d)!\n", f->subclass);
168                 return -1;
169         }
170
171 #ifdef REALTIME_WRITE
172         if (s->fmt->format == AST_FORMAT_ALAW) {
173                 struct pcm_desc *pd = (struct pcm_desc *)fs->_private;
174                 struct stat stat_buf;
175                 unsigned long cur_time = get_time();
176                 unsigned long fpos = ( cur_time - pd->start_time ) * 8; /* 8 bytes per msec */
177                 /* Check if we have written to this position yet. If we have, then increment pos by one frame
178                 *  for some degree of protection against receiving packets in the same clock tick.
179                 */
180                 
181                 fstat(fileno(fs->f), &stat_buf );
182                 if (stat_buf.st_size > fpos )
183                         fpos += f->datalen;     /* Incrementing with the size of this current frame */
184
185                 if (stat_buf.st_size < fpos) {
186                         /* fill the gap with 0x55 rather than 0. */
187                         char buf[1024];
188                         unsigned long cur, to_write;
189
190                         cur = stat_buf.st_size;
191                         if (fseek(fs->f, cur, SEEK_SET) < 0) {
192                                 ast_log( LOG_WARNING, "Cannot seek in file: %s\n", strerror(errno) );
193                                 return -1;
194                         }
195                         memset(buf, 0x55, 512);
196                         while (cur < fpos) {
197                                 to_write = fpos - cur;
198                                 if (to_write > sizeof(buf))
199                                         to_write = sizeof(buf);
200                                 fwrite(buf, 1, to_write, fs->f);
201                                 cur += to_write;
202                         }
203                 }
204
205                 if (fseek(s->f, fpos, SEEK_SET) < 0) {
206                         ast_log( LOG_WARNING, "Cannot seek in file: %s\n", strerror(errno) );
207                         return -1;
208                 }
209         }
210 #endif  /* REALTIME_WRITE */
211         
212         if ((res = fwrite(f->data.ptr, 1, f->datalen, fs->f)) != f->datalen) {
213                 ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
214                 return -1;
215         }
216         return 0;
217 }
218
219 /* SUN .au support routines */
220
221 #define AU_HEADER_SIZE          24
222 #define AU_HEADER(var)          uint32_t var[6]
223
224 #define AU_HDR_MAGIC_OFF        0
225 #define AU_HDR_HDR_SIZE_OFF     1
226 #define AU_HDR_DATA_SIZE_OFF    2
227 #define AU_HDR_ENCODING_OFF     3
228 #define AU_HDR_SAMPLE_RATE_OFF  4
229 #define AU_HDR_CHANNELS_OFF     5
230
231 #define AU_ENC_8BIT_ULAW        1
232
233 #define AU_MAGIC 0x2e736e64
234 #if __BYTE_ORDER == __BIG_ENDIAN
235 #define htoll(b) (b)
236 #define htols(b) (b)
237 #define ltohl(b) (b)
238 #define ltohs(b) (b)
239 #else
240 #if __BYTE_ORDER == __LITTLE_ENDIAN
241 #define htoll(b)  \
242           (((((b)      ) & 0xFF) << 24) | \
243                ((((b) >>  8) & 0xFF) << 16) | \
244                    ((((b) >> 16) & 0xFF) <<  8) | \
245                    ((((b) >> 24) & 0xFF)      ))
246 #define htols(b) \
247           (((((b)      ) & 0xFF) << 8) | \
248                    ((((b) >> 8) & 0xFF)      ))
249 #define ltohl(b) htoll(b)
250 #define ltohs(b) htols(b)
251 #else
252 #error "Endianess not defined"
253 #endif
254 #endif
255
256 static int check_header(FILE *f)
257 {
258         AU_HEADER(header);
259         uint32_t magic;
260         uint32_t hdr_size;
261         uint32_t data_size;
262         uint32_t encoding;
263         uint32_t sample_rate;
264         uint32_t channels;
265
266         if (fread(header, 1, AU_HEADER_SIZE, f) != AU_HEADER_SIZE) {
267                 ast_log(LOG_WARNING, "Read failed (header)\n");
268                 return -1;
269         }
270         magic = ltohl(header[AU_HDR_MAGIC_OFF]);
271         if (magic != (uint32_t) AU_MAGIC) {
272                 ast_log(LOG_WARNING, "Bad magic: 0x%x\n", magic);
273         }
274         hdr_size = ltohl(header[AU_HDR_HDR_SIZE_OFF]);
275         if (hdr_size < AU_HEADER_SIZE) {
276                 hdr_size = AU_HEADER_SIZE;
277         }
278 /*      data_size = ltohl(header[AU_HDR_DATA_SIZE_OFF]); */
279         encoding = ltohl(header[AU_HDR_ENCODING_OFF]);
280         if (encoding != AU_ENC_8BIT_ULAW) {
281                 ast_log(LOG_WARNING, "Unexpected format: %d. Only 8bit ULAW allowed (%d)\n", encoding, AU_ENC_8BIT_ULAW);
282                 return -1;
283         }
284         sample_rate = ltohl(header[AU_HDR_SAMPLE_RATE_OFF]);
285         if (sample_rate != DEFAULT_SAMPLE_RATE) {
286                 ast_log(LOG_WARNING, "Sample rate can only be 8000 not %d\n", sample_rate);
287                 return -1;
288         }
289         channels = ltohl(header[AU_HDR_CHANNELS_OFF]);
290         if (channels != 1) {
291                 ast_log(LOG_WARNING, "Not in mono: channels=%d\n", channels);
292                 return -1;
293         }
294         /* Skip to data */
295         fseek(f, 0, SEEK_END);
296         data_size = ftell(f) - hdr_size;
297         if (fseek(f, hdr_size, SEEK_SET) == -1 ) {
298                 ast_log(LOG_WARNING, "Failed to skip to data: %d\n", hdr_size);
299                 return -1;
300         }
301         return data_size;
302 }
303
304 static int update_header(FILE *f)
305 {
306         off_t cur, end;
307         uint32_t datalen;
308         int bytes;
309
310         cur = ftell(f);
311         fseek(f, 0, SEEK_END);
312         end = ftell(f);
313         /* data starts 24 bytes in */
314         bytes = end - AU_HEADER_SIZE;
315         datalen = htoll(bytes);
316
317         if (cur < 0) {
318                 ast_log(LOG_WARNING, "Unable to find our position\n");
319                 return -1;
320         }
321         if (fseek(f, AU_HDR_DATA_SIZE_OFF * sizeof(uint32_t), SEEK_SET)) {
322                 ast_log(LOG_WARNING, "Unable to set our position\n");
323                 return -1;
324         }
325         if (fwrite(&datalen, 1, sizeof(datalen), f) != sizeof(datalen)) {
326                 ast_log(LOG_WARNING, "Unable to set write file size\n");
327                 return -1;
328         }
329         if (fseek(f, cur, SEEK_SET)) {
330                 ast_log(LOG_WARNING, "Unable to return to position\n");
331                 return -1;
332         }
333         return 0;
334 }
335
336 static int write_header(FILE *f)
337 {
338         AU_HEADER(header);
339
340         header[AU_HDR_MAGIC_OFF] = htoll((uint32_t) AU_MAGIC);
341         header[AU_HDR_HDR_SIZE_OFF] = htoll(AU_HEADER_SIZE);
342         header[AU_HDR_DATA_SIZE_OFF] = 0;
343         header[AU_HDR_ENCODING_OFF] = htoll(AU_ENC_8BIT_ULAW);
344         header[AU_HDR_SAMPLE_RATE_OFF] = htoll(DEFAULT_SAMPLE_RATE);
345         header[AU_HDR_CHANNELS_OFF] = htoll(1);
346
347         /* Write an au header, ignoring sizes which will be filled in later */
348         fseek(f, 0, SEEK_SET);
349         if (fwrite(header, 1, AU_HEADER_SIZE, f) != AU_HEADER_SIZE) {
350                 ast_log(LOG_WARNING, "Unable to write header\n");
351                 return -1;
352         }
353         return 0;
354 }
355
356 static int au_open(struct ast_filestream *s)
357 {
358         if (check_header(s->f) < 0)
359                 return -1;
360         return 0;
361 }
362
363 static int au_rewrite(struct ast_filestream *s, const char *comment)
364 {
365         if (write_header(s->f))
366                 return -1;
367         return 0;
368 }
369
370 /* XXX check this, probably incorrect */
371 static int au_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
372 {
373         off_t min, max, cur;
374         long offset = 0, bytes;
375
376         if (fs->fmt->format == AST_FORMAT_G722)
377                 bytes = sample_offset / 2;
378         else
379                 bytes = sample_offset;
380
381         min = AU_HEADER_SIZE;
382         cur = ftello(fs->f);
383         fseek(fs->f, 0, SEEK_END);
384         max = ftello(fs->f);
385
386         if (whence == SEEK_SET)
387                 offset = bytes + min;
388         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
389                 offset = bytes + cur;
390         else if (whence == SEEK_END)
391                 offset = max - bytes;
392
393         if (whence != SEEK_FORCECUR) {
394                 offset = (offset > max) ? max : offset;
395         }
396
397         /* always protect the header space. */
398         offset = (offset < min) ? min : offset;
399
400         return fseeko(fs->f, offset, SEEK_SET);
401 }
402
403 static int au_trunc(struct ast_filestream *fs)
404 {
405         if (ftruncate(fileno(fs->f), ftell(fs->f)))
406                 return -1;
407         return update_header(fs->f);
408 }
409
410 static off_t au_tell(struct ast_filestream *fs)
411 {
412         off_t offset = ftello(fs->f);
413         return offset - AU_HEADER_SIZE;
414 }
415
416 static const struct ast_format alaw_f = {
417         .name = "alaw",
418         .exts = "alaw|al|alw",
419         .format = AST_FORMAT_ALAW,
420         .write = pcm_write,
421         .seek = pcm_seek,
422         .trunc = pcm_trunc,
423         .tell = pcm_tell,
424         .read = pcm_read,
425         .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
426 #ifdef REALTIME_WRITE
427         .open = pcma_open,
428         .rewrite = pcma_rewrite,
429         .desc_size = sizeof(struct pcm_desc),
430 #endif
431 };
432
433 static const struct ast_format pcm_f = {
434         .name = "pcm",
435         .exts = "pcm|ulaw|ul|mu|ulw",
436         .format = AST_FORMAT_ULAW,
437         .write = pcm_write,
438         .seek = pcm_seek,
439         .trunc = pcm_trunc,
440         .tell = pcm_tell,
441         .read = pcm_read,
442         .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,
443 };
444
445 static const struct ast_format g722_f = {
446         .name = "g722",
447         .exts = "g722",
448         .format = AST_FORMAT_G722,
449         .write = pcm_write,
450         .seek = pcm_seek,
451         .trunc = pcm_trunc,
452         .tell = pcm_tell,
453         .read = pcm_read,
454         .buf_size = (BUF_SIZE * 2) + AST_FRIENDLY_OFFSET,
455 };
456
457 static const struct ast_format au_f = {
458         .name = "au",
459         .exts = "au",
460         .format = AST_FORMAT_ULAW,
461         .open = au_open,
462         .rewrite = au_rewrite,
463         .write = pcm_write,
464         .seek = au_seek,
465         .trunc = au_trunc,
466         .tell = au_tell,
467         .read = pcm_read,
468         .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,     /* this many shorts */
469 };
470
471 static int load_module(void)
472 {
473         int i;
474
475         /* XXX better init ? */
476         for (i = 0; i < ARRAY_LEN(ulaw_silence); i++)
477                 ulaw_silence[i] = AST_LIN2MU(0);
478         for (i = 0; i < ARRAY_LEN(alaw_silence); i++)
479                 alaw_silence[i] = AST_LIN2A(0);
480
481         if ( ast_format_register(&pcm_f)
482                 || ast_format_register(&alaw_f)
483                 || ast_format_register(&au_f)
484                 || ast_format_register(&g722_f) )
485                 return AST_MODULE_LOAD_FAILURE;
486         return AST_MODULE_LOAD_SUCCESS;
487 }
488
489 static int unload_module(void)
490 {
491         return ast_format_unregister(pcm_f.name)
492                 || ast_format_unregister(alaw_f.name)
493                 || ast_format_unregister(au_f.name)
494                 || ast_format_unregister(g722_f.name);
495 }       
496
497 AST_MODULE_INFO_STANDARD(ASTERISK_GPL_KEY, "Raw/Sun uLaw/ALaw 8KHz (PCM,PCMA,AU), G.722 16Khz");