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