/*
 * CallWeaver -- An open source telephony toolkit.
 *
 * Copyright (C) 2002, Pauline Middelink
 *
 * Pauline Middelink <middelink@polyware.nl>
 *
 * See http://www.callweaver.org for more information about
 * the CallWeaver project. Please do not directly contact
 * any of the maintainers of this project for assistance;
 * the project provides a web site, mailing lists and IRC
 * channels for your use.
 *
 * This program is free software, distributed under the terms of
 * the GNU General Public License Version 2. See the LICENSE file
 * at the top of the source tree.
 */

/*! \file
 *
 * \brief Tone management
 * 
 * \author Pauline Middelink <middelink@polyware.nl>
 *
 * This set of function allow us to play a list of tones on a channel.
 * Each element has two frequencies, which are mixed together and a
 * duration. For silence both frequencies can be set to 0.
 * The playtones can be given as a comma separated string.
 *
 */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>
#define SPANDSP_EXPOSE_INTERNAL_STRUCTURES
#include <spandsp.h>

#include "callweaver.h"

CALLWEAVER_FILE_VERSION("$HeadURL$", "$Revision$")

#include "callweaver/indications.h"
#include "callweaver/frame.h"
#include "callweaver/options.h"
#include "callweaver/channel.h"
#include "callweaver/logger.h"
#include "callweaver/lock.h"
#include "callweaver/utils.h"


static int midi_tohz[128] =
{
	8,8,9,9,10,10,11,12,12,13,14,
	15,16,17,18,19,20,21,23,24,25,
	27,29,30,32,34,36,38,41,43,46,
	48,51,55,58,61,65,69,73,77,82,
	87,92,97,103,110,116,123,130,138,146,
	155,164,174,184,195,207,220,233,246,261,
	277,293,311,329,349,369,391,415,440,466,
	493,523,554,587,622,659,698,739,783,830,
	880,932,987,1046,1108,1174,1244,1318,1396,1479,
	1567,1661,1760,1864,1975,2093,2217,2349,2489,2637,
	2793,2959,3135,3322,3520,3729,3951,4186,4434,4698,
	4978,5274,5587,5919,6271,6644,7040,7458,7902,8372,
	8869,9397,9956,10548,11175,11839,12543
};

struct playtones_item
{
	int freq1;
	int freq2;
	int duration;
	int modulate;
	int modulation_depth;	/* percent, min 0, max 100 */
};

struct playtones_def
{
	int vol;
	int reppos;
	int nitems;
	int interruptible;
	struct playtones_item *items;
};

struct playtones_state
{
	int vol;
	int reppos;
	int nitems;
	struct playtones_item *items;
	int npos;
	int pos;
	tone_gen_descriptor_t tone_desc;
	tone_gen_state_t tone_state;
	int origwfmt;
	struct cw_frame f;
	int16_t data[CW_FRIENDLY_OFFSET / sizeof(int16_t) + 4000];
};

static void playtones_release(struct cw_channel *chan, void *params)
{
	struct playtones_state *ps = params;
	
	if (chan)
		cw_set_write_format(chan, ps->origwfmt);
        free(ps->items);
	free(ps);
}

static void tone_setup(struct playtones_state *ps, struct playtones_item *pi)
{
	uint16_t carrier_freq;
    uint16_t modulat_freq;

	if (pi->modulate)
    {
    	/* Make sure carrier frequency higher then modulating frequency */
    	if (pi->freq1 > pi->freq2)
        {
    		carrier_freq = pi->freq1;
    		modulat_freq = pi->freq2;
    	}
        else
        {
    		carrier_freq = pi->freq2;
    		modulat_freq = pi->freq1;
    	}

        make_tone_gen_descriptor(&ps->tone_desc,
                                 carrier_freq,
                                 ps->vol,
                                 -modulat_freq,
                                 pi->modulation_depth,
                                 1,
                                 0,
                                 0,
                                 0,
                                 1);
	}
    else
    {
        make_tone_gen_descriptor(&ps->tone_desc,
                                 pi->freq1,
                                 ps->vol,
                                 pi->freq2,
                                 ps->vol,
                                 1,
                                 0,
                                 0,
                                 0,
                                 1);
    }
    tone_gen_init(&ps->tone_state, &ps->tone_desc);
}

static void *playtones_alloc(struct cw_channel *chan, void *params)
{
	struct playtones_def *pd = params;
	struct playtones_state *ps;

	if ((ps = calloc(1, sizeof(*ps))) == NULL)
		return NULL;
	ps->origwfmt = chan->writeformat;
	if (cw_set_write_format(chan, CW_FORMAT_SLINEAR))
    {
		cw_log(CW_LOG_WARNING, "Unable to set '%s' to signed linear format (write)\n", chan->name);
		playtones_release(NULL, ps);
		ps = NULL;
	}
    else
    {
		struct playtones_item *pi;

		ps->vol = pd->vol;
		ps->reppos = pd->reppos;
		ps->nitems = pd->nitems;
		ps->items = pd->items;

		/* Initialize the tone generator */
		pi = &pd->items[0];
    	tone_setup(ps, pi);
	}
	/* Let interrupts interrupt :) */
	if (pd->interruptible)
		cw_set_flag(chan, CW_FLAG_WRITE_INT);
	else
		cw_clear_flag(chan, CW_FLAG_WRITE_INT);
	return ps;
}

