managerimpl.h 37.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
#include "audio/mainbuffer.h"

jpbl's avatar
jpbl committed
48
49
50
51
class AudioLayer;
class GuiFramework;
class TelephoneTone;
class VoIPLink;
52

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
class HistoryManager;
60
class SIPAccount;
jpbl's avatar
jpbl committed
61

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

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

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

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

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

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

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

static CallID default_conf = "conf"; 

85

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

98
/** Manager (controller) of sflphone daemon */
jpbl's avatar
jpbl committed
99
class ManagerImpl {
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
157
158
  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
159
160
161
162
163
164
165
166

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

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

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

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

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

213
214
215
216
217
    /**
     * Create a new conference given two participant
     * @param the first participant ID
     * @param the second participant ID
     */ 
218
    Conference* createConference(const CallID& id1, const CallID& id2);
219

220
221
222
223
    /**
     * Delete this conference
     * @param the conference ID
     */ 
224
225
    void removeConference(const CallID& conference_id);

226
227
228
229
    /**
     * Return the conference id for which this call is attached
     * @ param the call id
     */
230
231
    Conference* getConferenceFromCallID(const CallID& call_id);

232
233
234
235
    /**
     * Hold every participant to a conference
     * @param the conference id
     */
236
237
    void holdConference(const CallID& conferece_id);

238
239
240
241
    /**
     * Unhold all conference participants 
     * @param the conference id
     */
242
243
    void unHoldConference(const CallID& conference_id);

244
245
246
247
    /**
     * Test if this id is a conference (usefull to test current call)
     * @param the call id
     */
248
249
    bool isConference(const CallID& call_id);

250
251
252
253
    /**
     * Test if a call id particips to this conference
     * @param the call id
     */
254
255
    bool participToConference(const CallID& call_id);

256
257
258
259
260
    /**
     * Add a participant to a conference
     * @param the call id
     * @param the conference id
     */
261
    void addParticipant(const CallID& call_id, const CallID& conference_id);
262

263
264
265
266
    /**
     * Bind the main participant to a conference (mainly called on a double click action)
     * @param the conference id
     */
267
268
    void addMainParticipant(const CallID& conference_id);

269
270
271
272
273
    /**
     * Join two participants to create a conference
     * @param the fist call id
     * @param the second call id
     */
274
275
    void joinParticipant(const CallID& call_id1, const CallID& call_id2);

276
277
278
279
280
    /**
     * Detach a participant from a conference, put the call on hold, do not hangup it
     * @param call id
     * @param the current call id
     */
281
    void detachParticipant(const CallID& call_id, const CallID& current_call_id);
282

283
284
285
286
    /**
     * Remove the conference participant from a conference
     * @param call id
     */
287
    void removeParticipant(const CallID& call_id);
288
289
290
291
292
293
294
    
    /**
     * 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
     */
295
296
    void processRemainingParticipant(CallID current_call_id, Conference *conf);

297
298
299
    /**
     * Join two conference together into one unique conference
     */
300
301
    void joinConference(const CallID& conf_id1, const CallID& conf_id2);

302
303
    void addStream(const CallID& call_id);

304
305
    void removeStream(const CallID& call_id);

306
307
    /**
     * Save config to file
308
309
310
311
312
313
314
     * @return true on success
     *	    false otherwise
     */
    bool saveConfig (void);

    /**
     * Send registration to all enabled accounts
315
316
     * @return 0 on registration success
     *          1 otherelse
317
     */
318
    int initRegisterAccounts();
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346

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

    /**
347
     * Play a special ringtone ( BUSY ) if there's at least one message on the voice mail
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
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
     * @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);

    /**
396
     * Notify the client he has voice mails
397
398
399
     * @param accountId	  The account identifier
     * @param nb_msg The number of messages
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
400
    void startVoiceMessageNotification(const AccountID& accountId, int nb_msg);
401

402
403
    /**
     * Notify the client through DBus that registration state has been updated
404
     */
405
    void connectionStatusNotification(void);
406
407
408

