Largely simplify format handlers (for file copy etc.)
[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  * \file
20  *
21  * \brief Work with Sun Microsystems AU format.
22  *
23  * signed linear
24  * \arg File extension: au
25  * \ingroup formats
26  */
27  
28 #include <stdlib.h>
29 #include <sys/time.h>
30 #include <stdio.h>
31 #include <unistd.h>
32 #include <errno.h>
33 #include <string.h>
34
35 #include "asterisk.h"
36
37 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
38
39 #include "asterisk/lock.h"
40 #include "asterisk/channel.h"
41 #include "asterisk/file.h"
42 #include "asterisk/logger.h"
43 #include "asterisk/sched.h"
44 #include "asterisk/module.h"
45 #include "asterisk/endian.h"
46
47 #define BUF_SIZE                160     /* samples and 1 byte per sample */
48
49 #define AU_HEADER_SIZE          24
50 #define AU_HEADER(var)          u_int32_t var[6]
51
52 #define AU_HDR_MAGIC_OFF        0
53 #define AU_HDR_HDR_SIZE_OFF     1
54 #define AU_HDR_DATA_SIZE_OFF    2
55 #define AU_HDR_ENCODING_OFF     3
56 #define AU_HDR_SAMPLE_RATE_OFF  4
57 #define AU_HDR_CHANNELS_OFF     5
58
59 #define AU_ENC_8BIT_ULAW        1
60
61 #define AU_MAGIC 0x2e736e64
62 #if __BYTE_ORDER == __BIG_ENDIAN
63 #define htoll(b) (b)
64 #define htols(b) (b)
65 #define ltohl(b) (b)
66 #define ltohs(b) (b)
67 #else
68 #if __BYTE_ORDER == __LITTLE_ENDIAN
69 #define htoll(b)  \
70           (((((b)      ) & 0xFF) << 24) | \
71                ((((b) >>  8) & 0xFF) << 16) | \
72                    ((((b) >> 16) & 0xFF) <<  8) | \
73                    ((((b) >> 24) & 0xFF)      ))
74 #define htols(b) \
75           (((((b)      ) & 0xFF) << 8) | \
76                    ((((b) >> 8) & 0xFF)      ))
77 #define ltohl(b) htoll(b)
78 #define ltohs(b) htols(b)
79 #else
80 #error "Endianess not defined"
81 #endif
82 #endif
83
84
85 static int check_header(FILE *f)
86 {
87         AU_HEADER(header);
88         u_int32_t magic;
89         u_int32_t hdr_size;
90         off_t data_size;
91         u_int32_t encoding;
92         u_int32_t sample_rate;
93         u_int32_t channels;
94
95         if (fread(header, 1, AU_HEADER_SIZE, f) != AU_HEADER_SIZE) {
96                 ast_log(LOG_WARNING, "Read failed (header)\n");
97                 return -1;
98         }
99         magic = ltohl(header[AU_HDR_MAGIC_OFF]);
100         if (magic != (u_int32_t) AU_MAGIC) {
101                 ast_log(LOG_WARNING, "Bad magic: 0x%x\n", magic);
102         }
103 /*      hdr_size = ltohl(header[AU_HDR_HDR_SIZE_OFF]);
104         if (hdr_size < AU_HEADER_SIZE)*/
105         hdr_size = AU_HEADER_SIZE;
106 /*      data_size = ltohl(header[AU_HDR_DATA_SIZE_OFF]); */
107         encoding = ltohl(header[AU_HDR_ENCODING_OFF]);
108         if (encoding != AU_ENC_8BIT_ULAW) {
109                 ast_log(LOG_WARNING, "Unexpected format: %d. Only 8bit ULAW allowed (%d)\n", encoding, AU_ENC_8BIT_ULAW);
110                 return -1;
111         }
112         sample_rate = ltohl(header[AU_HDR_SAMPLE_RATE_OFF]);
113         if (sample_rate != DEFAULT_SAMPLE_RATE) {
114                 ast_log(LOG_WARNING, "Sample rate can only be 8000 not %d\n", sample_rate);
115                 return -1;
116         }
117         channels = ltohl(header[AU_HDR_CHANNELS_OFF]);
118         if (channels != 1) {
119                 ast_log(LOG_WARNING, "Not in mono: channels=%d\n", channels);
120                 return -1;
121         }
122         /* Skip to data */
123         fseek(f, 0, SEEK_END);
124         data_size = ftello(f) - hdr_size;
125         if (fseek(f, hdr_size, SEEK_SET) == -1 ) {
126                 ast_log(LOG_WARNING, "Failed to skip to data: %d\n", hdr_size);
127                 return -1;
128         }
129         return data_size;
130 }
131
132 static int update_header(FILE *f)
133 {
134         off_t cur, end;
135         u_int32_t datalen;
136         int bytes;
137
138         cur = ftello(f);
139         fseek(f, 0, SEEK_END);
140         end = ftello(f);
141         /* data starts 24 bytes in */
142         bytes = end - AU_HEADER_SIZE;
143         datalen = htoll(bytes);
144
145         if (cur < 0) {
146                 ast_log(LOG_WARNING, "Unable to find our position\n");
147                 return -1;
148         }
149         if (fseek(f, AU_HDR_DATA_SIZE_OFF * sizeof(u_int32_t), SEEK_SET)) {
150                 ast_log(LOG_WARNING, "Unable to set our position\n");
151                 return -1;
152         }
153         if (fwrite(&datalen, 1, sizeof(datalen), f) != sizeof(datalen)) {
154                 ast_log(LOG_WARNING, "Unable to set write file size\n");
155                 return -1;
156         }
157         if (fseek(f, cur, SEEK_SET)) {
158                 ast_log(LOG_WARNING, "Unable to return to position\n");
159                 return -1;
160         }
161         return 0;
162 }
163
164 static int write_header(FILE *f)
165 {
166         AU_HEADER(header);
167
168         header[AU_HDR_MAGIC_OFF] = htoll((u_int32_t) AU_MAGIC);
169         header[AU_HDR_HDR_SIZE_OFF] = htoll(AU_HEADER_SIZE);
170         header[AU_HDR_DATA_SIZE_OFF] = 0;
171         header[AU_HDR_ENCODING_OFF] = htoll(AU_ENC_8BIT_ULAW);
172         header[AU_HDR_SAMPLE_RATE_OFF] = htoll(DEFAULT_SAMPLE_RATE);
173         header[AU_HDR_CHANNELS_OFF] = htoll(1);
174
175         /* Write an au header, ignoring sizes which will be filled in later */
176         fseek(f, 0, SEEK_SET);
177         if (fwrite(header, 1, AU_HEADER_SIZE, f) != AU_HEADER_SIZE) {
178                 ast_log(LOG_WARNING, "Unable to write header\n");
179                 return -1;
180         }
181         return 0;
182 }
183
184 static int au_open(struct ast_filestream *s)
185 {
186         if (check_header(s->f) < 0)
187                 return -1;
188         return 0;
189 }
190
191 static int au_rewrite(struct ast_filestream *s, const char *comment)
192 {
193         if (write_header(s->f))
194                 return -1;
195         return 0;
196 }
197
198 static struct ast_frame *au_read(struct ast_filestream *s, int *whennext)
199 {
200         int res;
201         /* Send a frame from the file to the appropriate channel */
202
203         s->fr.frametype = AST_FRAME_VOICE;
204         s->fr.subclass = AST_FORMAT_ULAW;
205         s->fr.mallocd = 0;
206         FR_SET_BUF(&s->fr, s->buf, AST_FRIENDLY_OFFSET, BUF_SIZE);
207         if ((res = fread(s->fr.data, 1, s->fr.datalen, s->f)) < 1) {
208                 if (res)
209                         ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", res, strerror(errno));
210                 return NULL;
211         }
212         *whennext = s->fr.samples = res;
213         s->fr.datalen = res;
214         return &s->fr;
215 }
216
217 static int au_write(struct ast_filestream *fs, struct ast_frame *f)
218 {
219         int res;
220
221         if (f->frametype != AST_FRAME_VOICE) {
222                 ast_log(LOG_WARNING, "Asked to write non-voice frame!\n");
223                 return -1;
224         }
225         if (f->subclass != AST_FORMAT_ULAW) {
226                 ast_log(LOG_WARNING, "Asked to write non-ulaw frame (%d)!\n", f->subclass);
227                 return -1;
228         }
229         if ((res = fwrite(f->data, 1, f->datalen, fs->f)) != f->datalen) {
230                 ast_log(LOG_WARNING, "Bad write (%d/%d): %s\n", res, f->datalen, strerror(errno));
231                 return -1;
232         }
233         update_header(fs->f);
234         return 0;
235 }
236
237 static int au_seek(struct ast_filestream *fs, off_t sample_offset, int whence)
238 {
239         off_t min, max, cur;
240         unsigned long offset = 0, samples;
241         
242         samples = sample_offset;
243         min = AU_HEADER_SIZE;
244         cur = ftello(fs->f);
245         fseek(fs->f, 0, SEEK_END);
246         max = ftello(fs->f);
247         if (whence == SEEK_SET)
248                 offset = samples + min;
249         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
250                 offset = samples + cur;
251         else if (whence == SEEK_END)
252                 offset = max - samples;
253         if (whence != SEEK_FORCECUR) {
254                 offset = (offset > max) ? max : offset;
255         }
256         /* always protect the header space. */
257         offset = (offset < min) ? min : offset;
258         return fseek(fs->f, offset, SEEK_SET);
259 }
260
261 static int au_trunc(struct ast_filestream *fs)
262 {
263         if (ftruncate(fileno(fs->f), ftello(fs->f)))
264                 return -1;
265         return update_header(fs->f);
266 }
267
268 static off_t au_tell(struct ast_filestream *fs)
269 {
270         off_t offset = ftello(fs->f);
271         return offset - AU_HEADER_SIZE;
272 }
273
274 static struct ast_format_lock me = { .usecnt = -1 };
275
276 static const struct ast_format au_f = {
277         .name = "au",
278         .exts = "au",
279         .format = AST_FORMAT_ULAW,
280         .open = au_open,
281         .rewrite = au_rewrite,
282         .write = au_write,
283         .seek = au_seek,
284         .trunc = au_trunc,
285         .tell = au_tell,
286         .read = au_read,
287         .buf_size = BUF_SIZE + AST_FRIENDLY_OFFSET,     /* this many shorts */
288         .lockp = &me,
289 };
290
291 int load_module()
292 {
293         return ast_format_register(&au_f);
294 }
295
296 int unload_module()
297 {
298         return ast_format_unregister(au_f.name);
299 }
300
301 int usecount()
302 {
303         return me.usecnt;
304 }
305
306 char *description()
307 {
308         return "Sun Microsystems AU format (signed linear)";
309 }
310
311 char *key()
312 {
313         return ASTERISK_GPL_KEY;
314 }