sjero.net Git - linphone/blob - coreapi/ec-calibrator.c

   1 /*
   2 linphone
   3 Copyright (C) 2011 Belledonne Communications SARL
   4 Author: Simon MORLAT (simon.morlat@linphone.org)
   5
   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.
  10
  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.
  15
  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.
  19 */
  20
  21 #include "private.h"
  22
  23 #include "mediastreamer2/mstonedetector.h"
  24 #include "mediastreamer2/dtmfgen.h"
  25
  26 #include "lpconfig.h"
  27
  28
  29
  30 static void ecc_init_filters(EcCalibrator *ecc){
  31         unsigned int rate;
  32         int channels = 1;
  33         int ecc_channels = 1;
  34         MSTickerParams params={0};
  35         params.name="Echo calibrator";
  36         params.prio=MS_TICKER_PRIO_HIGH;
  37         ecc->ticker=ms_ticker_new_with_params(&params);
  38
  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);
  49
  50
  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);
  54
  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);
  58
  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);
  64
  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);
  73
  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);
  77
  78         ms_ticker_attach(ecc->ticker,ecc->sndread);
  79         ms_ticker_attach(ecc->ticker,ecc->play);
  80
  81 }
  82
  83 static void ecc_deinit_filters(EcCalibrator *ecc){
  84         ms_ticker_detach(ecc->ticker,ecc->sndread);
  85         ms_ticker_detach(ecc->ticker,ecc->play);
  86
  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);
  90
  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);
  94
  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);
 103
 104         ms_ticker_destroy(ecc->ticker);
 105 }
 106
 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);
 112 }
 113
 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;
 122         }else{
 123                 ms_error("Calibrator bug.");
 124                 return FALSE;
 125         }
 126         if (*toneflag){
 127                 ms_message("Duplicated tone event, ignored.");
 128                 return FALSE;
 129         }
 130         *toneflag=TRUE;
 131         return TRUE;
 132 }
 133
 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);
 140         }
 141 }
 142
 143 static void ecc_play_tones(EcCalibrator *ecc){
 144         MSDtmfGenCustomTone tone;
 145         MSToneDetectorDef expected_tone;
 146
 147         memset(&tone,0,sizeof(tone));
 148         memset(&expected_tone,0,sizeof(expected_tone));
 149
 150         ms_filter_set_notify_callback(ecc->det,on_tone_received,ecc);
 151
 152         /* configure the tones to be scanned */
 153
 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;
 158
 159         ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
 160
 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;
 165
 166         ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
 167
 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;
 172
 173         ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
 174
 175         /*play an initial tone to startup the audio playback/capture*/
 176
 177         tone.frequencies[0]=140;
 178         tone.duration=1000;
 179         tone.amplitude=0.5;
 180
 181         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 182         ms_sleep(2);
 183
 184         ms_filter_set_notify_callback(ecc->gen,on_tone_sent,ecc);
 185
 186         /* play the three tones*/
 187
 188         tone.frequencies[0]=2000;
 189         tone.duration=100;
 190         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 191         ms_usleep(300000);
 192
 193         tone.frequencies[0]=2300;
 194         tone.duration=100;
 195         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 196         ms_usleep(300000);
 197
 198         tone.frequencies[0]=2500;
 199         tone.duration=100;
 200         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 201         ms_sleep(1);
 202
 203         if (ecc->freq1 && ecc->freq2 && ecc->freq3) {
 204                 int delay=ecc->acc/3;
 205                 if (delay<0){
 206                         ms_error("Quite surprising calibration result, delay=%i",delay);
 207                         ecc->status=LinphoneEcCalibratorFailed;
 208                 }else{
 209                         ms_message("Echo calibration estimated delay to be %i ms",delay);
 210                         ecc->delay=delay;
 211                         ecc->status=LinphoneEcCalibratorDone;
 212                 }
 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;
 216         } else {
 217                         ecc->status = LinphoneEcCalibratorFailed;
 218         }
 219
 220         if (ecc->status == LinphoneEcCalibratorFailed) {
 221                 ms_error("Echo calibration failed.");
 222         }
 223 }
 224
 225 static void  * ecc_thread(void *p){
 226         EcCalibrator *ecc=(EcCalibrator*)p;
 227
 228         ecc_init_filters(ecc);
 229         ecc_play_tones(ecc);
 230         ecc_deinit_filters(ecc);
 231         ms_thread_exit(NULL);
 232         return NULL;
 233 }
 234
 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);
 237
 238         ecc->rate=rate;
 239         ecc->cb=cb;
 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);
 244         return ecc;
 245 }
 246
 247 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc){
 248         return ecc->status;
 249 }
 250
 251 void ec_calibrator_destroy(EcCalibrator *ecc){
 252         ms_thread_join(ecc->thread,NULL);
 253         ms_free(ecc);
 254 }
 255
 256 int linphone_core_start_echo_calibration(LinphoneCore *lc, LinphoneEcCalibrationCallback cb, void *cb_data){
 257         if (lc->ecc!=NULL){
 258                 ms_error("Echo calibration is still on going !");
 259                 return -1;
 260         }
 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);
 263         return 0;
 264 }
 265