3 Copyright (C) 2011 Belledonne Communications SARL
4 Author: Simon MORLAT (simon.morlat@linphone.org)
6 This program is free software; you can redistribute it and/or
7 modify it under the terms of the GNU General Public License
8 as published by the Free Software Foundation; either version 2
9 of the License, or (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include "mediastreamer2/mstonedetector.h"
24 #include "mediastreamer2/dtmfgen.h"
30 static void ecc_init_filters(EcCalibrator *ecc){
34 MSTickerParams params={0};
35 params.name="Echo calibrator";
36 params.prio=MS_TICKER_PRIO_HIGH;
37 ecc->ticker=ms_ticker_new_with_params(¶ms);
39 ecc->sndread=ms_snd_card_create_reader(ecc->play_card);
40 ms_filter_call_method(ecc->sndread,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
41 ms_filter_call_method(ecc->sndread,MS_FILTER_GET_SAMPLE_RATE,&rate);
42 ms_filter_call_method(ecc->sndread,MS_FILTER_SET_NCHANNELS,&ecc_channels);
43 ms_filter_call_method(ecc->sndread,MS_FILTER_GET_NCHANNELS,&channels);
44 ecc->read_resampler=ms_filter_new(MS_RESAMPLE_ID);
45 ms_filter_call_method(ecc->read_resampler,MS_FILTER_SET_SAMPLE_RATE,&rate);
46 ms_filter_call_method(ecc->read_resampler,MS_FILTER_SET_OUTPUT_SAMPLE_RATE,&ecc->rate);
47 ms_filter_call_method(ecc->read_resampler,MS_FILTER_SET_NCHANNELS,&ecc_channels);
48 ms_filter_call_method(ecc->read_resampler,MS_FILTER_SET_OUTPUT_NCHANNELS,&channels);
51 ecc->det=ms_filter_new(MS_TONE_DETECTOR_ID);
52 ms_filter_call_method(ecc->det,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
53 ecc->rec=ms_filter_new(MS_FILE_REC_ID);
55 ms_filter_link(ecc->sndread,0,ecc->read_resampler,0);
56 ms_filter_link(ecc->read_resampler,0,ecc->det,0);
57 ms_filter_link(ecc->det,0,ecc->rec,0);
59 ecc->play=ms_filter_new(MS_VOID_SOURCE_ID);
60 ecc->gen=ms_filter_new(MS_DTMF_GEN_ID);
61 ms_filter_call_method(ecc->gen,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
62 ecc->write_resampler=ms_filter_new(MS_RESAMPLE_ID);
63 ecc->sndwrite=ms_snd_card_create_writer(ecc->capt_card);
65 ms_filter_call_method(ecc->sndwrite,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
66 ms_filter_call_method(ecc->sndwrite,MS_FILTER_GET_SAMPLE_RATE,&rate);
67 ms_filter_call_method(ecc->sndwrite,MS_FILTER_SET_NCHANNELS,&ecc_channels);
68 ms_filter_call_method(ecc->sndwrite,MS_FILTER_GET_NCHANNELS,&channels);
69 ms_filter_call_method(ecc->write_resampler,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
70 ms_filter_call_method(ecc->write_resampler,MS_FILTER_SET_OUTPUT_SAMPLE_RATE,&rate);
71 ms_filter_call_method(ecc->write_resampler,MS_FILTER_SET_NCHANNELS,&ecc_channels);
72 ms_filter_call_method(ecc->write_resampler,MS_FILTER_SET_OUTPUT_NCHANNELS,&channels);
74 ms_filter_link(ecc->play,0,ecc->gen,0);
75 ms_filter_link(ecc->gen,0,ecc->write_resampler,0);
76 ms_filter_link(ecc->write_resampler,0,ecc->sndwrite,0);
78 ms_ticker_attach(ecc->ticker,ecc->sndread);
79 ms_ticker_attach(ecc->ticker,ecc->play);
83 static void ecc_deinit_filters(EcCalibrator *ecc){
84 ms_ticker_detach(ecc->ticker,ecc->sndread);
85 ms_ticker_detach(ecc->ticker,ecc->play);
87 ms_filter_unlink(ecc->play,0,ecc->gen,0);
88 ms_filter_unlink(ecc->gen,0,ecc->write_resampler,0);
89 ms_filter_unlink(ecc->write_resampler,0,ecc->sndwrite,0);
91 ms_filter_unlink(ecc->sndread,0,ecc->read_resampler,0);
92 ms_filter_unlink(ecc->read_resampler,0,ecc->det,0);
93 ms_filter_unlink(ecc->det,0,ecc->rec,0);
95 ms_filter_destroy(ecc->sndread);
96 ms_filter_destroy(ecc->det);
97 ms_filter_destroy(ecc->rec);
98 ms_filter_destroy(ecc->play);
99 ms_filter_destroy(ecc->gen);
100 ms_filter_destroy(ecc->read_resampler);
101 ms_filter_destroy(ecc->write_resampler);
102 ms_filter_destroy(ecc->sndwrite);
104 ms_ticker_destroy(ecc->ticker);
107 static void on_tone_sent(void *data, MSFilter *f, unsigned int event_id, void *arg){
108 MSDtmfGenEvent *ev=(MSDtmfGenEvent*)arg;
109 EcCalibrator *ecc=(EcCalibrator*)data;
110 ecc->acc-=ev->tone_start_time;
111 ms_message("Sent tone at %u",(unsigned int)ev->tone_start_time);
114 static bool_t is_valid_tone(EcCalibrator *ecc, MSToneDetectorEvent *ev){
115 bool_t *toneflag=NULL;
116 if (strcmp(ev->tone_name,"freq1")==0){
117 toneflag=&ecc->freq1;
118 }else if (strcmp(ev->tone_name,"freq2")==0){
119 toneflag=&ecc->freq2;
120 }else if (strcmp(ev->tone_name,"freq3")==0){
121 toneflag=&ecc->freq3;
123 ms_error("Calibrator bug.");
127 ms_message("Duplicated tone event, ignored.");
134 static void on_tone_received(void *data, MSFilter *f, unsigned int event_id, void *arg){
135 MSToneDetectorEvent *ev=(MSToneDetectorEvent*)arg;
136 EcCalibrator *ecc=(EcCalibrator*)data;
137 if (is_valid_tone(ecc,ev)){
138 ecc->acc+=ev->tone_start_time;
139 ms_message("Received tone at %u",(unsigned int)ev->tone_start_time);
143 static void ecc_play_tones(EcCalibrator *ecc){
144 MSDtmfGenCustomTone tone;
145 MSToneDetectorDef expected_tone;
147 memset(&tone,0,sizeof(tone));
148 memset(&expected_tone,0,sizeof(expected_tone));
150 ms_filter_set_notify_callback(ecc->det,on_tone_received,ecc);
152 /* configure the tones to be scanned */
154 strncpy(expected_tone.tone_name,"freq1",sizeof(expected_tone.tone_name));
155 expected_tone.frequency=2000;
156 expected_tone.min_duration=40;
157 expected_tone.min_amplitude=0.1;
159 ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
161 strncpy(expected_tone.tone_name,"freq2",sizeof(expected_tone.tone_name));
162 expected_tone.frequency=2300;
163 expected_tone.min_duration=40;
164 expected_tone.min_amplitude=0.1;
166 ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
168 strncpy(expected_tone.tone_name,"freq3",sizeof(expected_tone.tone_name));
169 expected_tone.frequency=2500;
170 expected_tone.min_duration=40;
171 expected_tone.min_amplitude=0.1;
173 ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
175 /*play an initial tone to startup the audio playback/capture*/
177 tone.frequencies[0]=140;
181 ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
184 ms_filter_set_notify_callback(ecc->gen,on_tone_sent,ecc);
186 /* play the three tones*/
188 tone.frequencies[0]=2000;
190 ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
193 tone.frequencies[0]=2300;
195 ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
198 tone.frequencies[0]=2500;
200 ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
203 if (ecc->freq1 && ecc->freq2 && ecc->freq3) {
204 int delay=ecc->acc/3;
206 ms_error("Quite surprising calibration result, delay=%i",delay);
207 ecc->status=LinphoneEcCalibratorFailed;
209 ms_message("Echo calibration estimated delay to be %i ms",delay);
211 ecc->status=LinphoneEcCalibratorDone;
213 } else if ((ecc->freq1 || ecc->freq2 || ecc->freq3)==FALSE) {
214 ms_message("Echo calibration succeeded, no echo has been detected");
215 ecc->status = LinphoneEcCalibratorDoneNoEcho;
217 ecc->status = LinphoneEcCalibratorFailed;
220 if (ecc->status == LinphoneEcCalibratorFailed) {
221 ms_error("Echo calibration failed.");
225 static void * ecc_thread(void *p){
226 EcCalibrator *ecc=(EcCalibrator*)p;
228 ecc_init_filters(ecc);
230 ecc_deinit_filters(ecc);
231 ms_thread_exit(NULL);
235 EcCalibrator * ec_calibrator_new(MSSndCard *play_card, MSSndCard *capt_card, unsigned int rate, LinphoneEcCalibrationCallback cb, void *cb_data ){
236 EcCalibrator *ecc=ms_new0(EcCalibrator,1);
240 ecc->cb_data=cb_data;
241 ecc->capt_card=capt_card;
242 ecc->play_card=play_card;
243 ms_thread_create(&ecc->thread,NULL,ecc_thread,ecc);
247 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc){
251 void ec_calibrator_destroy(EcCalibrator *ecc){
252 ms_thread_join(ecc->thread,NULL);
256 int linphone_core_start_echo_calibration(LinphoneCore *lc, LinphoneEcCalibrationCallback cb, void *cb_data){
258 ms_error("Echo calibration is still on going !");
261 unsigned int rate = lp_config_get_int(lc->config,"sound","echo_cancellation_rate",8000);
262 lc->ecc=ec_calibrator_new(lc->sound_conf.play_sndcard,lc->sound_conf.capt_sndcard,rate,cb,cb_data);