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->sent_count++;
 101         ecc->acc-=ev->tone_start_time;
 102         ms_message("Sent tone at %u",(unsigned int)ev->tone_start_time);
 103 }
 104
 105 static void on_tone_received(void *data, MSFilter *f, unsigned int event_id, void *arg){
 106         MSToneDetectorEvent *ev=(MSToneDetectorEvent*)arg;
 107         EcCalibrator *ecc=(EcCalibrator*)data;
 108         ecc->recv_count++;
 109         ecc->acc+=ev->tone_start_time;
 110         ms_message("Received tone at %u",(unsigned int)ev->tone_start_time);
 111 }
 112
 113 static void ecc_play_tones(EcCalibrator *ecc){
 114         MSDtmfGenCustomTone tone;
 115         MSToneDetectorDef expected_tone;
 116
 117         ms_filter_set_notify_callback(ecc->det,on_tone_received,ecc);
 118
 119         expected_tone.frequency=2000;
 120         expected_tone.min_duration=40;
 121         expected_tone.min_amplitude=0.02;
 122
 123         ms_filter_call_method (ecc->det,MS_TONE_DETECTOR_ADD_SCAN,&expected_tone);
 124
 125         tone.frequency=1300;
 126         tone.duration=1000;
 127         tone.amplitude=1.0;
 128
 129         /*play an initial tone to startup the audio playback/capture*/
 130         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 131         ms_sleep(2);
 132
 133         ms_filter_set_notify_callback(ecc->gen,on_tone_sent,ecc);
 134         tone.frequency=2000;
 135         tone.duration=100;
 136
 137         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 138         ms_sleep(1);
 139         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 140         ms_sleep(1);
 141         ms_filter_call_method(ecc->gen,MS_DTMF_GEN_PLAY_CUSTOM,&tone);
 142         ms_sleep(1);
 143
 144         if (ecc->sent_count==3) {
 145                 if (ecc->recv_count==3){
 146                         int delay=ecc->acc/3;
 147                         if (delay<0){
 148                                 ms_error("Quite surprising calibration result, delay=%i",delay);
 149                                 ecc->status=LinphoneEcCalibratorFailed;
 150                         }else{
 151                                 ms_message("Echo calibration estimated delay to be %i ms",delay);
 152                                 ecc->delay=delay;
 153                                 ecc->status=LinphoneEcCalibratorDone;
 154                         }
 155                 } else if (ecc->recv_count == 0) {
 156                         ms_message("Echo calibration succeeded, no echo has been detected");
 157                         ecc->status = LinphoneEcCalibratorDoneNoEcho;
 158                 } else {
 159                         ecc->status = LinphoneEcCalibratorFailed;
 160                 }
 161         }else{
 162                 ecc->status=LinphoneEcCalibratorFailed;
 163         }
 164         if (ecc->status == LinphoneEcCalibratorFailed) {
 165                 ms_error("Echo calibration failed, tones received = %i",ecc->recv_count);
 166         }
 167 }
 168
 169 static void  * ecc_thread(void *p){
 170         EcCalibrator *ecc=(EcCalibrator*)p;
 171
 172         ecc_init_filters(ecc);
 173         ecc_play_tones(ecc);
 174         ecc_deinit_filters(ecc);
 175         ms_thread_exit(NULL);
 176         return NULL;
 177 }
 178
 179 EcCalibrator * ec_calibrator_new(MSSndCard *play_card, MSSndCard *capt_card, unsigned int rate, LinphoneEcCalibrationCallback cb, void *cb_data ){
 180         EcCalibrator *ecc=ms_new0(EcCalibrator,1);
 181
 182         ecc->rate=rate;
 183         ecc->cb=cb;
 184         ecc->cb_data=cb_data;
 185         ecc->capt_card=capt_card;
 186         ecc->play_card=play_card;
 187         ms_thread_create(&ecc->thread,NULL,ecc_thread,ecc);
 188         return ecc;
 189 }
 190
 191 LinphoneEcCalibratorStatus ec_calibrator_get_status(EcCalibrator *ecc){
 192         return ecc->status;
 193 }
 194
 195 void ec_calibrator_destroy(EcCalibrator *ecc){
 196         ms_thread_join(ecc->thread,NULL);
 197         ms_free(ecc);
 198 }
 199
 200 int linphone_core_start_echo_calibration(LinphoneCore *lc, LinphoneEcCalibrationCallback cb, void *cb_data){
 201         if (lc->ecc!=NULL){
 202                 ms_error("Echo calibration is still on going !");
 203                 return -1;
 204         }
 205         unsigned int rate = lp_config_get_int(lc->config,"sound","echo_cancellation_rate",8000);
 206         lc->ecc=ec_calibrator_new(lc->sound_conf.play_sndcard,lc->sound_conf.capt_sndcard,rate,cb,cb_data);
 207         return 0;
 208 }
 209