Merge "Revert "AGI: Only defer frames when in an interception routine.""
[asterisk/asterisk.git] / addons / format_mp3.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Anthony Minessale <anthmct@yahoo.com>
5  *
6  * Derived from other asterisk sound formats by
7  * Mark Spencer <markster@linux-support.net>
8  *
9  * Thanks to mpglib from http://www.mpg123.org/
10  * and Chris Stenton [jacs@gnome.co.uk]
11  * for coding the ability to play stereo and non-8khz files
12
13  * See http://www.asterisk.org for more information about
14  * the Asterisk project. Please do not directly contact
15  * any of the maintainers of this project for assistance;
16  * the project provides a web site, mailing lists and IRC
17  * channels for your use.
18  *
19  * This program is free software, distributed under the terms of
20  * the GNU General Public License Version 2. See the LICENSE file
21  * at the top of the source tree.
22  */
23
24 /*!
25  * \file
26  * \brief MP3 Format Handler
27  * \ingroup formats
28  */
29
30 /*** MODULEINFO
31         <defaultenabled>no</defaultenabled>
32         <support_level>extended</support_level>
33  ***/
34
35 #include "asterisk.h"
36
37 #include "mp3/mpg123.h"
38 #include "mp3/mpglib.h"
39
40 #include "asterisk/module.h"
41 #include "asterisk/mod_format.h"
42 #include "asterisk/logger.h"
43 #include "asterisk/format_cache.h"
44
45 #define MP3_BUFLEN 320
46 #define MP3_SCACHE 16384
47 #define MP3_DCACHE 8192
48
49 struct mp3_private {
50         /*! state for the mp3 decoder */
51         struct mpstr mp;
52         /*! buffer to hold mp3 data after read from disk */
53         char sbuf[MP3_SCACHE];
54         /*! buffer for slinear audio after being decoded out of sbuf */
55         char dbuf[MP3_DCACHE];
56         /*! how much data has been written to the output buffer in the ast_filestream */
57         int buflen;
58         /*! how much data has been written to sbuf */
59         int sbuflen;
60         /*! how much data is left to be read out of dbuf, starting at dbufoffset */
61         int dbuflen;
62         /*! current offset for reading data out of dbuf */
63         int dbufoffset;
64         int offset;
65         long seek;
66 };
67
68 static const char name[] = "mp3";
69
70 #define BLOCKSIZE 160
71 #define OUTSCALE 4096
72
73 #define GAIN -4         /* 2^GAIN is the multiple to increase the volume by */
74
75 #if __BYTE_ORDER == __LITTLE_ENDIAN
76 #define htoll(b) (b)
77 #define htols(b) (b)
78 #define ltohl(b) (b)
79 #define ltohs(b) (b)
80 #else
81 #if __BYTE_ORDER == __BIG_ENDIAN
82 #define htoll(b)  \
83           (((((b)      ) & 0xFF) << 24) | \
84                ((((b) >>  8) & 0xFF) << 16) | \
85                    ((((b) >> 16) & 0xFF) <<  8) | \
86                    ((((b) >> 24) & 0xFF)      ))
87 #define htols(b) \
88           (((((b)      ) & 0xFF) << 8) | \
89                    ((((b) >> 8) & 0xFF)      ))
90 #define ltohl(b) htoll(b)
91 #define ltohs(b) htols(b)
92 #else
93 #error "Endianess not defined"
94 #endif
95 #endif
96
97
98 static int mp3_open(struct ast_filestream *s)
99 {
100         struct mp3_private *p = s->_private;
101         InitMP3(&p->mp, OUTSCALE);
102         return 0;
103 }
104
105
106 static void mp3_close(struct ast_filestream *s)
107 {
108         struct mp3_private *p = s->_private;
109
110         ExitMP3(&p->mp);
111         return;
112 }
113
114 static int mp3_squeue(struct ast_filestream *s)
115 {
116         struct mp3_private *p = s->_private;
117         int res=0;
118
119         res = ftell(s->f);
120         p->sbuflen = fread(p->sbuf, 1, MP3_SCACHE, s->f);
121         if(p->sbuflen < 0) {
122                 ast_log(LOG_WARNING, "Short read (%d) (%s)!\n", p->sbuflen, strerror(errno));
123                 return -1;
124         }
125         res = decodeMP3(&p->mp,p->sbuf,p->sbuflen,p->dbuf,MP3_DCACHE,&p->dbuflen);
126         if(res != MP3_OK)
127                 return -1;
128         p->sbuflen -= p->dbuflen;
129         p->dbufoffset = 0;
130         return 0;
131 }
132
133 static int mp3_dqueue(struct ast_filestream *s)
134 {
135         struct mp3_private *p = s->_private;
136         int res=0;
137
138         if((res = decodeMP3(&p->mp,NULL,0,p->dbuf,MP3_DCACHE,&p->dbuflen)) == MP3_OK) {
139                 p->sbuflen -= p->dbuflen;
140                 p->dbufoffset = 0;
141         }
142         return res;
143 }
144
145 static int mp3_queue(struct ast_filestream *s)
146 {
147         struct mp3_private *p = s->_private;
148         int res = 0, bytes = 0;
149
150         if(p->seek) {
151                 ExitMP3(&p->mp);
152                 InitMP3(&p->mp, OUTSCALE);
153                 fseek(s->f, 0, SEEK_SET);
154                 p->sbuflen = p->dbuflen = p->offset = 0;
155                 while(p->offset < p->seek) {
156                         if(mp3_squeue(s))
157                                 return -1;
158                         while(p->offset < p->seek && ((res = mp3_dqueue(s))) == MP3_OK) {
159                                 for(bytes = 0 ; bytes < p->dbuflen ; bytes++) {
160                                         p->dbufoffset++;
161                                         p->offset++;
162                                         if(p->offset >= p->seek)
163                                                 break;
164                                 }
165                         }
166                         if(res == MP3_ERR)
167                                 return -1;
168                 }
169
170                 p->seek = 0;
171                 return 0;
172         }
173         if(p->dbuflen == 0) {
174                 if(p->sbuflen) {
175                         res = mp3_dqueue(s);
176                         if(res == MP3_ERR)
177                                 return -1;
178                 }
179                 if(! p->sbuflen || res != MP3_OK) {
180                         if(mp3_squeue(s))
181                                 return -1;
182                 }
183
184         }
185
186         return 0;
187 }
188
189 static struct ast_frame *mp3_read(struct ast_filestream *s, int *whennext)
190 {
191
192         struct mp3_private *p = s->_private;
193         int delay =0;
194         int save=0;
195
196         /* Pre-populate the buffer that holds audio to be returned (dbuf) */
197         if (mp3_queue(s)) {
198                 return NULL;
199         }
200
201         if (p->dbuflen) {
202                 /* Read out what's waiting in dbuf */
203                 for (p->buflen = 0; p->buflen < MP3_BUFLEN && p->buflen < p->dbuflen; p->buflen++) {
204                         s->buf[p->buflen + AST_FRIENDLY_OFFSET] = p->dbuf[p->buflen + p->dbufoffset];
205                 }
206                 p->dbufoffset += p->buflen;
207                 p->dbuflen -= p->buflen;
208         }
209
210         if (p->buflen < MP3_BUFLEN) {
211                 /* dbuf didn't have enough, so reset dbuf, fill it back up and continue */
212                 p->dbuflen = p->dbufoffset = 0;
213
214                 if (mp3_queue(s)) {
215                         return NULL;
216                 }
217
218                 /* Make sure dbuf has enough to complete this read attempt */
219                 if (p->dbuflen >= (MP3_BUFLEN - p->buflen)) {
220                         for (save = p->buflen; p->buflen < MP3_BUFLEN; p->buflen++) {
221                                 s->buf[p->buflen + AST_FRIENDLY_OFFSET] = p->dbuf[(p->buflen - save) + p->dbufoffset];
222                         }
223                         p->dbufoffset += (MP3_BUFLEN - save);
224                         p->dbuflen -= (MP3_BUFLEN - save);
225                 }
226
227         }
228
229         p->offset += p->buflen;
230         delay = p->buflen / 2;
231         AST_FRAME_SET_BUFFER(&s->fr, s->buf, AST_FRIENDLY_OFFSET, p->buflen);
232         s->fr.samples = delay;
233         *whennext = delay;
234         return &s->fr;
235 }
236
237
238 static int mp3_write(struct ast_filestream *fs, struct ast_frame *f)
239 {
240         ast_log(LOG_ERROR,"I Can't write MP3 only read them.\n");
241         return -1;
242
243 }
244
245
246 static int mp3_seek(struct ast_filestream *s, off_t sample_offset, int whence)
247 {
248         struct mp3_private *p = s->_private;
249         off_t min,max,cur;
250         long offset=0,samples;
251         samples = sample_offset * 2;
252
253         min = 0;
254         fseek(s->f, 0, SEEK_END);
255         max = ftell(s->f) * 100;
256         cur = p->offset;
257
258         if (whence == SEEK_SET)
259                 offset = samples + min;
260         else if (whence == SEEK_CUR || whence == SEEK_FORCECUR)
261                 offset = samples + cur;
262         else if (whence == SEEK_END)
263                 offset = max - samples;
264         if (whence != SEEK_FORCECUR) {
265                 offset = (offset > max)?max:offset;
266         }
267
268         p->seek = offset;
269         return fseek(s->f, offset, SEEK_SET);
270
271 }
272
273 static int mp3_rewrite(struct ast_filestream *s, const char *comment)
274 {
275         ast_log(LOG_ERROR,"I Can't write MP3 only read them.\n");
276         return -1;
277 }
278
279 static int mp3_trunc(struct ast_filestream *s)
280 {
281
282         ast_log(LOG_ERROR,"I Can't write MP3 only read them.\n");
283         return -1;
284 }
285
286 static off_t mp3_tell(struct ast_filestream *s)
287 {
288         struct mp3_private *p = s->_private;
289
290         return p->offset/2;
291 }
292
293 static char *mp3_getcomment(struct ast_filestream *s)
294 {
295         return NULL;
296 }
297
298 static struct ast_format_def mp3_f = {
299         .name = "mp3",
300         .exts = "mp3",
301         .open = mp3_open,
302         .write = mp3_write,
303         .rewrite = mp3_rewrite,
304         .seek = mp3_seek,
305         .trunc = mp3_trunc,
306         .tell = mp3_tell,
307         .read = mp3_read,
308         .close = mp3_close,
309         .getcomment = mp3_getcomment,
310         .buf_size = MP3_BUFLEN + AST_FRIENDLY_OFFSET,
311         .desc_size = sizeof(struct mp3_private),
312 };
313
314
315 static int load_module(void)
316 {
317         mp3_f.format = ast_format_slin;
318         InitMP3Constants();
319         return ast_format_def_register(&mp3_f);
320 }
321
322 static int unload_module(void)
323 {
324         return ast_format_def_unregister(name);
325 }
326
327 AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "MP3 format [Any rate but 8000hz mono is optimal]");
328