Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:01:34 2007

Asterisk developer's documentation :: Codename Pineapple

---

indications.h File Reference

---

Detailed Description

BSD Telephony Of Mexico "Tormenta" Tone Zone Support 2/22/01.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

Primary Author: Pauline Middelink <middelink@polyware.nl>

Definition in file indications.h.

#include "asterisk/lock.h"

Include dependency graph for indications.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	ind_tone_zone
struct	ind_tone_zone_sound
	Description is a series of tones of the format: [!]freq1[+freq2][/duration] separated by commas. There are no spaces. The sequence is repeated back to the first tone description not preceeded by !. Duration is specified in milliseconds. More...
Functions
ind_tone_zone_sound *	ast_get_indication_tone (const struct ind_tone_zone *zone, const char *indication)
	locate a tone_zone_sound, given the tone_zone. if tone_zone == NULL, use the default tone_zone
ind_tone_zone *	ast_get_indication_zone (const char *country)
	locate tone_zone, given the country. if country == NULL, use the default country
int	ast_playtones_start (struct ast_channel *chan, int vol, const char *tonelist, int interruptible)
	Start a tone-list going.
void	ast_playtones_stop (struct ast_channel *chan)
	Stop the tones from playing.
int	ast_register_indication (struct ind_tone_zone *zone, const char *indication, const char *tonelist)
	add a new indication to a tone_zone. tone_zone must exist. if the indication already exists, it will be replaced.
int	ast_register_indication_country (struct ind_tone_zone *country)
	add a new country, if country exists, it will be replaced.
int	ast_set_indication_country (const char *country)
	set the default tone country
int	ast_unregister_indication (struct ind_tone_zone *zone, const char *indication)
	remove an existing tone_zone's indication. tone_zone must exist
int	ast_unregister_indication_country (const char *country)
	remove an existing country and all its indications, country must exist
ind_tone_zone *	ast_walk_indications (const struct ind_tone_zone *cur)
	support for walking through a list of indications

---

Function Documentation

struct ind_tone_zone_sound* ast_get_indication_tone (  const struct ind_tone_zone *  zone, const char *  indication )

locate a tone_zone_sound, given the tone_zone. if tone_zone == NULL, use the default tone_zone Definition at line 423 of file indications.c. References AST_LIST_FIRST, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, current_tonezone, ind_tone_zone_sound::name, ind_tone_zone_sound::next, and ind_tone_zone::tones. Referenced by ast_app_dtget(), ast_indicate_data(), dialtone_indicate(), and handle_playtones(). { struct ind_tone_zone_sound *ts = NULL; AST_RWLIST_RDLOCK(&tone_zones); /* If no zone is already specified we need to try to pick one */ if (!zone) { if (current_tonezone) { zone = current_tonezone; } else if (!(zone = AST_LIST_FIRST(&tone_zones))) { /* No zone has been found ;( */ AST_RWLIST_UNLOCK(&tone_zones); return NULL; } } /* Look through list of tones in the zone searching for the right one */ for (ts = zone->tones; ts; ts = ts->next) { if (!strcasecmp(ts->name, indication)) break; } AST_RWLIST_UNLOCK(&tone_zones); return ts; }

struct ind_tone_zone* ast_get_indication_zone (  const char *  country  )

locate tone_zone, given the country. if country == NULL, use the default country Definition at line 385 of file indications.c. References ind_tone_zone::alias, AST_LIST_FIRST, ast_log(), AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ind_tone_zone::country, current_tonezone, and LOG_NOTICE. Referenced by ast_set_indication_country(), handle_add_indication(), and handle_remove_indication(). { struct ind_tone_zone *tz = NULL; int alias_loop = 0; AST_RWLIST_RDLOCK(&tone_zones); if (!country) { if (current_tonezone) tz = current_tonezone; else tz = AST_LIST_FIRST(&tone_zones); } else { do { AST_RWLIST_TRAVERSE(&tone_zones, tz, list) { if (!strcasecmp(tz->country, country)) break; } if (!tz) break; /* If this is an alias then we have to search yet again otherwise we have found the zonezone */ if (tz->alias && tz->alias[0]) country = tz->alias; else break; } while ((++alias_loop < 20) && tz); } AST_RWLIST_UNLOCK(&tone_zones); /* If we reached the maximum loops to find the proper country via alias, print out a notice */ if (alias_loop == 20) ast_log(LOG_NOTICE, "Alias loop for '%s' is bonkers\n", country); return tz; }

