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