    /**
     * ConfigurationManager - Send registration request
409
     * @param accountId The account to register/unregister
410
     * @param enable The flag for the type of registration
411
412
413
     *		 0 for unregistration request
     *		 1 for registration request
     */
414
    void sendRegister( const ::std::string& accountId , const int32_t& enable);
415
416
417

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

418
419
    /**
     * Get account list
420
421
422
423
     * @return std::vector<std::string> A list of accoundIDs
     */
    std::vector< std::string >  getAccountList();

424
425
426
427
428
    /**
     * Set the account order in the config file
     */
    void setAccountsOrder (const std::string& order);

429
430
431
432
433
434
435
    /**
     * 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);

436
437
438
439
440
441
442
    /**
     * 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);

443
444
445
446
447
448
    /**
     * Get call list
     * @return std::vector<std::string> A list of call IDs
     */
    std::vector< std::string >  getCallList (void);

449
450
451
452
453
454
455
456
457
458
459
460
461
    /**
     * 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);

462
463
464
465
466
467
468

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

469
470
471
472
473
474
475
    /**
     * 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
     */
476
    void setAccountDetails( const ::std::string& accountID,
477
	const std::map< ::std::string, ::std::string >& details );
478
479
480
481

    /**
     * Add a new account, and give it a new account ID automatically
     * @param details The new account parameters
jquentin's avatar
jquentin committed
482
     * @return The account Id given to the new account
483
     */
jquentin's avatar
jquentin committed
484
    std::string addAccount(const std::map< ::std::string, ::std::string >& details);
485
486
487
488
489
490
491
492

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

493
494
495
496
497
498
499

    /**
     * Deletes all credentials defined for an account
     * @param accountID The account unique ID
     */
    void deleteAllCredential(const AccountID& accountID);
    
500
501
502
    /**
     * Get the list of codecs we supports, not ordered
     * @return The list of the codecs
503
     */
504
    std::vector< ::std::string > getCodecList( void );
505
506
507
508
509
510
511

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

Alexandre Savard's avatar
Alexandre Savard committed
514
515
516
517
518
519
520
    /**
     * Get current codec name
     * @param call id
     * @return std::string The codec name
     */
    std::string getCurrentCodecName(const CallID& id);

521
522
523
524
525
526
527
528
529
530
531
532
533
    /**
     * 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);

    /**
534
     * Set input audio plugin
535
536
537
538
539
     * @param audioPlugin The audio plugin
     */
    void setInputAudioPlugin(const std::string& audioPlugin);

    /**
540
     * Set output audio plugin
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
     * @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
     */
586
    std::string getCurrentAudioOutputPlugin( void );
587
588
589
590
591
592
593
594

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

595
596
    std::vector<std::string> unserialize(std::string v);

597
598
599
600
601
    /**
     * Tells if IAX2 support is enabled
     * @return int 1 if IAX2 is enabled
     *	       0 otherwise
     */
602
    int isIax2Enabled( void );
603
604
605

    /**
     * Ringtone option.
606
     * If ringtone is enabled, ringtone on incoming call use custom choice. If not, only standart tone.
607
608
609
     * @return int	1 if enabled
     *	        0 otherwise
     */
610
    int isRingtoneEnabled( void );
611
612

    /**
613
     * Set the ringtone option
614
615
     * Inverse current value
     */
616
    void ringtoneEnabled( void );
617
618

    /**
619
     * Get the ringtone
620
621
622
623
624
625
626
627
628
629
     * @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& );

630
631
632
633
634
635
636
637
638
639
    /**
     * 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
640
    void setRecordPath( const std::string& recPath);
641

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

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

666
    /**
667
     * Tells if the user wants to display the volume controls or not
668
669
670
671
672
673
674
675
676
677
     * @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
678
    /**
alexandresavard's avatar
alexandresavard committed
679
     * Set recording on / off
alexandresavard's avatar
alexandresavard committed
680
681
682
683
684
     * Start recording
     * @param id  The call identifier
     */
    void setRecordingCall(const CallID& id);

alexandresavard's avatar
alexandresavard committed
685
686
687
688
689
    /**
     * Return true if the call is currently recorded
     */
    bool isRecording(const CallID& id);

690
    /**
691
692
     * Set the maximum number of days to keep in the history
     * @param calls The number of days
693
     */
694
    void setHistoryLimit (const int& days);
695
696

    /**
697
698
     * Get the maximum number of days to keep in the history
     * @return double The number of days 
699
     */
700
701
702
703
    int getHistoryLimit (void);

