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