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