managerimpl.h 37.2 KB
Newer Older
jpbl's avatar
jpbl committed
1
/*
2
 *  Copyright (C) 2004, 2005, 2006, 2009, 2008, 2009, 2010 Savoir-Faire Linux Inc.
jpbl's avatar
jpbl committed
3
4
 *  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
 *  (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.
21
22
23
24
25
26
27
28
29
30
31
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  If you modify this program, or any covered work, by linking or
 *  combining it with the OpenSSL project's OpenSSL library (or a
 *  modified version of that library), containing parts covered by the
 *  terms of the OpenSSL or SSLeay licenses, Savoir-Faire Linux Inc.
 *  grants you additional permission to convey the resulting work.
 *  Corresponding Source for a non-source form of such a combination
 *  shall include the source code for the parts of OpenSSL used as well
 *  as that of the covered work.
jpbl's avatar
jpbl committed
32
33
 */

34
35
#ifndef __SFL_MANAGER_H__
#define __SFL_MANAGER_H__
jpbl's avatar
jpbl committed
36
37
38

#include <string>
#include <vector>
yanmorin's avatar
   
yanmorin committed
39
#include <set>
yanmorin's avatar
   
yanmorin committed
40
#include <map>
jpbl's avatar
jpbl committed
41
#include <cc++/thread.h>
42
#include "dbus/dbusmanager.h"
jpbl's avatar
jpbl committed
43
44
45

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

yanmorin's avatar
   
yanmorin committed
47
#include "account.h"
yanmorin's avatar
   
yanmorin committed
48
#include "call.h"
49
#include "conference.h"
50
#include "numbercleaner.h"
jpbl's avatar
jpbl committed
51

52
53
54
55
#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
56

57
#include "audio/mainbuffer.h"
58
#include "yamlparser.h"
59

jpbl's avatar
jpbl committed
60
61
62
63
class AudioLayer;
class GuiFramework;
class TelephoneTone;
class VoIPLink;
64

65
// class Conference;
yanmorin's avatar
   
yanmorin committed
66

jpbl's avatar
jpbl committed
67
68
69
70
#ifdef USE_ZEROCONF
class DNSService;
#endif

71
class HistoryManager;
72
class SIPAccount;
jpbl's avatar
jpbl committed
73

74
/** Define a type for a AccountMap container */
yanmorin's avatar
   
yanmorin committed
75
typedef std::map<AccountID, Account*> AccountMap;
76
77

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

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

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

85
/** To send multiple string */
jpbl's avatar
jpbl committed
86
87
typedef std::list<std::string> TokenList;

88
89
/** To store conference objects by call ids 
    used to retreive the conference according to a call */
90
91
92
typedef std::map<CallID, Conference*> ConferenceCallMap;

/** To store conference objects by conference ids */
93
94
95
96
typedef std::map<CallID, Conference*> ConferenceMap;

static CallID default_conf = "conf"; 

97
98
99
100
101
102
103
104
105
106
107
108
static char * mapStateToChar[] = {
    (char*) "UNREGISTERED",
    (char*) "TRYING",
    (char*) "REGISTERED",
    (char*) "ERROR",
    (char*) "ERRORAUTH",
    (char*) "ERRORNETWORK",
    (char*) "ERRORHOST",
    (char*) "ERROREXISTSTUN",    
    (char*) "ERRORCONFSTUN"    
};

109
/** Manager (controller) of sflphone daemon */
jpbl's avatar
jpbl committed
110
class ManagerImpl {
111
112
113
114
  public:
    ManagerImpl (void);
    ~ManagerImpl (void);

115

Alexandre Savard's avatar
Alexandre Savard committed
116
    short buildAccounts();
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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
    /**
     * 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
173
174
175
176
177
178
179
180

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

181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
    /**
     * 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);

210
211
212
213
214
215
216
217
218
219
    /**
     * Notify the client the transfer is successful
     */
    void transferSucceded();

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

220
221
222
223
224
225
226
    /**
     * Functions which occur with a user's action
     * Refuse the call
     * @param id  The call identifier
     */
    bool refuseCall(const CallID& id);

227
228
229
230
231
    /**
     * Create a new conference given two participant
     * @param the first participant ID
     * @param the second participant ID
     */ 
232
    Conference* createConference(const CallID& id1, const CallID& id2);
233

234
235
236
237
    /**
     * Delete this conference
     * @param the conference ID
     */ 
238
239
    void removeConference(const CallID& conference_id);

240
241
242
243
    /**
     * Return the conference id for which this call is attached
     * @ param the call id
     */
244
245
    Conference* getConferenceFromCallID(const CallID& call_id);

246
247
248
249
    /**
     * Hold every participant to a conference
     * @param the conference id
     */
250
251
    void holdConference(const CallID& conferece_id);

252
253
254
255
    /**
     * Unhold all conference participants 
     * @param the conference id
     */
256
257
    void unHoldConference(const CallID& conference_id);

258
259
260
261
    /**
     * Test if this id is a conference (usefull to test current call)
     * @param the call id
     */
262
263
    bool isConference(const CallID& call_id);

264
265
266
267
    /**
     * Test if a call id particips to this conference
     * @param the call id
     */
268
269
    bool participToConference(const CallID& call_id);

270
271
272
273
274
    /**
     * Add a participant to a conference
     * @param the call id
     * @param the conference id
     */
275
    void addParticipant(const CallID& call_id, const CallID& conference_id);
276

277
278
279
280
    /**
     * Bind the main participant to a conference (mainly called on a double click action)
     * @param the conference id
     */
281
282
    void addMainParticipant(const CallID& conference_id);

283
284
285
286
287
    /**
     * Join two participants to create a conference
     * @param the fist call id
     * @param the second call id
     */
288
289
    void joinParticipant(const CallID& call_id1, const CallID& call_id2);

290
291
292
293
294
    /**
     * Detach a participant from a conference, put the call on hold, do not hangup it
     * @param call id
     * @param the current call id
     */
295
    void detachParticipant(const CallID& call_id, const CallID& current_call_id);
296

297
298
299
300
    /**
     * Remove the conference participant from a conference
     * @param call id
     */
301
    void removeParticipant(const CallID& call_id);
302
303
304
305
306
307
308
    
