Version 0.1.12 from FTP
[asterisk/asterisk.git] / res / res_musiconhold.c
1 /*
2  * Asterisk -- A telephony toolkit for Linux.
3  *
4  * Routines implementing call parking
5  * 
6  * Copyright (C) 1999, Mark Spencer
7  *
8  * Mark Spencer <markster@linux-support.net>
9  *
10  * This program is free software, distributed under the terms of
11  * the GNU General Public License
12  */
13
14 #include <asterisk/lock.h>
15 #include <asterisk/file.h>
16 #include <asterisk/logger.h>
17 #include <asterisk/channel.h>
18 #include <asterisk/pbx.h>
19 #include <asterisk/options.h>
20 #include <asterisk/module.h>
21 #include <asterisk/translate.h>
22 #include <asterisk/say.h>
23 #include <asterisk/channel_pvt.h>
24 #include <asterisk/musiconhold.h>
25 #include <asterisk/config.h>
26 #include <stdlib.h>
27 #include <errno.h>
28 #include <unistd.h>
29 #include <string.h>
30 #include <stdlib.h>
31 #include <stdio.h>
32 #include <sys/time.h>
33 #include <sys/signal.h>
34 #include <netinet/in.h>
35 #include <sys/stat.h>
36 #include <dirent.h>
37 #ifdef ZAPATA_MOH
38 #include <linux/zaptel.h>
39 #endif
40 #include <unistd.h>
41 #include <sys/ioctl.h>
42 #include <sys/wait.h>
43
44 #include <pthread.h>
45
46 static char *app0 = "MusicOnHold";
47 static char *app1 = "WaitMusicOnHold";
48 static char *app2 = "SetMusicOnHold";
49
50 static char *synopsis0 = "Play Music On Hold indefinitely";
51 static char *synopsis1 = "Wait, playing Music On Hold";
52 static char *synopsis2 = "Set default Music On Hold class";
53
54 static char *descrip0 = "MusicOnHold(class): "
55 "Plays hold music specified by class.  If omitted, the default\n"
56 "music source for the channel will be used.  Returns -1 on hangup.\n"
57 "Never returns otherwise.\n";
58
59 static char *descrip1 = "WaitMusicOnHold(delay): "
60 "Plays hold music specified number of seconds.  Returns 0 when\n"
61 "done, or -1 on hangup.  If no hold music is available, the delay will\n"
62 "still occur with no sound.\n";
63
64 static char *descrip2 = "SetMusicOnHold(class): "
65 "Sets the default class for music on hold for a given channel.  When\n"
66 "music on hold is activated, this class will be used to select which\n"
67 "music is played.\n";
68
69 struct mohclass {
70         char class[80];
71         char dir[256];
72         char miscargs[256];
73         int destroyme;
74         int pid;                /* PID of mpg123 */
75         int quiet;
76         pthread_t thread;
77         struct mohdata *members;
78         /* Source of audio */
79         int srcfd;
80         /* FD for timing source */
81         int pseudofd;
82         struct mohclass *next;
83 };
84
85 struct mohdata {
86         int pipe[2];
87         int origrfmt;
88         int origwfmt;
89         struct mohclass *parent;
90         struct mohdata *next;
91 };
92
93 static struct mohclass *mohclasses;
94
95 static pthread_mutex_t moh_lock = AST_MUTEX_INITIALIZER;
96
97 #define MPG_123 "/usr/bin/mpg123"
98 #define MAX_MP3S 256
99
100 static void child_handler(int sig)
101 {
102         int status;
103         if (wait4(-1,&status, WNOHANG, NULL)<1)         
104                 ast_log(LOG_NOTICE, "Huh?  Child handler, but nobody there?\n");
105 }
106
107 static int spawn_mp3(struct mohclass *class)
108 {
109         int fds[2];
110         int files;
111         char fns[80][MAX_MP3S];
112         char *argv[MAX_MP3S + 50];
113         char xargs[256];
114         char *argptr;
115         int argc;
116         DIR *dir;
117         struct dirent *de;
118         dir = opendir(class->dir);
119         if (!dir) {
120                 ast_log(LOG_WARNING, "%s is not a valid directory\n", class->dir);
121                 return -1;
122         }
123         argv[0] = MPG_123;
124         argv[1] = "-q";
125         argv[2] = "-s";
126         argv[3] = "--mono";
127         argv[4] = "-r";
128         argv[5] = "8000";
129         argc = 6;
130         if (class->quiet) {
131                 argv[argc++] = "-f";
132                 argv[argc++] = "8192";
133         }
134
135         /* Look for extra arguments and add them to the list */
136         strncpy(xargs, class->miscargs, sizeof(xargs) - 1);
137         argptr = xargs;
138         while(argptr && strlen(argptr)) {
139                 argv[argc++] = argptr;
140                 argptr = strchr(argptr, ',');
141                 if (argptr) {
142                         *argptr = '\0';
143                         argptr++;
144                 }
145         }
146
147         files = 0;
148         while((de = readdir(dir)) && (files < MAX_MP3S)) {
149                 if ((strlen(de->d_name) > 3) && !strcasecmp(de->d_name + strlen(de->d_name) - 4, ".mp3")) {
150                         strncpy(fns[files], de->d_name, sizeof(fns[files]));
151                         argv[argc++] = fns[files];
152                         files++;
153                 }
154         }
155         argv[argc] = NULL;
156         closedir(dir);
157         if (pipe(fds)) {        
158                 ast_log(LOG_WARNING, "Pipe failed\n");
159                 return -1;
160         }
161 #if 0
162         printf("%d files total, %d args total\n", files, argc);
163         {
164                 int x;
165                 for (x=0;argv[x];x++)
166                         printf("arg%d: %s\n", x, argv[x]);
167         }
168 #endif  
169         if (!files) {
170                 ast_log(LOG_WARNING, "Found no files in '%s'\n", class->dir);
171                 return -1;
172         }
173         class->pid = fork();
174         if (class->pid < 0) {
175                 close(fds[0]);
176                 close(fds[1]);
177                 ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
178                 return -1;
179         }
180         if (!class->pid) {
181                 int x;
182                 close(fds[0]);
183                 /* Stdout goes to pipe */
184                 dup2(fds[1], STDOUT_FILENO);
185                 /* Close unused file descriptors */
186                 for (x=3;x<8192;x++)
187                         close(x);
188                 /* Child */
189                 chdir(class->dir);
190                 execv(MPG_123, argv);
191                 ast_log(LOG_WARNING, "Exec failed: %s\n", strerror(errno));
192                 exit(1);
193         } else {
194                 /* Parent */
195                 close(fds[1]);
196         }
197         return fds[0];
198 }
199
200 static void *monmp3thread(void *data)
201 {
202         struct mohclass *class = data;
203         struct mohdata *moh;
204         char buf[8192];
205         short sbuf[8192];
206         int res, res2;
207         signal(SIGCHLD, child_handler);
208         for(;/* ever */;) {
209                 /* Spawn mp3 player if it's not there */
210                 if (class->srcfd < 0)  {
211                         if ((class->srcfd = spawn_mp3(class)) < 0) {
212                                 ast_log(LOG_WARNING, "unable to spawn mp3player\n");
213                                 /* Try again later */
214                                 sleep(500);
215                         }
216                 }
217                 if (class->pseudofd > -1) {
218                         /* Pause some amount of time */
219                         res = read(class->pseudofd, buf, sizeof(buf));
220                 } else {
221                         /* otherwise just sleep (unreliable) */
222                         usleep(250000);
223                         res = 2000;
224                 }
225                 if (!class->members)
226                         continue;
227                 /* Read mp3 audio */
228                 if ((res2 = read(class->srcfd, sbuf, res * 2)) != res * 2) {
229                         if (!res2) {
230                                 close(class->srcfd);
231                                 class->srcfd = -1;
232                                 if (class->pid) {
233                                         kill(class->pid, SIGKILL);
234                                         class->pid = 0;
235                                 }
236                         } else
237                                 ast_log(LOG_DEBUG, "Read %d bytes of audio while expecting %d\n", res2, res * 2);
238                         continue;
239                 }
240                 ast_pthread_mutex_lock(&moh_lock);
241                 moh = class->members;
242                 while(moh) {
243                         /* Write data */
244                         if ((res = write(moh->pipe[1], sbuf, res2)) != res2) 
245                                 if (option_debug)
246                                     ast_log(LOG_DEBUG, "Only wrote %d of %d bytes to pipe\n", res, res2);
247                         moh = moh->next;
248                 }
249                 pthread_mutex_unlock(&moh_lock);
250         }
251         return NULL;
252 }
253
254 static int moh0_exec(struct ast_channel *chan, void *data)
255 {
256         if (ast_moh_start(chan, data)) {
257                 ast_log(LOG_WARNING, "Unable to start music on hold (class '%s') on channel %s\n", (char *)data, chan->name);
258                 return -1;
259         }
260         while(!ast_safe_sleep(chan, 10000));
261         return -1;
262 }
263
264 static int moh1_exec(struct ast_channel *chan, void *data)
265 {
266         int res;
267         if (!data || !atoi(data)) {
268                 ast_log(LOG_WARNING, "WaitMusicOnHold requires an argument (number of seconds to wait)\n");
269                 return -1;
270         }
271         if (ast_moh_start(chan, NULL)) {
272                 ast_log(LOG_WARNING, "Unable to start music on hold (class '%s') on channel %s\n", (char *)data, chan->name);
273                 return -1;
274         }
275         res = ast_safe_sleep(chan, atoi(data) * 1000);
276         ast_moh_stop(chan);
277         return res;
278 }
279
280 static int moh2_exec(struct ast_channel *chan, void *data)
281 {
282         if (!data || !strlen(data)) {
283                 ast_log(LOG_WARNING, "SetMusicOnHold requires an argument (class)\n");
284                 return -1;
285         }
286         strncpy(chan->musicclass, data, sizeof(chan->musicclass));
287         return 0;
288 }
289
290 static struct mohclass *get_mohbyname(char *name)
291 {
292         struct mohclass *moh;
293         moh = mohclasses;
294         while(moh) {
295                 if (!strcasecmp(name, moh->class))
296                         return moh;
297                 moh = moh->next;
298         }
299         return NULL;
300 }
301
302 static struct mohdata *mohalloc(struct mohclass *cl)
303 {
304         struct mohdata *moh;
305         long flags;
306         moh = malloc(sizeof(struct mohdata));
307         if (!moh)
308                 return NULL;
309         memset(moh, 0, sizeof(struct mohdata));
310         if (pipe(moh->pipe)) {
311                 ast_log(LOG_WARNING, "Failed to create pipe: %s\n", strerror(errno));
312                 free(moh);
313                 return NULL;
314         }
315         /* Make entirely non-blocking */
316         flags = fcntl(moh->pipe[0], F_GETFL);
317         fcntl(moh->pipe[0], F_SETFL, flags | O_NONBLOCK);
318         flags = fcntl(moh->pipe[1], F_GETFL);
319         fcntl(moh->pipe[1], F_SETFL, flags | O_NONBLOCK);
320         moh->parent = cl;
321         moh->next = cl->members;
322         cl->members = moh;
323         return moh;
324 }
325
326 static void moh_release(struct ast_channel *chan, void *data)
327 {
328         struct mohdata *moh = data, *prev, *cur;
329         int oldrfmt, oldwfmt;
330         ast_pthread_mutex_lock(&moh_lock);
331         /* Unlink */
332         prev = NULL;
333         cur = moh->parent->members;
334         while(cur) {
335                 if (cur == moh) {
336                         if (prev)
337                                 prev->next = cur->next;
338                         else
339                                 moh->parent->members = cur->next;
340                         break;
341                 }
342                 prev = cur;
343                 cur = cur->next;
344         }
345         ast_pthread_mutex_unlock(&moh_lock);
346         close(moh->pipe[0]);
347         close(moh->pipe[1]);
348         oldrfmt = moh->origrfmt;
349         oldwfmt = moh->origwfmt;
350         free(moh);
351         if (chan) {
352                 if (ast_set_write_format(chan, oldwfmt) ||
353                     ast_set_read_format(chan, oldrfmt)) 
354                         ast_log(LOG_WARNING, "Unable to restore channel '%s' to format %d/%d\n", chan->name, oldwfmt, oldrfmt);
355                 if (option_verbose > 2)
356                         ast_verbose(VERBOSE_PREFIX_3 "Stopped music on hold on %s\n", chan->name);
357         }
358 }
359
360 static void *moh_alloc(struct ast_channel *chan, void *params)
361 {
362         struct mohdata *res;
363         struct mohclass *class;
364         ast_pthread_mutex_lock(&moh_lock);
365         class = get_mohbyname(params);
366         if (class)
367                 res = mohalloc(class);
368         else {
369                 if (strcasecmp(params, "default"))
370                         ast_log(LOG_WARNING, "No class: %s\n", (char *)params);
371                 res = NULL;
372         }
373         ast_pthread_mutex_unlock(&moh_lock);
374         if (res) {
375                 res->origrfmt = chan->readformat;
376                 res->origwfmt = chan->writeformat;
377                 if (ast_set_write_format(chan, AST_FORMAT_SLINEAR)) {
378                         ast_log(LOG_WARNING, "Unable to set '%s' to signed linear format\n", chan->name);
379                         moh_release(NULL, res);
380                         res = NULL;
381                 } else if (ast_set_read_format(chan, AST_FORMAT_SLINEAR)) {
382                         ast_log(LOG_WARNING, "Unable to set '%s' to signed linear format\n", chan->name);
383                         moh_release(NULL, res);
384                         res = NULL;
385                 }
386                 /* Allow writes to interrupt */
387                 chan->writeinterrupt = 1;
388                 if (option_verbose > 2)
389                         ast_verbose(VERBOSE_PREFIX_3 "Started music on hold, class '%s', on %s\n", (char *)params, chan->name);
390         }
391         return res;
392 }
393
394 static int moh_generate(struct ast_channel *chan, void *data, int len)
395 {
396         struct ast_frame f;
397         struct mohdata *moh = data;
398         short buf[640 + AST_FRIENDLY_OFFSET / 2];
399         int res;
400         if (len > sizeof(buf)) {
401                 ast_log(LOG_WARNING, "Only doing %d of %d requested bytes on %s\n", sizeof(buf), len, chan->name);
402                 len = sizeof(buf);
403         }
404         res = read(moh->pipe[0], buf + AST_FRIENDLY_OFFSET/2, len);
405 #if 0
406         if (res != len) {
407                 ast_log(LOG_WARNING, "Read only %d of %d bytes: %s\n", res, len, strerror(errno));
408         }
409 #endif
410         if (res > 0) {
411                 memset(&f, 0, sizeof(f));
412                 f.frametype = AST_FRAME_VOICE;
413                 f.subclass = AST_FORMAT_SLINEAR;
414                 f.mallocd = 0;
415                 f.datalen = res;
416                 f.timelen = res / 8;
417                 f.data = buf + AST_FRIENDLY_OFFSET / 2;
418                 f.offset = AST_FRIENDLY_OFFSET;
419                 if (ast_write(chan, &f)< 0) {
420                         ast_log(LOG_WARNING, "Failed to write frame to '%s': %s\n", chan->name, strerror(errno));
421                         return -1;
422                 }
423         }
424         return 0;
425 }
426
427 static struct ast_generator mohgen = 
428 {
429         alloc: moh_alloc,
430         release: moh_release,
431         generate: moh_generate,
432 };
433
434 static int moh_register(char *classname, char *mode, char *param, char *miscargs)
435 {
436         struct mohclass *moh;
437         int x;
438         ast_pthread_mutex_lock(&moh_lock);
439         moh = get_mohbyname(classname);
440         ast_pthread_mutex_unlock(&moh_lock);
441         if (moh) {
442                 ast_log(LOG_WARNING, "Music on Hold '%s' already exists\n", classname);
443                 return -1;
444         }
445         moh = malloc(sizeof(struct mohclass));
446         if (!moh)
447                 return -1;
448         memset(moh, 0, sizeof(struct mohclass));
449
450         strncpy(moh->class, classname, sizeof(moh->class) - 1);
451         if (miscargs)
452                 strncpy(moh->miscargs, miscargs, sizeof(moh->miscargs) - 1);
453         if (!strcasecmp(mode, "mp3") || !strcasecmp(mode, "quietmp3") || !strcasecmp(mode, "httpmp3")) {
454                 if (!strcasecmp(mode, "quietmp3"))
455                         moh->quiet = 1;
456                 strncpy(moh->dir, param, sizeof(moh->dir));
457                 moh->srcfd = -1;
458 #ifdef ZAPATA_MOH
459                 /* It's an MP3 Moh -- Open /dev/zap/pseudo for timing...  Is
460                    there a better, yet reliable way to do this? */
461                 moh->pseudofd = open("/dev/zap/pseudo", O_RDONLY);
462                 if (moh->pseudofd < 0) {
463                         ast_log(LOG_WARNING, "Unable to open pseudo channel for timing...  Sound may be choppy.\n");
464                 } else {
465                         x = 320;
466                         ioctl(moh->pseudofd, ZT_SET_BLOCKSIZE, &x);
467                 }
468 #else
469                 moh->pseudofd = -1;
470 #endif
471                 if (pthread_create(&moh->thread, NULL, monmp3thread, moh)) {
472                         ast_log(LOG_WARNING, "Unable to create moh...\n");
473                         if (moh->pseudofd > -1)
474                                 close(moh->pseudofd);
475                         free(moh);
476                         return -1;
477                 }
478         } else {
479                 ast_log(LOG_WARNING, "Don't know how to do a mode '%s' music on hold\n", mode);
480                 free(moh);
481                 return -1;
482         }
483         ast_pthread_mutex_lock(&moh_lock);
484         moh->next = mohclasses;
485         mohclasses = moh;
486         ast_pthread_mutex_unlock(&moh_lock);
487         return 0;
488 }
489
490 int ast_moh_start(struct ast_channel *chan, char *class)
491 {
492         if (!class || !strlen(class))
493                 class = chan->musicclass;
494         if (!class || !strlen(class))
495                 class = "default";
496         return ast_activate_generator(chan, &mohgen, class);
497 }
498
499 void ast_moh_stop(struct ast_channel *chan)
500 {
501         ast_deactivate_generator(chan);
502 }
503
504 static void load_moh_classes(void)
505 {
506         struct ast_config *cfg;
507         struct ast_variable *var;
508         char *data;
509         char *args;
510         cfg = ast_load("musiconhold.conf");
511         if (cfg) {
512                 var = ast_variable_browse(cfg, "classes");
513                 while(var) {
514                         data = strchr(var->value, ':');
515                         if (data) {
516                                 *data = '\0';
517                                 data++;
518                                 args = strchr(data, ',');
519                                 if (args) {
520                                         *args = '\0';
521                                         args++;
522                                 }
523                                 moh_register(var->name, var->value, data,args);
524                         }
525                         var = var->next;
526                 }
527                 ast_destroy(cfg);
528         }
529 }
530
531 int load_module(void)
532 {
533         int res;
534         load_moh_classes();
535         res = ast_register_application(app0, moh0_exec, synopsis0, descrip0);
536         if (!res)
537                 res = ast_register_application(app1, moh1_exec, synopsis1, descrip1);
538         if (!res)
539                 res = ast_register_application(app2, moh2_exec, synopsis2, descrip2);
540         return res;
541 }
542
543 int unload_module(void)
544 {
545         return -1;
546 }
547
548 char *description(void)
549 {
550         return "Music On Hold Resource";
551 }
552
553 int usecount(void)
554 {
555         /* Never allow Music On Hold to be unloaded
556            unresolve needed symbols in the dialer */
557 #if 0
558         int res;
559         STANDARD_USECOUNT(res);
560         return res;
561 #else
562         return 1;
563 #endif
564 }
565
566 char *key()
567 {
568         return ASTERISK_GPL_KEY;
569 }