dom mar 16 23:37:23 CET 2003
[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                 if (option_debug)       
105                         ast_log(LOG_DEBUG, "Huh?  Child handler, but nobody there?\n");
106 }
107
108 static int spawn_mp3(struct mohclass *class)
109 {
110         int fds[2];
111         int files;
112         char fns[MAX_MP3S][80];
113         char *argv[MAX_MP3S + 50];
114         char xargs[256];
115         char *argptr;
116         int argc;
117         DIR *dir;
118         struct dirent *de;
119         dir = opendir(class->dir);
120         if (!dir) {
121                 ast_log(LOG_WARNING, "%s is not a valid directory\n", class->dir);
122                 return -1;
123         }
124         argv[0] = MPG_123;
125         argv[1] = "-q";
126         argv[2] = "-s";
127         argv[3] = "--mono";
128         argv[4] = "-r";
129         argv[5] = "8000";
130         argv[6] = "-b";
131         argv[7] = "2048";
132         argc = 8;
133         if (class->quiet) {
134                 argv[argc++] = "-f";
135                 argv[argc++] = "8192";
136         }
137
138         /* Look for extra arguments and add them to the list */
139         strncpy(xargs, class->miscargs, sizeof(xargs) - 1);
140         argptr = xargs;
141         while(argptr && strlen(argptr)) {
142                 argv[argc++] = argptr;
143                 argptr = strchr(argptr, ',');
144                 if (argptr) {
145                         *argptr = '\0';
146                         argptr++;
147                 }
148         }
149
150         files = 0;
151         while((de = readdir(dir)) && (files < MAX_MP3S)) {
152                 if ((strlen(de->d_name) > 3) && !strcasecmp(de->d_name + strlen(de->d_name) - 4, ".mp3")) {
153                         strncpy(fns[files], de->d_name, sizeof(fns[files]));
154                         argv[argc++] = fns[files];
155                         files++;
156                 }
157         }
158         argv[argc] = NULL;
159         closedir(dir);
160         if (pipe(fds)) {        
161                 ast_log(LOG_WARNING, "Pipe failed\n");
162                 return -1;
163         }
164 #if 0
165         printf("%d files total, %d args total\n", files, argc);
166         {
167                 int x;
168                 for (x=0;argv[x];x++)
169                         printf("arg%d: %s\n", x, argv[x]);
170         }
171 #endif  
172         if (!files) {
173                 ast_log(LOG_WARNING, "Found no files in '%s'\n", class->dir);
174                 return -1;
175         }
176         class->pid = fork();
177         if (class->pid < 0) {
178                 close(fds[0]);
179                 close(fds[1]);
180                 ast_log(LOG_WARNING, "Fork failed: %s\n", strerror(errno));
181                 return -1;
182         }
183         if (!class->pid) {
184                 int x;
185                 close(fds[0]);
186                 /* Stdout goes to pipe */
187                 dup2(fds[1], STDOUT_FILENO);
188                 /* Close unused file descriptors */
189                 for (x=3;x<8192;x++)
190                         close(x);
191                 /* Child */
192                 chdir(class->dir);
193                 execv(MPG_123, argv);
194                 ast_log(LOG_WARNING, "Exec failed: %s\n", strerror(errno));
195                 exit(1);
196         } else {
197                 /* Parent */
198                 close(fds[1]);
199         }
200         return fds[0];
201 }
202
203 static void *monmp3thread(void *data)
204 {
205         struct mohclass *class = data;
206         struct mohdata *moh;
207         char buf[8192];
208         short sbuf[8192];
209         int res, res2;
210         signal(SIGCHLD, child_handler);
211         for(;/* ever */;) {
212                 /* Spawn mp3 player if it's not there */
213                 if (class->srcfd < 0)  {
214                         if ((class->srcfd = spawn_mp3(class)) < 0) {
215                                 ast_log(LOG_WARNING, "unable to spawn mp3player\n");
216                                 /* Try again later */
217                                 sleep(500);
218                         }
219                 }
220                 if (class->pseudofd > -1) {
221                         /* Pause some amount of time */
222                         res = read(class->pseudofd, buf, sizeof(buf));
223                 } else {
224                         /* otherwise just sleep (unreliable) */
225                         usleep(250000);
226                         res = 2000;
227                 }
228                 if (!class->members)
229                         continue;
230                 /* Read mp3 audio */
231                 if ((res2 = read(class->srcfd, sbuf, res * 2)) != res * 2) {
232                         if (!res2) {
233                                 close(class->srcfd);
234                                 class->srcfd = -1;
235                                 if (class->pid) {
236                                         kill(class->pid, SIGKILL);
237                                         class->pid = 0;
238                                 }
239                         } else
240                                 ast_log(LOG_DEBUG, "Read %d bytes of audio while expecting %d\n", res2, res * 2);
241                         continue;
242                 }
243                 ast_pthread_mutex_lock(&moh_lock);
244                 moh = class->members;
245                 while(moh) {
246                         /* Write data */
247                         if ((res = write(moh->pipe[1], sbuf, res2)) != res2) 
248                                 if (option_debug)
249                                     ast_log(LOG_DEBUG, "Only wrote %d of %d bytes to pipe\n", res, res2);
250                         moh = moh->next;
251                 }
252                 pthread_mutex_unlock(&moh_lock);
253         }
254         return NULL;
255 }
256
257 static int moh0_exec(struct ast_channel *chan, void *data)
258 {
259         if (ast_moh_start(chan, data)) {
260                 ast_log(LOG_WARNING, "Unable to start music on hold (class '%s') on channel %s\n", (char *)data, chan->name);
261                 return -1;
262         }
263         while(!ast_safe_sleep(chan, 10000));
264         return -1;
265 }
266
267 static int moh1_exec(struct ast_channel *chan, void *data)
268 {
269         int res;
270         if (!data || !atoi(data)) {
271                 ast_log(LOG_WARNING, "WaitMusicOnHold requires an argument (number of seconds to wait)\n");
272                 return -1;
273         }
274         if (ast_moh_start(chan, NULL)) {
275                 ast_log(LOG_WARNING, "Unable to start music on hold (class '%s') on channel %s\n", (char *)data, chan->name);
276                 return -1;
277         }
278         res = ast_safe_sleep(chan, atoi(data) * 1000);
279         ast_moh_stop(chan);
280         return res;
281 }
282
283 static int moh2_exec(struct ast_channel *chan, void *data)
284 {
285         if (!data || !strlen(data)) {
286                 ast_log(LOG_WARNING, "SetMusicOnHold requires an argument (class)\n");
287                 return -1;
288         }
289         strncpy(chan->musicclass, data, sizeof(chan->musicclass));
290         return 0;
291 }
292
293 static struct mohclass *get_mohbyname(char *name)
294 {
295         struct mohclass *moh;
296         moh = mohclasses;
297         while(moh) {
298                 if (!strcasecmp(name, moh->class))
299                         return moh;
300                 moh = moh->next;
301         }
302         return NULL;
303 }
304
305 static struct mohdata *mohalloc(struct mohclass *cl)
306 {
307         struct mohdata *moh;
308         long flags;
309         moh = malloc(sizeof(struct mohdata));
310         if (!moh)
311                 return NULL;
312         memset(moh, 0, sizeof(struct mohdata));
313         if (pipe(moh->pipe)) {
314                 ast_log(LOG_WARNING, "Failed to create pipe: %s\n", strerror(errno));
315                 free(moh);
316                 return NULL;
317         }
318         /* Make entirely non-blocking */
319         flags = fcntl(moh->pipe[0], F_GETFL);
320         fcntl(moh->pipe[0], F_SETFL, flags | O_NONBLOCK);
321         flags = fcntl(moh->pipe[1], F_GETFL);
322         fcntl(moh->pipe[1], F_SETFL, flags | O_NONBLOCK);
323         moh->parent = cl;
324         moh->next = cl->members;
325         cl->members = moh;
326         return moh;
327 }
328
329 static void moh_release(struct ast_channel *chan, void *data)
330 {
331         struct mohdata *moh = data, *prev, *cur;
332         int oldrfmt, oldwfmt;
333         ast_pthread_mutex_lock(&moh_lock);
334         /* Unlink */
335         prev = NULL;
336         cur = moh->parent->members;
337         while(cur) {
338                 if (cur == moh) {
339                         if (prev)
340                                 prev->next = cur->next;
341                         else
342                                 moh->parent->members = cur->next;
343                         break;
344                 }
345                 prev = cur;
346                 cur = cur->next;
347         }
348         ast_pthread_mutex_unlock(&moh_lock);
349         close(moh->pipe[0]);
350         close(moh->pipe[1]);
351         oldrfmt = moh->origrfmt;
352         oldwfmt = moh->origwfmt;
353         free(moh);
354         if (chan) {
355                 if (ast_set_write_format(chan, oldwfmt) ||
356                     ast_set_read_format(chan, oldrfmt)) 
357                         ast_log(LOG_WARNING, "Unable to restore channel '%s' to format %d/%d\n", chan->name, oldwfmt, oldrfmt);
358                 if (option_verbose > 2)
359                         ast_verbose(VERBOSE_PREFIX_3 "Stopped music on hold on %s\n", chan->name);
360         }
361 }
362
363 static void *moh_alloc(struct ast_channel *chan, void *params)
364 {
365         struct mohdata *res;
366         struct mohclass *class;
367         ast_pthread_mutex_lock(&moh_lock);
368         class = get_mohbyname(params);
369         if (class)
370                 res = mohalloc(class);
371         else {
372                 if (strcasecmp(params, "default"))
373                         ast_log(LOG_WARNING, "No class: %s\n", (char *)params);
374                 res = NULL;
375         }
376         ast_pthread_mutex_unlock(&moh_lock);
377         if (res) {
378                 res->origrfmt = chan->readformat;
379                 res->origwfmt = chan->writeformat;
380                 if (ast_set_write_format(chan, AST_FORMAT_SLINEAR)) {
381                         ast_log(LOG_WARNING, "Unable to set '%s' to signed linear format\n", chan->name);
382                         moh_release(NULL, res);
383                         res = NULL;
384                 } else if (ast_set_read_format(chan, AST_FORMAT_SLINEAR)) {
385                         ast_log(LOG_WARNING, "Unable to set '%s' to signed linear format\n", chan->name);
386                         moh_release(NULL, res);
387                         res = NULL;
388                 }
389 #if 0
390                 /* Allow writes to interrupt */
391                 chan->writeinterrupt = 1;
392 #endif          
393                 if (option_verbose > 2)
394                         ast_verbose(VERBOSE_PREFIX_3 "Started music on hold, class '%s', on %s\n", (char *)params, chan->name);
395         }
396         return res;
397 }
398
399 static int moh_generate(struct ast_channel *chan, void *data, int len, int samples)
400 {
401         struct ast_frame f;
402         struct mohdata *moh = data;
403         short buf[640 + AST_FRIENDLY_OFFSET / 2];
404         int res;
405         if (len > sizeof(buf)) {
406                 ast_log(LOG_WARNING, "Only doing %d of %d requested bytes on %s\n", sizeof(buf), len, chan->name);
407                 len = sizeof(buf);
408         }
409         res = read(moh->pipe[0], buf + AST_FRIENDLY_OFFSET/2, len);
410 #if 0
411         if (res != len) {
412                 ast_log(LOG_WARNING, "Read only %d of %d bytes: %s\n", res, len, strerror(errno));
413         }
414 #endif
415         if (res > 0) {
416                 memset(&f, 0, sizeof(f));
417                 f.frametype = AST_FRAME_VOICE;
418                 f.subclass = AST_FORMAT_SLINEAR;
419                 f.mallocd = 0;
420                 f.datalen = res;
421                 f.samples = res / 2;
422                 f.data = buf + AST_FRIENDLY_OFFSET / 2;
423                 f.offset = AST_FRIENDLY_OFFSET;
424                 if (ast_write(chan, &f)< 0) {
425                         ast_log(LOG_WARNING, "Failed to write frame to '%s': %s\n", chan->name, strerror(errno));
426                         return -1;
427                 }
428         }
429         return 0;
430 }
431
432 static struct ast_generator mohgen = 
433 {
434         alloc: moh_alloc,
435         release: moh_release,
436         generate: moh_generate,
437 };
438
439 static int moh_register(char *classname, char *mode, char *param, char *miscargs)
440 {
441         struct mohclass *moh;
442         int x;
443         ast_pthread_mutex_lock(&moh_lock);
444         moh = get_mohbyname(classname);
445         ast_pthread_mutex_unlock(&moh_lock);
446         if (moh) {
447                 ast_log(LOG_WARNING, "Music on Hold '%s' already exists\n", classname);
448                 return -1;
449         }
450         moh = malloc(sizeof(struct mohclass));
451         if (!moh)
452                 return -1;
453         memset(moh, 0, sizeof(struct mohclass));
454
455         strncpy(moh->class, classname, sizeof(moh->class) - 1);
456         if (miscargs)
457                 strncpy(moh->miscargs, miscargs, sizeof(moh->miscargs) - 1);
458         if (!strcasecmp(mode, "mp3") || !strcasecmp(mode, "quietmp3") || !strcasecmp(mode, "httpmp3")) {
459                 if (!strcasecmp(mode, "quietmp3"))
460                         moh->quiet = 1;
461                 strncpy(moh->dir, param, sizeof(moh->dir));
462                 moh->srcfd = -1;
463 #ifdef ZAPATA_MOH
464                 /* It's an MP3 Moh -- Open /dev/zap/pseudo for timing...  Is
465                    there a better, yet reliable way to do this? */
466                 moh->pseudofd = open("/dev/zap/pseudo", O_RDONLY);
467                 if (moh->pseudofd < 0) {
468                         ast_log(LOG_WARNING, "Unable to open pseudo channel for timing...  Sound may be choppy.\n");
469                 } else {
470                         x = 320;
471                         ioctl(moh->pseudofd, ZT_SET_BLOCKSIZE, &x);
472                 }
473 #else
474                 moh->pseudofd = -1;
475 #endif
476                 if (pthread_create(&moh->thread, NULL, monmp3thread, moh)) {
477                         ast_log(LOG_WARNING, "Unable to create moh...\n");
478                         if (moh->pseudofd > -1)
479                                 close(moh->pseudofd);
480                         free(moh);
481                         return -1;
482                 }
483         } else {
484                 ast_log(LOG_WARNING, "Don't know how to do a mode '%s' music on hold\n", mode);
485                 free(moh);
486                 return -1;
487         }
488         ast_pthread_mutex_lock(&moh_lock);
489         moh->next = mohclasses;
490         mohclasses = moh;
491         ast_pthread_mutex_unlock(&moh_lock);
492         return 0;
493 }
494
495 int ast_moh_start(struct ast_channel *chan, char *class)
496 {
497         if (!class || !strlen(class))
498                 class = chan->musicclass;
499         if (!class || !strlen(class))
500                 class = "default";
501         return ast_activate_generator(chan, &mohgen, class);
502 }
503
504 void ast_moh_stop(struct ast_channel *chan)
505 {
506         ast_deactivate_generator(chan);
507 }
508
509 static void load_moh_classes(void)
510 {
511         struct ast_config *cfg;
512         struct ast_variable *var;
513         char *data;
514         char *args;
515         cfg = ast_load("musiconhold.conf");
516         if (cfg) {
517                 var = ast_variable_browse(cfg, "classes");
518                 while(var) {
519                         data = strchr(var->value, ':');
520                         if (data) {
521                                 *data = '\0';
522                                 data++;
523                                 args = strchr(data, ',');
524                                 if (args) {
525                                         *args = '\0';
526                                         args++;
527                                 }
528                                 moh_register(var->name, var->value, data,args);
529                         }
530                         var = var->next;
531                 }
532                 ast_destroy(cfg);
533         }
534 }
535
536 static void ast_moh_destroy(void)
537 {
538         struct mohclass *moh;
539         ast_pthread_mutex_lock(&moh_lock);
540         moh = mohclasses;
541         while(moh) {
542                 if (moh->pid) {
543                         kill(moh->pid, SIGKILL);
544                         moh->pid = 0;
545                         }
546                 moh = moh->next;
547         }
548         ast_pthread_mutex_unlock(&moh_lock);
549 }
550
551 int load_module(void)
552 {
553         int res;
554         load_moh_classes();
555         res = ast_register_application(app0, moh0_exec, synopsis0, descrip0);
556         atexit(ast_moh_destroy);
557         if (!res)
558                 res = ast_register_application(app1, moh1_exec, synopsis1, descrip1);
559         if (!res)
560                 res = ast_register_application(app2, moh2_exec, synopsis2, descrip2);
561         return res;
562 }
563
564 int unload_module(void)
565 {
566         return -1;
567 }
568
569 char *description(void)
570 {
571         return "Music On Hold Resource";
572 }
573
574 int usecount(void)
575 {
576         /* Never allow Music On Hold to be unloaded
577            unresolve needed symbols in the dialer */
578 #if 0
579         int res;
580         STANDARD_USECOUNT(res);
581         return res;
582 #else
583         return 1;
584 #endif
585 }
586
587 char *key()
588 {
589         return ASTERISK_GPL_KEY;
590 }