static struct cw_frame *playtones_generator(struct cw_channel *chan, void *data, int samples)
{
	struct playtones_state *ps = data;
	struct playtones_item *pi;
	int x;

	CW_UNUSED(chan);

	cw_fr_init_ex(&ps->f, CW_FRAME_VOICE, CW_FORMAT_SLINEAR);

	ps->f.datalen = samples * sizeof(ps->data[0]);
	if (ps->f.datalen > sizeof(ps->data) / sizeof(ps->data[0]) - 1)
		ps->f.datalen = sizeof(ps->data) / sizeof(ps->data[0]) - 1;

	ps->f.samples = ps->f.datalen / sizeof(ps->data[0]);
	ps->f.offset = CW_FRIENDLY_OFFSET;
	ps->f.data = &ps->data[CW_FRIENDLY_OFFSET / sizeof(ps->data[0])];

	x = tone_gen(&ps->tone_state, ps->f.data, ps->f.samples);

	pi = &ps->items[ps->npos];
	ps->pos += x;
	if (pi->duration  &&  ps->pos >= pi->duration*8)
	{
		/* item finished? */
		ps->pos = 0;					/* start new item */
		ps->npos++;
		if (ps->npos >= ps->nitems)
		{
			/* last item */
			if (ps->reppos == -1)			/* repeat set? */
				return NULL;
			ps->npos = ps->reppos;			/* redo from top */
		}

		/* Prepare the tone generator for more */
		pi = &ps->items[ps->npos];
		tone_setup(ps, pi);
	}
	return &ps->f;
}

static struct cw_generator playtones =
{
	alloc: playtones_alloc,
	release: playtones_release,
	generate: playtones_generator,
};

int cw_playtones_start(struct cw_channel *chan, int vol, const char *playlst, int interruptible)
{
	char *s;
	char *data = cw_strdupa(playlst);
	struct playtones_def d = { vol, -1, 0, 1, NULL};
	char *stringp = NULL;
	const char *separator;

	if (!playtones.is_initialized)
		cw_object_init_obj(&playtones.obj, CW_OBJECT_CURRENT_MODULE, 0);

	if (vol >= 0)
		d.vol = -13;
	else
		d.vol = vol;

	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, t, modulate=0, moddepth=90, midinote=0;

		if (s[0] == '!')
			s++;
		else if (d.reppos == -1)
			d.reppos = d.nitems;
		
        if (sscanf(s, "%d+%d/%d", &freq1, &freq2, &t) == 3)
        {
			/* f1+f2/time format */
		}
        else if (sscanf(s, "%d+%d", &freq1, &freq2) == 2)
        {
			/* f1+f2 format */
			t = 0;
		}
        else if (sscanf(s, "%d*%d/%d", &freq1, &freq2, &t) == 3)
        {
			/* f1*f2/time format */
			modulate = 1;
		}
        else if (sscanf(s, "%d*%d@%d/%d", &freq1, &freq2, &moddepth, &t) == 4)
        {
			/* f1*f2@md/time format */
			modulate = 1;
		}
        else if (sscanf(s, "%d*%d", &freq1, &freq2) == 2)
        {
			/* f1*f2 format */
			t = 0;
			modulate = 1;
		}
        else if (sscanf(s, "%d*%d@%d", &freq1, &freq2, &moddepth) == 3)
        {
			/* f1*f2@md format */
			t = 0;
			modulate = 1;
		}
        else if (sscanf(s, "%d/%d", &freq1, &t) == 2)
        {
			/* f1/time format */
			freq2 = 0;
		}
        else if (sscanf(s, "%d", &freq1) == 1)
        {
			/* f1 format */
			freq2 = 0;
			t = 0;
		}
        else if (sscanf(s, "M%d+M%d/%d", &freq1, &freq2, &t) == 3)
        {
			/* Mf1+Mf2/time format */
			midinote = 1;
		}
        else if (sscanf(s, "M%d+M%d", &freq1, &freq2) == 2)
        {
			/* Mf1+Mf2 format */
			t = 0;
			midinote = 1;
		}
        else if (sscanf(s, "M%d*M%d/%d", &freq1, &freq2, &t) == 3)
        {
			/* Mf1*Mf2/time format */
			modulate = 1;
			midinote = 1;
		}
        else if (sscanf(s, "M%d*M%d", &freq1, &freq2) == 2)
        {
			/* Mf1*Mf2 format */
			t = 0;
			modulate = 1;
			midinote = 1;
		}
        else if (sscanf(s, "M%d/%d", &freq1, &t) == 2)
        {
			/* Mf1/time format */
			freq2 = -1;
			midinote = 1;
		}
        else if (sscanf(s, "M%d", &freq1) == 1)
        {
			/* Mf1 format */
			freq2 = -1;
			t = 0;
			midinote = 1;
		}
        else
        {
			cw_log(CW_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 = realloc(d.items,(d.nitems + 1)*sizeof(struct playtones_item))) == NULL)
		{
			cw_log(CW_LOG_WARNING, "Realloc failed!\n");
			return -1;
		}
		d.items[d.nitems].freq1    = freq1;
		d.items[d.nitems].freq2    = freq2;
		d.items[d.nitems].duration = t;
		d.items[d.nitems].modulate = modulate;
		d.items[d.nitems].modulation_depth = moddepth;
		d.nitems++;

		s = strsep(&stringp, separator);
	}

	if (cw_generator_activate(chan, &chan->generator, &playtones, &d))
		return -1;

	return 0;
}

