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