managerimpl.h 38.9 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
47

#include "call.h"
48
#include "conference.h"
jpbl's avatar
jpbl committed
49

50
#include "audio/sound/tonelist.h"  // for Tone::TONEID declaration
51
#include "audio/sound/audiofile.h"
52
#include "audio/sound/dtmf.h" // DTMF class contained by value here
53
#include "audio/codecs/audiocodecfactory.h" 
jpbl's avatar
jpbl committed
54

55
#include "audio/mainbuffer.h"
56
#include "yamlemitter.h"
57
#include "yamlparser.h"
58
#include "preferences.h"
59

60
61
#include "im/InstantMessaging.h"

jpbl's avatar
jpbl committed
62
63
64
65
class AudioLayer;
class GuiFramework;
class TelephoneTone;
class VoIPLink;
66

67
// class Conference;
yanmorin's avatar
   
yanmorin committed
68

jpbl's avatar
jpbl committed
69
70
71
72
#ifdef USE_ZEROCONF
class DNSService;
#endif

73
class HistoryManager;
74
class Account;
jpbl's avatar
jpbl committed
75

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

79
80
/** 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
81

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

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

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

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

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

97
static std::string default_conf = "conf";
98

99
/** Manager (controller) of sflphone daemon */
Julien Bonjean's avatar
Julien Bonjean committed
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
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;

        /**
         * Initialisation of thread (sound) and map.
         * Init a new VoIPLink, audio codec and audio driver
         */
141
        void init (std::string config_file="");
Julien Bonjean's avatar
Julien Bonjean committed
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160

        /**
         * 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
         */
161
162
        AudioCodecFactory& getAudioCodecFactory (void) {
            return _audioCodecFactory;
Julien Bonjean's avatar
Julien Bonjean committed
163
164
165
166
167
168
        }

        /**
         * Functions which occur with a user's action
         * Place a new call
         * @param accountId	The account to make tha call with
169
         * @param call_id  The call identifier
Julien Bonjean's avatar
Julien Bonjean committed
170
         * @param to  The recipient of the call
171
	 * @param conf_id The conference identifier if any
Julien Bonjean's avatar
Julien Bonjean committed
172
173
174
         * @return bool true on success
         *		  false otherwise
         */
175
        bool outgoingCall (const std::string&, const std::string&, const std::string&, const std::string& = "");
Julien Bonjean's avatar
Julien Bonjean committed
176
177
178
179
180
181

        /**
         * Functions which occur with a user's action
         * Answer the call
         * @param id  The call identifier
         */
182
        bool answerCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
183
184
185
186
187
188

        /**
         * Functions which occur with a user's action
         * Hangup the call
         * @param id  The call identifier
         */
189
        void hangupCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
190
191
192
193
194
195
196


        /**
         * Functions which occur with a user's action
         * Hangup the conference (hangup every participants)
         * @param id  The call identifier
         */