void cw_playtones_stop(struct cw_channel *chan)
{
	cw_generator_deactivate(&chan->generator);
}

struct tone_zone *tone_zones;
static struct tone_zone *current_tonezone;

/* Protect the tone_zones list (highly unlikely that two things would change
 * it at the same time, but still! */
CW_MUTEX_DEFINE_EXPORTED(tzlock);

struct tone_zone *cw_walk_indications(const struct tone_zone *cur)
{
	struct tone_zone *tz;

	if (cur == NULL)
		return tone_zones;
	cw_mutex_lock(&tzlock);
	for (tz = tone_zones; tz; tz = tz->next)
		if (tz == cur)
			break;
	if (tz)
		tz = tz->next;
	cw_mutex_unlock(&tzlock);
	return tz;
}


/* Set global indication country */
int cw_set_indication_country(const char *country)
{
	if (country)
    {
		struct tone_zone *z = cw_get_indication_zone(country);
		if (z)
        {
			if (option_verbose > 2)
				cw_verbose(VERBOSE_PREFIX_3 "Setting default indication country to '%s'\n",country);
			current_tonezone = z;
			return 0;
		}
	}
	return 1; /* not found */
}

/* locate tone_zone, given the country. if country == NULL, use the default country */
struct tone_zone *cw_get_indication_zone(const char *country)
{
	struct tone_zone *tz;
	int alias_loop = 0;

	/* we need some tonezone, pick the first */
	if (country == NULL  &&  current_tonezone)
		return current_tonezone;	/* default country? */
	if (country == NULL  &&  tone_zones)
		return tone_zones;		/* any country? */
	if (country == NULL)
		return 0;	/* not a single country insight */

	if (cw_mutex_lock(&tzlock))
    {
		cw_log(CW_LOG_WARNING, "Unable to lock tone_zones list\n");
		return 0;
	}
	do
    {
		for (tz=tone_zones; tz; tz=tz->next)
        {
			if (strcasecmp(country, tz->country) == 0)
            {
				/* tone_zone found */
				if (tz->alias  &&  tz->alias[0])
                {
					country = tz->alias;
					break;
				}
				cw_mutex_unlock(&tzlock);
				return tz;
			}
		}
	}
    while (++alias_loop < 20  &&  tz);
	cw_mutex_unlock(&tzlock);
	if (alias_loop == 20)
		cw_log(CW_LOG_NOTICE,"Alias loop for '%s' forcefull broken\n",country);
	/* nothing found, sorry */
	return 0;
}

/* locate a tone_zone_sound, given the tone_zone. if tone_zone == NULL, use the default tone_zone */
struct tone_zone_sound *cw_get_indication_tone(const struct tone_zone *zone, const char *indication)
{
	struct tone_zone_sound *ts;

	/* we need some tonezone, pick the first */
	if (zone == NULL  &&  current_tonezone)
		zone = current_tonezone;	/* default country? */
	if (zone == NULL  &&  tone_zones)
		zone = tone_zones;		/* any country? */
	if (zone == NULL)
		return 0;	/* not a single country insight */

	if (cw_mutex_lock(&tzlock))
    {
		cw_log(CW_LOG_WARNING, "Unable to lock tone_zones list\n");
		return 0;
	}
	for (ts = zone->tones;  ts;  ts = ts->next)
    {
		if (strcasecmp(indication, ts->name) == 0)
        {
			/* found indication! */
			cw_mutex_unlock(&tzlock);
			return ts;
		}
	}
	/* nothing found, sorry */
	cw_mutex_unlock(&tzlock);
	return 0;
}

