git migration: Refactor the ASTERISK_FILE_VERSION macro
[asterisk/asterisk.git] / apps / app_mp3.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, 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 Silly application to play an MP3 file -- uses mpg123
22  *
23  * \author Mark Spencer <markster@digium.com>
24  *
25  * \note Add feature to play local M3U playlist file
26  * Vincent Li <mchun.li@gmail.com>
27  * 
28  * \ingroup applications
29  */
30
31 /*** MODULEINFO
32         <support_level>extended</support_level>
33  ***/
34  
35 #include "asterisk.h"
36
37 ASTERISK_REGISTER_FILE()
38
39 #include <sys/time.h>
40 #include <signal.h>
41
42 #include "asterisk/lock.h"
43 #include "asterisk/file.h"
44 #include "asterisk/channel.h"
45 #include "asterisk/frame.h"
46 #include "asterisk/pbx.h"
47 #include "asterisk/module.h"
48 #include "asterisk/translate.h"
49 #include "asterisk/app.h"
50 #include "asterisk/format_cache.h"
51
52 #define LOCAL_MPG_123 "/usr/local/bin/mpg123"
53 #define MPG_123 "/usr/bin/mpg123"
54
55 /*** DOCUMENTATION
56         <application name="MP3Player" language="en_US">
57                 <synopsis>
58                         Play an MP3 file or M3U playlist file or stream.
59                 </synopsis>
60                 <syntax>
61                         <parameter name="Location" required="true">
62                                 <para>Location of the file to be played.
63                                 (argument passed to mpg123)</para>
64                         </parameter>
65                 </syntax>
66                 <description>
67                         <para>Executes mpg123 to play the given location, which typically would be a mp3 filename
68                         or m3u playlist filename or a URL. Please read http://en.wikipedia.org/wiki/M3U
69                         to see how M3U playlist file format is like, Example usage would be
70                         exten => 1234,1,MP3Player(/var/lib/asterisk/playlist.m3u)
71                         User can exit by pressing any key on the dialpad, or by hanging up.</para>
72                         <para>This application does not automatically answer and should be preceeded by an
73                         application such as Answer() or Progress().</para>
74                 </description>
75         </application>
76
77  ***/
78 static char *app = "MP3Player";
79
80 static int mp3play(const char *filename, int fd)
81 {
82         int res;
83
84         res = ast_safe_fork(0);
85         if (res < 0) 
86                 ast_log(LOG_WARNING, "Fork failed\n");
87         if (res) {
88                 return res;
89         }
90         if (ast_opt_high_priority)
91                 ast_set_priority(0);
92
93         dup2(fd, STDOUT_FILENO);
94         ast_close_fds_above_n(STDERR_FILENO);
95
96         /* Execute mpg123, but buffer if it's a net connection */
97         if (!strncasecmp(filename, "http://", 7)) {
98                 /* Most commonly installed in /usr/local/bin */
99             execl(LOCAL_MPG_123, "mpg123", "-q", "-s", "-b", "1024", "-f", "8192", "--mono", "-r", "8000", filename, (char *)NULL);
100                 /* But many places has it in /usr/bin */
101             execl(MPG_123, "mpg123", "-q", "-s", "-b", "1024","-f", "8192", "--mono", "-r", "8000", filename, (char *)NULL);
102                 /* As a last-ditch effort, try to use PATH */
103             execlp("mpg123", "mpg123", "-q", "-s", "-b", "1024",  "-f", "8192", "--mono", "-r", "8000", filename, (char *)NULL);
104         }
105         else if (strstr(filename, ".m3u")) {
106                 /* Most commonly installed in /usr/local/bin */
107             execl(LOCAL_MPG_123, "mpg123", "-q", "-z", "-s", "-b", "1024", "-f", "8192", "--mono", "-r", "8000", "-@", filename, (char *)NULL);
108                 /* But many places has it in /usr/bin */
109             execl(MPG_123, "mpg123", "-q", "-z", "-s", "-b", "1024","-f", "8192", "--mono", "-r", "8000", "-@", filename, (char *)NULL);
110                 /* As a last-ditch effort, try to use PATH */
111             execlp("mpg123", "mpg123", "-q", "-z", "-s", "-b", "1024",  "-f", "8192", "--mono", "-r", "8000", "-@", filename, (char *)NULL);
112         }
113         else {
114                 /* Most commonly installed in /usr/local/bin */
115             execl(MPG_123, "mpg123", "-q", "-s", "-f", "8192", "--mono", "-r", "8000", filename, (char *)NULL);
116                 /* But many places has it in /usr/bin */
117             execl(LOCAL_MPG_123, "mpg123", "-q", "-s", "-f", "8192", "--mono", "-r", "8000", filename, (char *)NULL);
118                 /* As a last-ditch effort, try to use PATH */
119             execlp("mpg123", "mpg123", "-q", "-s", "-f", "8192", "--mono", "-r", "8000", filename, (char *)NULL);
120         }
121         /* Can't use ast_log since FD's are closed */
122         fprintf(stderr, "Execute of mpg123 failed\n");
123         _exit(0);
124 }
125
126 static int timed_read(int fd, void *data, int datalen, int timeout)
127 {
128         int res;
129         struct pollfd fds[1];
130         fds[0].fd = fd;
131         fds[0].events = POLLIN;
132         res = ast_poll(fds, 1, timeout);
133         if (res < 1) {
134                 ast_log(LOG_NOTICE, "Poll timed out/errored out with %d\n", res);
135                 return -1;
136         }
137         return read(fd, data, datalen);
138         
139 }
140
141 static int mp3_exec(struct ast_channel *chan, const char *data)
142 {
143         int res=0;
144         int fds[2];
145         int ms = -1;
146         int pid = -1;
147         RAII_VAR(struct ast_format *, owriteformat, NULL, ao2_cleanup);
148         int timeout = 2000;
149         struct timeval next;
150         struct ast_frame *f;
151         struct myframe {
152                 struct ast_frame f;
153                 char offset[AST_FRIENDLY_OFFSET];
154                 short frdata[160];
155         } myf = {
156                 .f = { 0, },
157         };
158
159         if (ast_strlen_zero(data)) {
160                 ast_log(LOG_WARNING, "MP3 Playback requires an argument (filename)\n");
161                 return -1;
162         }
163
164         if (pipe(fds)) {
165                 ast_log(LOG_WARNING, "Unable to create pipe\n");
166                 return -1;
167         }
168         
169         ast_stopstream(chan);
170
171         owriteformat = ao2_bump(ast_channel_writeformat(chan));
172         res = ast_set_write_format(chan, ast_format_slin);
173         if (res < 0) {
174                 ast_log(LOG_WARNING, "Unable to set write format to signed linear\n");
175                 return -1;
176         }
177
178         myf.f.frametype = AST_FRAME_VOICE;
179         myf.f.subclass.format = ast_format_slin;
180         myf.f.mallocd = 0;
181         myf.f.offset = AST_FRIENDLY_OFFSET;
182         myf.f.src = __PRETTY_FUNCTION__;
183         myf.f.delivery.tv_sec = 0;
184         myf.f.delivery.tv_usec = 0;
185         myf.f.data.ptr = myf.frdata;
186         
187         res = mp3play(data, fds[1]);
188         if (!strncasecmp(data, "http://", 7)) {
189                 timeout = 10000;
190         }
191         /* Wait 1000 ms first */
192         next = ast_tvnow();
193         next.tv_sec += 1;
194         if (res >= 0) {
195                 pid = res;
196                 /* Order is important -- there's almost always going to be mp3...  we want to prioritize the
197                    user */
198                 for (;;) {
199                         ms = ast_tvdiff_ms(next, ast_tvnow());
200                         if (ms <= 0) {
201                                 res = timed_read(fds[0], myf.frdata, sizeof(myf.frdata), timeout);
202                                 if (res > 0) {
203                                         myf.f.datalen = res;
204                                         myf.f.samples = res / 2;
205                                         if (ast_write(chan, &myf.f) < 0) {
206                                                 res = -1;
207                                                 break;
208                                         }
209                                 } else {
210                                         ast_debug(1, "No more mp3\n");
211                                         res = 0;
212                                         break;
213                                 }
214                                 next = ast_tvadd(next, ast_samp2tv(myf.f.samples, 8000));
215                         } else {
216                                 ms = ast_waitfor(chan, ms);
217                                 if (ms < 0) {
218                                         ast_debug(1, "Hangup detected\n");
219                                         res = -1;
220                                         break;
221                                 }
222                                 if (ms) {
223                                         f = ast_read(chan);
224                                         if (!f) {
225                                                 ast_debug(1, "Null frame == hangup() detected\n");
226                                                 res = -1;
227                                                 break;
228                                         }
229                                         if (f->frametype == AST_FRAME_DTMF) {
230                                                 ast_debug(1, "User pressed a key\n");
231                                                 ast_frfree(f);
232                                                 res = 0;
233                                                 break;
234                                         }
235                                         ast_frfree(f);
236                                 } 
237                         }
238                 }
239         }
240         close(fds[0]);
241         close(fds[1]);
242         
243         if (pid > -1)
244                 kill(pid, SIGKILL);
245         if (!res && owriteformat)
246                 ast_set_write_format(chan, owriteformat);
247
248         ast_frfree(&myf.f);
249         
250         return res;
251 }
252
253 static int unload_module(void)
254 {
255         return ast_unregister_application(app);
256 }
257
258 static int load_module(void)
259 {
260         return ast_register_application_xml(app, mp3_exec);
261 }
262
263 AST_MODULE_INFO_STANDARD_EXTENDED(ASTERISK_GPL_KEY, "Silly MP3 Application");
264