Use FILE * instead of fd for files to support buffering
[asterisk/asterisk.git] / formats / format_au.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2005, Andriy Pylypenko
5  * Code based on format_wav.c by Mark Spencer
6  *
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*
19  *
20  * Work with Sun Microsystems AU format.
21  * 
22  */
23  
24 #include <stdlib.h>
25 #include <sys/time.h>
26 #include <stdio.h>
27 #include <unistd.h>
28 #include <errno.h>
29 #include <string.h>
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include "asterisk/lock.h"
36 #include "asterisk/channel.h"
37 #include "asterisk/file.h"
38 #include "asterisk/logger.h"
39 #include "asterisk/sched.h"
40 #include "asterisk/module.h"
41 #include "asterisk/endian.h"
42
43 #define BUF_SIZE                160
44
45 #define AU_HEADER_SIZE          24
46 #define AU_HEADER(var)          u_int32_t var[6]
47
48 #define AU_HDR_MAGIC_OFF        0
49 #define AU_HDR_HDR_SIZE_OFF     1
50 #define AU_HDR_DATA_SIZE_OFF    2
51 #define AU_HDR_ENCODING_OFF     3
52 #define AU_HDR_SAMPLE_RATE_OFF  4
53 #define AU_HDR_CHANNELS_OFF     5
54
55 #define AU_ENC_8BIT_ULAW        1
56
57 struct ast_filestream {
58         void *reserved[AST_RESERVED_POINTERS];
59         /* This is what a filestream means to us */
60         FILE *f;                                /* Descriptor */
61         struct ast_channel *owner;
62         struct ast_frame fr;                    /* Frame information */
63         char waste[AST_FRIENDLY_OFFSET];        /* Buffer for sending frames, etc */
64         char empty;                             /* Empty character */
65         short buf[BUF_SIZE];
66 };
67
68
69 AST_MUTEX_DEFINE_STATIC(au_lock);
70 static int localusecnt = 0;
71
72 static char *name = "au";
73 static char *desc = "Sun Microsystems AU format (signed linear)";
74 static char *exts = "au";
75
76
77 #define AU_MAGIC 0x2e736e64
78 #if __BYTE_ORDER == __BIG_ENDIAN
79 #define htoll(b) (b)
80 #define htols(b) (b)
81 #define ltohl(b) (b)
82 #define ltohs(b) (b)
83 #else
84 #if __BYTE_ORDER == __LITTLE_ENDIAN
85 #define htoll(b)  \
86           (((((b)      ) & 0xFF) << 24) | \
87                ((((b) >>  8) & 0xFF) << 16) | \
88                    ((((b) >> 16) & 0xFF) <<  8) | \
89                    ((((b) >> 24) & 0xFF)      ))
90 #define htols(b) \
91           (((((b)      ) & 0xFF) << 8) | \
92                    ((((b) >> 8) & 0xFF)      ))
93 #define ltohl(b) htoll(b)
94 #define ltohs(b) htols(b)
95 #else
96 #error "Endianess not defined"
97 #endif
98 #endif
99
100
101 static int check_header(FILE *f)
102 {
103         AU_HEADER(header);
104         u_int32_t magic;
105         u_int32_t hdr_size;
106         u_int32_t data_size;
107         u_int32_t encoding;
108         u_int32_t sample_rate;
109         u_int32_t channels;
110
111         if (fread(header, 1, AU_HEADER_SIZE, f) != AU_HEADER_SIZE) {
112                 ast_log(LOG_WARNING, "Read failed (header)\n");
113                 return -1;
114         }
115         magic = ltohl(header[AU_HDR_MAGIC_OFF]);
116         if (magic != (u_int32_t) AU_MAGIC) {
117                 ast_log(LOG_WARNING, "Bad magic: 0x%x\n", magic);
118         }
119 /*      hdr_size = ltohl(header[AU_HDR_HDR_SIZE_OFF]);
120         if (hdr_size < AU_HEADER_SIZE)*/
121         hdr_size = AU_HEADER_SIZE;
122 /*      data_size = ltohl(header[AU_HDR_DATA_SIZE_OFF]); */
123         encoding = ltohl(header[AU_HDR_ENCODING_OFF]);
124         if (encoding != AU_ENC_8BIT_ULAW) {
125                 ast_log(LOG_WARNING, "Unexpected format: %d. Only 8bit ULAW allowed (%d)\n", encoding, AU_ENC_8BIT_ULAW);
126                 return -1;
127         }
128         sample_rate = ltohl(header[AU_HDR_SAMPLE_RATE_OFF]);
129         if (sample_rate != 8000) {
130                 ast_log(LOG_WARNING, "Sample rate can only be 8000 not %d\n", sample_rate);
131                 return -1;
132         }
133         channels = ltohl(header[AU_HDR_CHANNELS_OFF]);
134         if (channels != 1) {
135                 ast_log(LOG_WARNING, "Not in mono: channels=%d\n", channels);
136                 return -1;
137         }
138         /* Skip to data */
139         fseek(f, 0, SEEK_END);
140         data_size = ftell(f) - hdr_size;
141         if (fseek(f, hdr_size, SEEK_SET) == -1 ) {
142                 ast_log(LOG_WARNING, "Failed to skip to data: %d\n", hdr_size);
143                 return -1;
144         }
145         return data_size;
146 }
147
148 static int update_header(FILE *f)
149 {
150         off_t cur, end;
151         u_int32_t datalen;
152         int bytes;
153
154         cur = ftell(f);
155         fseek(f, 0, SEEK_END);
156         end = ftell(f);
157         /* data starts 24 bytes in */
158         bytes = end - AU_HEADER_SIZE;
159         datalen = htoll(bytes);
160
161         if (cur < 0) {
162                 ast_log(LOG_WARNING, "Unable to find our position\n");
163                 return -1;
164         }
165         if (fseek(f, AU_HDR_DATA_SIZE_OFF * sizeof(u_int32_t), SEEK_SET)) {
166                 ast_log(LOG_WARNING, "Unable to set our position\n");
167                 return -1;
168         }
169         if (fwrite(&datalen, 1, sizeof(datalen), f) != sizeof(datalen)) {
170                 ast_log(LOG_WARNING, "Unable to set write file size\n");
171                 return -1;
172         }
173         if (fseek(f, cur, SEEK_SET)) {
174                 ast_log(LOG_WARNING, "Unable to return to position\n");
175                 return -1;
176         }
177         return 0;
178 }
179
180 static int write_header(FILE *f)
181 {
182         AU_HEADER(header);
183
184         header[AU_HDR_MAGIC_OFF] = htoll((u_int32_t) AU_MAGIC);
185         header[AU_HDR_HDR_SIZE_OFF] = htoll(AU_HEADER_SIZE);
186         header[AU_HDR_DATA_SIZE_OFF] = 0;
187         header[AU_HDR_ENCODING_OFF] = htoll(AU_ENC_8BIT_ULAW);
188         header[AU_HDR_SAMPLE_RATE_OFF] = htoll(8000);
189         header[AU_HDR_CHANNELS_OFF] = htoll(1);
190
191         /* Write an au header, ignoring sizes which will be filled in later */
192         fseek(f, 0, SEEK_SET);
193         if (fwrite(header, 1, AU_HEADER_SIZE, f) != AU_HEADER_SIZE) {
194                 ast_log(LOG_WARNING, "Unable to write header\n");
195                 return -1;
196         }
197         return 0;
198 }
199
200 static struct ast_filestream *au_open(FILE *f)
201 {
202         struct ast_filestream *tmp;
203
204         if (!(tmp = malloc(sizeof(struct ast_filestream)))) {
205                 ast_log(LOG_ERROR, "Out of memory\n");
206                 return NULL;
207         }
208
209         memset(tmp, 0, sizeof(struct ast_filestream));
210         if (check_header(f) < 0) {
211                 free(tmp);
212                 return NULL;
213         }
214         if (ast_mutex_lock(&au_lock)) {
215                 ast_log(LOG_WARNING, "Unable to lock au count\n");
216                 free(tmp);
217                 return NULL;
218         }
219         tmp->f = f;
220         tmp->fr.data = tmp->buf;
221         tmp->fr.frametype = AST_FRAME_VOICE;
222         tmp->fr.subclass = AST_FORMAT_ULAW;
223         /* datalen will vary for each frame */
224         tmp->fr.src = name;
225         tmp->fr.mallocd = 0;
226         localusecnt++;
227         ast_mutex_unlock(&au_lock);
228         ast_update_use_count();
229         return tmp;
230 }
231
232 static struct ast_filestream *au_rewrite(FILE *f, const char *comment)
233 {
234         struct ast_filestream *tmp;
235
236         if ((tmp = malloc(sizeof(struct ast_filestream))) == NULL) {
237                 ast_log(LOG_ERROR, "Out of memory\n");
238                 return NULL;
239         }
240
241         memset(tmp, 0, sizeof(struct ast_filestream));
242         if (write_header(f)) {
243                 free(tmp);
244                 return NULL;
245         }
246         if (ast_mutex_lock(&au_lock)) {
247                 ast_log(LOG_WARNING, "Unable to lock au count\n");
248                 free(tmp);
249                 return NULL;
250         }
251         tmp->f = f;
252         localusecnt++;
253         ast_mutex_unlock(&au_lock);
254         ast_update_use_count();
255         return tmp;
256 }
257
258 static void au_close(struct ast_filestream *s)
259 {
260         if (ast_mutex_lock(&au_lock)) {
261                 ast_log(LOG_WARNING, "Unable to lock au count\n");
262                 return;
263         }
264         localusecnt--;
265         ast_mutex_unlock(&au_lock);
266         ast_update_use_count();
267         fclose(s->f);
268         free(s);
269 }
270
271 static struct ast_frame *au_read(struct ast_filestream *s, int *whennext)
272 {
273         int res;
274         int delay;
275         /* Send a frame from the file to the appropriate channel */
276
277         s->fr.frametype = AST_FRAME_VOICE;
278         s->fr.subclass = AST_FORMAT_ULAW;
279         s->fr.offset = AST_FRIENDLY_OFFSET;
280         s->fr.mallocd = 0;
281         s->fr.data = s->buf;
282         if ((res = fread(s->buf, 1, BUF_SIZE, s->f)) < 1) {
283                 if (res)
284                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
285                 return NULL;
286         }
287         s->fr.samples = res;
288         s->fr.datalen = res;
289         delay = s->fr.samples;
290         *whennext = delay;
291         return &s->fr;
292 }
293
294 static int au_write(struct ast_filestream *fs, struct ast_frame *f)
295 {
296         int res;
297
298         if (f->frametype != AST_FRAME_VOICE) {
299                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
300                 return -1;
301         }
302         if (f->subclass != AST_FORMAT_ULAW) {
303                 ast_log(LOG_WARNING, "Asked to write non-ulaw frame (%d)!\n", f->subclass);
304                 return -1;
305         }
306         if ((res = fwrite(f->data, 1, f->datalen, fs->f)) != f->datalen) {
307                         ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
308                         return -1;
309         }
310         update_header(fs->f);
311         return 0;
312 }
313
314 static int au_seek(struct ast_filestream *fs, long sample_offset, int whence)
315 {
316         off_t min, max, cur;
317         long offset = 0, samples;
318         
319         samples = sample_offset;
320         min = AU_HEADER_SIZE;
321         cur = ftell(fs->f);
322         fseek(fs->f, 0, SEEK_END);
323         max = ftell(fs->f);
324         if (whence == SEEK_SET)
325                 offset = samples + min;
326         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
327                 offset = samples + cur;
328         else if (whence == SEEK_END)
329                 offset = max - samples;
330         if (whence != SEEK_FORCECUR) {
331                 offset = (offset > max) ? max : offset;
332         }
333         /* always protect the header space. */
334         offset = (offset < min) ? min : offset;
335         return fseek(fs->f, offset, SEEK_SET);
336 }
337
338 static int au_trunc(struct ast_filestream *fs)
339 {
340         if (ftruncate(fileno(fs->f), ftell(fs->f)))
341                 return -1;
342         return update_header(fs->f);
343 }
344
345 static long au_tell(struct ast_filestream *fs)
346 {
347         off_t offset;
348
349         offset = ftell(fs->f);
350         return offset - AU_HEADER_SIZE;
351 }
352
353 static char *au_getcomment(struct ast_filestream *s)
354 {
355         return NULL;
356 }
357
358 int load_module()
359 {
360         return ast_format_register(name, exts, AST_FORMAT_ULAW,
361                                    au_open,
362                                    au_rewrite,
363                                    au_write,
364                                    au_seek,
365                                    au_trunc,
366                                    au_tell,
367                                    au_read,
368                                    au_close,
369                                    au_getcomment);
370 }
371
372 int unload_module()
373 {
374         return ast_format_unregister(name);
375 }
376
377 int usecount()
378 {
379         return localusecnt;
380 }
381
382 char *description()
383 {
384         return desc;
385 }
386
387 char *key()
388 {
389         return ASTERISK_GPL_KEY;
390 }