managerimpl.h 41.6 KB
Newer Older
jpbl's avatar
jpbl committed
1
/*
2
 *  Copyright (C) 2004, 2005, 2006, 2008, 2009, 2010, 2011 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>
7
 *  Author: Alexandre Savard <alexandre.savard@savoirfairelinux.com>
jpbl's avatar
jpbl committed
8
9
10
 *
 *  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
11
 *  the Free Software Foundation; either version 3 of the License, or
jpbl's avatar
jpbl committed
12
13
14
15
16
17
18
19
20
21
 *  (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.
22
23
24
25
26
27
28
29
30
31
32
 *
 *  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
33
34
 */

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

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

#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
#include "audio/sound/tonelist.h"  // for Tone::TONEID declaration
53
#include "audio/sound/audiofile.h"
54
#include "audio/sound/dtmf.h" // DTMF class contained by value here
55
#include "audio/codecs/audiocodecfactory.h" 
jpbl's avatar
jpbl committed
56

57
#include "audio/mainbuffer.h"
58
#include "yamlemitter.h"
59
#include "yamlparser.h"
60
#include "preferences.h"
61

62
63
#include "im/InstantMessaging.h"

jpbl's avatar
jpbl committed
64
65
66
67
class AudioLayer;
class GuiFramework;
class TelephoneTone;
class VoIPLink;
68

69
// class Conference;
yanmorin's avatar
   
yanmorin committed
70

jpbl's avatar
jpbl committed
71
72
73
74
#ifdef USE_ZEROCONF
class DNSService;
#endif

75
class HistoryManager;
76
class SIPAccount;
jpbl's avatar
jpbl committed
77

78
/** Define a type for a AccountMap container */
79
typedef std::map<std::string, Account*> AccountMap;
80

81
82
/** Define a type for a std::string to std::string Map inside ManagerImpl */
typedef std::map<std::string, std::string> CallAccountMap;
yanmorin's avatar
   
yanmorin committed
83

84
typedef std::map<std::string, Call::CallConfiguration> CallConfigMap;
Emmanuel Milou's avatar
Emmanuel Milou committed
85

86
87
/** Define a type for std::string vector (waiting list, incoming not answered) */
typedef std::set<std::string> CallIDSet;
yanmorin's avatar
   
yanmorin committed
88

89
/** To send multiple string */
jpbl's avatar
jpbl committed
90
91
typedef std::list<std::string> TokenList;

Julien Bonjean's avatar
Julien Bonjean committed
92
/** To store conference objects by call ids
93
    used to retreive the conference according to a call */
94
typedef std::map<std::string, Conference*> ConferenceCallMap;
95
96

/** To store conference objects by conference ids */
97
typedef std::map<std::string, Conference*> ConferenceMap;
98

99
static std::string default_conf = "conf";
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",
Julien Bonjean's avatar
Julien Bonjean committed
109
110
    (char*) "ERROREXISTSTUN",
    (char*) "ERRORCONFSTUN"
111
112
};

113
/** Manager (controller) of sflphone daemon */
Julien Bonjean's avatar
Julien Bonjean committed
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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
class ManagerImpl
{
    public:
        ManagerImpl (void);
        ~ManagerImpl (void);


        /**
         * General preferences configuration
         */
        Preferences preferences;

        /**
         * Voip related preferences
         */
        VoipPreference voipPreferences;

        /**
         * Addressbook related preferences
         */
        AddressbookPreference addressbookPreference;

        /**
         * Hook preferences
         */
        HookPreference hookPreference;

        /**
         * Audio preferences
         */
        AudioPreference audioPreference;

        /**
         * Shortcut preferences
         */
        ShortcutPreferences shortcutPreferences;

        /**
         * Method to build preferences from configuration
         */
        short buildConfiguration();

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

        /**
         * 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
         */
180
181
        AudioCodecFactory& getAudioCodecFactory (void) {
            return _audioCodecFactory;
Julien Bonjean's avatar
Julien Bonjean committed
182
183
184
185
186
187
        }