    /**
     * Process remaining participant given a conference and the current call id.
     * Mainly called when a participant is detached or hagned up
     * @param current call id
     * @param conference pointer
     */
309
310
    void processRemainingParticipant(CallID current_call_id, Conference *conf);

311
312
313
    /**
     * Join two conference together into one unique conference
     */
314
315
    void joinConference(const CallID& conf_id1, const CallID& conf_id2);

316
317
    void addStream(const CallID& call_id);

318
319
    void removeStream(const CallID& call_id);

320
321
    /**
     * Save config to file
322
323
324
325
326
327
328
     * @return true on success
     *	    false otherwise
     */
    bool saveConfig (void);

    /**
     * Send registration to all enabled accounts
329
330
     * @return 0 on registration success
     *          1 otherelse
331
     */
332
    int initRegisterAccounts();
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349

    /**
     * @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
     */
350
    bool playDtmf (char code);
351
352
353
354
355
356
357
358
359

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

    /**
360
     * Play a special ringtone ( BUSY ) if there's at least one message on the voice mail
361
362
363
364
365
366
367
368
     * @return bool True on success
     *	      false otherwise
     */
    bool playToneWithMessage ();

    /**
     * Acts on the audio streams and audio files
     */
369
    void stopTone (void);
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407

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

    /**
408
     * Notify the client he has voice mails
409
410
411
     * @param accountId	  The account identifier
     * @param nb_msg The number of messages
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
412
    void startVoiceMessageNotification(const AccountID& accountId, int nb_msg);
413

414
415
    /**
     * Notify the client through DBus that registration state has been updated
416
     */
417
    void connectionStatusNotification(void);
418
419
420

    /**
     * ConfigurationManager - Send registration request
421
     * @param accountId The account to register/unregister
422
     * @param enable The flag for the type of registration
423
424
425
     *		 0 for unregistration request
     *		 1 for registration request
     */
426
    void sendRegister( const ::std::string& accountId , const int32_t& enable);
427
428
429

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

430
431
    /**
     * Get account list
432
433
434
435
     * @return std::vector<std::string> A list of accoundIDs
     */
    std::vector< std::string >  getAccountList();

436
437
438
439
440
    /**
     * Set the account order in the config file
     */
    void setAccountsOrder (const std::string& order);

441
442
443
444
445
446
    /**
     * Load the accounts order set by the user from the sflphonedrc config file
     * @return std::vector<std::string> A vector containing the account ID's
     */
    std::vector<std::string> loadAccountOrder ();

447
448
449
450
451
452
453
    /**
     * 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);

454
455
456
457
458
459
460
    /**
     * 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);

461
462
463
464
465
466
    /**
     * Get call list
     * @return std::vector<std::string> A list of call IDs
     */
    std::vector< std::string >  getCallList (void);

467
468
469
470
471
472
473
474
475
476
477
478
479
    /**
     * 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);

480
481
482
483
484
485
486

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

487
488
489
490
491
492
493
    /**
     * 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
     */
494
    void setAccountDetails( const ::std::string& accountID,
495
	const std::map< ::std::string, ::std::string >& details );
496
497
498
499

    /**
     * Add a new account, and give it a new account ID automatically
     * @param details The new account parameters
jquentin's avatar
jquentin committed
500
     * @return The account Id given to the new account
501
     */
jquentin's avatar
jquentin committed
502
    std::string addAccount(const std::map< ::std::string, ::std::string >& details);
503
504
505
506
507
508
509
510

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

511
512
513
514
515
516
517