/* helper function to delete a tone_zone in its entirety */
static inline void free_zone(struct tone_zone* zone)
{
	while (zone->tones)
    {
		struct tone_zone_sound *tmp = zone->tones->next;

		free((void *) zone->tones->name);
		free((void *) zone->tones->data);
		free(zone->tones);
		zone->tones = tmp;
	}
	free((void *) zone->ringcadence);
	free(zone);
}

/* add a new country, if country exists, it will be replaced. */
int cw_register_indication_country(struct tone_zone *zone)
{
	struct tone_zone *tz,*pz;

	if (cw_mutex_lock(&tzlock))
    {
		cw_log(CW_LOG_WARNING, "Unable to lock tone_zones list\n");
		return -1;
	}
	for (pz = NULL, tz = tone_zones;  tz;  pz = tz, tz = tz->next)
    {
		if (strcasecmp(zone->country,tz->country) == 0)
        {
			/* tone_zone already there, replace */
			zone->next = tz->next;
			if (pz)
				pz->next = zone;
			else
				tone_zones = zone;
			/* if we are replacing the default zone, re-point it */
			if (tz == current_tonezone)
				current_tonezone = zone;
			/* now free the previous zone */
			free_zone(tz);
			cw_mutex_unlock(&tzlock);
			return 0;
		}
	}
	/* country not there, add */
	zone->next = NULL;
	if (pz)
		pz->next = zone;
	else
		tone_zones = zone;
	cw_mutex_unlock(&tzlock);

	if (option_verbose > 2)
		cw_verbose(VERBOSE_PREFIX_3 "Registered indication country '%s'\n",zone->country);
	return 0;
}

/* remove an existing country and all its indications, country must exist.
 * Also, all countries which are an alias for the specified country are removed. */
int cw_unregister_indication_country(const char *country)
{
	struct tone_zone *tz, *pz = NULL, *tmp;
	int res = -1;

	if (cw_mutex_lock(&tzlock))
    {
		cw_log(CW_LOG_WARNING, "Unable to lock tone_zones list\n");
		return -1;
	}
	tz = tone_zones;
	while (tz)
    {
		if (country == NULL
            ||
		    (strcasecmp(country, tz->country) == 0
            ||
		     strcasecmp(country, tz->alias) == 0))
        {
			/* tone_zone found, remove */
			tmp = tz->next;
			if (pz)
				pz->next = tmp;
			else
				tone_zones = tmp;
			/* if we are unregistering the default country, w'll notice */
			if (tz == current_tonezone) {
				cw_log(CW_LOG_NOTICE,"Removed default indication country '%s'\n",tz->country);
				current_tonezone = NULL;
			}
			if (option_verbose > 2)
				cw_verbose(VERBOSE_PREFIX_3 "Unregistered indication country '%s'\n",tz->country);
			free_zone(tz);
			if (tone_zones == tz)
				tone_zones = tmp;
			tz = tmp;
			res = 0;
		}
		else {
			/* next zone please */
			pz = tz;
			tz = tz->next;
		}
	}
	cw_mutex_unlock(&tzlock);
	return res;
}

/* add a new indication to a tone_zone. tone_zone must exist. if the indication already
 * exists, it will be replaced. */
int cw_register_indication(struct tone_zone *zone, const char *indication, const char *tonelist)
{
	struct tone_zone_sound *ts;
	struct tone_zone_sound *ps;

	/* is it an alias? stop */
	if (zone->alias[0])
		return -1;

	if (cw_mutex_lock(&tzlock))
    {
		cw_log(CW_LOG_WARNING, "Unable to lock tone_zones list\n");
		return -2;
	}
	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 = malloc(sizeof(struct tone_zone_sound))) == NULL)
		{
			cw_log(CW_LOG_WARNING, "Out of memory\n");
			cw_mutex_unlock(&tzlock);
			return -2;
		}
		ts->next = NULL;
	}
	ts->name = strdup(indication);
	ts->data = strdup(tonelist);
	if (ts->name == NULL  ||  ts->data == NULL)
    {
		cw_log(CW_LOG_WARNING, "Out of memory\n");
		cw_mutex_unlock(&tzlock);
		return -2;
	}
	if (ps)
		ps->next = ts;
	else
		zone->tones = ts;
	cw_mutex_unlock(&tzlock);
	return 0;
}

/* remove an existing country's indication. Both country and indication must exist */
int cw_unregister_indication(struct tone_zone *zone, const char *indication)
{
	struct tone_zone_sound *ts,*ps = NULL, *tmp;
	int res = -1;

	/* is it an alias? stop */
	if (zone->alias[0])
		return -1;

	if (cw_mutex_lock(&tzlock))
    {
		cw_log(CW_LOG_WARNING, "Unable to lock tone_zones list\n");
		return -1;
	}
	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 */
	cw_mutex_unlock(&tzlock);
	return res;
}