pbx.c: Additional fixes to ast_context_remove_extension_callerid2.
[asterisk/asterisk.git] / formats / format_wav_gsm.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 Save GSM in the proprietary Microsoft format.
22  * 
23  * Microsoft WAV format (Proprietary GSM)
24  * \arg File name extension: WAV,wav49  (Upper case WAV, lower case is another format)
25  * This format can be played on Windows systems, used for
26  * e-mail attachments mainly.
27  * \ingroup formats
28  */
29
30 /*** MODULEINFO
31         <support_level>core</support_level>
32  ***/
33  
34 #include "asterisk.h"
35
36 ASTERISK_REGISTER_FILE()
37
38 #include "asterisk/mod_format.h"
39 #include "asterisk/module.h"
40 #include "asterisk/endian.h"
41 #include "asterisk/format_cache.h"
42
43 #include "msgsm.h"
44
45 /* Some Ideas for this code came from makewave.c by Jeffrey Chilton */
46
47 /* Portions of the conversion code are by guido@sienanet.it */
48
49 #define GSM_FRAME_SIZE  33
50 #define MSGSM_FRAME_SIZE        65
51 #define MSGSM_DATA_OFFSET               60      /* offset of data bytes */
52 #define GSM_SAMPLES             160     /* samples in a GSM block */
53 #define MSGSM_SAMPLES           (2*GSM_SAMPLES) /* samples in an MSGSM block */
54
55 /* begin binary data: */
56 static char msgsm_silence[] = /* 65 */
57 {0x48,0x17,0xD6,0x84,0x02,0x80,0x24,0x49,0x92,0x24,0x89,0x02,0x80,0x24,0x49
58 ,0x92,0x24,0x89,0x02,0x80,0x24,0x49,0x92,0x24,0x89,0x02,0x80,0x24,0x49,0x92
59 ,0x24,0x09,0x82,0x74,0x61,0x4D,0x28,0x00,0x48,0x92,0x24,0x49,0x92,0x28,0x00
60 ,0x48,0x92,0x24,0x49,0x92,0x28,0x00,0x48,0x92,0x24,0x49,0x92,0x28,0x00,0x48
61 ,0x92,0x24,0x49,0x92,0x00};
62 /* end binary data. size = 65 bytes */
63
64 struct wavg_desc {
65         /* Believe it or not, we must decode/recode to account for the
66            weird MS format */
67         int secondhalf;                                         /* Are we on the second half */
68 };
69
70 #if __BYTE_ORDER == __LITTLE_ENDIAN
71 #define htoll(b) (b)
72 #define htols(b) (b)
73 #define ltohl(b) (b)
74 #define ltohs(b) (b)
75 #else
76 #if __BYTE_ORDER == __BIG_ENDIAN
77 #define htoll(b) \
78         (((((b)      ) & 0xFF) << 24) | \
79         ((( (b) >>  8) & 0xFF) << 16) | \
80         ((( (b) >> 16) & 0xFF) <<  8) | \
81         ((( (b) >> 24) & 0xFF)      ))
82 #define htols(b) \
83         (((((b)      ) & 0xFF) <<  8) | \
84         ((( (b) >>  8) & 0xFF)      ))
85 #define ltohl(b) htoll(b)
86 #define ltohs(b) htols(b)
87 #else
88 #error "Endianess not defined"
89 #endif
90 #endif
91
92
93 static int check_header(FILE *f)
94 {
95         int type, size, formtype;
96         int fmt, hsize, fact;
97         short format, chans;
98         int freq;
99         int data;
100         if (fread(&type, 1, 4, f) != 4) {
101                 ast_log(LOG_WARNING, "Read failed (type)\n");
102                 return -1;
103         }
104         if (fread(&size, 1, 4, f) != 4) {
105                 ast_log(LOG_WARNING, "Read failed (size)\n");
106                 return -1;
107         }
108 #if __BYTE_ORDER == __BIG_ENDIAN
109         size = ltohl(size);
110 #endif
111         if (fread(&formtype, 1, 4, f) != 4) {
112                 ast_log(LOG_WARNING, "Read failed (formtype)\n");
113                 return -1;
114         }
115         if (memcmp(&type, "RIFF", 4)) {
116                 ast_log(LOG_WARNING, "Does not begin with RIFF\n");
117                 return -1;
118         }
119         if (memcmp(&formtype, "WAVE", 4)) {
120                 ast_log(LOG_WARNING, "Does not contain WAVE\n");
121                 return -1;
122         }
123         if (fread(&fmt, 1, 4, f) != 4) {
124                 ast_log(LOG_WARNING, "Read failed (fmt)\n");
125                 return -1;
126         }
127         if (memcmp(&fmt, "fmt ", 4)) {
128                 ast_log(LOG_WARNING, "Does not say fmt\n");
129                 return -1;
130         }
131         if (fread(&hsize, 1, 4, f) != 4) {
132                 ast_log(LOG_WARNING, "Read failed (formtype)\n");
133                 return -1;
134         }
135         if (ltohl(hsize) != 20) {
136                 ast_log(LOG_WARNING, "Unexpected header size %d\n", ltohl(hsize));
137                 return -1;
138         }
139         if (fread(&format, 1, 2, f) != 2) {
140                 ast_log(LOG_WARNING, "Read failed (format)\n");
141                 return -1;
142         }
143         if (ltohs(format) != 49) {
144                 ast_log(LOG_WARNING, "Not a GSM file %d\n", ltohs(format));
145                 return -1;
146         }
147         if (fread(&chans, 1, 2, f) != 2) {
148                 ast_log(LOG_WARNING, "Read failed (format)\n");
149                 return -1;
150         }
151         if (ltohs(chans) != 1) {
152                 ast_log(LOG_WARNING, "Not in mono %d\n", ltohs(chans));
153                 return -1;
154         }
155         if (fread(&freq, 1, 4, f) != 4) {
156                 ast_log(LOG_WARNING, "Read failed (freq)\n");
157                 return -1;
158         }
159         if (ltohl(freq) != DEFAULT_SAMPLE_RATE) {
160                 ast_log(LOG_WARNING, "Unexpected frequency %d\n", ltohl(freq));
161                 return -1;
162         }
163         /* Ignore the byte frequency */
164         if (fread(&freq, 1, 4, f) != 4) {
165                 ast_log(LOG_WARNING, "Read failed (X_1)\n");
166                 return -1;
167         }
168         /* Ignore the two weird fields */
169         if (fread(&freq, 1, 4, f) != 4) {
170                 ast_log(LOG_WARNING, "Read failed (X_2/X_3)\n");
171                 return -1;
172         }
173         /* Ignore the byte frequency */
174         if (fread(&freq, 1, 4, f) != 4) {
175                 ast_log(LOG_WARNING, "Read failed (Y_1)\n");
176                 return -1;
177         }
178         /* Check for the word fact */
179         if (fread(&fact, 1, 4, f) != 4) {
180                 ast_log(LOG_WARNING, "Read failed (fact)\n");
181                 return -1;
182         }
183         if (memcmp(&fact, "fact", 4)) {
184                 ast_log(LOG_WARNING, "Does not say fact\n");
185                 return -1;
186         }
187         /* Ignore the "fact value" */
188         if (fread(&fact, 1, 4, f) != 4) {
189                 ast_log(LOG_WARNING, "Read failed (fact header)\n");
190                 return -1;
191         }
192         if (fread(&fact, 1, 4, f) != 4) {
193                 ast_log(LOG_WARNING, "Read failed (fact value)\n");
194                 return -1;
195         }
196         /* Check for the word data */
197         if (fread(&data, 1, 4, f) != 4) {
198                 ast_log(LOG_WARNING, "Read failed (data)\n");
199                 return -1;
200         }
201         if (memcmp(&data, "data", 4)) {
202                 ast_log(LOG_WARNING, "Does not say data\n");
203                 return -1;
204         }
205         /* Ignore the data length */
206         if (fread(&data, 1, 4, f) != 4) {
207                 ast_log(LOG_WARNING, "Read failed (data)\n");
208                 return -1;
209         }
210         return 0;
211 }
212
213 static int update_header(FILE *f)
214 {
215         off_t cur,end,bytes;
216         int datalen, filelen, samples;
217
218         cur = ftello(f);
219         fseek(f, 0, SEEK_END);
220         end = ftello(f);
221         /* in a gsm WAV, data starts 60 bytes in */
222         bytes = end - MSGSM_DATA_OFFSET;
223         samples = htoll(bytes / MSGSM_FRAME_SIZE * MSGSM_SAMPLES);
224         datalen = htoll(bytes);
225         filelen = htoll(MSGSM_DATA_OFFSET - 8 + bytes);
226         if (cur < 0) {
227                 ast_log(LOG_WARNING, "Unable to find our position\n");
228                 return -1;
229         }
230         if (fseek(f, 4, SEEK_SET)) {
231                 ast_log(LOG_WARNING, "Unable to set our position\n");
232                 return -1;
233         }
234         if (fwrite(&filelen, 1, 4, f) != 4) {
235                 ast_log(LOG_WARNING, "Unable to write file size\n");
236                 return -1;
237         }
238         if (fseek(f, 48, SEEK_SET)) {
239                 ast_log(LOG_WARNING, "Unable to set our position\n");
240                 return -1;
241         }
242         if (fwrite(&samples, 1, 4, f) != 4) {
243                 ast_log(LOG_WARNING, "Unable to write samples\n");
244                 return -1;
245         }
246         if (fseek(f, 56, SEEK_SET)) {
247                 ast_log(LOG_WARNING, "Unable to set our position\n");
248                 return -1;
249         }
250         if (fwrite(&datalen, 1, 4, f) != 4) {
251                 ast_log(LOG_WARNING, "Unable to write datalen\n");
252                 return -1;
253         }
254         if (fseeko(f, cur, SEEK_SET)) {
255                 ast_log(LOG_WARNING, "Unable to return to position\n");
256                 return -1;
257         }
258         return 0;
259 }
260
261 static int write_header(FILE *f)
262 {
263         /* Samples per second (always 8000 for this format). */
264         unsigned int sample_rate = htoll(8000);
265         /* Bytes per second (always 1625 for this format). */
266         unsigned int byte_sample_rate = htoll(1625);
267         /* This is the size of the "fmt " subchunk */
268         unsigned int fmtsize = htoll(20);
269         /* WAV #49 */
270         unsigned short fmt = htols(49);
271         /* Mono = 1 channel */
272         unsigned short chans = htols(1);
273         /* Each block of data is exactly 65 bytes in size. */
274         unsigned int block_align = htoll(MSGSM_FRAME_SIZE);
275         /* Not actually 2, but rounded up to the nearest bit */
276         unsigned short bits_per_sample = htols(2);
277         /* Needed for compressed formats */
278         unsigned short extra_format = htols(MSGSM_SAMPLES);
279         /* This is the size of the "fact" subchunk */
280         unsigned int factsize = htoll(4);
281         /* Number of samples in the data chunk */
282         unsigned int num_samples = htoll(0);
283         /* Number of bytes in the data chunk */
284         unsigned int size = htoll(0);
285         /* Write a GSM header, ignoring sizes which will be filled in later */
286
287         /*  0: Chunk ID */
288         if (fwrite("RIFF", 1, 4, f) != 4) {
289                 ast_log(LOG_WARNING, "Unable to write header\n");
290                 return -1;
291         }
292         /*  4: Chunk Size */
293         if (fwrite(&size, 1, 4, f) != 4) {
294                 ast_log(LOG_WARNING, "Unable to write header\n");
295                 return -1;
296         }
297         /*  8: Chunk Format */
298         if (fwrite("WAVE", 1, 4, f) != 4) {
299                 ast_log(LOG_WARNING, "Unable to write header\n");
300                 return -1;
301         }
302         /* 12: Subchunk 1: ID */
303         if (fwrite("fmt ", 1, 4, f) != 4) {
304                 ast_log(LOG_WARNING, "Unable to write header\n");
305                 return -1;
306         }
307         /* 16: Subchunk 1: Size (minus 8) */
308         if (fwrite(&fmtsize, 1, 4, f) != 4) {
309                 ast_log(LOG_WARNING, "Unable to write header\n");
310                 return -1;
311         }
312         /* 20: Subchunk 1: Audio format (49) */
313         if (fwrite(&fmt, 1, 2, f) != 2) {
314                 ast_log(LOG_WARNING, "Unable to write header\n");
315                 return -1;
316         }
317         /* 22: Subchunk 1: Number of channels */
318         if (fwrite(&chans, 1, 2, f) != 2) {
319                 ast_log(LOG_WARNING, "Unable to write header\n");
320                 return -1;
321         }
322         /* 24: Subchunk 1: Sample rate */
323         if (fwrite(&sample_rate, 1, 4, f) != 4) {
324                 ast_log(LOG_WARNING, "Unable to write header\n");
325                 return -1;
326         }
327         /* 28: Subchunk 1: Byte rate */
328         if (fwrite(&byte_sample_rate, 1, 4, f) != 4) {
329                 ast_log(LOG_WARNING, "Unable to write header\n");
330                 return -1;
331         }
332         /* 32: Subchunk 1: Block align */
333         if (fwrite(&block_align, 1, 4, f) != 4) {
334                 ast_log(LOG_WARNING, "Unable to write header\n");
335                 return -1;
336         }
337         /* 36: Subchunk 1: Bits per sample */
338         if (fwrite(&bits_per_sample, 1, 2, f) != 2) {
339                 ast_log(LOG_WARNING, "Unable to write header\n");
340                 return -1;
341         }
342         /* 38: Subchunk 1: Extra format bytes */
343         if (fwrite(&extra_format, 1, 2, f) != 2) {
344                 ast_log(LOG_WARNING, "Unable to write header\n");
345                 return -1;
346         }
347         /* 40: Subchunk 2: ID */
348         if (fwrite("fact", 1, 4, f) != 4) {
349                 ast_log(LOG_WARNING, "Unable to write header\n");
350                 return -1;
351         }
352         /* 44: Subchunk 2: Size (minus 8) */
353         if (fwrite(&factsize, 1, 4, f) != 4) {
354                 ast_log(LOG_WARNING, "Unable to write header\n");
355                 return -1;
356         }
357         /* 48: Subchunk 2: Number of samples */
358         if (fwrite(&num_samples, 1, 4, f) != 4) {
359                 ast_log(LOG_WARNING, "Unable to write header\n");
360                 return -1;
361         }
362         /* 52: Subchunk 3: ID */
363         if (fwrite("data", 1, 4, f) != 4) {
364                 ast_log(LOG_WARNING, "Unable to write header\n");
365                 return -1;
366         }
367         /* 56: Subchunk 3: Size */
368         if (fwrite(&size, 1, 4, f) != 4) {
369                 ast_log(LOG_WARNING, "Unable to write header\n");
370                 return -1;
371         }
372         return 0;
373 }
374
375 static int wav_open(struct ast_filestream *s)
376 {
377         /* We don't have any header to read or anything really, but
378            if we did, it would go here.  We also might want to check
379            and be sure it's a valid file.  */
380         struct wavg_desc *fs = (struct wavg_desc *)s->_private;
381
382         if (check_header(s->f))
383                 return -1;
384         fs->secondhalf = 0;     /* not strictly necessary */
385         return 0;
386 }
387
388 static int wav_rewrite(struct ast_filestream *s, const char *comment)
389 {
390         /* We don't have any header to read or anything really, but
391            if we did, it would go here.  We also might want to check
392            and be sure it's a valid file.  */
393
394         if (write_header(s->f))
395                 return -1;
396         return 0;
397 }
398
399 static void wav_close(struct ast_filestream *s)
400 {
401         if (s->mode == O_RDONLY) {
402                 return;
403         }
404
405         if (s->filename) {
406                 update_header(s->f);
407         }
408 }
409
410 static struct ast_frame *wav_read(struct ast_filestream *s, int *whennext)
411 {
412         /* Send a frame from the file to the appropriate channel */
413         struct wavg_desc *fs = (struct wavg_desc *)s->_private;
414
415         s->fr.samples = GSM_SAMPLES;
416         AST_FRAME_SET_BUFFER(&s->fr, s->buf, AST_FRIENDLY_OFFSET, GSM_FRAME_SIZE);
417         if (fs->secondhalf) {
418                 /* Just return a frame based on the second GSM frame */
419                 s->fr.data.ptr = (char *)s->fr.data.ptr + GSM_FRAME_SIZE;
420                 s->fr.offset += GSM_FRAME_SIZE;
421         } else {
422                 /* read and convert */
423                 unsigned char msdata[MSGSM_FRAME_SIZE];
424                 int res;
425                 
426                 if ((res = fread(msdata, 1, MSGSM_FRAME_SIZE, s->f)) != MSGSM_FRAME_SIZE) {
427                         if (res && (res != 1))
428                                 ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
429                         return NULL;
430                 }
431                 /* Convert from MS format to two real GSM frames */
432                 conv65(msdata, s->fr.data.ptr);
433         }
434         fs->secondhalf = !fs->secondhalf;
435         *whennext = GSM_SAMPLES;
436         return &s->fr;
437 }
438
439 static int wav_write(struct ast_filestream *s, struct ast_frame *f)
440 {
441         int len;
442         int size;
443         struct wavg_desc *fs = (struct wavg_desc *)s->_private;
444
445         /* XXX this might fail... if the input is a multiple of MSGSM_FRAME_SIZE
446          * we assume it is already in the correct format.
447          */
448         if (!(f->datalen % MSGSM_FRAME_SIZE)) {
449                 size = MSGSM_FRAME_SIZE;
450                 fs->secondhalf = 0;
451         } else {
452                 size = GSM_FRAME_SIZE;
453         }
454         for (len = 0; len < f->datalen ; len += size) {
455                 int res;
456                 unsigned char *src, msdata[MSGSM_FRAME_SIZE];
457                 if (fs->secondhalf) {   /* second half of raw gsm to be converted */
458                         memcpy(s->buf + GSM_FRAME_SIZE, f->data.ptr + len, GSM_FRAME_SIZE);
459                         conv66((unsigned char *) s->buf, msdata);
460                         src = msdata;
461                         fs->secondhalf = 0;
462                 } else if (size == GSM_FRAME_SIZE) {    /* first half of raw gsm */
463                         memcpy(s->buf, f->data.ptr + len, GSM_FRAME_SIZE);
464                         src = NULL;     /* nothing to write */
465                         fs->secondhalf = 1;
466                 } else {        /* raw msgsm data */
467                         src = f->data.ptr + len;
468                 }
469                 if (src && (res = fwrite(src, 1, MSGSM_FRAME_SIZE, s->f)) != MSGSM_FRAME_SIZE) {
470                         ast_log(LOG_WARNING, "Bad write (%d/65): %s\n", res, strerror(errno));
471                         return -1;
472                 }
473         }
474         return 0;
475 }
476
477 static int wav_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
478 {
479         off_t offset = 0, min = MSGSM_DATA_OFFSET, distance, max, cur;
480         struct wavg_desc *s = (struct wavg_desc *)fs->_private;
481
482         if ((cur = ftello(fs->f)) < 0) {
483                 ast_log(AST_LOG_WARNING, "Unable to determine current position in WAV filestream %p: %s\n", fs, strerror(errno));
484                 return -1;
485         }
486
487         if (fseeko(fs->f, 0, SEEK_END) < 0) {
488                 ast_log(AST_LOG_WARNING, "Unable to seek to end of WAV filestream %p: %s\n", fs, strerror(errno));
489                 return -1;
490         }
491
492         /* XXX ideally, should round correctly */
493         if ((max = ftello(fs->f)) < 0) {
494                 ast_log(AST_LOG_WARNING, "Unable to determine max position in WAV filestream %p: %s\n", fs, strerror(errno));
495                 return -1;
496         }
497
498         /* Compute the distance in bytes, rounded to the block size */
499         distance = (sample_offset/MSGSM_SAMPLES) * MSGSM_FRAME_SIZE;
500         if (whence == SEEK_SET)
501                 offset = distance + min;
502         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
503                 offset = distance + cur;
504         else if (whence == SEEK_END)
505                 offset = max - distance;
506         /* always protect against seeking past end of header */
507         if (offset < min)
508                 offset = min;
509         if (whence != SEEK_FORCECUR) {
510                 if (offset > max)
511                         offset = max;
512         } else if (offset > max) {
513                 int i;
514                 fseek(fs->f, 0, SEEK_END);
515                 for (i=0; i< (offset - max) / MSGSM_FRAME_SIZE; i++) {
516                         if (!fwrite(msgsm_silence, 1, MSGSM_FRAME_SIZE, fs->f)) {
517                                 ast_log(LOG_WARNING, "fwrite() failed: %s\n", strerror(errno));
518                         }
519                 }
520         }
521         s->secondhalf = 0;
522         return fseeko(fs->f, offset, SEEK_SET);
523 }
524
525 static int wav_trunc(struct ast_filestream *fs)
526 {
527         int fd;
528         off_t cur;
529
530         if ((fd = fileno(fs->f)) < 0) {
531                 ast_log(AST_LOG_WARNING, "Unable to determine file descriptor for WAV filestream %p: %s\n", fs, strerror(errno));
532                 return -1;
533         }
534         if ((cur = ftello(fs->f)) < 0) {
535                 ast_log(AST_LOG_WARNING, "Unable to determine current position in WAV filestream %p: %s\n", fs, strerror(errno));
536                 return -1;
537         }
538         /* Truncate file to current length */
539         if (ftruncate(fd, cur)) {
540                 return -1;
541         }
542         return update_header(fs->f);
543 }
544
545 static off_t wav_tell(struct ast_filestream *fs)
546 {
547         off_t offset;
548         offset = ftello(fs->f);
549         /* since this will most likely be used later in play or record, lets stick
550          * to that level of resolution, just even frames boundaries */
551         return (offset - MSGSM_DATA_OFFSET)/MSGSM_FRAME_SIZE*MSGSM_SAMPLES;
552 }
553
554 static struct ast_format_def wav49_f = {
555         .name = "wav49",
556         .exts = "WAV|wav49",
557         .open = wav_open,
558         .rewrite = wav_rewrite,
559         .write = wav_write,
560         .seek = wav_seek,
561         .trunc = wav_trunc,
562         .tell = wav_tell,
563         .read = wav_read,
564         .close = wav_close,
565         .buf_size = 2*GSM_FRAME_SIZE + AST_FRIENDLY_OFFSET,
566         .desc_size = sizeof(struct wavg_desc),
567 };
568
569 static int load_module(void)
570 {
571         wav49_f.format = ast_format_gsm;
572         if (ast_format_def_register(&wav49_f))
573                 return AST_MODULE_LOAD_FAILURE;
574         return AST_MODULE_LOAD_SUCCESS;
575 }
576
577 static int unload_module(void)
578 {
579         return ast_format_def_unregister(wav49_f.name);
580 }
581
582 AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_LOAD_ORDER, "Microsoft WAV format (Proprietary GSM)",
583         .support_level = AST_MODULE_SUPPORT_CORE,
584         .load = load_module,
585         .unload = unload_module,
586         .load_pri = AST_MODPRI_APP_DEPEND
587 );