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