managerimpl.h 35.1 KB
Newer Older
jpbl's avatar
jpbl committed
1
2
3
4
/*
 *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
 *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
 *  Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
5
 *  Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
6
 *  Author: Guillaume Carmel-Archambault <guillaume.carmel-archambault@savoirfairelinux.com>
jpbl's avatar
jpbl committed
7
8
9
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
10
 *  the Free Software Foundation; either version 3 of the License, or
jpbl's avatar
jpbl committed
11
12
13
14
15
16
17
18
19
20
21
22
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

23
24
#ifndef __SFL_MANAGER_H__
#define __SFL_MANAGER_H__
jpbl's avatar
jpbl committed
25
26
27

#include <string>
#include <vector>
yanmorin's avatar
   
yanmorin committed
28
#include <set>
yanmorin's avatar
   
yanmorin committed
29
#include <map>
jpbl's avatar
jpbl committed
30
#include <cc++/thread.h>
31
#include "dbus/dbusmanager.h"
jpbl's avatar
jpbl committed
32
33
34

#include "observer.h"
#include "config/config.h"
yanmorin's avatar
   
yanmorin committed
35

yanmorin's avatar
   
yanmorin committed
36
#include "account.h"
yanmorin's avatar
   
yanmorin committed
37
#include "call.h"
38
#include "conference.h"
39
#include "numbercleaner.h"
jpbl's avatar
jpbl committed
40

41
42
43
44
#include "audio/sound/tonelist.h"  // for Tone::TONEID declaration
#include "audio/sound/audiofile.h" // AudioFile class contained by value here 
#include "audio/sound/dtmf.h" // DTMF class contained by value here
#include "audio/codecs/codecDescriptor.h" // CodecDescriptor class contained by value here
jpbl's avatar
jpbl committed
45
46
47
48
49

class AudioLayer;
class GuiFramework;
class TelephoneTone;
class VoIPLink;
50

51
// class Conference;
yanmorin's avatar
   
yanmorin committed
52

jpbl's avatar
jpbl committed
53
54
55
56
#ifdef USE_ZEROCONF
class DNSService;
#endif

57
class HistoryManager;
58
class SIPAccount;
jpbl's avatar
jpbl committed
59

60
/** Define a type for a AccountMap container */
yanmorin's avatar
   
yanmorin committed
61
typedef std::map<AccountID, Account*> AccountMap;
62
63

/** Define a type for a CallID to AccountID Map inside ManagerImpl */
yanmorin's avatar
   
yanmorin committed
64
typedef std::map<CallID, AccountID> CallAccountMap;
yanmorin's avatar
   
yanmorin committed
65

Emmanuel Milou's avatar
Emmanuel Milou committed
66
67
typedef std::map<CallID, Call::CallConfiguration> CallConfigMap;

68
/** Define a type for CallID vector (waiting list, incoming not answered) */
yanmorin's avatar
   
yanmorin committed
69
70
typedef std::set<CallID> CallIDSet;

71
/** To send multiple string */
jpbl's avatar
jpbl committed
72
73
typedef std::list<std::string> TokenList;

74
75
/** To store conference objects by call ids 
    used to retreive the conference according to a call */
76
77
78
typedef std::map<CallID, Conference*> ConferenceCallMap;

/** To store conference objects by conference ids */
79
80
81
82
typedef std::map<CallID, Conference*> ConferenceMap;

static CallID default_conf = "conf"; 

83

84
85
86
87
88
89
90
91
92
93
94
95
static char * mapStateToChar[] = {
    (char*) "UNREGISTERED",
    (char*) "TRYING",
    (char*) "REGISTERED",
    (char*) "ERROR",
    (char*) "ERRORAUTH",
    (char*) "ERRORNETWORK",
    (char*) "ERRORHOST",
    (char*) "ERROREXISTSTUN",    
    (char*) "ERRORCONFSTUN"    
};

96
/** Manager (controller) of sflphone daemon */
jpbl's avatar
jpbl committed
97
class ManagerImpl {
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
  public:
    ManagerImpl (void);
    ~ManagerImpl (void);

    /**
     * Initialisation of thread (sound) and map.
     * Init a new VoIPLink, audio codec and audio driver
     */
    void init (void);

    /**
     * Terminate all thread (sound, link) and unload AccountMap
     */
    void terminate (void);

