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