issue #5826
[asterisk/asterisk.git] / include / asterisk / indications.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * See http://www.asterisk.org for more information about
5  * the Asterisk project. Please do not directly contact
6  * any of the maintainers of this project for assistance;
7  * the project provides a web site, mailing lists and IRC
8  * channels for your use.
9  */
10
11 /*! \file
12  * \brief BSD Telephony Of Mexico "Tormenta" Tone Zone Support 2/22/01
13  * 
14  * This program is free software; you can redistribute it and/or modify
15  * it under the terms of the GNU Lesser General Public License as published by
16  * the Free Software Foundation; either version 2 of the License, or
17  * (at your option) any later version.
18  * 
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU Lesser General Public License for more details.
23  * 
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software
26  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 
27  *
28  * Primary Author: Pauline Middelink <middelink@polyware.nl>
29  *
30  */
31
32 #ifndef _ASTERISK_INDICATIONS_H
33 #define _ASTERISK_INDICATIONS_H
34
35 #include "asterisk/lock.h"
36
37 /* forward reference */
38 struct ast_channel;
39
40 struct tone_zone_sound {
41         struct tone_zone_sound *next;           /* next element */
42         const char *name;                       /* Identifing name */
43         const char *data;                       /* Actual zone description */
44         /* Description is a series of tones of the format:
45            [!]freq1[+freq2][/duration] separated by commas.  There
46            are no spaces.  The sequence is repeated back to the 
47            first tone description not preceeded by !. Duration is
48            specified in milliseconds */
49 };
50
51 struct tone_zone {
52         struct tone_zone* next;                         /* next in list */
53         char country[5];                                /* Country code */
54         char alias[5];                                  /* is this an alias? */
55         char description[40];                           /* Description */
56         int  nrringcadence;                             /* # registered ringcadence elements */
57         int *ringcadence;                               /* Ring cadence */
58         struct tone_zone_sound *tones;                  /* The known tones for this zone */
59 };
60
61 /* set the default tone country */
62 extern int ast_set_indication_country(const char *country);
63
64 /* locate tone_zone, given the country. if country == NULL, use the default country */
65 extern struct tone_zone *ast_get_indication_zone(const char *country);
66 /* locate a tone_zone_sound, given the tone_zone. if tone_zone == NULL, use the default tone_zone */
67 extern struct tone_zone_sound *ast_get_indication_tone(const struct tone_zone *zone, const char *indication);
68
69 /* add a new country, if country exists, it will be replaced. */
70 extern int ast_register_indication_country(struct tone_zone *country);
71 /* remove an existing country and all its indications, country must exist */
72 extern int ast_unregister_indication_country(const char *country);
73 /* add a new indication to a tone_zone. tone_zone must exist. if the indication already
74  * exists, it will be replaced. */
75 extern int ast_register_indication(struct tone_zone *zone, const char *indication, const char *tonelist);
76 /* remove an existing tone_zone's indication. tone_zone must exist */
77 extern int ast_unregister_indication(struct tone_zone *zone, const char *indication);
78
79 /* Start a tone-list going */
80 int ast_playtones_start(struct ast_channel *chan, int vol, const char* tonelist, int interruptible);
81 /*! Stop the tones from playing */
82 void ast_playtones_stop(struct ast_channel *chan);
83
84 extern struct tone_zone *tone_zones;
85 extern ast_mutex_t tzlock;
86
87 #endif /* _ASTERISK_INDICATIONS_H */