    /**
     * Set user interface manager.
     * @param man The DBUS interface implementation
     */
    void setDBusManager (DBusManagerImpl* man) { _dbus = man; }

    /**
     * Accessor to audiodriver.
     * it's multi-thread and use mutex internally
     * @return AudioLayer*  The audio layer object
     */
    AudioLayer* getAudioDriver(void) const { return _audiodriver; }

    /**
     * Get a descriptor map of codec available
     * @return CodecDescriptor  The internal codec map
     */
    CodecDescriptor& getCodecDescriptorMap(void) {return _codecDescriptorMap;}

    /**
     * Functions which occur with a user's action
     * Place a new call
     * @param accountId	The account to make tha call with
     * @param id  The call identifier
     * @param to  The recipient of the call
     * @return bool true on success
     *		  false otherwise
     */
    bool outgoingCall(const AccountID& accountId, const CallID& id, const std::string& to);

    /**
     * Functions which occur with a user's action
     * Answer the call
     * @param id  The call identifier
     */
    bool answerCall(const CallID& id);

    /**
     * Functions which occur with a user's action
     * Hangup the call
     * @param id  The call identifier
     */
    bool hangupCall(const CallID& id);

Alexandre Savard's avatar
Alexandre Savard committed
157
158
159
160
161
162
163
164

    /**
     * Functions which occur with a user's action
     * Hangup the conference (hangup every participants)
     * @param id  The call identifier
     */
    bool hangupConference(const ConfID& id);

165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
    /**
     * Functions which occur with a user's action
     * Cancel the call
     * @param id  The call identifier
     */
    bool cancelCall(const CallID& id);

    /**
     * Functions which occur with a user's action
     * Put the call on hold
     * @param id  The call identifier
     */
    bool onHoldCall(const CallID& id);

    /**
     * Functions which occur with a user's action
     * Put the call off hold
     * @param id  The call identifier
     */
    bool offHoldCall(const CallID& id);

    /**
     * Functions which occur with a user's action
     * Transfer the call
     * @param id  The call identifier
     * @param to  The recipient of the transfer
     */
    bool transferCall(const CallID& id, const std::string& to);

194
195
196
197
198
199
200
201
202
203
    /**
     * Notify the client the transfer is successful
     */
    void transferSucceded();

    /**
     * Notify the client that the transfer failed
     */
    void transferFailed();

204
205
206
207
208
209
210
    /**
     * Functions which occur with a user's action
     * Refuse the call
     * @param id  The call identifier
     */
    bool refuseCall(const CallID& id);

211
    Conference* createConference(const CallID& id1, const CallID& id2);
212

213
214
    void removeConference(const CallID& conference_id);

215
216
    Conference* getConferenceFromCallID(const CallID& call_id);

217
218
219
220
    void holdConference(const CallID& conferece_id);

    void unHoldConference(const CallID& conference_id);

221
222
    bool isConference(const CallID& call_id);

223
224
    bool participToConference(const CallID& call_id);

225
    void addParticipant(const CallID& call_id, const CallID& conference_id);
226

227
228
    void addMainParticipant(const CallID& conference_id);

229
230
    void joinParticipant(const CallID& call_id1, const CallID& call_id2);

231
    void detachParticipant(const CallID& call_id, const CallID& current_call_id);
232

233
    void removeParticipant(const CallID& call_id);
234

235
236
    void processRemainingParticipant(CallID current_call_id, Conference *conf);

237
238
    void joinConference(const CallID& conf_id1, const CallID& conf_id2);

239
240
    void addStream(const CallID& call_id);

241
242
    void removeStream(const CallID& call_id);

243
244
    /**
     * Save config to file
245
246
247
248
249
250
251
     * @return true on success
     *	    false otherwise
     */
    bool saveConfig (void);

    /**
     * Send registration to all enabled accounts
252
253
     * @return 0 on registration success
     *          1 otherelse
254
     */
255
    int initRegisterAccounts();
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

    /**
     * @return true if we tried to register once
     */
    bool _hasTriedToRegister;

    /**
     * Handle choice of the DTMF-send-way
     * @param   id: callid of the line.
     * @param   code: pressed key.
     */
    bool sendDtmf(const CallID& id, char code);

    /**
     * Play the dtmf-associated sound
     * @param code  The pressed key
     * @param isTalking	In conversation or not. Useful to know whether or not the sound streams are started
     */
    bool playDtmf(char code, bool isTalking);

