indications.h File Reference

00467 {
00468    struct ast_tone_zone_sound *ts = NULL;
00469    /* _zone is const to the users of the API */
00470    struct ast_tone_zone *zone = (struct ast_tone_zone *) _zone;
00471 
00472    /* If no zone is specified, use the default */
00473    if (!zone) {
00474       ao2_lock(ast_tone_zones);
00475       if (default_tone_zone) {
00476          zone = ast_tone_zone_ref(default_tone_zone);
00477       }
00478       ao2_unlock(ast_tone_zones);
00479 
00480       if (!zone) {
00481          return NULL;
00482       }
00483    }
00484 
00485    ast_tone_zone_lock(zone);
00486 
00487    /* Look through list of tones in the zone searching for the right one */
00488    AST_LIST_TRAVERSE(&zone->tones, ts, entry) {
00489       if (!strcasecmp(ts->name, indication)) {
00490          /* Increase ref count for the reference we will return */
00491          ts = ast_tone_zone_sound_ref(ts);
00492          break;
00493       }
00494    }
00495 
00496    ast_tone_zone_unlock(zone);
00497 
00498    return ts;
00499 }

struct ast_tone_zone* ast_get_indication_zone ( const char * country ) [read]

locate ast_tone_zone

Parameters:

country

country to find. If NULL is provided, get the default.

Returns:: a reference to the specified country if found or NULL if not found

Definition at line 444 of file indications.c.

References ao2_find, ao2_lock, ao2_unlock, ast_copy_string(), ast_strlen_zero(), ast_tone_zone_ref(), ast_tone_zone::country, ast_tone_zone::nrringcadence, OBJ_POINTER, and tz.

Referenced by ast_set_indication_country(), ast_var_indications(), build_device(), build_peer(), func_channel_write_real(), handle_cli_indication_add(), handle_cli_indication_remove(), reload_config(), and sip_new().

00445 {
00446    struct ast_tone_zone *tz = NULL;
00447    struct ast_tone_zone zone_arg = {
00448       .nrringcadence = 0,
00449    };
00450 
00451    if (ast_strlen_zero(country)) {
00452       ao2_lock(ast_tone_zones);
00453       if (default_tone_zone) {
00454          tz = ast_tone_zone_ref(default_tone_zone);
00455       }
00456       ao2_unlock(ast_tone_zones);
00457 
00458       return tz;
00459    }
00460 
00461    ast_copy_string(zone_arg.country, country, sizeof(zone_arg.country));
00462 
00463    return ao2_find(ast_tone_zones, &zone_arg, OBJ_POINTER);
00464 }

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

Start playing a list of tones on a channel.

Parameters:

	chan	the channel to play tones on
	vol	volume
	tonelist	the list of tones to play, comma separated
	interruptible	whether or not this tone can be interrupted

Return values:

	0	success
	non-zero	failure

Definition at line 315 of file indications.c.

References ast_activate_generator(), ast_free, ast_log(), ast_realloc, ast_strdupa, ast_strip(), ast_strlen_zero(), ast_tone_zone_part_parse(), cos, playtones_item::duration, playtones_item::fac1, playtones_item::fac2, ast_tone_zone_part::freq1, ast_tone_zone_part::freq2, 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_ERROR, M_PI, ast_tone_zone_part::midinote, ast_tone_zone_part::modulate, playtones_item::modulate, playtones_def::nitems, playtones_def::reppos, strsep(), ast_tone_zone_part::time, and playtones_def::vol.

