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