    void setHistoryEnabled (void);

704
	std::string getHistoryEnabled (void);
705

706

707
708
709
710
711
712
713
714
715
716
717
718
719
720
    /**
     * 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 );

    /**
721
     * Configure the popup behaviour
722
     * @return int	1 if it should popup on incoming calls
723
     *		0 if it should never popups
724
725
726
727
     */
    int popupMode( void );

    /**
728
     * Configure the popup behaviour
729
730
731
732
733
     * When SFLphone is in the system tray, you can configure when it popups
     * Never or only on incoming calls
     */
    void switchPopupMode( void );

734
735
736
737
738
739
740
741
742
743
    /**
     * Determine whether or not the search bar (history) should be displayed
     */
    int getSearchbar( void );

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

744
745
746
747
748
749
750
751
752
    /**
     * Set the desktop notification level
     */
    void setNotify( void );

    /**
     * Get the desktop notification level
     * @return int The notification level
     */
753
    int32_t getNotify( void );
754
755
756
757
758
759

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

760

Emmanuel Milou's avatar
Emmanuel Milou committed
761
    /**
762
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
763
764
765
766
     */
    std::map<std::string, int32_t> getAddressbookSettings (void);

    /**
767
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
768
     */
769
770
    void setAddressbookSettings (const std::map<std::string, int32_t>& settings);

771
    /**
772
773
774
775
776
777
     * Addressbook list
     */
    void setAddressbookList(const std::vector<  std::string >& list);

    /**
     * Addressbook list
Emmanuel Milou's avatar
Emmanuel Milou committed
778
     */
779
780
    std::vector <std::string> getAddressbookList( void );

781
    /**
782
     * Hook configuration
783
784
785
786
     */
    std::map<std::string, std::string> getHookSettings (void);

    /**
787
     * Hook configuration
788
789
790
     */
     void setHookSettings (const std::map<std::string, std::string>& settings);

Emmanuel Milou's avatar
Emmanuel Milou committed
791

792
    /**
793
794
795
796
797
     * Get the audio manager
     * @return int The audio manager
     *		    0 ALSA
     *		    1 PULSEAUDIO
     */
798
    int32_t getAudioManager( void );
799
800
801
802

    /**
     * Set the audio manager
     */
803
    void setAudioManager( const int32_t& api );
804
805

    void switchAudioManager( void );
806

807
    /**
808
809
810
     * Get the desktop mail notification level
     * @return int The mail notification level
     */
811
    int32_t getMailNotify( void );
812

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

    /**
     * Set the list of the active codecs
     * @param list  The new list of active codecs
829
     */
830
    void setActiveCodecList( const std::vector< ::std::string >& list);
831
832
833
834
835
836

    /*
     * Notify the client that an error occured
     * @param errCode The error code. Could be: ALSA_CAPTURE_ERROR
     *					       ALSA_PLAYBACK_ERROR
     */
837
    void notifyErrClient( const int32_t& errCode );
838
839
840
841
842
843
844
845
846
847

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

849
850
851
    /**
     * Change a specific value in the configuration tree.
     * This value will then be saved in the user config file sflphonedrc
852
     * @param section	The section name
853
     * @param name	The parameter name
854
     * @param value	The new string value
855
856
857
858
     * @return bool	true on success
     *		      false otherwise
     */
    bool setConfig(const std::string& section, const std::string& name, const std::string& value);
859

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

    /**
919
     * Handle audio sounds heard by a caller while they wait for their
920
921
922
923
924
925
926
927
928
929
930
931
932
     * 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 ();
933

934
935
936
937
938
939
940
941
942
943
    /**
     * 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);

944
    /**
945
     * Retrieve the current telephone tone
946
     * @return AudioLoop*   The audio tone or 0 if no tone (init before calling this function)
947
948
     */
    AudioLoop* getTelephoneTone();
949
950

    /**
951
     * Retrieve the current telephone file
952
     * @return AudioLoop* The audio file or 0 if the wav is stopped
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
     */
    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; }
974

975
976
977
978
979
980
    /*
     * 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
     */
981
    void setSpkrVolume(unsigned short spkr_vol);
982

983
984
985
986
987
988
989
    /*
     * 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;  }
990

991
992
993
994
995
996
    /*
     * 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
     */
997
    void setMicVolume(unsigned short mic_vol);
998
999
1000

    /**
     * Init default values for the different fields in the config file.