00316 {
00317    char *s, *data = ast_strdupa(playlst);
00318    struct playtones_def d = { vol, -1, 0, 1, NULL };
00319    char *stringp;
00320    char *separator;
00321    static const float sample_rate = 8000.0;
00322    static const float max_sample_val = 32768.0;
00323 
00324    if (vol < 1) {
00325       d.vol = 7219; /* Default to -8db */
00326    }
00327 
00328    d.interruptible = interruptible;
00329 
00330    stringp = data;
00331 
00332    /* check if the data is separated with '|' or with ',' by default */
00333    if (strchr(stringp,'|')) {
00334       separator = "|";
00335    } else {
00336       separator = ",";
00337    }
00338 
00339    while ((s = strsep(&stringp, separator)) && !ast_strlen_zero(s)) {
00340       struct ast_tone_zone_part tone_data = {
00341          .time = 0,
00342       };
00343 
00344       s = ast_strip(s);
00345 
00346       if (s[0]=='!') {
00347          s++;
00348       } else if (d.reppos == -1) {
00349          d.reppos = d.nitems;
00350       }
00351 
00352       if (ast_tone_zone_part_parse(s, &tone_data)) {
00353          ast_log(LOG_ERROR, "Failed to parse tone part '%s'\n", s);
00354          continue;
00355       }
00356 
00357       if (tone_data.midinote) {
00358          /* midi notes must be between 0 and 127 */
00359 
00360          if (tone_data.freq1 >= 0 && tone_data.freq1 <= 127) {
00361             tone_data.freq1 = midi_tohz[tone_data.freq1];
00362          } else {
00363             tone_data.freq1 = 0;
00364          }
00365 
00366          if (tone_data.freq2 >= 0 && tone_data.freq2 <= 127) {
00367             tone_data.freq2 = midi_tohz[tone_data.freq2];
00368          } else {
00369             tone_data.freq2 = 0;
00370          }
00371       }
00372 
00373       if (!(d.items = ast_realloc(d.items, (d.nitems + 1) * sizeof(*d.items)))) {
00374          return -1;
00375       }
00376 
00377       d.items[d.nitems].fac1 = 2.0 * cos(2.0 * M_PI * (tone_data.freq1 / sample_rate)) * max_sample_val;
00378       d.items[d.nitems].init_v2_1 = sin(-4.0 * M_PI * (tone_data.freq1 / sample_rate)) * d.vol;
00379       d.items[d.nitems].init_v3_1 = sin(-2.0 * M_PI * (tone_data.freq1 / sample_rate)) * d.vol;
00380 
00381       d.items[d.nitems].fac2 = 2.0 * cos(2.0 * M_PI * (tone_data.freq2 / sample_rate)) * max_sample_val;
00382       d.items[d.nitems].init_v2_2 = sin(-4.0 * M_PI * (tone_data.freq2 / sample_rate)) * d.vol;
00383       d.items[d.nitems].init_v3_2 = sin(-2.0 * M_PI * (tone_data.freq2 / sample_rate)) * d.vol;
00384 
00385       d.items[d.nitems].duration = tone_data.time;
00386       d.items[d.nitems].modulate = tone_data.modulate;
00387 
00388       d.nitems++;
00389    }
00390 
00391    if (!d.nitems) {
00392       ast_log(LOG_ERROR, "No valid tone parts\n");
00393       return -1;
00394    }
00395 
00396    if (ast_activate_generator(chan, &playtones, &d)) {
00397       ast_free(d.items);
00398       return -1;
00399    }
00400 
00401    return 0;
00402 }

void ast_playtones_stop ( struct ast_channel * chan )

Stop playing tones on a channel.

Parameters:

chan

the channel to stop tones on

Stop the tones from playing

Definition at line 404 of file indications.c.

References ast_deactivate_generator().

00405 {
00406    ast_deactivate_generator(chan);
00407 }

int ast_tone_zone_count ( void )

Get the number of registered tone zones.

Returns:: the total number of registered tone zones

Definition at line 409 of file indications.c.

References ao2_container_count().

00410 {
00411    return ao2_container_count(ast_tone_zones);
00412 }

int ast_tone_zone_data_add_structure	(	struct ast_data *	tree,
		struct ast_tone_zone *	zone
	)

Add a tone_zone structure to the data tree specified.

Return values:

	<0	on error.
	0	on success.

Definition at line 1122 of file indications.c.

References ast_data_add_node(), ast_data_add_structure, AST_LIST_EMPTY, AST_LIST_TRAVERSE, ast_tone_zone_lock, ast_tone_zone_unlock, ast_tone_zone_sound::entry, and ast_tone_zone::tones.

Referenced by ast_channel_data_add_structure().

01123 {
01124    struct ast_data *data_zone_sound;
01125    struct ast_tone_zone_sound *s;
01126 
01127    ast_data_add_structure(ast_tone_zone, tree, zone);
01128 
01129    if (AST_LIST_EMPTY(&zone->tones)) {
01130       return 0;
01131    }
01132 
01133    data_zone_sound = ast_data_add_node(tree, "tones");
01134    if (!data_zone_sound) {
01135       return -1;
01136    }
01137 
01138    ast_tone_zone_lock(zone);
01139 
01140    AST_LIST_TRAVERSE(&zone->tones, s, entry) {
01141       ast_data_add_structure(ast_tone_zone_sound, data_zone_sound, s);
01142    }
01143 
01144    ast_tone_zone_unlock(zone);
01145 
01146    return 0;
01147 }