    /**
     * Play a ringtone
     * @return bool True on success
     *	      false otherwise
     */
    bool playTone ();

    /**
284
     * Play a special ringtone ( BUSY ) if there's at least one message on the voice mail
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
     * @return bool True on success
     *	      false otherwise
     */
    bool playToneWithMessage ();

    /**
     * Acts on the audio streams and audio files
     * @param stopAudio	Tells whether or not to stop the streams
     */
    void stopTone(bool stopAudio);

    /**
     * When receiving a new incoming call, add it to the callaccount map
     * and notify user
     * @param call A call pointer
     * @param accountId an account id
     * @return bool True if the call was added correctly
     */
    bool incomingCall(Call* call, const AccountID& accountId);

    /**
     * Notify the user that the recipient of the call has answered and the put the
     * call in Current state
     * @param id  The call identifier
     */
    void peerAnsweredCall(const CallID& id);

    /**
     * Rings back because the outgoing call is ringing and the put the
     * call in Ringing state
     * @param id  The call identifier
     */
    void peerRingingCall(const CallID& id);

    /**
     * Put the call in Hungup state, remove the call from the list
     * @param id  The call identifier
     */
    void peerHungupCall(const CallID& id);

    /**
     * Notify the client with an incoming message
     * @param accountId	The account identifier
     * @param message The content of the message
     */
    void incomingMessage(const AccountID& accountId, const std::string& message);

    /**
333
     * Notify the client he has voice mails
334
335
336
     * @param accountId	  The account identifier
     * @param nb_msg The number of messages
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
337
    void startVoiceMessageNotification(const AccountID& accountId, int nb_msg);
338

339
340
    /**
     * Notify the client through DBus that registration state has been updated
341
     */
342
    void connectionStatusNotification(void);
343
344
345

    /**
     * ConfigurationManager - Send registration request
346
     * @param accountId The account to register/unregister
347
     * @param enable The flag for the type of registration
348
349
350
     *		 0 for unregistration request
     *		 1 for registration request
     */
351
    void sendRegister( const ::std::string& accountId , const int32_t& enable);
352
353
354

    bool getCallStatus(const std::string& sequenceId);

355
356
    /**
     * Get account list
357
358
359
360
     * @return std::vector<std::string> A list of accoundIDs
     */
    std::vector< std::string >  getAccountList();

361
362
363
364
365
    /**
     * Set the account order in the config file
     */
    void setAccountsOrder (const std::string& order);

366
367
368
369
370
371
372
    /**
     * Retrieve details about a given account
     * @param accountID	  The account identifier
     * @return std::map< std::string, std::string > The account details
     */
    std::map< std::string, std::string > getAccountDetails(const AccountID& accountID);

373
374
375
376
377
378
379
    /**
     * Retrieve details about a given call
     * @param callID	  The account identifier
     * @return std::map< std::string, std::string > The call details
     */
    std::map< std::string, std::string > getCallDetails(const CallID& callID);

380
381
382
383
384
385
    /**
     * Get call list
     * @return std::vector<std::string> A list of call IDs
     */
    std::vector< std::string >  getCallList (void);

386
387
388
389
390
391
392
393
394
395
396
397
398
    /**
     * Retrieve details about a given call
     * @param callID	  The account identifier
     * @return std::map< std::string, std::string > The call details
     */
    std::map< std::string, std::string > getConferenceDetails(const CallID& callID);

    /**
     * Get call list
     * @return std::vector<std::string> A list of call IDs
     */
    std::vector< std::string >  getConferenceList (void);

399
400
401
402
403
404
405

    /**
     * Get a list of participant to a conference
     * @return std::vector<std::string> A list of call IDs
     */
    std::vector< std::string >  getParticipantList (const std::string& confID);

406
407
408
409
410
411
412
    /**
     * Save the details of an existing account, given the account ID
     * This will load the configuration map with the given data.
     * It will also register/unregister links where the 'Enabled' switched.
     * @param accountID	  The account identifier
     * @param details	  The account parameters
     */
413
    void setAccountDetails( const ::std::string& accountID,
414
	const std::map< ::std::string, ::std::string >& details );
415
416
417
418

    /**
     * Add a new account, and give it a new account ID automatically
     * @param details The new account parameters
jquentin's avatar
jquentin committed
419
     * @return The account Id given to the new account
420
     */
jquentin's avatar
jquentin committed
421
    std::string addAccount(const std::map< ::std::string, ::std::string >& details);
422
423
424
425
426
427
428
429

