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