struct ao2_iterator ast_tone_zone_iterator_init ( void ) [read]

Get an iterator for the available tone zones.

Note:: Use ao2_iterator_next() to iterate the tone zones.
Use ao2_iterator_destroy() to clean up.

Returns:: an initialized iterator

Definition at line 414 of file indications.c.

References ao2_iterator_init().

Referenced by ast_var_indications(), ast_var_indications_table(), and handle_cli_indication_show().

00415 {
00416    return ao2_iterator_init(ast_tone_zones, 0);
00417 }

int ast_tone_zone_part_parse	(	const char *	s,
		struct ast_tone_zone_part *	tone_data
	)

Parse a tone part.

Parameters:

	s	The part of a tone to parse. This should be in the form described for the data part of ast_tone_zone_sound. '!' should be removed if present.
	tone_data	An output parameter that contains the result of the parsing.

Return values:

	0	success
	-1	failure, and the contents of tone_data are undefined

Definition at line 258 of file indications.c.

References ast_tone_zone_part::freq1, ast_tone_zone_part::freq2, ast_tone_zone_part::midinote, ast_tone_zone_part::modulate, and ast_tone_zone_part::time.

Referenced by ast_playtones_start().

00259 {
00260    if (sscanf(s, "%30u+%30u/%30u", &tone_data->freq1, &tone_data->freq2, 
00261          &tone_data->time) == 3) {
00262       /* f1+f2/time format */
00263    } else if (sscanf(s, "%30u+%30u", &tone_data->freq1, &tone_data->freq2) == 2) {
00264       /* f1+f2 format */
00265       tone_data->time = 0;
00266    } else if (sscanf(s, "%30u*%30u/%30u", &tone_data->freq1, &tone_data->freq2, 
00267          &tone_data->time) == 3) {
00268       /* f1*f2/time format */
00269       tone_data->modulate = 1;
00270    } else if (sscanf(s, "%30u*%30u", &tone_data->freq1, &tone_data->freq2) == 2) {
00271       /* f1*f2 format */
00272       tone_data->time = 0;
00273       tone_data->modulate = 1;
00274    } else if (sscanf(s, "%30u/%30u", &tone_data->freq1, &tone_data->time) == 2) {
00275       /* f1/time format */
00276       tone_data->freq2 = 0;
00277    } else if (sscanf(s, "%30u", &tone_data->freq1) == 1) {
00278       /* f1 format */
00279       tone_data->freq2 = 0;
00280       tone_data->time = 0;
00281    } else if (sscanf(s, "M%30u+M%30u/%30u", &tone_data->freq1, &tone_data->freq2, 
00282          &tone_data->time) == 3) {
00283       /* Mf1+Mf2/time format */
00284       tone_data->midinote = 1;
00285    } else if (sscanf(s, "M%30u+M%30u", &tone_data->freq1, &tone_data->freq2) == 2) {
00286       /* Mf1+Mf2 format */
00287       tone_data->time = 0;
00288       tone_data->midinote = 1;
00289    } else if (sscanf(s, "M%30u*M%30u/%30u", &tone_data->freq1, &tone_data->freq2, 
00290          &tone_data->time) == 3) {
00291       /* Mf1*Mf2/time format */
00292       tone_data->modulate = 1;
00293       tone_data->midinote = 1;
00294    } else if (sscanf(s, "M%30u*M%30u", &tone_data->freq1, &tone_data->freq2) == 2) {
00295       /* Mf1*Mf2 format */
00296       tone_data->time = 0;
00297       tone_data->modulate = 1;
00298       tone_data->midinote = 1;
00299    } else if (sscanf(s, "M%30u/%30u", &tone_data->freq1, &tone_data->time) == 2) {
00300       /* Mf1/time format */
00301       tone_data->freq2 = -1;
00302       tone_data->midinote = 1;
00303    } else if (sscanf(s, "M%30u", &tone_data->freq1) == 1) {
00304       /* Mf1 format */
00305       tone_data->freq2 = -1;
00306       tone_data->time = 0;
00307       tone_data->midinote = 1;
00308    } else {
00309       return -1;
00310    }
00311 
00312    return 0;
00313 }

static struct ast_tone_zone* ast_tone_zone_ref ( struct ast_tone_zone * tz ) [static, read]

Increase the reference count on an ast_tone_zone.

Returns:: The tone zone provided as an argument

Definition at line 217 of file indications.h.

References ao2_ref.