    /**
     * Delete an existing account, unregister VoIPLink associated, and
     * purge from configuration.
     * @param accountID	The account unique ID
     */
    void removeAccount(const AccountID& accountID);

430
431
432
433
434
435
436

    /**
     * Deletes all credentials defined for an account
     * @param accountID The account unique ID
     */
    void deleteAllCredential(const AccountID& accountID);
    
437
438
439
    /**
     * Get the list of codecs we supports, not ordered
     * @return The list of the codecs
440
     */
441
    std::vector< ::std::string > getCodecList( void );
442
443
444
445
446
447
448

    /**
     * Get the info about one codec
     * Name / Clock rate / bitrate / bandwidth
     * @param payload The payload of the codec
     * @return std::vector<::DBus::string> The information
     */
449
    std::vector< ::std::string > getCodecDetails( const int32_t& payload);
450

Alexandre Savard's avatar
Alexandre Savard committed
451
452
453
454
455
456
457
    /**
     * Get current codec name
     * @param call id
     * @return std::string The codec name
     */
    std::string getCurrentCodecName(const CallID& id);

458
459
460
461
462
463
464
465
466
467
468
469
470
    /**
     * Get a list of supported input audio plugin
     * @return std::vector<std::string> List of names
     */
    std::vector< std::string> getInputAudioPluginList(void);

    /**
     * Get a list of supported output audio plugin
     * @return std::vector<std::string> List of names
     */
    std::vector< std::string> getOutputAudioPluginList(void);

    /**
471
     * Set input audio plugin
472
473
474
475
476
     * @param audioPlugin The audio plugin
     */
    void setInputAudioPlugin(const std::string& audioPlugin);

    /**
477
     * Set output audio plugin
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
     * @param audioPlugin The audio plugin
     */
    void setOutputAudioPlugin(const std::string& audioPlugin);

    /**
     * Get list of supported audio output device
     * @return std::vector<std::string> A list of the audio devices supporting playback
     */
    std::vector<std::string> getAudioOutputDeviceList(void);

    /**
     * Set audio output device
     * @param index The index of the soundcard
     */
    void setAudioOutputDevice(const int index);

    /**
     * Get list of supported audio input device
     * @return std::vector<std::string> A list of the audio devices supporting capture
     */
    std::vector<std::string> getAudioInputDeviceList(void);

    /**
     * Set audio input device
     * @param index The index of the soundcard
     */
    void setAudioInputDevice(const int index);

    /**
     * Get string array representing integer indexes of output and input device
     * @return std::vector<std::string> A list of the current audio devices
     */
    std::vector<std::string> getCurrentAudioDevicesIndex();

    /**
     * Get index of an audio device
     * @param name The string description of an audio device
     * @return int  His index
     */
    int getAudioDeviceIndex( const std::string name );

    /*
     * Get current alsa plugin
     * @return std::string  The Alsa plugin
     */
523
    std::string getCurrentAudioOutputPlugin( void );
524
525
526
527
528
529
530
531

    /**
     * Convert a list of payload in a special format, readable by the server.
     * Required format: payloads separated with one slash.
     * @return std::string The serializabled string
     */
    std::string serialize(std::vector<std::string> v);

532
533
    std::vector<std::string> unserialize(std::string v);

534
535
536
537
538
    /**
     * Tells if IAX2 support is enabled
     * @return int 1 if IAX2 is enabled
     *	       0 otherwise
     */
539
    int isIax2Enabled( void );
540
541
542

    /**
     * Ringtone option.
543
     * If ringtone is enabled, ringtone on incoming call use custom choice. If not, only standart tone.
544
545
546
     * @return int	1 if enabled
     *	        0 otherwise
     */
547
    int isRingtoneEnabled( void );
548
549

    /**
550
     * Set the ringtone option
551
552
     * Inverse current value
     */
553
    void ringtoneEnabled( void );
554
555

    /**
556
     * Get the ringtone
557
558
559
560
561
562
563
564
565
566
     * @return gchar* The file name selected as a ringtone
     */
    std::string getRingtoneChoice( void );

    /**
     * Set a ringtone
     * @param tone The file name of the ringtone
     */
    void setRingtoneChoice( const std::string& );

567
568
569
570
571
572
573
574
575
576
    /**
     * Get the recording path from configuration tree
     * @return the string correspoding to the path
     */
    std::string getRecordPath( void );

    /**
     * Set the recoding path in the configuration tree
     * @param a string reresenting the path
     */
alexandresavard's avatar
alexandresavard committed
577
    void setRecordPath( const std::string& recPath);
578

579
580
581
582
583
584
585
586
587
588
589
590
    /** 
     * Set a credential for a given account. If it 
     * does not exist yet, it will be created.
     */
    void setCredential (const std::string& accountID, const int32_t& index, const std::map< std::string, std::string >& details);

    /**
     * Retreive the value set in the configuration file.
     * @return True if credentials hashing is enabled.
     */
    bool getMd5CredentialHashing(void);
    
591
    /**
592
     * Tells if the user wants to display the dialpad or not
593
594
595
596
597
598
599
600
601
602
     * @return int 1 if dialpad has to be displayed
     *	       0 otherwise
     */
    int getDialpad( void );

    /**
     * Set the dialpad visible or not
     */
    void setDialpad( void );

603
    /**
604
     * Tells if the user wants to display the volume controls or not
605
606
607
608
609
610
611
612
613
614
     * @return int 1 if the controls have to be displayed
     *	       0 otherwise
     */
    int getVolumeControls( void );

    /**
     * Set the volume controls ( mic and speaker ) visible or not
     */
    void setVolumeControls( void );

alexandresavard's avatar
alexandresavard committed
615
    /**
alexandresavard's avatar
alexandresavard committed
616
     * Set recording on / off
alexandresavard's avatar
alexandresavard committed
617
618
619
620
621
     * Start recording
     * @param id  The call identifier
     */
    void setRecordingCall(const CallID& id);

alexandresavard's avatar
alexandresavard committed
622
623
624
625
626
    /**
     * Return true if the call is currently recorded
     */
    bool isRecording(const CallID& id);

627
    /**
628
629
     * Set the maximum number of days to keep in the history
     * @param calls The number of days
630
     */
631
    void setHistoryLimit (const int& days);
632
633

    /**
634
635
     * Get the maximum number of days to keep in the history
     * @return double The number of days 
636
     */
637
638
639
640
    int getHistoryLimit (void);

    void setHistoryEnabled (void);

641
	std::string getHistoryEnabled (void);
642

643

644
645
646
647
648
649
650
651
652
653
654
655
656
657
    /**
     * Configure the start-up option
     * @return int	1 if SFLphone should start in the system tray
     *	        0 otherwise
     */
    int isStartHidden( void );

    /**
     * Configure the start-up option
     * At startup, SFLphone can be displayed or start hidden in the system tray
     */
    void startHidden( void );

    /**
658
     * Configure the popup behaviour
659
     * @return int	1 if it should popup on incoming calls
660
     *		0 if it should never popups
661
662
663
664
     */
    int popupMode( void );

    /**
665
     * Configure the popup behaviour
666
667
668
669
670
     * When SFLphone is in the system tray, you can configure when it popups
     * Never or only on incoming calls
     */
    void switchPopupMode( void );

671
672
673
674
675
676
677
678
679
680
    /**
     * Determine whether or not the search bar (history) should be displayed
     */
    int getSearchbar( void );

    /**
     * Configure the search bar behaviour
     */
    void setSearchbar( void );

681
682
683
684
685
686
687
688
689
    /**
     * Set the desktop notification level
     */
    void setNotify( void );

    /**
     * Get the desktop notification level
     * @return int The notification level
     */
690
    int32_t getNotify( void );
691
692
693
694
695
696

    /**
     * Set the desktop mail notification level
     */
    void setMailNotify( void );

697

Emmanuel Milou's avatar
Emmanuel Milou committed
698
    /**
699
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
700
701
702
703
     */
    std::map<std::string, int32_t> getAddressbookSettings (void);

    /**
704
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
705
     */
706
707
    void setAddressbookSettings (const std::map<std::string, int32_t>& settings);

708
    /**
709
710
711
712
713
714
     * Addressbook list
     */
    void setAddressbookList(const std::vector<  std::string >& list);

    /**
     * Addressbook list
Emmanuel Milou's avatar
Emmanuel Milou committed
715
     */
716
717
    std::vector <std::string> getAddressbookList( void );

718
    /**
719
     * Hook configuration
720
721
722
723
     */
    std::map<std::string, std::string> getHookSettings (void);

    /**
724
     * Hook configuration
725
726
727
     */
     void setHookSettings (const std::map<std::string, std::string>& settings);

Emmanuel Milou's avatar
Emmanuel Milou committed
728

729
    /**
730
731
732
733
734
     * Get the audio manager
     * @return int The audio manager
     *		    0 ALSA
     *		    1 PULSEAUDIO
     */
735
    int32_t getAudioManager( void );
736
737
738
739

    /**
     * Set the audio manager
     */
740
    void setAudioManager( const int32_t& api );
741
742

    void switchAudioManager( void );
743
744

    void setPulseAppVolumeControl( void );
745
	std::string getPulseAppVolumeControl( void );
746

747
    /**
748
749
750
     * Get the desktop mail notification level
     * @return int The mail notification level
     */
751
    int32_t getMailNotify( void );
752

753
754
755
756
757
758
759
760
761
    /**
     * Retrieve the formatted list of codecs payload in the user config file and
     * load in the active list of codecs
     * @return std::vector<std::string>	  The vector containing the active codecs
     */
    std::vector<std::string> retrieveActiveCodecs( void );

    /**
     * Get the list of the active codecs
762
     * @return std::vector< ::std::string >  The list of active codecs
763
764
     */
    std::vector< ::std::string > getActiveCodecList( void );
765
766
767
768

    /**
     * Set the list of the active codecs
     * @param list  The new list of active codecs
769
     */
770
    void setActiveCodecList( const std::vector< ::std::string >& list);
771
772
773
774
775
776

    /*
     * Notify the client that an error occured
     * @param errCode The error code. Could be: ALSA_CAPTURE_ERROR
     *					       ALSA_PLAYBACK_ERROR
     */
777
    void notifyErrClient( const int32_t& errCode );
778
779
780
781
782
783
784
785
786
787

    /**
     * Retrieve in the configuration tree the value of a parameter in a specific section
     * @param section	The section to look in
     * @param name	The name of the parameter you want to get
     * @param arg	Undocumented
     * @return bool	true on success
     *			false otherwise
     */
    bool getConfig(const std::string& section, const std::string& name, TokenList& arg);
788

789
790
791
    /**
     * Change a specific value in the configuration tree.
     * This value will then be saved in the user config file sflphonedrc
792
     * @param section	The section name
793
     * @param name	The parameter name
794
     * @param value	The new string value
795
796
797
798
     * @return bool	true on success
     *		      false otherwise
     */
    bool setConfig(const std::string& section, const std::string& name, const std::string& value);
799

800
801
802
    /**
     * Change a specific value in the configuration tree.
     * This value will then be saved in the user config file sflphonedrc
803
     * @param section	The section name
804
     * @param name	The parameter name
805
     * @param value	The new int value
806
807
808
809
     * @return bool	true on success
     *		      false otherwise
     */
    bool setConfig(const std::string& section, const std::string& name, int value);
810
811
812
813
814
815
816
817
818
819
820
821
    
    inline std::string mapStateNumberToString(RegistrationState state) {
        std::string stringRepresentation;
        if (state > NumberOfState) {
            stringRepresentation = "ERROR";
            return stringRepresentation;
        }
        
        stringRepresentation = mapStateToChar[state];
        return stringRepresentation;
    }
    
822
    /**
823
824
825
826
827
828
     * Get a int from the configuration tree
     * Throw an Conf::ConfigTreeItemException if not found
     * @param section The section name to look in
     * @param name    The parameter name
     * @return int    The int value
     */
829
     
830
    int getConfigInt(const std::string& section, const std::string& name);
pierre-luc's avatar
pierre-luc committed
831
832
833
834
835
836
837
838
839
840
841
 
  /**
     * Get a bool from the configuration tree
     * Throw an Conf::ConfigTreeItemException if not found
     * @param section The section name to look in
     * @param name    The parameter name
     * @return bool    The bool value
     */
     
    bool getConfigBool(const std::string& section, const std::string& name);
            
842
    /**
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
     * Get a string from the configuration tree
     * Throw an Conf::ConfigTreeItemException if not found
     * @param section The section name to look in
     * @param name    The parameter name
     * @return sdt::string    The string value
     */
    std::string getConfigString(const std::string& section, const std::string& name);

    /**
     * Retrieve the soundcards index in the user config file and try to open audio devices
     * with a specific alsa plugin.
     * Set the audio layer sample rate
     */
    void selectAudioDriver(void);

    /**
859
     * Handle audio sounds heard by a caller while they wait for their
860
861
862
863
864
865
866
867
868
869
870
871
872
     * connection to a called party to be completed.
     */
    void ringback ();

    /**
     * Handle played music when an incoming call occurs
     */
    void ringtone ();

    /**
     * Handle played music when a congestion occurs
     */
    void congestion ();
873

874
875
876
877
878
879
880
881
882
883
    /**
     * Handle played sound when a call can not be conpleted because of a busy recipient
     */
    void callBusy(const CallID& id);

    /**
     * Handle played sound when a failure occurs
     */
    void callFailure(const CallID& id);

884
    /**
885
     * Retrieve the current telephone tone
886
     * @return AudioLoop*   The audio tone or 0 if no tone (init before calling this function)
887
888
     */
    AudioLoop* getTelephoneTone();
889
890

    /**
891
     * Retrieve the current telephone file
892
     * @return AudioLoop* The audio file or 0 if the wav is stopped
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
     */
    AudioLoop* getTelephoneFile();

    /**
     * @return true is there is one or many incoming call waiting
     * new call, not anwsered or refused
     */
    bool incomingCallWaiting(void);

    /**
     * Notification of incoming call when you are already busy
     */
    void notificationIncomingCall(void);

    /*
     * Inline functions to manage speaker volume control
     * Read by main thread and AudioLayer thread
     * Write by main thread only
     * @return unsigned short	The volume value
     */
    unsigned short getSpkrVolume(void) { return _spkr_volume; }
914

915
916
917
918
919
920
    /*
     * Inline functions to manage speaker volume control
     * Read by main thread and AudioLayer thread
     * Write by main thread only
     * @param spkr_vol	The volume value
     */
921
    void setSpkrVolume(unsigned short spkr_vol);
922

923
924
925
926
927
928
929
    /*
     * Inline functions to manage mic volume control
     * Read by main thread and AudioLayer thread
     * Write by main thread only
     * @return unsigned short	The volume value
     */
    unsigned short getMicVolume(void) {  return _mic_volume;  }
930

931
932
933
934
935
936
    /*
     * Inline functions to manage mic volume control
     * Read by main thread and AudioLayer thread
     * Write by main thread only
     * @param mic_vol	The volume value
     */
937
    void setMicVolume(unsigned short mic_vol);
938
939
940
941
942
943

    /**
     * Init default values for the different fields in the config file.
     * Fills the local _config (Conf::ConfigTree) with the default contents.
     * Called in main.cpp, just before Manager::init().
     */
944
    void initConfigFile ( bool load_user_value=true, std::string alternate="");
945
946
947
948
949
950
951
952

    /**
     * Tell if the setup was already loaded
     * @return bool True if yes
     *		  false otherwise
     */
    bool hasLoadedSetup() { return _setupLoaded; }

953
    /**
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
     * Return a new random callid that is not present in the list
     * @return CallID A brand new callid
     */
    CallID getNewCallID();

    /**
     * Get the current call id
     * @return CallID	The call id or ""
     */
    const CallID& getCurrentCallId();

    /**
     * Check if a call is the current one
     * @param callId the new callid
     * @return bool   True if the id is the current call
     */
    bool isCurrentCall(const CallID& callId);

972
    /**
973
974
975
     * Restart PJSIP
     * @param void
     * @return void
976
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
977
    void restartPJSIP( );
978

979
    void unregisterCurSIPAccounts();
980

Emmanuel Milou's avatar
Emmanuel Milou committed
981
    void registerCurSIPAccounts(VoIPLink *link);
982

983
984
985
986
    /*
     * Initialize audiodriver
     */
    bool initAudioDriver(void);
987
    
988
  private:
989
990
991
992
993
994
995
996
997
998
999
1000
    /* Transform digest to string.
    * output must be at least PJSIP_MD5STRLEN+1 bytes.
    * Helper function taken from sip_auth_client.c in 
    * pjproject-1.0.3.
    *
    * NOTE: THE OUTPUT STRING IS NOT NULL TERMINATED!
    */
    void digest2str(const unsigned char digest[], char *output);

    /** 
     * Helper function that creates an MD5 Hash from the credential
     * information provided as parameters. The hash is computed as