int ast_playtones_start (  struct ast_channel *  chan, int  vol, const char *  tonelist, int  interruptible )

Start a tone-list going. Definition at line 220 of file indications.c. References ast_activate_generator(), ast_log(), ast_realloc, ast_strdupa, playtones_item::duration, playtones_item::fac1, playtones_item::fac2, free, playtones_item::init_v2_1, playtones_item::init_v2_2, playtones_item::init_v3_1, playtones_item::init_v3_2, playtones_def::interruptible, playtones_def::items, LOG_WARNING, midi_tohz, playtones_item::modulate, playtones_def::nitems, playtones, playtones_def::reppos, s, strsep(), and playtones_def::vol. Referenced by ast_app_dtget(), ast_indicate_data(), ast_senddigit_begin(), dialtone_indicate(), handle_playtones(), and send_digit_to_chan(). { char *s, *data = ast_strdupa(playlst); /* cute */ struct playtones_def d = { vol, -1, 0, 1, NULL}; char *stringp; char *separator; if (vol < 1) d.vol = 7219; /* Default to -8db */ d.interruptible = interruptible; stringp=data; /* the stringp/data is not null here */ /* check if the data is separated with '|' or with ',' by default */ if (strchr(stringp,'|')) separator = "|"; else separator = ","; s = strsep(&stringp,separator); while (s && *s) { int freq1, freq2, time, modulate=0, midinote=0; if (s[0]=='!') s++; else if (d.reppos == -1) d.reppos = d.nitems; if (sscanf(s, "%d+%d/%d", &freq1, &freq2, &time) == 3) { /* f1+f2/time format */ } else if (sscanf(s, "%d+%d", &freq1, &freq2) == 2) { /* f1+f2 format */ time = 0; } else if (sscanf(s, "%d*%d/%d", &freq1, &freq2, &time) == 3) { /* f1*f2/time format */ modulate = 1; } else if (sscanf(s, "%d*%d", &freq1, &freq2) == 2) { /* f1*f2 format */ time = 0; modulate = 1; } else if (sscanf(s, "%d/%d", &freq1, &time) == 2) { /* f1/time format */ freq2 = 0; } else if (sscanf(s, "%d", &freq1) == 1) { /* f1 format */ freq2 = 0; time = 0; } else if (sscanf(s, "M%d+M%d/%d", &freq1, &freq2, &time) == 3) { /* Mf1+Mf2/time format */ midinote = 1; } else if (sscanf(s, "M%d+M%d", &freq1, &freq2) == 2) { /* Mf1+Mf2 format */ time = 0; midinote = 1; } else if (sscanf(s, "M%d*M%d/%d", &freq1, &freq2, &time) == 3) { /* Mf1*Mf2/time format */ modulate = 1; midinote = 1; } else if (sscanf(s, "M%d*M%d", &freq1, &freq2) == 2) { /* Mf1*Mf2 format */ time = 0; modulate = 1; midinote = 1; } else if (sscanf(s, "M%d/%d", &freq1, &time) == 2) { /* Mf1/time format */ freq2 = -1; midinote = 1; } else if (sscanf(s, "M%d", &freq1) == 1) { /* Mf1 format */ freq2 = -1; time = 0; midinote = 1; } else { ast_log(LOG_WARNING,"%s: tone component '%s' of '%s' is no good\n",chan->name,s,playlst); return -1; } if (midinote) { /* midi notes must be between 0 and 127 */ if ((freq1 >= 0) && (freq1 <= 127)) freq1 = midi_tohz[freq1]; else freq1 = 0; if ((freq2 >= 0) && (freq2 <= 127)) freq2 = midi_tohz[freq2]; else freq2 = 0; } if (!(d.items = ast_realloc(d.items, (d.nitems + 1) * sizeof(*d.items)))) { return -1; } d.items[d.nitems].fac1 = 2.0 * cos(2.0 * M_PI * (freq1 / 8000.0)) * 32768.0; d.items[d.nitems].init_v2_1 = sin(-4.0 * M_PI * (freq1 / 8000.0)) * d.vol; d.items[d.nitems].init_v3_1 = sin(-2.0 * M_PI * (freq1 / 8000.0)) * d.vol; d.items[d.nitems].fac2 = 2.0 * cos(2.0 * M_PI * (freq2 / 8000.0)) * 32768.0; d.items[d.nitems].init_v2_2 = sin(-4.0 * M_PI * (freq2 / 8000.0)) * d.vol; d.items[d.nitems].init_v3_2 = sin(-2.0 * M_PI * (freq2 / 8000.0)) * d.vol; d.items[d.nitems].duration = time; d.items[d.nitems].modulate = modulate; d.nitems++; s = strsep(&stringp,separator); } if (ast_activate_generator(chan, &playtones, &d)) { free(d.items); return -1; } return 0; }