Referenced by ast_get_indication_tone(), ast_get_indication_zone(), ast_register_indication_country(), ast_set_indication_country(), and func_channel_write_real().

00218 {
00219    ao2_ref(tz, +1);
00220    return tz;
00221 }

static struct ast_tone_zone_sound* ast_tone_zone_sound_ref ( struct ast_tone_zone_sound * ts ) [static, read]

Increase the reference count on an ast_tone_zone_sound.

Returns:: The tone zone sound provided as an argument

Definition at line 239 of file indications.h.

References ao2_ref.

Referenced by ast_get_indication_tone().

00240 {
00241    ao2_ref(ts, +1);
00242    return ts;
00243 }

static struct ast_tone_zone_sound* ast_tone_zone_sound_unref ( struct ast_tone_zone_sound * ts ) [static, read]

Release a reference to an ast_tone_zone_sound.

Returns:: NULL

Definition at line 228 of file indications.h.

References ao2_ref.

Referenced by ast_app_dtget(), ast_indicate_data(), ast_register_indication(), ast_tone_zone_destructor(), ast_unregister_indication(), dial_handle_playtones(), handle_playtones(), in_band_indication(), pbx_builtin_waitexten(), play_dialtone(), prune_tone_zone(), read_exec(), readexten_exec(), skinny_transfer(), and stop_indicate().

00229 {
00230    ao2_ref(ts, -1);
00231    return NULL;
00232 }

static struct ast_tone_zone* ast_tone_zone_unref ( struct ast_tone_zone * tz ) [static, read]

Release a reference to an ast_tone_zone.

Returns:: NULL

Definition at line 206 of file indications.h.

References ao2_ref.

Referenced by ast_channel_destructor(), ast_set_indication_country(), ast_unregister_indication_country(), ast_var_indications(), ast_var_indications_table(), build_device(), build_peer(), complete_country(), complete_indications(), func_channel_write_real(), handle_cli_indication_add(), handle_cli_indication_remove(), handle_cli_indication_show(), parse_tone_zone(), and reload_config().

00207 {
00208    ao2_ref(tz, -1);
00209    return NULL;
00210 }


Data Structures
struct	ast_tone_zone
	A set of tones for a given locale. More...
struct	ast_tone_zone_part
	A description of a part of a tone. More...
struct	ast_tone_zone_sound
	Description of a tone. More...
Defines
#define	ast_tone_zone_lock(tz) ao2_lock(tz)
	Lock an ast_tone_zone.
#define	ast_tone_zone_trylock(tz) ao2_trylock(tz)
	Trylock an ast_tone_zone.
#define	ast_tone_zone_unlock(tz) ao2_unlock(tz)
	Unlock an ast_tone_zone.
#define	MAX_TONEZONE_COUNTRY 16
Functions
struct ast_tone_zone_sound *	ast_get_indication_tone (const struct ast_tone_zone zone, const char indication)
	Locate a tone zone sound.
struct ast_tone_zone *	ast_get_indication_zone (const char *country)
	locate ast_tone_zone
int	ast_playtones_start (struct ast_channel chan, int vol, const char tonelist, int interruptible)
	Start playing a list of tones on a channel.
void	ast_playtones_stop (struct ast_channel *chan)
	Stop playing tones on a channel.
int	ast_tone_zone_count (void)
	Get the number of registered tone zones.
int	ast_tone_zone_data_add_structure (struct ast_data tree, struct ast_tone_zone zone)
	Add a tone_zone structure to the data tree specified.
struct ao2_iterator	ast_tone_zone_iterator_init (void)
	Get an iterator for the available tone zones.
int	ast_tone_zone_part_parse (const char s, struct ast_tone_zone_part tone_data)
	Parse a tone part.
static struct ast_tone_zone *	ast_tone_zone_ref (struct ast_tone_zone *tz)
	Increase the reference count on an ast_tone_zone.
static struct ast_tone_zone_sound *	ast_tone_zone_sound_ref (struct ast_tone_zone_sound *ts)
	Increase the reference count on an ast_tone_zone_sound.
static struct ast_tone_zone_sound *	ast_tone_zone_sound_unref (struct ast_tone_zone_sound *ts)
	Release a reference to an ast_tone_zone_sound.
static struct ast_tone_zone *	ast_tone_zone_unref (struct ast_tone_zone *tz)
	Release a reference to an ast_tone_zone.

Asterisk developer's documentation

indications.h File Reference

Data Structures

Defines

Functions

Detailed Description

Define Documentation

Function Documentation