        /**
         * Functions which occur with a user's action
         * Place a new call
         * @param accountId	The account to make tha call with
188
         * @param call_id  The call identifier
Julien Bonjean's avatar
Julien Bonjean committed
189
         * @param to  The recipient of the call
190
	 * @param conf_id The conference identifier if any
Julien Bonjean's avatar
Julien Bonjean committed
191
192
193
         * @return bool true on success
         *		  false otherwise
         */
194
        bool outgoingCall (const std::string&, const std::string&, const std::string&, const std::string& = "");
Julien Bonjean's avatar
Julien Bonjean committed
195
196
197
198
199
200

        /**
         * Functions which occur with a user's action
         * Answer the call
         * @param id  The call identifier
         */
201
        bool answerCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
202
203
204
205
206

        /**
         * Functions which occur with a user's action
         * Hangup the call
         * @param id  The call identifier
207
         * @return true on success
Julien Bonjean's avatar
Julien Bonjean committed
208
         */
209
        bool hangupCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
210
211
212
213
214
215
216


        /**
         * Functions which occur with a user's action
         * Hangup the conference (hangup every participants)
         * @param id  The call identifier
         */
217
        bool hangupConference (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
218
219
220
221
222
223

        /**
         * Functions which occur with a user's action
         * Cancel the call
         * @param id  The call identifier
         */
224
        bool cancelCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
225
226
227
228
229
230

        /**
         * Functions which occur with a user's action
         * Put the call on hold
         * @param id  The call identifier
         */
231
        bool onHoldCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
232
233
234
235
236
237

        /**
         * Functions which occur with a user's action
         * Put the call off hold
         * @param id  The call identifier
         */
238
        bool offHoldCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
239
240
241
242
243
244
245

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

248
249
250
251
252
        /**
         * Attended transfer
         * @param The call id to be transfered
         * @param The target
         */
253
        bool attendedTransfer(const std::string& transferID, const std::string& targetID);
254

Julien Bonjean's avatar
Julien Bonjean committed
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
        /**
         * Notify the client the transfer is successful
         */
        void transferSucceded();

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

        /**
         * Functions which occur with a user's action
         * Refuse the call
         * @param id  The call identifier
         */
270
        bool refuseCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
271
272
273
274
275
276

        /**
         * Create a new conference given two participant
         * @param the first participant ID
         * @param the second participant ID
         */
277
        Conference* createConference (const std::string& id1, const std::string& id2);
Julien Bonjean's avatar
Julien Bonjean committed
278
279
280
281
282

        /**
         * Delete this conference
         * @param the conference ID
         */
283
        void removeConference (const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
284
285
286
287
288

        /**
         * Return the conference id for which this call is attached
         * @ param the call id
         */
289
        Conference* getConferenceFromCallID (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
290
291
292
293
294

        /**
         * Hold every participant to a conference
         * @param the conference id
         */
295
        void holdConference (const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
296
297
298
299
300

        /**
         * Unhold all conference participants
         * @param the conference id
         */
301
        void unHoldConference (const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
302
303
304
305
306

        /**
         * Test if this id is a conference (usefull to test current call)
         * @param the call id
         */
307
        bool isConference (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
308
309
310
311
312

        /**
         * Test if a call id particips to this conference
         * @param the call id
         */
313
        bool participToConference (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
314
315
316
317
318
319

        /**
         * Add a participant to a conference
         * @param the call id
         * @param the conference id
         */
320
        void addParticipant (const std::string& call_id, const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
321
322
323
324
325

        /**
         * Bind the main participant to a conference (mainly called on a double click action)
         * @param the conference id
         */
326
        void addMainParticipant (const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
327
328
329
330
331
332

        /**
         * Join two participants to create a conference
         * @param the fist call id
         * @param the second call id
         */
333
        void joinParticipant (const std::string& call_id1, const std::string& call_id2);
Julien Bonjean's avatar
Julien Bonjean committed
334

335
336
337
338
339
340
	/**
	 * Create a conference from a list of participant
	 * @param A vector containing the list of participant
 	 */
	void createConfFromParticipantList(const std::vector< std::string > &);

Julien Bonjean's avatar
Julien Bonjean committed
341
342
343
344
345
        /**
         * Detach a participant from a conference, put the call on hold, do not hangup it
         * @param call id
         * @param the current call id
         */
346
        void detachParticipant (const std::string& call_id, const std::string& current_call_id);
Julien Bonjean's avatar
Julien Bonjean committed
347
348
349
350
351

        /**
         * Remove the conference participant from a conference
         * @param call id
         */
352
        void removeParticipant (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
353
354
355
356
357
358
359

        /**
         * 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
         */
360
        void processRemainingParticipant (std::string current_call_id, Conference *conf);
Julien Bonjean's avatar
Julien Bonjean committed
361
362
363
364

        /**
         * Join two conference together into one unique conference
         */
365
        void joinConference (const std::string& conf_id1, const std::string& conf_id2);
Julien Bonjean's avatar
Julien Bonjean committed
366

367
        void addStream (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
368

369
        void removeStream (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387

        /**
         * Save config to file
         * @return true on success
         *	    false otherwise
         */
        bool saveConfig (void);

        /**
         * @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.
         */
388
        bool sendDtmf (const std::string& id, char code);
Julien Bonjean's avatar
Julien Bonjean committed
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421

        /**
         * Play the dtmf-associated sound
         * @param code  The pressed key
         */
        bool playDtmf (char code);

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

        /**
         * Play a special ringtone ( BUSY ) if there's at least one message on the voice mail
         * @return bool True on success
         *	      false otherwise
         */
        bool playToneWithMessage ();

        /**
         * Acts on the audio streams and audio files
         */
        void stopTone (void);

        /**
         * 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
         */
422
        bool incomingCall (Call* call, const std::string& accountId);
Julien Bonjean's avatar
Julien Bonjean committed
423
424
425
426
427
428

        /**
         * Notify the user that the recipient of the call has answered and the put the
         * call in Current state
         * @param id  The call identifier
         */
429
        void peerAnsweredCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
430
431
432
433
434
435

        /**
         * Rings back because the outgoing call is ringing and the put the
         * call in Ringing state
         * @param id  The call identifier
         */
436
        void peerRingingCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
437
438
439
440
441

        /**
         * Put the call in Hungup state, remove the call from the list
         * @param id  The call identifier
         */
442
        void peerHungupCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
443
444
445
446
447
448

        /**
         * Notify the client with an incoming message
         * @param accountId	The account identifier
         * @param message The content of the message
         */
449
        void incomingMessage (const std::string& callID, const std::string& from, const std::string& message);
Julien Bonjean's avatar
Julien Bonjean committed
450

451
452

        /**
453
         * Send a new text message to the call, if participate to a conference, send to all participant.
454
455
         * @param callID	The call to send the message
         * @param message	The content of the message
456
457
        * @param from	        The sender of this message (could be another participant of a conference)
         */
458
        bool sendTextMessage (const std::string& callID, const std::string& message, const std::string& from);
459

Julien Bonjean's avatar
Julien Bonjean committed
460
461
462
463
464
        /**
         * Notify the client he has voice mails
         * @param accountId	  The account identifier
         * @param nb_msg The number of messages
         */
465
        void startVoiceMessageNotification (const std::string& accountId, int nb_msg);
Julien Bonjean's avatar
Julien Bonjean committed
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484

        /**
         * Notify the client through DBus that registration state has been updated
         */
        void connectionStatusNotification (void);

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

        /**
         * Get account list
         * @return std::vector<std::string> A list of accoundIDs
         */
485
        std::vector< std::string >  getAccountList() const;
Julien Bonjean's avatar
Julien Bonjean committed
486
487
488
489
490
491
492
493
494
495
496

        /**
         * Set the account order in the config file
         */
        void setAccountsOrder (const std::string& order);

        /**
         * Retrieve details about a given account
         * @param accountID	  The account identifier
         * @return std::map< std::string, std::string > The account details
         */
497
        std::map< std::string, std::string > getAccountDetails (const std::string& accountID) const;
Julien Bonjean's avatar
Julien Bonjean committed
498
499
500
501
502
503

        /**
         * Retrieve details about a given call
         * @param callID	  The account identifier
         * @return std::map< std::string, std::string > The call details
         */
504
        std::map< std::string, std::string > getCallDetails (const std::string& callID);
Julien Bonjean's avatar
Julien Bonjean committed
505
506
507
508
509

        /**
         * Get call list
         * @return std::vector<std::string> A list of call IDs
         */
510
        std::vector< std::string >  getCallList (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
511
512
513
514
515
516

        /**
         * Retrieve details about a given call
         * @param callID	  The account identifier
         * @return std::map< std::string, std::string > The call details
         */
517
        std::map< std::string, std::string > getConferenceDetails (const std::string& callID) const;
Julien Bonjean's avatar
Julien Bonjean committed
518
519
520
521
522

        /**
         * Get call list
         * @return std::vector<std::string> A list of call IDs
         */
523
        std::vector< std::string >  getConferenceList (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
524
525
526
527
528
529


        /**
         * Get a list of participant to a conference
         * @return std::vector<std::string> A list of call IDs
         */
530
        std::vector< std::string >  getParticipantList (const std::string& confID) const;
Julien Bonjean's avatar
Julien Bonjean committed
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553

        /**
         * 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
         */
        void setAccountDetails (const ::std::string& accountID,
                                const std::map< ::std::string, ::std::string >& details);

        /**
         * Add a new account, and give it a new account ID automatically
         * @param details The new account parameters
         * @return The account Id given to the new account
         */
        std::string addAccount (const std::map< ::std::string, ::std::string >& details);

        /**
         * Delete an existing account, unregister VoIPLink associated, and
         * purge from configuration.
         * @param accountID	The account unique ID
         */
554
        void removeAccount (const std::string& accountID);
Julien Bonjean's avatar
Julien Bonjean committed
555
556
557
558
559
560

        /**
         * Get current codec name
         * @param call id
         * @return std::string The codec name
         */
561
        std::string getCurrentCodecName (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
562
563
564
565
566

        /**
         * Set input audio plugin
         * @param audioPlugin The audio plugin
         */
567
        void setAudioPlugin (const std::string& audioPlugin);
Julien Bonjean's avatar
Julien Bonjean committed
568
569

        /**
570
571
572
573
574
             * Set audio device
             * @param index The index of the soundcard
             * @param the type of stream, either SFL_PCM_PLAYBACK, SFL_PCM_CAPTURE, SFL_PCM_RINGTONE
             */
        void setAudioDevice (const int index, const int streamType);
Julien Bonjean's avatar
Julien Bonjean committed
575
576
577
578
579
580
581
582
583
584
585
586
587
588

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

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

        /**
589
         * Get string array representing integer indexes of output, input, and ringtone device
Julien Bonjean's avatar
Julien Bonjean committed
590
591
592
593
594
595
596
597
598
         * @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
         */
599
        int getAudioDeviceIndex (const std::string &name);
Julien Bonjean's avatar
Julien Bonjean committed
600
601
602
603
604

        /**
         * Get current alsa plugin
         * @return std::string  The Alsa plugin
         */
605
        std::string getCurrentAudioOutputPlugin (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
606

607
608
609
610
        /**
         * Get the noise reduction engin state from
         * the current audio layer.
         */
611
        std::string getNoiseSuppressState (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
612

613
614
615
616
        /**
         * Set the noise reduction engin state in the current
         * audio layer.
         */
617
        void setNoiseSuppressState (const std::string &state);
Julien Bonjean's avatar
Julien Bonjean committed
618

619
620
621
622
        /**
         * Get the echo canceller engin state from
         * the current audio layer
         */
623
        std::string getEchoCancelState(void) const;
624
625
626
627

        /**
         * Set the echo canceller engin state
         */
628
        void setEchoCancelState(const std::string &state);
629

630
        int getEchoCancelTailLength(void) const;
631
632
633

        void setEchoCancelTailLength(int);

634
        int getEchoCancelDelay(void) const;
635
636
637

        void setEchoCancelDelay(int);

Julien Bonjean's avatar
Julien Bonjean committed
638
639
640
641
642
        /**
         * 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
         */
643
        static std::string serialize (const std::vector<std::string> &v);
Julien Bonjean's avatar
Julien Bonjean committed
644

645
        static std::vector<std::string> unserialize (std::string v);
Julien Bonjean's avatar
Julien Bonjean committed
646
647
648
649
650
651
652
653
654
655
656
657
658
659

        /**
         * Tells if IAX2 support is enabled
         * @return int 1 if IAX2 is enabled
         *	       0 otherwise
         */
        int isIax2Enabled (void);

        /**
         * Ringtone option.
         * If ringtone is enabled, ringtone on incoming call use custom choice. If not, only standart tone.
         * @return int	1 if enabled
         *	        0 otherwise
         */
660
        int isRingtoneEnabled (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
661
662
663
664
665

        /**
         * Set the ringtone option
         * Inverse current value
         */
666
        void ringtoneEnabled (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
667
668
669
670
671

        /**
         * Get the ringtone
         * @return gchar* The file name selected as a ringtone
         */
672
        std::string getRingtoneChoice (const std::string& id) const;
Julien Bonjean's avatar
Julien Bonjean committed
673
674
675
676
677

        /**
         * Set a ringtone
         * @param tone The file name of the ringtone
         */
678
        void setRingtoneChoice (const std::string&, const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
679
680
681
682
683

        /**
         * Get the recording path from configuration tree
         * @return the string correspoding to the path
         */
684
        std::string getRecordPath (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
685
686
687
688
689
690
691

        /**
         * Set the recoding path in the configuration tree
         * @param a string reresenting the path
         */
        void setRecordPath (const std::string& recPath);

692
693
694
        /**
         * Get is always recording functionality
         */
695
        bool getIsAlwaysRecording(void) const;
696
697
698
699
700
701
702

        /**
         * Set is always recording functionality, every calls will then be set in RECORDING mode
         * once answered
         */
        void setIsAlwaysRecording(bool isAlwaysRec);

Julien Bonjean's avatar
Julien Bonjean committed
703
704
705
706
707
        /**
         * Set recording on / off
         * Start recording
         * @param id  The call identifier
         */
708
        void setRecordingCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
709
710
711
712

        /**
         * Return true if the call is currently recorded
         */
713
        bool isRecording (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
714

715
716
717
718
	/**
	 * Start playback fo a recorded file if and only if audio layer is not already started.
 	 * @param File path of the file to play
         */
719
        bool startRecordedFilePlayback(const std::string&);
720
721
722
723
724
725
726

	/**
	 * Stop playback of recorded file
	 * @param File of the file to stop
	 */
        void stopRecordedFilePlayback(const std::string&);

Julien Bonjean's avatar
Julien Bonjean committed
727
728
729
730
        /**
         * Set the maximum number of days to keep in the history
         * @param calls The number of days
         */
731
        void setHistoryLimit (int days);
Julien Bonjean's avatar
Julien Bonjean committed
732
733
734
735
736

        /**
         * Get the maximum number of days to keep in the history
         * @return double The number of days
         */
737
        int getHistoryLimit (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760

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

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


        /**
         * Addressbook configuration
         */
761
        std::map<std::string, int32_t> getAddressbookSettings (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
762
763
764
765
766
767
768
769
770
771
772
773
774
775

        /**
         * Addressbook configuration
         */
        void setAddressbookSettings (const std::map<std::string, int32_t>& settings);

        /**
         * Addressbook list
         */
        void setAddressbookList (const std::vector<  std::string >& list);

        /**
         * Addressbook list
         */
776
        std::vector <std::string> getAddressbookList (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
777
778
779
780

        /**
         * Hook configuration
         */
781
        std::map<std::string, std::string> getHookSettings (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
782
783
784
785
786
787
788
789
790
791
792
793
794

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


        /**
         * Get the audio manager
         * @return int The audio manager
         *		    0 ALSA
         *		    1 PULSEAUDIO
         */
795
        int32_t getAudioManager (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
796
797
798
799

        /**
         * Set the audio manager
         */
800
        void setAudioManager (int32_t api);
Julien Bonjean's avatar
Julien Bonjean committed
801
802
803

        void switchAudioManager (void);

804
805
806
807
808
        /**
         * Set the internal audio sampling rate change. Should close the audio layer and
         * reopen stream at different rate,
         */
        void audioSamplingRateChanged (int);
Julien Bonjean's avatar
Julien Bonjean committed
809
810
811
812
813

        /**
         * Get the desktop mail notification level
         * @return int The mail notification level
         */
814
        int32_t getMailNotify (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
815
816
817
818
819

        /**
         * Get the list of the active codecs
         * @return std::vector< ::std::string >  The list of active codecs
         */
820
        std::vector< ::std::string > getActiveCodecList (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
821
822
823
824
825
826

        /*
         * Notify the client that an error occured
         * @param errCode The error code. Could be: ALSA_CAPTURE_ERROR
         *					       ALSA_PLAYBACK_ERROR
         */
827
        void notifyErrClient (int32_t errCode);
Julien Bonjean's avatar
Julien Bonjean committed
828
829
830
831
832
833
834
835
836

        /**
         * 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
         */
837
        bool getConfig (const std::string& section, const std::string& name, TokenList& arg) const;
Julien Bonjean's avatar
Julien Bonjean committed
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860

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

        /**
         * Change a specific value in the configuration tree.
         * This value will then be saved in the user config file sflphonedrc
         * @param section	The section name
         * @param name	The parameter name
         * @param value	The new int value
         * @return bool	true on success
         *		      false otherwise
         */
        bool setConfig (const std::string& section, const std::string& name, int value);

861
        std::string mapStateNumberToString (RegistrationState state) const {
Julien Bonjean's avatar
Julien Bonjean committed
862
863
864
865
866
867
868
869
            std::string stringRepresentation;

            if (state > NumberOfState) {
                stringRepresentation = "ERROR";
                return stringRepresentation;
            }

            stringRepresentation = mapStateToChar[state];
870
871
            return stringRepresentation;
        }
Julien Bonjean's avatar
Julien Bonjean committed
872
873
874
875
876
877
878
879
880

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

881
        int getConfigInt (const std::string& section, const std::string& name) const;
Julien Bonjean's avatar
Julien Bonjean committed
882
883
884
885
886
887
888
889
890

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

891
        bool getConfigBool (const std::string& section, const std::string& name) const;
Julien Bonjean's avatar
Julien Bonjean committed
892
893
894
895
896
897
898
899

        /**
         * 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
         */
900
        std::string getConfigString (const std::string& section, const std::string& name) const;
Julien Bonjean's avatar
Julien Bonjean committed
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917

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

        /**
         * Handle audio sounds heard by a caller while they wait for their
         * connection to a called party to be completed.
         */
        void ringback ();

        /**
         * Handle played music when an incoming call occurs
         */
918
        void ringtone (const std::string& accountID);
Julien Bonjean's avatar
Julien Bonjean committed
919
920
921
922
923
924
925
926
927

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

        /**
         * Handle played sound when a call can not be conpleted because of a busy recipient
         */
928
        void callBusy (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
929
930
931
932

        /**
         * Handle played sound when a failure occurs
         */
933
        void callFailure (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963

        /**
         * Retrieve the current telephone tone
         * @return AudioLoop*   The audio tone or 0 if no tone (init before calling this function)
         */
        AudioLoop* getTelephoneTone();

        /**
         * Retrieve the current telephone file
         * @return AudioLoop* The audio file or 0 if the wav is stopped
         */
        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
         */
964
        unsigned short getSpkrVolume (void) const {
Julien Bonjean's avatar
Julien Bonjean committed
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
            return _spkr_volume;
        }

        /*
         * 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
         */
        void setSpkrVolume (unsigned short spkr_vol);

        /*
         * 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
         */
982
        unsigned short getMicVolume (void) const {
Julien Bonjean's avatar
Julien Bonjean committed
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
            return _mic_volume;
        }

        /*
         * 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
         */
        void setMicVolume (unsigned short mic_vol);

        /**
         * 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().
         */
999
        void initConfigFile (std::string alternate="");
Julien Bonjean's avatar
Julien Bonjean committed
1000