void ast_playtones_stop (  struct ast_channel *  chan  )

Stop the tones from playing. Definition at line 333 of file indications.c. References ast_deactivate_generator(). Referenced by ast_app_dtget(), ast_indicate_data(), ast_senddigit_end(), handle_stopplaytones(), and stop_indicate(). { ast_deactivate_generator(chan); }

int ast_register_indication (  struct ind_tone_zone *  zone, const char *  indication, const char *  tonelist )

add a new indication to a tone_zone. tone_zone must exist. if the indication already exists, it will be replaced. Definition at line 534 of file indications.c. References ind_tone_zone::alias, ast_malloc, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strdup, ind_tone_zone_sound::data, free, ind_tone_zone_sound::name, ind_tone_zone_sound::next, and ind_tone_zone::tones. Referenced by handle_add_indication(). { struct ind_tone_zone_sound *ts, *ps; /* is it an alias? stop */ if (zone->alias[0]) return -1; AST_RWLIST_WRLOCK(&tone_zones); for (ps=NULL,ts=zone->tones; ts; ps=ts,ts=ts->next) { if (strcasecmp(indication,ts->name)==0) { /* indication already there, replace */ free((void*)ts->name); free((void*)ts->data); break; } } if (!ts) { /* not there, we have to add */ if (!(ts = ast_malloc(sizeof(*ts)))) { AST_RWLIST_UNLOCK(&tone_zones); return -2; } ts->next = NULL; } if (!(ts->name = ast_strdup(indication)) || !(ts->data = ast_strdup(tonelist))) { AST_RWLIST_UNLOCK(&tone_zones); return -2; } if (ps) ps->next = ts; else zone->tones = ts; AST_RWLIST_UNLOCK(&tone_zones); return 0; }

int ast_register_indication_country (  struct ind_tone_zone *  country  )

add a new country, if country exists, it will be replaced. Definition at line 471 of file indications.c. References AST_RWLIST_INSERT_TAIL, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verbose(), ind_tone_zone::country, current_tonezone, free_zone(), option_verbose, and VERBOSE_PREFIX_3. Referenced by handle_add_indication(), and ind_load_module(). { struct ind_tone_zone *tz = NULL; AST_RWLIST_WRLOCK(&tone_zones); AST_RWLIST_TRAVERSE_SAFE_BEGIN(&tone_zones, tz, list) { /* If this is not the same zone, then just continue to the next entry */ if (strcasecmp(zone->country, tz->country)) continue; /* If this zone we are going to remove is the current default then make the new zone the default */ if (tz == current_tonezone) current_tonezone = zone; /* Remove from the linked list */ AST_RWLIST_REMOVE_CURRENT(&tone_zones, list); /* Finally free the zone itself */ free_zone(tz); break; } AST_RWLIST_TRAVERSE_SAFE_END /* Add zone to the list */ AST_RWLIST_INSERT_TAIL(&tone_zones, zone, list); /* It's all over. */ AST_RWLIST_UNLOCK(&tone_zones); if (option_verbose > 2) ast_verbose(VERBOSE_PREFIX_3 "Registered indication country '%s'\n", zone->country); return 0; }

