Doxygen documentation update from oej (issue #5505)
[asterisk/asterisk.git] / apps / app_ices.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 Stream to an icecast server via ICES (see contrib/asterisk-ices.xml)
22  * 
23  */
24  
25 #include <string.h>
26 #include <stdio.h>
27 #include <signal.h>
28 #include <stdlib.h>
29 #include <unistd.h>
30 #include <fcntl.h>
31 #include <sys/time.h>
32 #include <errno.h>
33
34 #include "asterisk.h"
35
36 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
37
38 #include "asterisk/lock.h"
39 #include "asterisk/file.h"
40 #include "asterisk/logger.h"
41 #include "asterisk/channel.h"
42 #include "asterisk/frame.h"
43 #include "asterisk/pbx.h"
44 #include "asterisk/module.h"
45 #include "asterisk/translate.h"
46
47 #define ICES "/usr/bin/ices"
48 #define LOCAL_ICES "/usr/local/bin/ices"
49
50 static char *tdesc = "Encode and Stream via icecast and ices";
51
52 static char *app = "ICES";
53
54 static char *synopsis = "Encode and stream using 'ices'";
55
56 static char *descrip = 
57 "  ICES(config.xml) Streams to an icecast server using ices\n"
58 "(available separately).  A configuration file must be supplied\n"
59 "for ices (see examples/asterisk-ices.conf).  Returns  -1  on\n"
60 "hangup or 0 otherwise.\n";
61
62 STANDARD_LOCAL_USER;
63
64 LOCAL_USER_DECL;
65
66 static int icesencode(char *filename, int fd)
67 {
68         int res;
69         int x;
70         res = fork();
71         if (res < 0) 
72                 ast_log(LOG_WARNING, "Fork failed\n");
73         if (res)
74                 return res;
75         dup2(fd, STDIN_FILENO);
76         for (x=STDERR_FILENO + 1;x<256;x++) {
77                 if ((x != STDIN_FILENO) && (x != STDOUT_FILENO))
78                         close(x);
79         }
80         /* Most commonly installed in /usr/local/bin */
81         execl(ICES, "ices", filename, (char *)NULL);
82         /* But many places has it in /usr/bin */
83         execl(LOCAL_ICES, "ices", filename, (char *)NULL);
84         /* As a last-ditch effort, try to use PATH */
85         execlp("ices", "ices", filename, (char *)NULL);
86         ast_log(LOG_WARNING, "Execute of ices failed\n");
87         return -1;
88 }
89
90 static int ices_exec(struct ast_channel *chan, void *data)
91 {
92         int res=0;
93         struct localuser *u;
94         int fds[2];
95         int ms = -1;
96         int pid = -1;
97         int flags;
98         int oreadformat;
99         struct timeval last;
100         struct ast_frame *f;
101         char filename[256]="";
102         char *c;
103
104         if (!data || ast_strlen_zero(data)) {
105                 ast_log(LOG_WARNING, "ICES requires an argument (configfile.xml)\n");
106                 return -1;
107         }
108
109         LOCAL_USER_ADD(u);
110         
111         last = ast_tv(0, 0);
112         
113         if (pipe(fds)) {
114                 ast_log(LOG_WARNING, "Unable to create pipe\n");
115                 LOCAL_USER_REMOVE(u);
116                 return -1;
117         }
118         flags = fcntl(fds[1], F_GETFL);
119         fcntl(fds[1], F_SETFL, flags | O_NONBLOCK);
120         
121         ast_stopstream(chan);
122
123         if (chan->_state != AST_STATE_UP)
124                 res = ast_answer(chan);
125                 
126         if (res) {
127                 close(fds[0]);
128                 close(fds[1]);
129                 ast_log(LOG_WARNING, "Answer failed!\n");
130                 LOCAL_USER_REMOVE(u);
131                 return -1;
132         }
133
134         oreadformat = chan->readformat;
135         res = ast_set_read_format(chan, AST_FORMAT_SLINEAR);
136         if (res < 0) {
137                 close(fds[0]);
138                 close(fds[1]);
139                 ast_log(LOG_WARNING, "Unable to set write format to signed linear\n");
140                 LOCAL_USER_REMOVE(u);
141                 return -1;
142         }
143         if (((char *)data)[0] == '/')
144                 strncpy(filename, (char *)data, sizeof(filename) - 1);
145         else
146                 snprintf(filename, sizeof(filename), "%s/%s", (char *)ast_config_AST_CONFIG_DIR, (char *)data);
147         /* Placeholder for options */           
148         c = strchr(filename, '|');
149         if (c)
150                 *c = '\0';      
151         res = icesencode(filename, fds[0]);
152         close(fds[0]);
153         if (res >= 0) {
154                 pid = res;
155                 for (;;) {
156                         /* Wait for audio, and stream */
157                         ms = ast_waitfor(chan, -1);
158                         if (ms < 0) {
159                                 ast_log(LOG_DEBUG, "Hangup detected\n");
160                                 res = -1;
161                                 break;
162                         }
163                         f = ast_read(chan);
164                         if (!f) {
165                                 ast_log(LOG_DEBUG, "Null frame == hangup() detected\n");
166                                 res = -1;
167                                 break;
168                         }
169                         if (f->frametype == AST_FRAME_VOICE) {
170                                 res = write(fds[1], f->data, f->datalen);
171                                 if (res < 0) {
172                                         if (errno != EAGAIN) {
173                                                 ast_log(LOG_WARNING, "Write failed to pipe: %s\n", strerror(errno));
174                                                 res = -1;
175                                                 break;
176                                         }
177                                 }
178                         }
179                         ast_frfree(f);
180                 }
181         }
182         close(fds[1]);
183         
184         if (pid > -1)
185                 kill(pid, SIGKILL);
186         if (!res && oreadformat)
187                 ast_set_read_format(chan, oreadformat);
188
189         LOCAL_USER_REMOVE(u);
190
191         return res;
192 }
193
194 int unload_module(void)
195 {
196         int res;
197
198         res = ast_unregister_application(app);
199
200         STANDARD_HANGUP_LOCALUSERS;
201
202         return res;
203 }
204
205 int load_module(void)
206 {
207         return ast_register_application(app, ices_exec, synopsis, descrip);
208 }
209
210 char *description(void)
211 {
212         return tdesc;
213 }
214
215 int usecount(void)
216 {
217         int res;
218         STANDARD_USECOUNT(res);
219         return res;
220 }
221
222 char *key()
223 {
224         return ASTERISK_GPL_KEY;
225 }