197
        bool hangupConference (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
198
199
200
201
202
203

        /**
         * Functions which occur with a user's action
         * Put the call on hold
         * @param id  The call identifier
         */
204
        bool onHoldCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
205
206
207
208
209
210

        /**
         * Functions which occur with a user's action
         * Put the call off hold
         * @param id  The call identifier
         */
211
        bool offHoldCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
212
213
214
215
216
217
218

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

221
222
223
224
225
        /**
         * Attended transfer
         * @param The call id to be transfered
         * @param The target
         */
226
        bool attendedTransfer(const std::string& transferID, const std::string& targetID);
227

Julien Bonjean's avatar
Julien Bonjean committed
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
        /**
         * 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
         */
243
        bool refuseCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
244
245
246
247
248
249

        /**
         * Create a new conference given two participant
         * @param the first participant ID
         * @param the second participant ID
         */
250
        Conference* createConference (const std::string& id1, const std::string& id2);
Julien Bonjean's avatar
Julien Bonjean committed
251
252
253
254
255

        /**
         * Delete this conference
         * @param the conference ID
         */
256
        void removeConference (const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
257
258
259
260
261

        /**
         * Return the conference id for which this call is attached
         * @ param the call id
         */
262
        Conference* getConferenceFromCallID (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
263
264
265
266
267

        /**
         * Hold every participant to a conference
         * @param the conference id
         */
268
        void holdConference (const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
269
270
271
272
273

        /**
         * Unhold all conference participants
         * @param the conference id
         */
274
        void unHoldConference (const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
275
276
277
278
279

        /**
         * Test if this id is a conference (usefull to test current call)
         * @param the call id
         */
280
        bool isConference (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
281
282
283
284
285

        /**
         * Test if a call id particips to this conference
         * @param the call id
         */
286
        bool participToConference (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
287
288
289
290
291
292

        /**
         * Add a participant to a conference
         * @param the call id
         * @param the conference id
         */
293
        void addParticipant (const std::string& call_id, const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
294
295
296
297
298

        /**
         * Bind the main participant to a conference (mainly called on a double click action)
         * @param the conference id
         */
299
        void addMainParticipant (const std::string& conference_id);
Julien Bonjean's avatar
Julien Bonjean committed
300
301
302
303
304
305

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

308
309
310
311
312
313
	/**
	 * 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
314
315
316
317
318
        /**
         * Detach a participant from a conference, put the call on hold, do not hangup it
         * @param call id
         * @param the current call id
         */
319
        void detachParticipant (const std::string& call_id, const std::string& current_call_id);
Julien Bonjean's avatar
Julien Bonjean committed
320
321
322
323
324

        /**
         * Remove the conference participant from a conference
         * @param call id
         */
325
        void removeParticipant (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
326
327
328
329
330
331
332

        /**
         * 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
         */
333
        void processRemainingParticipant (std::string current_call_id, Conference *conf);
Julien Bonjean's avatar
Julien Bonjean committed
334
335
336
337

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

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

342
        void removeStream (const std::string& call_id);
Julien Bonjean's avatar
Julien Bonjean committed
343
344
345
346

        /**
         * Save config to file
         */
347
        void saveConfig (void);
Julien Bonjean's avatar
Julien Bonjean committed
348
349
350
351
352
353
354
355
356
357
358

        /**
         * @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.
         */
359
        bool sendDtmf (const std::string& id, char code);
Julien Bonjean's avatar
Julien Bonjean committed
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

        /**
         * 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
         */
393
        bool incomingCall (Call* call, const std::string& accountId);
Julien Bonjean's avatar
Julien Bonjean committed
394
395
396
397
398
399

        /**
         * Notify the user that the recipient of the call has answered and the put the
         * call in Current state
         * @param id  The call identifier
         */
400
        void peerAnsweredCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
401
402
403
404
405
406

        /**
         * Rings back because the outgoing call is ringing and the put the
         * call in Ringing state
         * @param id  The call identifier
         */
407
        void peerRingingCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
408
409
410
411
412

        /**
         * Put the call in Hungup state, remove the call from the list
         * @param id  The call identifier
         */
413
        void peerHungupCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
414
415
416
417
418
419

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

422
423

        /**
424
         * Send a new text message to the call, if participate to a conference, send to all participant.
425
426
         * @param callID	The call to send the message
         * @param message	The content of the message
427
428
        * @param from	        The sender of this message (could be another participant of a conference)
         */
429
        bool sendTextMessage (const std::string& callID, const std::string& message, const std::string& from);
430

Julien Bonjean's avatar
Julien Bonjean committed
431
432
433
434
435
        /**
         * Notify the client he has voice mails
         * @param accountId	  The account identifier
         * @param nb_msg The number of messages
         */
436
        void startVoiceMessageNotification (const std::string& accountId, int nb_msg);
Julien Bonjean's avatar
Julien Bonjean committed
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455

        /**
         * 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
         */
456
        std::vector< std::string >  getAccountList() const;
Julien Bonjean's avatar
Julien Bonjean committed
457
458
459
460
461
462
463
464
465
466
467

        /**
         * 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
         */
468
        std::map< std::string, std::string > getAccountDetails (const std::string& accountID) const;
Julien Bonjean's avatar
Julien Bonjean committed
469
470
471
472
473
474

        /**
         * Retrieve details about a given call
         * @param callID	  The account identifier
         * @return std::map< std::string, std::string > The call details
         */
475
        std::map< std::string, std::string > getCallDetails (const std::string& callID);
Julien Bonjean's avatar
Julien Bonjean committed
476
477
478
479
480

        /**
         * Get call list
         * @return std::vector<std::string> A list of call IDs
         */
481
        std::vector< std::string >  getCallList (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
482
483
484
485
486
487

        /**
         * Retrieve details about a given call
         * @param callID	  The account identifier
         * @return std::map< std::string, std::string > The call details
         */
488
        std::map< std::string, std::string > getConferenceDetails (const std::string& callID) const;
Julien Bonjean's avatar
Julien Bonjean committed
489
490
491
492
493

        /**
         * Get call list
         * @return std::vector<std::string> A list of call IDs
         */
494
        std::vector< std::string >  getConferenceList (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
495
496
497
498
499
500


        /**
         * Get a list of participant to a conference
         * @return std::vector<std::string> A list of call IDs
         */
501
        std::vector< std::string >  getParticipantList (const std::string& confID) const;
Julien Bonjean's avatar
Julien Bonjean committed
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524

        /**
         * 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
         */
525
        void removeAccount (const std::string& accountID);
Julien Bonjean's avatar
Julien Bonjean committed
526
527
528
529
530
531

        /**
         * Get current codec name
         * @param call id
         * @return std::string The codec name
         */
532
        std::string getCurrentCodecName (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
533
534
535
536
537

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

        /**
541
542
543
544
545
             * 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
546
547
548
549
550
551
552
553
554
555
556
557
558
559

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

        /**
560
         * Get string array representing integer indexes of output, input, and ringtone device
Julien Bonjean's avatar
Julien Bonjean committed
561
562
563
564
565
566
567
568
569
         * @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
         */
570
        int getAudioDeviceIndex (const std::string &name);
Julien Bonjean's avatar
Julien Bonjean committed
571
572
573
574
575

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

578
579
580
581
        /**
         * Get the noise reduction engin state from
         * the current audio layer.
         */
582
        std::string getNoiseSuppressState (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
583

584
585
586
587
        /**
         * Set the noise reduction engin state in the current
         * audio layer.
         */
588
        void setNoiseSuppressState (const std::string &state);
Julien Bonjean's avatar
Julien Bonjean committed
589

590
591
592
593
        /**
         * Get the echo canceller engin state from
         * the current audio layer
         */
594
        std::string getEchoCancelState(void) const;
595
596
597
598

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

601
        int getEchoCancelTailLength(void) const;
602
603
604

        void setEchoCancelTailLength(int);

605
        int getEchoCancelDelay(void) const;
606
607
608

        void setEchoCancelDelay(int);

Julien Bonjean's avatar
Julien Bonjean committed
609
610
611
612
613
        /**
         * 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
         */
614
        static std::string serialize (const std::vector<std::string> &v);
Julien Bonjean's avatar
Julien Bonjean committed
615

616
        static std::vector<std::string> unserialize (std::string v);
Julien Bonjean's avatar
Julien Bonjean committed
617
618
619
620
621
622
623

        /**
         * 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
         */
624
        int isRingtoneEnabled (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
625
626
627
628
629

        /**
         * Set the ringtone option
         * Inverse current value
         */
630
        void ringtoneEnabled (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
631
632
633
634
635

        /**
         * Get the recording path from configuration tree
         * @return the string correspoding to the path
         */
636
        std::string getRecordPath (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
637
638
639
640
641
642
643

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

644
645
646
        /**
         * Get is always recording functionality
         */
647
        bool getIsAlwaysRecording(void) const;
648
649
650
651
652
653
654

        /**
         * 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
655
656
657
658
659
        /**
         * Set recording on / off
         * Start recording
         * @param id  The call identifier
         */
660
        void setRecordingCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
661
662
663
664

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

667
668
669
670
	/**
	 * Start playback fo a recorded file if and only if audio layer is not already started.
 	 * @param File path of the file to play
         */
671
        bool startRecordedFilePlayback(const std::string&);
672
673
674
675
676
677
678

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

Julien Bonjean's avatar
Julien Bonjean committed
679
680
681
682
        /**
         * Set the maximum number of days to keep in the history
         * @param calls The number of days
         */
683
        void setHistoryLimit (int days);
Julien Bonjean's avatar
Julien Bonjean committed
684
685
686
687
688

        /**
         * Get the maximum number of days to keep in the history
         * @return double The number of days
         */
689
        int getHistoryLimit (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712

        /**
         * 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
         */
713
        std::map<std::string, int32_t> getAddressbookSettings (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
714
715
716
717
718
719
720
721
722
723
724
725
726
727

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

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

        /**
         * Addressbook list
         */
728
        std::vector <std::string> getAddressbookList (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
729
730
731
732

        /**
         * Hook configuration
         */
733
        std::map<std::string, std::string> getHookSettings (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
734
735
736
737
738
739
740
741
742
743
744
745
746

        /**
         * 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
         */
747
        int32_t getAudioManager (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
748
749
750
751

        /**
         * Set the audio manager
         */
752
        void setAudioManager (int32_t api);
Julien Bonjean's avatar
Julien Bonjean committed
753
754
755

        void switchAudioManager (void);

756
757
758
759
760
        /**
         * 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
761
762
763
764
765

        /**
         * Get the desktop mail notification level
         * @return int The mail notification level
         */
766
        int32_t getMailNotify (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
767
768
769
770
771

        /**
         * Get the list of the active codecs
         * @return std::vector< ::std::string >  The list of active codecs
         */
772
        std::vector< ::std::string > getActiveCodecList (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
773
774
775
776
777
778

        /*
         * Notify the client that an error occured
         * @param errCode The error code. Could be: ALSA_CAPTURE_ERROR
         *					       ALSA_PLAYBACK_ERROR
         */
779
        void notifyErrClient (int32_t errCode);
Julien Bonjean's avatar
Julien Bonjean committed
780
781
782
783
784
785
786
787
788

        /**
         * 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
         */
789
        bool getConfig (const std::string& section, const std::string& name, TokenList& arg) const;
Julien Bonjean's avatar
Julien Bonjean committed
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820

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

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

821
        int getConfigInt (const std::string& section, const std::string& name) const;
Julien Bonjean's avatar
Julien Bonjean committed
822
823
824
825
826
827
828
829
830

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

831
        bool getConfigBool (const std::string& section, const std::string& name) const;
Julien Bonjean's avatar
Julien Bonjean committed
832
833
834
835
836
837
838
839

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

        /**
         * 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
         */
858
        void ringtone (const std::string& accountID);
Julien Bonjean's avatar
Julien Bonjean committed
859
860
861
862
863
864
865
866
867

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

        /**
         * Handle played sound when a call can not be conpleted because of a busy recipient
         */
868
        void callBusy (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
869
870
871
872

        /**
         * Handle played sound when a failure occurs
         */
873
        void callFailure (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903

        /**
         * 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
         */
904
        unsigned short getSpkrVolume (void) const {
Julien Bonjean's avatar
Julien Bonjean committed
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
            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
         */
922
        unsigned short getMicVolume (void) const {
Julien Bonjean's avatar
Julien Bonjean committed
923
924
925
926
927
928
929
930
931
932
933
934
935
            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);

        /**
         * Return a new random callid that is not present in the list
936
         * @return std::string A brand new callid
Julien Bonjean's avatar
Julien Bonjean committed
937
         */
938
        std::string getNewCallID();
Julien Bonjean's avatar
Julien Bonjean committed
939
940
941

        /**
         * Get the current call id
942
         * @return std::string	The call id or ""
Julien Bonjean's avatar
Julien Bonjean committed
943
         */
944
        const std::string& getCurrentCallId() const;
Julien Bonjean's avatar
Julien Bonjean committed
945
946
947
948
949
950

        /**
         * Check if a call is the current one
         * @param callId the new callid
         * @return bool   True if the id is the current call
         */
951
        bool isCurrentCall (const std::string& callId);
Julien Bonjean's avatar
Julien Bonjean committed
952
953
954
955
956
957

        /*
         * Initialize audiodriver
         */
        bool initAudioDriver (void);

958
959
960
961
962
963
964
965
966
        /**
         * Enter the mutex for the audio layer
         */
        void audioLayerMutexLock(void) { _audiolayerMutex.enterMutex(); }

        /**
         * Leave the mutex for audio layer
         */
        void audioLayerMutexUnlock(void) { _audiolayerMutex.leaveMutex(); }
Julien Bonjean's avatar
Julien Bonjean committed
967

968
969
970
971
972
        /**
         * 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 () const;
Julien Bonjean's avatar
Julien Bonjean committed
973
    private:
974

Julien Bonjean's avatar
Julien Bonjean committed
975
        /**
976
         * Create config directory in home user and return configuration file path
Julien Bonjean's avatar
Julien Bonjean committed
977
         */
978
        std::string getConfigFile (void) const;
Julien Bonjean's avatar
Julien Bonjean committed
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994


        /*
         * Initialize zeroconf module and scanning
         */
        void initZeroconf (void);

        /*
         * Init the volume for speakers/micro from 0 to 100 value
         */
        void initVolume();

        /**
         * Switch of current call id
         * @param id The new callid
         */
995
        void switchCall (const std::string& id);
Julien Bonjean's avatar
Julien Bonjean committed
996
997
998
999
1000

        /*
         * Play one tone
         * @return false if the driver is uninitialize
         */