int ast_set_indication_country (  const char *  country  )

set the default tone country Definition at line 364 of file indications.c. References ast_get_indication_zone(), AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verbose(), current_tonezone, option_verbose, and VERBOSE_PREFIX_3. Referenced by ind_load_module(). { struct ind_tone_zone *zone = NULL; /* If no country is specified or we are unable to find the zone, then return not found */ if (!country || !(zone = ast_get_indication_zone(country))) return 1; if (option_verbose > 2) ast_verbose(VERBOSE_PREFIX_3 "Setting default indication country to '%s'\n", country); /* Protect the current tonezone using the tone_zones lock as well */ AST_RWLIST_WRLOCK(&tone_zones); current_tonezone = zone; AST_RWLIST_UNLOCK(&tone_zones); /* Zone was found */ return 0; }

int ast_unregister_indication (  struct ind_tone_zone *  zone, const char *  indication )

remove an existing tone_zone's indication. tone_zone must exist Definition at line 572 of file indications.c. References ind_tone_zone::alias, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ind_tone_zone_sound::data, free, ind_tone_zone_sound::name, ind_tone_zone_sound::next, and ind_tone_zone::tones. Referenced by handle_remove_indication(). { struct ind_tone_zone_sound *ts,*ps = NULL, *tmp; int res = -1; /* is it an alias? stop */ if (zone->alias[0]) return -1; AST_RWLIST_WRLOCK(&tone_zones); ts = zone->tones; while (ts) { if (strcasecmp(indication,ts->name)==0) { /* indication found */ tmp = ts->next; if (ps) ps->next = tmp; else zone->tones = tmp; free((void*)ts->name); free((void*)ts->data); free(ts); ts = tmp; res = 0; } else { /* next zone please */ ps = ts; ts = ts->next; } } /* indication not found, goodbye */ AST_RWLIST_UNLOCK(&tone_zones); return res; }

int ast_unregister_indication_country (  const char *  country  )

remove an existing country and all its indications, country must exist Definition at line 505 of file indications.c. References ind_tone_zone::alias, ast_log(), AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verbose(), ind_tone_zone::country, current_tonezone, free_zone(), LOG_NOTICE, option_verbose, and VERBOSE_PREFIX_3. Referenced by handle_add_indication(), handle_remove_indication(), reload(), and unload_module(). { struct ind_tone_zone *tz = NULL; int res = -1; AST_RWLIST_WRLOCK(&tone_zones); AST_RWLIST_TRAVERSE_SAFE_BEGIN(&tone_zones, tz, list) { if (country && (strcasecmp(country, tz->country) && strcasecmp(country, tz->alias))) continue; /* If this tonezone is the current default then unset it */ if (tz == current_tonezone) { ast_log(LOG_NOTICE,"Removed default indication country '%s'\n", tz->country); current_tonezone = NULL; } /* Remove from the list */ AST_RWLIST_REMOVE_CURRENT(&tone_zones, list); if (option_verbose > 2) ast_verbose(VERBOSE_PREFIX_3 "Unregistered indication country '%s'\n", tz->country); free_zone(tz); res = 0; } AST_RWLIST_TRAVERSE_SAFE_END AST_RWLIST_UNLOCK(&tone_zones); return res; }

struct ind_tone_zone* ast_walk_indications (  const struct ind_tone_zone *  cur  )

support for walking through a list of indications Definition at line 343 of file indications.c. References AST_RWLIST_FIRST, AST_RWLIST_NEXT, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, and AST_RWLIST_UNLOCK. Referenced by handle_show_indications(). { struct ind_tone_zone *tz = NULL; AST_RWLIST_RDLOCK(&tone_zones); /* If cur is not NULL, then we have to iterate through - otherwise just return the first entry */ if (cur) { AST_RWLIST_TRAVERSE(&tone_zones, tz, list) { if (tz == cur) break; } tz = AST_RWLIST_NEXT(tz, list); } else { tz = AST_RWLIST_FIRST(&tone_zones); } AST_RWLIST_UNLOCK(&tone_zones); return tz; }

---

Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen