managerimpl.h 34.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
23
24
25
26
27
 *  (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.
 */

#ifndef __MANAGER_H__
#define __MANAGER_H__

#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
35

#include "stund/stun.h"
#include "observer.h"
#include "config/config.h"
yanmorin's avatar
   
yanmorin committed
36

yanmorin's avatar
   
yanmorin committed
37
#include "account.h"
yanmorin's avatar
   
yanmorin committed
38
#include "call.h"
39
#include "conference.h"
40
#include "numbercleaner.h"
41
#include <history/historymanager.h>
jpbl's avatar
jpbl committed
42
43
44
45
46
47
48
49
50
51
52

#include "audio/tonelist.h" // for Tone::TONEID declaration
#include "audio/audiofile.h"
#include "audio/dtmf.h"
#include "audio/codecDescriptor.h"

class AudioLayer;
class CodecDescriptor;
class GuiFramework;
class TelephoneTone;
class VoIPLink;
53
// class Conference;
yanmorin's avatar
   
yanmorin committed
54

jpbl's avatar
jpbl committed
55
56
57
58
#ifdef USE_ZEROCONF
class DNSService;
#endif

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

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

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

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

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

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

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

static CallID default_conf = "conf"; 

82

83
/** Manager (controller) of sflphone daemon */
jpbl's avatar
jpbl committed
84
class ManagerImpl {
85
86
87
88
89
90
91
92
93
94
95
96
97
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
  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
144
145
146
147
148
149
150
151

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

152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
    /**
     * 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);

181
182
183
184
185
186
187
188
189
190
    /**
     * Notify the client the transfer is successful
     */
    void transferSucceded();

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

191
192
193
194
195
196
197
    /**
     * Functions which occur with a user's action
     * Refuse the call
     * @param id  The call identifier
     */
    bool refuseCall(const CallID& id);

198
    Conference* createConference(const CallID& id1, const CallID& id2);
199

200
201
    void removeConference(const CallID& conference_id);

202
203
    Conference* getConferenceFromCallID(const CallID& call_id);

204
205
206
207
    void holdConference(const CallID& conferece_id);

    void unHoldConference(const CallID& conference_id);

208
209
    bool isConference(const CallID& call_id);

210
211
    bool participToConference(const CallID& call_id);

212
    void addParticipant(const CallID& call_id, const CallID& conference_id);
213

214
215
    void addMainParticipant(const CallID& conference_id);

216
217
    void joinParticipant(const CallID& call_id1, const CallID& call_id2);

218
    void detachParticipant(const CallID& call_id, const CallID& current_call_id);
219

220
    void removeParticipant(const CallID& call_id);
221

222
223
    void processRemainingParticipant(CallID current_call_id, Conference *conf);

224
225
    void joinConference(const CallID& conf_id1, const CallID& conf_id2);

226
227
    void addStream(const CallID& call_id);

228
229
    void removeStream(const CallID& call_id);

230
231
    /**
     * Save config to file
232
233
234
235
236
237
238
     * @return true on success
     *	    false otherwise
     */
    bool saveConfig (void);

    /**
     * Send registration to all enabled accounts
239
240
     * @return 0 on registration success
     *          1 otherelse
241
     */
242
    int initRegisterAccounts();
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270

    /**
     * @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 ();

    /**
271
     * Play a special ringtone ( BUSY ) if there's at least one message on the voice mail
272
273
274
275
276
277
278
279
280
281
282
283
284
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
     * @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);

    /**
320
     * Notify the client he has voice mails
321
322
323
     * @param accountId	  The account identifier
     * @param nb_msg The number of messages
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
324
    void startVoiceMessageNotification(const AccountID& accountId, int nb_msg);
325

326
327
    /**
     * Notify the client through DBus that registration state has been updated
328
     */
329
    void connectionStatusNotification(void);
330
331
332

    /**
     * ConfigurationManager - Send registration request
333
     * @param accountId The account to register/unregister
334
335
336
337
     * @param expire The flag for the type of registration
     *		 0 for unregistration request
     *		 1 for registration request
     */
338
    void sendRegister( const ::std::string& accountId , const int32_t& expire );
339
340
341

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

342
343
    /**
     * Get account list
344
345
346
347
     * @return std::vector<std::string> A list of accoundIDs
     */
    std::vector< std::string >  getAccountList();

348
349
350
351
352
    /**
     * Set the account order in the config file
     */
    void setAccountsOrder (const std::string& order);

353
354
355
356
357
358
359
    /**
     * 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);

360
361
362
363
364
365
366
    /**
     * 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);

367
368
369
370
371
372
    /**
     * Get call list
     * @return std::vector<std::string> A list of call IDs
     */
    std::vector< std::string >  getCallList (void);

373
374
375
376
377
378
379
380
381
382
383
384
385
    /**
     * 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);

386
387
388
389
390
391
392

    /**
     * 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);

393
394
395
396
397
398
399
    /**
     * 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
     */
400
    void setAccountDetails( const ::std::string& accountID,
401
	const std::map< ::std::string, ::std::string >& details );
402
403
404
405

    /**
     * Add a new account, and give it a new account ID automatically
     * @param details The new account parameters
jquentin's avatar
jquentin committed
406
     * @return The account Id given to the new account
407
     */
jquentin's avatar
jquentin committed
408
    std::string addAccount(const std::map< ::std::string, ::std::string >& details);
409
410
411
412
413
414
415
416
417
418
419

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

    /**
     * Get the list of codecs we supports, not ordered
     * @return The list of the codecs
420
     */
421
    std::vector< ::std::string > getCodecList( void );
422
423
424
425
426
427
428

    /**
     * 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
     */
429
    std::vector< ::std::string > getCodecDetails( const int32_t& payload);
430

Alexandre Savard's avatar
Alexandre Savard committed
431
432
433
434
435
436
437
    /**
     * Get current codec name
     * @param call id
     * @return std::string The codec name
     */
    std::string getCurrentCodecName(const CallID& id);

438
439
440
441
442
443
444
445
446
447
448
449
450
    /**
     * 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);

    /**
451
     * Set input audio plugin
452
453
454
455
456
     * @param audioPlugin The audio plugin
     */
    void setInputAudioPlugin(const std::string& audioPlugin);

    /**
457
     * Set output audio plugin
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
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
     * @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
     */
503
    std::string getCurrentAudioOutputPlugin( void );
504
505
506
507
508
509
510
511

    /**
     * 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);

512
513
    std::vector<std::string> unserialize(std::string v);

514
515
516
517
518
    /**
     * Tells if IAX2 support is enabled
     * @return int 1 if IAX2 is enabled
     *	       0 otherwise
     */
519
    int isIax2Enabled( void );
520
521
522

    /**
     * Ringtone option.
523
     * If ringtone is enabled, ringtone on incoming call use custom choice. If not, only standart tone.
524
525
526
     * @return int	1 if enabled
     *	        0 otherwise
     */
527
    int isRingtoneEnabled( void );
528
529

    /**
530
     * Set the ringtone option
531
532
     * Inverse current value
     */
533
    void ringtoneEnabled( void );
534
535

    /**
536
     * Get the ringtone
537
538
539
540
541
542
543
544
545
546
     * @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& );

547
548
549
550
551
552
553
554
555
556
    /**
     * 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
557
    void setRecordPath( const std::string& recPath);
558

559
    /**
560
     * Tells if the user wants to display the dialpad or not
561
562
563
564
565
566
567
568
569
570
     * @return int 1 if dialpad has to be displayed
     *	       0 otherwise
     */
    int getDialpad( void );

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

571
    /**
572
     * Tells if the user wants to display the volume controls or not
573
574
575
576
577
578
579
580
581
582
     * @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
583
    /**
alexandresavard's avatar
alexandresavard committed
584
     * Set recording on / off
alexandresavard's avatar
alexandresavard committed
585
586
587
588
589
     * Start recording
     * @param id  The call identifier
     */
    void setRecordingCall(const CallID& id);

alexandresavard's avatar
alexandresavard committed
590
591
592
593
594
    /**
     * Return true if the call is currently recorded
     */
    bool isRecording(const CallID& id);

595
    /**
596
597
     * Set the maximum number of days to keep in the history
     * @param calls The number of days
598
     */
599
    void setHistoryLimit (const int& days);
600
601

    /**
602
603
     * Get the maximum number of days to keep in the history
     * @return double The number of days 
604
     */
605
606
607
608
609
610
    int getHistoryLimit (void);

    void setHistoryEnabled (void);

    int getHistoryEnabled (void);

611

612
613
614
615
616
617
618
619
620
621
622
623
624
625
    /**
     * 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 );

    /**
626
     * Configure the popup behaviour
627
     * @return int	1 if it should popup on incoming calls
628
     *		0 if it should never popups
629
630
631
632
     */
    int popupMode( void );

    /**
633
     * Configure the popup behaviour
634
635
636
637
638
     * When SFLphone is in the system tray, you can configure when it popups
     * Never or only on incoming calls
     */
    void switchPopupMode( void );

639
640
641
642
643
644
645
646
647
648
    /**
     * Determine whether or not the search bar (history) should be displayed
     */
    int getSearchbar( void );

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

649
650
651
652
653
654
655
656
657
    /**
     * Set the desktop notification level
     */
    void setNotify( void );

    /**
     * Get the desktop notification level
     * @return int The notification level
     */
658
    int32_t getNotify( void );
659
660
661
662
663
664

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

665

Emmanuel Milou's avatar
Emmanuel Milou committed
666
    /**
667
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
668
669
670
671
     */
    std::map<std::string, int32_t> getAddressbookSettings (void);

    /**
672
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
673
     */
674
675
    void setAddressbookSettings (const std::map<std::string, int32_t>& settings);

676
    /**
677
678
679
680
681
682
     * Addressbook list
     */
    void setAddressbookList(const std::vector<  std::string >& list);

    /**
     * Addressbook list
Emmanuel Milou's avatar
Emmanuel Milou committed
683
     */
684
685
    std::vector <std::string> getAddressbookList( void );

686
    /**
687
     * Hook configuration
688
689
690
691
     */
    std::map<std::string, std::string> getHookSettings (void);

    /**
692
     * Hook configuration
693
694
695
     */
     void setHookSettings (const std::map<std::string, std::string>& settings);

Emmanuel Milou's avatar
Emmanuel Milou committed
696

697
    /**
698
699
700
701
702
     * Get the audio manager
     * @return int The audio manager
     *		    0 ALSA
     *		    1 PULSEAUDIO
     */
703
    int32_t getAudioManager( void );
704
705
706
707

    /**
     * Set the audio manager
     */
708
    void setAudioManager( const int32_t& api );
709
710

    void switchAudioManager( void );
711
712
713

    void setPulseAppVolumeControl( void );
    int32_t getPulseAppVolumeControl( void );
714

715
    /**
716
717
718
     * Get the desktop mail notification level
     * @return int The mail notification level
     */
719
    int32_t getMailNotify( void );
720

721
722
723
724
725
726
727
728
729
    /**
     * 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
730
     * @return std::vector< ::std::string >  The list of active codecs
731
732
     */
    std::vector< ::std::string > getActiveCodecList( void );
733
734
735
736

    /**
     * Set the list of the active codecs
     * @param list  The new list of active codecs
737
     */
738
    void setActiveCodecList( const std::vector< ::std::string >& list);
739
740
741
742
743
744

    /*
     * Notify the client that an error occured
     * @param errCode The error code. Could be: ALSA_CAPTURE_ERROR
     *					       ALSA_PLAYBACK_ERROR
     */
745
    void notifyErrClient( const int32_t& errCode );
746
747
748
749
750
751
752
753
754
755

    /**
     * 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);
756

757
758
759
    /**
     * Change a specific value in the configuration tree.
     * This value will then be saved in the user config file sflphonedrc
760
     * @param section	The section name
761
     * @param name	The parameter name
762
     * @param value	The new string value
763
764
765
766
     * @return bool	true on success
     *		      false otherwise
     */
    bool setConfig(const std::string& section, const std::string& name, const std::string& value);
767

768
769
770
    /**
     * Change a specific value in the configuration tree.
     * This value will then be saved in the user config file sflphonedrc
771
     * @param section	The section name
772
     * @param name	The parameter name
773
     * @param value	The new int value
774
775
776
777
     * @return bool	true on success
     *		      false otherwise
     */
    bool setConfig(const std::string& section, const std::string& name, int value);
778
779

    /**
780
781
782
783
784
785
786
787
     * 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
     */
    int getConfigInt(const std::string& section, const std::string& name);

788
    /**
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
     * 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);

    /**
805
     * Handle audio sounds heard by a caller while they wait for their
806
807
808
809
810
811
812
813
814
815
816
817
818
     * 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 ();
819

820
821
822
823
824
825
826
827
828
829
    /**
     * 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);

830
    /**
831
     * Retrieve the current telephone tone
832
     * @return AudioLoop*   The audio tone or 0 if no tone (init before calling this function)
833
834
     */
    AudioLoop* getTelephoneTone();
835
836

    /**
837
     * Retrieve the current telephone file
838
     * @return AudioLoop* The audio file or 0 if the wav is stopped
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
     */
    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; }
860

861
862
863
864
865
866
    /*
     * 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
     */
867
    void setSpkrVolume(unsigned short spkr_vol);
868

869
870
871
872
873
874
875
    /*
     * 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;  }
876

877
878
879
880
881
882
    /*
     * 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
     */
883
    void setMicVolume(unsigned short mic_vol);
884
885

    // Manage information about firewall
886

887
    /*
888
     * Get information about firewall
889
890
891
892
893
894
895
896
897
898
899
     * @param  stunSvrAddr: stun server
     * @param  port         port number to open to test the connection
     * @return true if the connection is successful
     */
    bool getStunInfo(StunAddress4& stunSvrAddr, int port);

    /*
     * Inline functions to manage firewall settings
     * @return int The firewall port
     */
    inline int getFirewallPort(void) 		{ return _firewallPort; }
900

901
902
903
904
905
    /*
     * Inline functions to manage firewall settings
     * @param port The firewall port
     */
    inline void setFirewallPort(int port) 	{ _firewallPort = port; }
906

907
908
909
910
911
912
913
    /*
     * Inline functions to manage firewall settings
     * @return std::string The firewall address
     */
    inline std::string getFirewallAddress (void) 	{ return _firewallAddr; }

    /**
914
915
     * If you are behind a NAT, you have to use STUN server, specified in
     * STUN configuration(you can change this one by default) to give you an
916
917
918
919
920
921
922
923
924
925
926
927
928
     * public IP address and assign a port number.
     * Note: Set firewall port/address retreive
     * @param svr   Server on which to send request
     * @param port  On which port we want to listen to
     * @return true if we are behind a NAT (without error)
     */
    bool behindNat(const std::string& svr, int port);

    /**
     * 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().
     */
929
    void initConfigFile ( bool load_user_value=true, std::string alternate="");
930
931
932
933
934
935
936
937

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

938
    /**
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
     * 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);

957
    /**
958
959
960
     * Restart PJSIP
     * @param void
     * @return void
961
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
962
    void restartPJSIP( );
963

964
    void unregisterCurSIPAccounts();
965

Emmanuel Milou's avatar
Emmanuel Milou committed
966
    void registerCurSIPAccounts(VoIPLink *link);
967

968
969
970
971
972
    /*
     * Initialize audiodriver
     */
    bool initAudioDriver(void);

973
  private:
974

975
976
977
978
979
980
981
982
    /**
     * Check if a process is running with the system command
     *
     * @return 0 on success
     *          1 otherelse
     */
    int app_is_running(std::string process);

983
    /**
984
     * Create .PROGNAME directory in home user and create
985
986
987
988
989
990
991
992
993
994
995
996
997
     * configuration tree from the settings file if this file exists.
     *
     * @return	0 if creating file failed
     *			1 if config-file exists
     *			2 if file doesn't exist yet.
     */
    int createSettingsPath (void);

    /*
     * Initialize audiocodec with config setting
     */
    void initAudioCodec(void);

998
    
999
1000
    /*
     * Initialize zeroconf module and scanning