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         MSTickerParams params={0};
  33         params.name="Echo calibrator";
  34         params.prio=MS_TICKER_PRIO_HIGH;
  35         ecc->ticker=ms_ticker_new_with_params(&params);
  36
  37         ecc->sndread=ms_snd_card_create_reader(ecc->play_card);
  38         ms_filter_call_method(ecc->sndread,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
  39         ms_filter_call_method(ecc->sndread,MS_FILTER_GET_SAMPLE_RATE,&rate);
  40         ecc->read_resampler=ms_filter_new(MS_RESAMPLE_ID);
  41         ms_filter_call_method(ecc->read_resampler,MS_FILTER_SET_SAMPLE_RATE,&rate);
  42         ms_filter_call_method(ecc->read_resampler,MS_FILTER_SET_OUTPUT_SAMPLE_RATE,&ecc->rate);
  43
  44
  45         ecc->det=ms_filter_new(MS_TONE_DETECTOR_ID);
  46         ms_filter_call_method(ecc->det,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
  47         ecc->rec=ms_filter_new(MS_FILE_REC_ID);
  48
  49         ms_filter_link(ecc->sndread,0,ecc->read_resampler,0);
  50         ms_filter_link(ecc->read_resampler,0,ecc->det,0);
  51         ms_filter_link(ecc->det,0,ecc->rec,0);
  52
  53         ecc->play=ms_filter_new(MS_FILE_PLAYER_ID);
  54         ecc->gen=ms_filter_new(MS_DTMF_GEN_ID);
  55         ms_filter_call_method(ecc->gen,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
  56         ecc->write_resampler=ms_filter_new(MS_RESAMPLE_ID);
  57         ecc->sndwrite=ms_snd_card_create_writer(ecc->capt_card);
  58
  59         ms_filter_call_method(ecc->sndwrite,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
  60         ms_filter_call_method(ecc->sndwrite,MS_FILTER_GET_SAMPLE_RATE,&rate);
  61         ms_filter_call_method(ecc->write_resampler,MS_FILTER_SET_SAMPLE_RATE,&ecc->rate);
  62         ms_filter_call_method(ecc->write_resampler,MS_FILTER_SET_OUTPUT_SAMPLE_RATE,&rate);
  63
  64         ms_filter_link(ecc->play,0,ecc->gen,0);
  65         ms_filter_link(ecc->gen,0,ecc->write_resampler,0);
  66         ms_filter_link(ecc->write_resampler,0,ecc->sndwrite,0);
  67
  68         ms_ticker_attach(ecc->ticker,ecc->sndread);
  69         ms_ticker_attach(ecc->ticker,ecc->play);
  70
  71 }
  72
  73 static void ecc_deinit_filters(EcCalibrator *ecc){
  74         ms_ticker_detach(ecc->ticker,ecc->sndread);
  75         ms_ticker_detach(ecc->ticker,ecc->play);
  76
  77         ms_filter_unlink(ecc->play,0,ecc->gen,0);
  78         ms_filter_unlink(ecc->gen,0,ecc->write_resampler,0);
  79         ms_filter_unlink(ecc->write_resampler,0,ecc->sndwrite,0);
  80
  81         ms_filter_unlink(ecc->sndread,0,ecc->read_resampler,0);
  82         ms_filter_unlink(ecc->read_resampler,0,ecc->det,0);
  83         ms_filter_unlink(ecc->det,0,ecc->rec,0);
  84
  85         ms_filter_destroy(ecc->sndread);
  86         ms_filter_destroy(ecc->det);
  87         ms_filter_destroy(ecc->rec);
  88         ms_filter_destroy(ecc->play);
  89         ms_filter_destroy(ecc->gen);
  90         ms_filter_destroy(ecc->read_resampler);
  91         ms_filter_destroy(ecc->write_resampler);
  92         ms_filter_destroy(ecc->sndwrite);
  93
  94         ms_ticker_destroy(ecc->ticker);
  95 }
  96
  97 static void on_tone_sent(void *data, MSFilter *f, unsigned int event_id, void *arg){
  98         MSDtmfGenEvent *ev=(MSDtmfGenEvent*)arg;
  99         EcCalibrator *ecc=(EcCalibrator*)data;
 100         ecc->acc-=ev->tone_start_time;
 101         ms_message("Sent tone at %u",(unsigned int)ev->tone_start_time);
 102 }
 103
 104 static bool_t is_valid_tone(EcCalibrator *ecc, MSToneDetectorEvent *ev){
 105         bool_t *toneflag=NULL;
 106         if (strcmp(ev->tone_name,"freq1")==0){
 107                 toneflag=&ecc->freq1;
 108         }else if (strcmp(ev->tone_name,"freq2")==0){
 109                 toneflag=&ecc->freq2;
 110         }else if (strcmp(ev->tone_name,"freq3")==0){
 111                 toneflag=&ecc->freq3;
 112         }else{
 113                 ms_error("Calibrator bug.");
 114                 return FALSE;
 115         }
 116         if (*toneflag){
 117                 ms_message("Duplicated tone event, ignored.");
 118                 return FALSE;
 119         }
 120         *toneflag=TRUE;
 121         return TRUE;
 122 }
 123
 124 static void on_tone_received(void *data, MSFilter *f, unsigned int event_id, void *arg){
 125         MSToneDetectorEvent *ev=(MSToneDetectorEvent*)arg;
 126         EcCalibrator *ecc=(EcCalibrator*)data;
 127         if (is_valid_tone(ecc,ev)){
 128                 ecc->acc+=ev->tone_start_time;
 129                 ms_message("Received tone at %u",(unsigned int)ev->tone_start_time);
 130         }
 131 }
 132
 133 static void ecc_play_tones(EcCalibrator *ecc){
 134         MSDtmfGenCustomTone tone;
 135         MSToneDetectorDef expected_tone;
 136
 137         ms_filter_set_notify_callback(ecc->det,on_tone_received,ecc);
 138
 139         /* configure the tones to be scanned */
 140
 141         strncpy(expected_tone.tone_name,"freq1",sizeof(expected_tone.tone_name));
 142         expected_tone.frequency=2000;
 143         expected_tone.min_duration=40;
 144         expected_tone.min_amplitude=0.1;
 145
 146         ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
 147
 148         strncpy(expected_tone.tone_name,"freq2",sizeof(expected_tone.tone_name));
 149         expected_tone.frequency=2300;
 150         expected_tone.min_duration=40;
 151         expected_tone.min_amplitude=0.1;
 152
 153         ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
 154
 155         strncpy(expected_tone.tone_name,"freq3",sizeof(expected_tone.tone_name));
 156         expected_tone.frequency=2500;
 157         expected_tone.min_duration=40;
 158         expected_tone.min_amplitude=0.1;
 159
 160         ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
 161
 162         /*play an initial tone to startup the audio playback/capture*/
 163
 164         tone.frequency=140;
 165         tone.duration=1000;
 166         tone.amplitude=0.5;
 167
 168         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 169         ms_sleep(2);
 170
 171         ms_filter_set_notify_callback(ecc->gen,on_tone_sent,ecc);
 172
 173         /* play the three tones*/
 174
 175         tone.frequency=2000;
 176         tone.duration=100;
 177         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 178         ms_usleep(300000);
 179
 180         tone.frequency=2300;
 181         tone.duration=100;
 182         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 183         ms_usleep(300000);
 184
 185         tone.frequency=2500;
 186         tone.duration=100;
 187         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 188         ms_sleep(1);
 189
 190         if (ecc->freq1 && ecc->freq2 && ecc->freq3) {
 191                 int delay=ecc->acc/3;
 192                 if (delay<0){
 193                         ms_error("Quite surprising calibration result, delay=%i",delay);
 194                         ecc->status=LinphoneEcCalibratorFailed;
 195                 }else{
 196                         ms_message("Echo calibration estimated delay to be %i ms",delay);
 197                         ecc->delay=delay;
 198                         ecc->status=LinphoneEcCalibratorDone;
 199                 }
 200         } else if ((ecc->freq1 || ecc->freq2 || ecc->freq3)==FALSE) {
 201                         ms_message("Echo calibration succeeded, no echo has been detected");
 202                         ecc->status = LinphoneEcCalibratorDoneNoEcho;
 203         } else {
 204                         ecc->status = LinphoneEcCalibratorFailed;
 205         }
 206
 207         if (ecc->status == LinphoneEcCalibratorFailed) {
 208                 ms_error("Echo calibration failed.");
 209         }
 210 }
 211
 212 static void  * ecc_thread(void *p){
 213         EcCalibrator *ecc=(EcCalibrator*)p;
 214
 215         ecc_init_filters(ecc);
 216         ecc_play_tones(ecc);
 217         ecc_deinit_filters(ecc);
 218         ms_thread_exit(NULL);
 219         return NULL;
 220 }
 221
 222 EcCalibrator * ec_calibrator_new(MSSndCard *play_card, MSSndCard *capt_card, unsigned int rate, LinphoneEcCalibrationCallback cb, void *cb_data ){
 223         EcCalibrator *ecc=ms_new0(EcCalibrator,1);
 224
 225         ecc->rate=rate;
 226         ecc->cb=cb;
 227         ecc->cb_data=cb_data;
 228         ecc->capt_card=capt_card;
 229         ecc->play_card=play_card;
 230         ms_thread_create(&ecc->thread,NULL,ecc_thread,ecc);
 231         return ecc;
 232 }
 233
 234 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc){
 235         return ecc->status;
 236 }
 237
 238 void ec_calibrator_destroy(EcCalibrator *ecc){
 239         ms_thread_join(ecc->thread,NULL);
 240         ms_free(ecc);
 241 }
 242
 243 int linphone_core_start_echo_calibration(LinphoneCore *lc, LinphoneEcCalibrationCallback cb, void *cb_data){
 244         if (lc->ecc!=NULL){
 245                 ms_error("Echo calibration is still on going !");
 246                 return -1;
 247         }
 248         unsigned int rate = lp_config_get_int(lc->config,"sound","echo_cancellation_rate",8000);
 249         lc->ecc=ec_calibrator_new(lc->sound_conf.play_sndcard,lc->sound_conf.capt_sndcard,rate,cb,cb_data);
 250         return 0;
 251 }
 252