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