    /**
     * Deletes all credentials defined for an account
     * @param accountID The account unique ID
     */
    void deleteAllCredential(const AccountID& accountID);
    
Alexandre Savard's avatar
Alexandre Savard committed
518
519
520
521
522
523
524
    /**
     * Get current codec name
     * @param call id
     * @return std::string The codec name
     */
    std::string getCurrentCodecName(const CallID& id);

525
    /**
526
     * Set input audio plugin
527
528
529
530
531
     * @param audioPlugin The audio plugin
     */
    void setInputAudioPlugin(const std::string& audioPlugin);

    /**
532
     * Set output audio plugin
533
534
535
536
537
538
539
540
541
542
543
     * @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);

    /**
544
     * Set audio device
545
     * @param index The index of the soundcard
546
     * @param the type of stream, either SFL_PCM_PLAYBACK, SFL_PCM_CAPTURE, SFL_PCM_RINGTONE
547
     */
548
    void setAudioDevice(const int index, const int streamType);
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568

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

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

569
    /**
570
571
572
     * Get current alsa plugin
     * @return std::string  The Alsa plugin
     */
573
    std::string getCurrentAudioOutputPlugin( void );
574

575
576
577
578
579
580
581
582
    std::string getEchoCancelState(void);

    void setEchoCancelState(std::string state);

    std::string getNoiseSuppressState(void);

    void setNoiseSuppressState(std::string state);

583
584
585
586
587
588
589
    /**
     * 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);

590
591
    std::vector<std::string> unserialize(std::string v);

592
593
594
595
596
    /**
     * Tells if IAX2 support is enabled
     * @return int 1 if IAX2 is enabled
     *	       0 otherwise
     */
597
    int isIax2Enabled( void );
598
599
600

    /**
     * Ringtone option.
601
     * If ringtone is enabled, ringtone on incoming call use custom choice. If not, only standart tone.
602
603
604
     * @return int	1 if enabled
     *	        0 otherwise
     */
605
    int isRingtoneEnabled( void );
606
607

    /**
608
     * Set the ringtone option
609
610
     * Inverse current value
     */
611
    void ringtoneEnabled( void );
612
613

    /**
614
     * Get the ringtone
615
616
617
618
619
620
621
622
623
624
     * @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& );

625
626
627
628
629
630
631
632
633
634
    /**
     * 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
635
    void setRecordPath( const std::string& recPath);
636

637
638
639
640
641
642
643
644
645
646
647
648
    /** 
     * 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);
    
649
    /**
650
     * Tells if the user wants to display the dialpad or not
651
652
653
654
655
656
657
658
     * @return int 1 if dialpad has to be displayed
     *	       0 otherwise
     */
    int getDialpad( void );

    /**
     * Set the dialpad visible or not
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
659
    void setDialpad (bool display);
660

661
    /**
662
     * Tells if the user wants to display the volume controls or not
663
664
665
666
667
668
669
670
     * @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
     */
671
    void setVolumeControls (bool display);
672

alexandresavard's avatar
alexandresavard committed
673
    /**
alexandresavard's avatar
alexandresavard committed
674
     * Set recording on / off
alexandresavard's avatar
alexandresavard committed
675
676
677
678
679
     * Start recording
     * @param id  The call identifier
     */
    void setRecordingCall(const CallID& id);

alexandresavard's avatar
alexandresavard committed
680
681
682
683
684
    /**
     * Return true if the call is currently recorded
     */
    bool isRecording(const CallID& id);

685
    /**
686
687
     * Set the maximum number of days to keep in the history
     * @param calls The number of days
688
     */
689
    void setHistoryLimit (const int& days);
690
691

    /**
692
693
     * Get the maximum number of days to keep in the history
     * @return double The number of days 
694
     */
695
696
697
698
    int getHistoryLimit (void);

    void setHistoryEnabled (void);

699
	std::string getHistoryEnabled (void);
700

701

702
703
704
705
706
707
708
709
710
711
712
713
714
715
    /**
     * 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 );

    /**
716
     * Configure the popup behaviour
717
     * @return int	1 if it should popup on incoming calls
718
     *		0 if it should never popups
719
720
721
722
     */
    int popupMode( void );

    /**
723
     * Configure the popup behaviour
724
725
726
727
728
     * When SFLphone is in the system tray, you can configure when it popups
     * Never or only on incoming calls
     */
    void switchPopupMode( void );

729
730
731
732
733
734
735
736
737
738
    /**
     * Determine whether or not the search bar (history) should be displayed
     */
    int getSearchbar( void );

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

739
740
741
742
743
744
745
746
747
    /**
     * Set the desktop notification level
     */
    void setNotify( void );

