another bunch of include removals (errno.h and asterisk/logger.h)
[asterisk/asterisk.git] / main / indications.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2002, Pauline Middelink
5  *
6  *
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  *
20  * \brief Tone Management
21  * 
22  * \author Pauline Middelink <middelink@polyware.nl>
23  *
24  * This set of function allow us to play a list of tones on a channel.
25  * Each element has two frequencies, which are mixed together and a
26  * duration. For silence both frequencies can be set to 0.
27  * The playtones can be given as a comma separated string.
28  *
29  */
30
31 #include "asterisk.h"
32
33 ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
34
35 #include <math.h>
36
37 #include "asterisk/lock.h"
38 #include "asterisk/linkedlists.h"
39 #include "asterisk/indications.h"
40 #include "asterisk/frame.h"
41 #include "asterisk/options.h"
42 #include "asterisk/channel.h"
43 #include "asterisk/utils.h"
44
45 static int midi_tohz[128] = {
46                         8,8,9,9,10,10,11,12,12,13,14,
47                         15,16,17,18,19,20,21,23,24,25,
48                         27,29,30,32,34,36,38,41,43,46,
49                         48,51,55,58,61,65,69,73,77,82,
50                         87,92,97,103,110,116,123,130,138,146,
51                         155,164,174,184,195,207,220,233,246,261,
52                         277,293,311,329,349,369,391,415,440,466,
53                         493,523,554,587,622,659,698,739,783,830,
54                         880,932,987,1046,1108,1174,1244,1318,1396,1479,
55                         1567,1661,1760,1864,1975,2093,2217,2349,2489,2637,
56                         2793,2959,3135,3322,3520,3729,3951,4186,4434,4698,
57                         4978,5274,5587,5919,6271,6644,7040,7458,7902,8372,
58                         8869,9397,9956,10548,11175,11839,12543
59                         };
60
61 struct playtones_item {
62         int fac1;
63         int init_v2_1;
64         int init_v3_1;
65         int fac2;
66         int init_v2_2;
67         int init_v3_2;
68         int modulate;
69         int duration;
70 };
71
72 struct playtones_def {
73         int vol;
74         int reppos;
75         int nitems;
76         int interruptible;
77         struct playtones_item *items;
78 };
79
80 struct playtones_state {
81         int vol;
82         int v1_1;
83         int v2_1;
84         int v3_1;
85         int v1_2;
86         int v2_2;
87         int v3_2;
88         int reppos;
89         int nitems;
90         struct playtones_item *items;
91         int npos;
92         int oldnpos;
93         int pos;
94         int origwfmt;
95         struct ast_frame f;
96         unsigned char offset[AST_FRIENDLY_OFFSET];
97         short data[4000];
98 };
99
100 static void playtones_release(struct ast_channel *chan, void *params)
101 {
102         struct playtones_state *ps = params;
103
104         if (chan)
105                 ast_set_write_format(chan, ps->origwfmt);
106         if (ps->items)
107                 ast_free(ps->items);
108
109         ast_free(ps);
110 }
111
112 static void * playtones_alloc(struct ast_channel *chan, void *params)
113 {
114         struct playtones_def *pd = params;
115         struct playtones_state *ps = NULL;
116
117         if (!(ps = ast_calloc(1, sizeof(*ps))))
118                 return NULL;
119
120         ps->origwfmt = chan->writeformat;
121
122         if (ast_set_write_format(chan, AST_FORMAT_SLINEAR)) {
123                 ast_log(LOG_WARNING, "Unable to set '%s' to signed linear format (write)\n", chan->name);
124                 playtones_release(NULL, ps);
125                 ps = NULL;
126         } else {
127                 ps->vol = pd->vol;
128                 ps->reppos = pd->reppos;
129                 ps->nitems = pd->nitems;
130                 ps->items = pd->items;
131                 ps->oldnpos = -1;
132         }
133
134         /* Let interrupts interrupt :) */
135         if (pd->interruptible)
136                 ast_set_flag(chan, AST_FLAG_WRITE_INT);
137         else
138                 ast_clear_flag(chan, AST_FLAG_WRITE_INT);
139
140         return ps;
141 }
142
143 static int playtones_generator(struct ast_channel *chan, void *data, int len, int samples)
144 {
145         struct playtones_state *ps = data;
146         struct playtones_item *pi;
147         int x;
148         /* we need to prepare a frame with 16 * timelen samples as we're 
149          * generating SLIN audio
150          */
151         len = samples * 2;
152         if (len > sizeof(ps->data) / 2 - 1) {
153                 ast_log(LOG_WARNING, "Can't generate that much data!\n");
154                 return -1;
155         }
156         memset(&ps->f, 0, sizeof(ps->f));
157
158         pi = &ps->items[ps->npos];
159         if (ps->oldnpos != ps->npos) {
160                 /* Load new parameters */
161                 ps->v1_1 = 0;
162                 ps->v2_1 = pi->init_v2_1;
163                 ps->v3_1 = pi->init_v3_1;
164                 ps->v1_2 = 0;
165                 ps->v2_2 = pi->init_v2_2;
166                 ps->v3_2 = pi->init_v3_2;
167                 ps->oldnpos = ps->npos;
168         }
169         for (x=0;x<len/2;x++) {
170                 ps->v1_1 = ps->v2_1;
171                 ps->v2_1 = ps->v3_1;
172                 ps->v3_1 = (pi->fac1 * ps->v2_1 >> 15) - ps->v1_1;
173                 
174                 ps->v1_2 = ps->v2_2;
175                 ps->v2_2 = ps->v3_2;
176                 ps->v3_2 = (pi->fac2 * ps->v2_2 >> 15) - ps->v1_2;
177                 if (pi->modulate) {
178                         int p;
179                         p = ps->v3_2 - 32768;
180                         if (p < 0) p = -p;
181                         p = ((p * 9) / 10) + 1;
182                         ps->data[x] = (ps->v3_1 * p) >> 15;
183                 } else
184                         ps->data[x] = ps->v3_1 + ps->v3_2; 
185         }
186         
187         ps->f.frametype = AST_FRAME_VOICE;
188         ps->f.subclass = AST_FORMAT_SLINEAR;
189         ps->f.datalen = len;
190         ps->f.samples = samples;
191         ps->f.offset = AST_FRIENDLY_OFFSET;
192         ps->f.data = ps->data;
193         ps->f.delivery.tv_sec = 0;
194         ps->f.delivery.tv_usec = 0;
195         ast_write(chan, &ps->f);
196
197         ps->pos += x;
198         if (pi->duration && ps->pos >= pi->duration * 8) {      /* item finished? */
199                 ps->pos = 0;                                    /* start new item */
200                 ps->npos++;
201                 if (ps->npos >= ps->nitems) {                   /* last item? */
202                         if (ps->reppos == -1)                   /* repeat set? */
203                                 return -1;
204                         ps->npos = ps->reppos;                  /* redo from top */
205                 }
206         }
207         return 0;
208 }
209
210 static struct ast_generator playtones = {
211         alloc: playtones_alloc,
212         release: playtones_release,
213         generate: playtones_generator,
214 };
215
216 int ast_playtones_start(struct ast_channel *chan, int vol, const char *playlst, int interruptible)
217 {
218         char *s, *data = ast_strdupa(playlst); /* cute */
219         struct playtones_def d = { vol, -1, 0, 1, NULL};
220         char *stringp;
221         char *separator;
222         
223         if (vol < 1)
224                 d.vol = 7219; /* Default to -8db */
225
226         d.interruptible = interruptible;
227         
228         stringp=data;
229         /* the stringp/data is not null here */
230         /* check if the data is separated with '|' or with ',' by default */
231         if (strchr(stringp,'|'))
232                 separator = "|";
233         else
234                 separator = ",";
235         s = strsep(&stringp,separator);
236         while (s && *s) {
237                 int freq1, freq2, time, modulate=0, midinote=0;
238
239                 if (s[0]=='!')
240                         s++;
241                 else if (d.reppos == -1)
242                         d.reppos = d.nitems;
243                 if (sscanf(s, "%d+%d/%d", &freq1, &freq2, &time) == 3) {
244                         /* f1+f2/time format */
245                 } else if (sscanf(s, "%d+%d", &freq1, &freq2) == 2) {
246                         /* f1+f2 format */
247                         time = 0;
248                 } else if (sscanf(s, "%d*%d/%d", &freq1, &freq2, &time) == 3) {
249                         /* f1*f2/time format */
250                         modulate = 1;
251                 } else if (sscanf(s, "%d*%d", &freq1, &freq2) == 2) {
252                         /* f1*f2 format */
253                         time = 0;
254                         modulate = 1;
255                 } else if (sscanf(s, "%d/%d", &freq1, &time) == 2) {
256                         /* f1/time format */
257                         freq2 = 0;
258                 } else if (sscanf(s, "%d", &freq1) == 1) {
259                         /* f1 format */
260                         freq2 = 0;
261                         time = 0;
262                 } else if (sscanf(s, "M%d+M%d/%d", &freq1, &freq2, &time) == 3) {
263                         /* Mf1+Mf2/time format */
264                         midinote = 1;
265                 } else if (sscanf(s, "M%d+M%d", &freq1, &freq2) == 2) {
266                         /* Mf1+Mf2 format */
267                         time = 0;
268                         midinote = 1;
269                 } else if (sscanf(s, "M%d*M%d/%d", &freq1, &freq2, &time) == 3) {
270                         /* Mf1*Mf2/time format */
271                         modulate = 1;
272                         midinote = 1;
273                 } else if (sscanf(s, "M%d*M%d", &freq1, &freq2) == 2) {
274                         /* Mf1*Mf2 format */
275                         time = 0;
276                         modulate = 1;
277                         midinote = 1;
278                 } else if (sscanf(s, "M%d/%d", &freq1, &time) == 2) {
279                         /* Mf1/time format */
280                         freq2 = -1;
281                         midinote = 1;
282                 } else if (sscanf(s, "M%d", &freq1) == 1) {
283                         /* Mf1 format */
284                         freq2 = -1;
285                         time = 0;
286                         midinote = 1;
287                 } else {
288                         ast_log(LOG_WARNING,"%s: tone component '%s' of '%s' is no good\n",chan->name,s,playlst);
289                         return -1;
290                 }
291
292                 if (midinote) {
293                         /* midi notes must be between 0 and 127 */
294                         if ((freq1 >= 0) && (freq1 <= 127))
295                                 freq1 = midi_tohz[freq1];
296                         else
297                                 freq1 = 0;
298
299                         if ((freq2 >= 0) && (freq2 <= 127))
300                                 freq2 = midi_tohz[freq2];
301                         else
302                                 freq2 = 0;
303                 }
304
305                 if (!(d.items = ast_realloc(d.items, (d.nitems + 1) * sizeof(*d.items)))) {
306                         return -1;
307                 }
308                 d.items[d.nitems].fac1 = 2.0 * cos(2.0 * M_PI * (freq1 / 8000.0)) * 32768.0;
309                 d.items[d.nitems].init_v2_1 = sin(-4.0 * M_PI * (freq1 / 8000.0)) * d.vol;
310                 d.items[d.nitems].init_v3_1 = sin(-2.0 * M_PI * (freq1 / 8000.0)) * d.vol;
311
312                 d.items[d.nitems].fac2 = 2.0 * cos(2.0 * M_PI * (freq2 / 8000.0)) * 32768.0;
313                 d.items[d.nitems].init_v2_2 = sin(-4.0 * M_PI * (freq2 / 8000.0)) * d.vol;
314                 d.items[d.nitems].init_v3_2 = sin(-2.0 * M_PI * (freq2 / 8000.0)) * d.vol;
315                 d.items[d.nitems].duration = time;
316                 d.items[d.nitems].modulate = modulate;
317                 d.nitems++;
318
319                 s = strsep(&stringp,separator);
320         }
321
322         if (ast_activate_generator(chan, &playtones, &d)) {
323                 ast_free(d.items);
324                 return -1;
325         }
326         return 0;
327 }
328
329 void ast_playtones_stop(struct ast_channel *chan)
330 {
331         ast_deactivate_generator(chan);
332 }
333
334 /*--------------------------------------------*/
335
336 static AST_RWLIST_HEAD_STATIC(tone_zones, ind_tone_zone);
337 static struct ind_tone_zone *current_tonezone;
338
339 struct ind_tone_zone *ast_walk_indications(const struct ind_tone_zone *cur)
340 {
341         struct ind_tone_zone *tz = NULL;
342
343         AST_RWLIST_RDLOCK(&tone_zones);
344         /* If cur is not NULL, then we have to iterate through - otherwise just return the first entry */
345         if (cur) {
346                 AST_RWLIST_TRAVERSE(&tone_zones, tz, list) {
347                         if (tz == cur)
348                                 break;
349                 }
350                 tz = AST_RWLIST_NEXT(tz, list);
351         } else {
352                 tz = AST_RWLIST_FIRST(&tone_zones);
353         }
354         AST_RWLIST_UNLOCK(&tone_zones);
355
356         return tz;
357 }
358
359 /* Set global indication country */
360 int ast_set_indication_country(const char *country)
361 {
362         struct ind_tone_zone *zone = NULL;
363
364         /* If no country is specified or we are unable to find the zone, then return not found */
365         if (!country || !(zone = ast_get_indication_zone(country)))
366                 return 1;
367         
368         ast_verb(3, "Setting default indication country to '%s'\n", country);
369
370         /* Protect the current tonezone using the tone_zones lock as well */
371         AST_RWLIST_WRLOCK(&tone_zones);
372         current_tonezone = zone;
373         AST_RWLIST_UNLOCK(&tone_zones);
374
375         /* Zone was found */
376         return 0;
377 }
378
379 /* locate tone_zone, given the country. if country == NULL, use the default country */
380 struct ind_tone_zone *ast_get_indication_zone(const char *country)
381 {
382         struct ind_tone_zone *tz = NULL;
383         int alias_loop = 0;
384
385         AST_RWLIST_RDLOCK(&tone_zones);
386
387         if (!country) {
388                 if (current_tonezone)
389                         tz = current_tonezone;
390                 else
391                         tz = AST_LIST_FIRST(&tone_zones);
392         } else {
393                 do {
394                         AST_RWLIST_TRAVERSE(&tone_zones, tz, list) {
395                                 if (!strcasecmp(tz->country, country))
396                                         break;
397                         }
398                         if (!tz)
399                                 break;
400                         /* If this is an alias then we have to search yet again otherwise we have found the zonezone */
401                         if (tz->alias && tz->alias[0])
402                                 country = tz->alias;
403                         else
404                                 break;
405                 } while ((++alias_loop < 20) && tz);
406         }
407
408         AST_RWLIST_UNLOCK(&tone_zones);
409
410         /* If we reached the maximum loops to find the proper country via alias, print out a notice */
411         if (alias_loop == 20)
412                 ast_log(LOG_NOTICE, "Alias loop for '%s' is bonkers\n", country);
413
414         return tz;
415 }
416
417 /* locate a tone_zone_sound, given the tone_zone. if tone_zone == NULL, use the default tone_zone */
418 struct ind_tone_zone_sound *ast_get_indication_tone(const struct ind_tone_zone *zone, const char *indication)
419 {
420         struct ind_tone_zone_sound *ts = NULL;
421
422         AST_RWLIST_RDLOCK(&tone_zones);
423
424         /* If no zone is already specified we need to try to pick one */
425         if (!zone) {
426                 if (current_tonezone) {
427                         zone = current_tonezone;
428                 } else if (!(zone = AST_LIST_FIRST(&tone_zones))) {
429                         /* No zone has been found ;( */
430                         AST_RWLIST_UNLOCK(&tone_zones);
431                         return NULL;
432                 }
433         }
434
435         /* Look through list of tones in the zone searching for the right one */
436         for (ts = zone->tones; ts; ts = ts->next) {
437                 if (!strcasecmp(ts->name, indication))
438                         break;
439         }
440
441         AST_RWLIST_UNLOCK(&tone_zones);
442
443         return ts;
444 }
445
446 /* helper function to delete a tone_zone in its entirety */
447 static inline void free_zone(struct ind_tone_zone* zone)
448 {
449         while (zone->tones) {
450                 struct ind_tone_zone_sound *tmp = zone->tones->next;
451                 ast_free((void *)zone->tones->name);
452                 ast_free((void *)zone->tones->data);
453                 ast_free(zone->tones);
454                 zone->tones = tmp;
455         }
456
457         if (zone->ringcadence)
458                 ast_free(zone->ringcadence);
459
460         ast_free(zone);
461 }
462
463 /*--------------------------------------------*/
464
465 /* add a new country, if country exists, it will be replaced. */
466 int ast_register_indication_country(struct ind_tone_zone *zone)
467 {
468         struct ind_tone_zone *tz = NULL;
469
470         AST_RWLIST_WRLOCK(&tone_zones);
471         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&tone_zones, tz, list) {
472                 /* If this is not the same zone, then just continue to the next entry */
473                 if (strcasecmp(zone->country, tz->country))
474                         continue;
475                 /* If this zone we are going to remove is the current default then make the new zone the default */
476                 if (tz == current_tonezone)
477                         current_tonezone = zone;
478                 /* Remove from the linked list */
479                 AST_RWLIST_REMOVE_CURRENT(list);
480                 /* Finally free the zone itself */
481                 free_zone(tz);
482                 break;
483         }
484         AST_RWLIST_TRAVERSE_SAFE_END;
485
486         /* Add zone to the list */
487         AST_RWLIST_INSERT_TAIL(&tone_zones, zone, list);
488
489         /* It's all over. */
490         AST_RWLIST_UNLOCK(&tone_zones);
491
492         ast_verb(3, "Registered indication country '%s'\n", zone->country);
493
494         return 0;
495 }
496
497 /* remove an existing country and all its indications, country must exist.
498  * Also, all countries which are an alias for the specified country are removed. */
499 int ast_unregister_indication_country(const char *country)
500 {
501         struct ind_tone_zone *tz = NULL;
502         int res = -1;
503
504         AST_RWLIST_WRLOCK(&tone_zones);
505         AST_RWLIST_TRAVERSE_SAFE_BEGIN(&tone_zones, tz, list) {
506                 if (country && (strcasecmp(country, tz->country) && strcasecmp(country, tz->alias)))
507                         continue;
508                 /* If this tonezone is the current default then unset it */
509                 if (tz == current_tonezone) {
510                         ast_log(LOG_NOTICE,"Removed default indication country '%s'\n", tz->country);
511                         current_tonezone = NULL;
512                 }
513                 /* Remove from the list */
514                 AST_RWLIST_REMOVE_CURRENT(list);
515                 ast_verb(3, "Unregistered indication country '%s'\n", tz->country);
516                 free_zone(tz);
517                 res = 0;
518         }
519         AST_RWLIST_TRAVERSE_SAFE_END;
520         AST_RWLIST_UNLOCK(&tone_zones);
521
522         return res;
523 }
524
525 /* add a new indication to a tone_zone. tone_zone must exist. if the indication already
526  * exists, it will be replaced. */
527 int ast_register_indication(struct ind_tone_zone *zone, const char *indication, const char *tonelist)
528 {
529         struct ind_tone_zone_sound *ts, *ps;
530
531         /* is it an alias? stop */
532         if (zone->alias[0])
533                 return -1;
534
535         AST_RWLIST_WRLOCK(&tone_zones);
536         for (ps=NULL,ts=zone->tones; ts; ps=ts,ts=ts->next) {
537                 if (strcasecmp(indication,ts->name)==0) {
538                         /* indication already there, replace */
539                         ast_free((void*)ts->name);
540                         ast_free((void*)ts->data);
541                         break;
542                 }
543         }
544         if (!ts) {
545                 /* not there, we have to add */
546                 if (!(ts = ast_malloc(sizeof(*ts)))) {
547                         AST_RWLIST_UNLOCK(&tone_zones);
548                         return -2;
549                 }
550                 ts->next = NULL;
551         }
552         if (!(ts->name = ast_strdup(indication)) || !(ts->data = ast_strdup(tonelist))) {
553                 AST_RWLIST_UNLOCK(&tone_zones);
554                 return -2;
555         }
556         if (ps)
557                 ps->next = ts;
558         else
559                 zone->tones = ts;
560         AST_RWLIST_UNLOCK(&tone_zones);
561         return 0;
562 }
563
564 /* remove an existing country's indication. Both country and indication must exist */
565 int ast_unregister_indication(struct ind_tone_zone *zone, const char *indication)
566 {
567         struct ind_tone_zone_sound *ts,*ps = NULL, *tmp;
568         int res = -1;
569
570         /* is it an alias? stop */
571         if (zone->alias[0])
572                 return -1;
573
574         AST_RWLIST_WRLOCK(&tone_zones);
575         ts = zone->tones;
576         while (ts) {
577                 if (strcasecmp(indication,ts->name)==0) {
578                         /* indication found */
579                         tmp = ts->next;
580                         if (ps)
581                                 ps->next = tmp;
582                         else
583                                 zone->tones = tmp;
584                         ast_free((void*)ts->name);
585                         ast_free((void*)ts->data);
586                         ast_free(ts);
587                         ts = tmp;
588                         res = 0;
589                 }
590                 else {
591                         /* next zone please */
592                         ps = ts;
593                         ts = ts->next;
594                 }
595         }
596         /* indication not found, goodbye */
597         AST_RWLIST_UNLOCK(&tone_zones);
598         return res;
599 }