    /**
     * Get the desktop notification level
     * @return int The notification level
     */
748
    int32_t getNotify( void );
749
750
751
752
753
754

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

755

Emmanuel Milou's avatar
Emmanuel Milou committed
756
    /**
757
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
758
759
760
761
     */
    std::map<std::string, int32_t> getAddressbookSettings (void);

    /**
762
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
763
     */
764
765
    void setAddressbookSettings (const std::map<std::string, int32_t>& settings);

766
    /**
767
768
769
770
771
772
     * Addressbook list
     */
    void setAddressbookList(const std::vector<  std::string >& list);

    /**
     * Addressbook list
Emmanuel Milou's avatar
Emmanuel Milou committed
773
     */
774
775
    std::vector <std::string> getAddressbookList( void );

776
    /**
777
     * Hook configuration
778
779
780
781
     */
    std::map<std::string, std::string> getHookSettings (void);

    /**
782
     * Hook configuration
783
784
785
     */
     void setHookSettings (const std::map<std::string, std::string>& settings);

Emmanuel Milou's avatar
Emmanuel Milou committed
786

787
    /**
788
789
790
791
792
     * Get the audio manager
     * @return int The audio manager
     *		    0 ALSA
     *		    1 PULSEAUDIO
     */
793
    int32_t getAudioManager( void );
794
795
796
797

    /**
     * Set the audio manager
     */
798
    void setAudioManager( const int32_t& api );
799
800

    void switchAudioManager( void );
801

802
803
    void audioSamplingRateChanged( void );

804
    /**
805
806
807
     * Get the desktop mail notification level
     * @return int The mail notification level
     */
808
    int32_t getMailNotify( void );
809

810
811
812
813
814
815
816
817
818
    /**
     * 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
819
     * @return std::vector< ::std::string >  The list of active codecs
820
821
     */
    std::vector< ::std::string > getActiveCodecList( void );
822
823
824
825
826
827

    /*
     * Notify the client that an error occured
     * @param errCode The error code. Could be: ALSA_CAPTURE_ERROR
     *					       ALSA_PLAYBACK_ERROR
     */
828
    void notifyErrClient( const int32_t& errCode );
829
830
831
832
833
834
835
836
837
838

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

840
841
842
    /**
     * Change a specific value in the configuration tree.
     * This value will then be saved in the user config file sflphonedrc
843
     * @param section	The section name
844
     * @param name	The parameter name
845
     * @param value	The new string value
846
847
848
849
     * @return bool	true on success
     *		      false otherwise
     */
    bool setConfig(const std::string& section, const std::string& name, const std::string& value);
850

851
852
853
    /**
     * Change a specific value in the configuration tree.
     * This value will then be saved in the user config file sflphonedrc
854
     * @param section	The section name
855
     * @param name	The parameter name
856
     * @param value	The new int value
857
858
859
860
     * @return bool	true on success
     *		      false otherwise
     */
    bool setConfig(const std::string& section, const std::string& name, int value);
861
862
863
864
865
866
867
868
869
870
871
872
    
    inline std::string mapStateNumberToString(RegistrationState state) {
        std::string stringRepresentation;
        if (state > NumberOfState) {
            stringRepresentation = "ERROR";
            return stringRepresentation;
        }
        
        stringRepresentation = mapStateToChar[state];
        return stringRepresentation;
    }
    
873
    /**
874
875
876
877
878
879
     * 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
     */
880
     
881
    int getConfigInt(const std::string& section, const std::string& name);
pierre-luc's avatar
pierre-luc committed
882
883
884
885
886
887
888
889
890
891
892
 
  /**
     * 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);
            
893
    /**
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
     * 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);

    /**
910
     * Handle audio sounds heard by a caller while they wait for their
911
912
913
914
915
916
917
918
919
920
921
922
923
     * 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 ();
924

925
926
927
928
929
930
931
932
933
934
    /**
     * 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);

935
    /**
936
     * Retrieve the current telephone tone
937
     * @return AudioLoop*   The audio tone or 0 if no tone (init before calling this function)
938
939
     */
    AudioLoop* getTelephoneTone();
940
941

    /**
942
     * Retrieve the current telephone file
943
     * @return AudioLoop* The audio file or 0 if the wav is stopped
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
     */
    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; }
965

966
967
968
969
970
971
    /*
     * 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
     */
972
    void setSpkrVolume(unsigned short spkr_vol);
973

974
975
976
977
978
979
980
    /*
     * 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;  }
981

982
983
984
985
986
987
    /*
     * 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
     */
988
    void setMicVolume(unsigned short mic_vol);
989
990
991
992
993
994

    /**
     * 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().
     */
995
    void initConfigFile ( bool load_user_value=true, std::string alternate="");
996
997
998
999
1000

    /**
     * Tell if the setup was already loaded
     * @return bool True if yes
     *		  false otherwise