managerimpl.h 32.4 KB
Newer Older
jpbl's avatar
jpbl committed
1
2
3
4
/*
 *  Copyright (C) 2004-2005 Savoir-Faire Linux inc.
 *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
 *  Author: Laurielle Lea <laurielle.lea@savoirfairelinux.com>
5
 *  Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
6
 *  Author: Guillaume Carmel-Archambault <guillaume.carmel-archambault@savoirfairelinux.com>
jpbl's avatar
jpbl committed
7
8
9
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
10
 *  the Free Software Foundation; either version 3 of the License, or
jpbl's avatar
jpbl committed
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef __MANAGER_H__
#define __MANAGER_H__

#include <string>
#include <vector>
yanmorin's avatar
   
yanmorin committed
28
#include <set>
yanmorin's avatar
   
yanmorin committed
29
#include <map>
jpbl's avatar
jpbl committed
30
#include <cc++/thread.h>
31
#include "dbus/dbusmanager.h"
jpbl's avatar
jpbl committed
32
33
34
35

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

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

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

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

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

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

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

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

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

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

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

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

79
/** Manager (controller) of sflphone daemon */
jpbl's avatar
jpbl committed
80
class ManagerImpl {
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
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
  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);

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

169
170
171
172
173
174
175
176
177
178
    /**
     * Notify the client the transfer is successful
     */
    void transferSucceded();

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

179
180
181
182
183
184
185
    /**
     * Functions which occur with a user's action
     * Refuse the call
     * @param id  The call identifier
     */
    bool refuseCall(const CallID& id);

186
187
    void createConference(const CallID& id);

188
189
190
191
192
193
194
    void removeConference(const CallID& conference_id);

    bool participToConference(const CallID& call_id);

    void addParticipant(const CallID& call_id);

    void removeParticipant(const CallID& call_id);
195

196
197
    /**
     * Save config to file
198
199
200
201
202
203
204
     * @return true on success
     *	    false otherwise
     */
    bool saveConfig (void);

    /**
     * Send registration to all enabled accounts
205
206
     * @return 0 on registration success
     *          1 otherelse
207
     */
208
    int initRegisterAccounts();
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236

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

    /**
237
     * Play a special ringtone ( BUSY ) if there's at least one message on the voice mail
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
     * @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);

    /**
286
     * Notify the client he has voice mails
287
288
289
     * @param accountId	  The account identifier
     * @param nb_msg The number of messages
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
290
    void startVoiceMessageNotification(const AccountID& accountId, int nb_msg);
291

292
293
    /**
     * Notify the client through DBus that registration state has been updated
294
     */
295
    void connectionStatusNotification(void);
296
297
298

    /**
     * ConfigurationManager - Send registration request
299
     * @param accountId The account to register/unregister
300
301
302
303
     * @param expire The flag for the type of registration
     *		 0 for unregistration request
     *		 1 for registration request
     */
304
    void sendRegister( const ::std::string& accountId , const int32_t& expire );
305
306
307

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

308
309
    /**
     * Get account list
310
311
312
313
     * @return std::vector<std::string> A list of accoundIDs
     */
    std::vector< std::string >  getAccountList();

314
315
316
317
318
    /**
     * Set the account order in the config file
     */
    void setAccountsOrder (const std::string& order);

319
320
321
322
323
324
325
    /**
     * 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);

326
327
328
329
330
331
332
    /**
     * 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);

333
334
335
336
337
338
    /**
     * Get call list
     * @return std::vector<std::string> A list of call IDs
     */
    std::vector< std::string >  getCallList (void);

339
340
341
342
343
344
345
    /**
     * 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
     */
346
    void setAccountDetails( const ::std::string& accountID,
347
	const std::map< ::std::string, ::std::string >& details );
348
349
350
351

    /**
     * Add a new account, and give it a new account ID automatically
     * @param details The new account parameters
jquentin's avatar
jquentin committed
352
     * @return The account Id given to the new account
353
     */
jquentin's avatar
jquentin committed
354
    std::string addAccount(const std::map< ::std::string, ::std::string >& details);
355
356
357
358
359
360
361
362
363
364
365

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

    /**
     * Get the list of codecs we supports, not ordered
     * @return The list of the codecs
366
     */
367
    std::vector< ::std::string > getCodecList( void );
368
369
370
371
372
373
374

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

Alexandre Savard's avatar
Alexandre Savard committed
377
378
379
380
381
382
383
    /**
     * Get current codec name
     * @param call id
     * @return std::string The codec name
     */
    std::string getCurrentCodecName(const CallID& id);

384
385
386
387
388
389
390
391
392
393
394
395
396
    /**
     * 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);

    /**
397
     * Set input audio plugin
398
399
400
401
402
     * @param audioPlugin The audio plugin
     */
    void setInputAudioPlugin(const std::string& audioPlugin);

    /**
403
     * Set output audio plugin
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
     * @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
     */
449
    std::string getCurrentAudioOutputPlugin( void );
450
451
452
453
454
455
456
457

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

458
459
    std::vector<std::string> unserialize(std::string v);

460
461
462
463
464
    /**
     * Tells if IAX2 support is enabled
     * @return int 1 if IAX2 is enabled
     *	       0 otherwise
     */
465
    int isIax2Enabled( void );
466
467
468

    /**
     * Ringtone option.
469
     * If ringtone is enabled, ringtone on incoming call use custom choice. If not, only standart tone.
470
471
472
     * @return int	1 if enabled
     *	        0 otherwise
     */
473
    int isRingtoneEnabled( void );
474
475

    /**
476
     * Set the ringtone option
477
478
     * Inverse current value
     */
479
    void ringtoneEnabled( void );
480
481

    /**
482
     * Get the ringtone
483
484
485
486
487
488
489
490
491
492
     * @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& );

493
494
495
496
497
498
499
500
501
502
    /**
     * 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
503
    void setRecordPath( const std::string& recPath);
504

505
    /**
506
     * Tells if the user wants to display the dialpad or not
507
508
509
510
511
512
513
514
515
516
     * @return int 1 if dialpad has to be displayed
     *	       0 otherwise
     */
    int getDialpad( void );

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

517
    /**
518
     * Tells if the user wants to display the volume controls or not
519
520
521
522
523
524
525
526
527
528
     * @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
529
    /**
alexandresavard's avatar
alexandresavard committed
530
     * Set recording on / off
alexandresavard's avatar
alexandresavard committed
531
532
533
534
535
     * Start recording
     * @param id  The call identifier
     */
    void setRecordingCall(const CallID& id);

alexandresavard's avatar
alexandresavard committed
536
537
538
539
540
    /**
     * Return true if the call is currently recorded
     */
    bool isRecording(const CallID& id);

541
    /**
542
543
     * Set the maximum number of days to keep in the history
     * @param calls The number of days
544
     */
545
    void setHistoryLimit (const int& days);
546
547

    /**
548
549
     * Get the maximum number of days to keep in the history
     * @return double The number of days 
550
     */
551
552
553
554
555
556
    int getHistoryLimit (void);

    void setHistoryEnabled (void);

    int getHistoryEnabled (void);

557

558
559
560
561
562
563
564
565
566
567
568
569
570
571
    /**
     * 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 );

    /**
572
     * Configure the popup behaviour
573
     * @return int	1 if it should popup on incoming calls
574
     *		0 if it should never popups
575
576
577
578
     */
    int popupMode( void );

    /**
579
     * Configure the popup behaviour
580
581
582
583
584
     * When SFLphone is in the system tray, you can configure when it popups
     * Never or only on incoming calls
     */
    void switchPopupMode( void );

585
586
587
588
589
590
591
592
593
594
    /**
     * Determine whether or not the search bar (history) should be displayed
     */
    int getSearchbar( void );

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

595
596
597
598
599
600
601
602
603
    /**
     * Set the desktop notification level
     */
    void setNotify( void );

    /**
     * Get the desktop notification level
     * @return int The notification level
     */
604
    int32_t getNotify( void );
605
606
607
608
609
610

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

611

Emmanuel Milou's avatar
Emmanuel Milou committed
612
    /**
613
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
614
615
616
617
     */
    std::map<std::string, int32_t> getAddressbookSettings (void);

    /**
618
     * Addressbook configuration
Emmanuel Milou's avatar
Emmanuel Milou committed
619
     */
620
621
    void setAddressbookSettings (const std::map<std::string, int32_t>& settings);

622
    /**
623
624
625
626
627
628
     * Addressbook list
     */
    void setAddressbookList(const std::vector<  std::string >& list);

    /**
     * Addressbook list
Emmanuel Milou's avatar
Emmanuel Milou committed
629
     */
630
631
    std::vector <std::string> getAddressbookList( void );

632
    /**
633
     * Hook configuration
634
635
636
637
     */
    std::map<std::string, std::string> getHookSettings (void);

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

Emmanuel Milou's avatar
Emmanuel Milou committed
642

643
    /**
644
645
646
647
648
     * Get the audio manager
     * @return int The audio manager
     *		    0 ALSA
     *		    1 PULSEAUDIO
     */
649
    int32_t getAudioManager( void );
650
651
652
653

    /**
     * Set the audio manager
     */
654
    void setAudioManager( const int32_t& api );
655
656

    void switchAudioManager( void );
657
658
659

    void setPulseAppVolumeControl( void );
    int32_t getPulseAppVolumeControl( void );
660

661
    /**
662
663
664
     * Get the desktop mail notification level
     * @return int The mail notification level
     */
665
    int32_t getMailNotify( void );
666

667
668
669
670
671
672
673
674
675
    /**
     * 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
676
     * @return std::vector< ::std::string >  The list of active codecs
677
678
     */
    std::vector< ::std::string > getActiveCodecList( void );
679
680
681
682

    /**
     * Set the list of the active codecs
     * @param list  The new list of active codecs
683
     */
684
    void setActiveCodecList( const std::vector< ::std::string >& list);
685
686
687
688
689
690

    /*
     * Notify the client that an error occured
     * @param errCode The error code. Could be: ALSA_CAPTURE_ERROR
     *					       ALSA_PLAYBACK_ERROR
     */
691
    void notifyErrClient( const int32_t& errCode );
692
693
694
695
696
697
698
699
700
701

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

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

714
715
716
    /**
     * Change a specific value in the configuration tree.
     * This value will then be saved in the user config file sflphonedrc
717
     * @param section	The section name
718
     * @param name	The parameter name
719
     * @param value	The new int value
720
721
722
723
     * @return bool	true on success
     *		      false otherwise
     */
    bool setConfig(const std::string& section, const std::string& name, int value);
724
725

    /**
726
727
728
729
730
731
732
733
     * Get a int from the configuration tree
     * Throw an Conf::ConfigTreeItemException if not found
     * @param section The section name to look in
     * @param name    The parameter name
     * @return int    The int value
     */
    int getConfigInt(const std::string& section, const std::string& name);

734
    /**
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
     * 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);

    /**
751
     * Handle audio sounds heard by a caller while they wait for their
752
753
754
755
756
757
758
759
760
761
762
763
764
     * 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 ();
765

766
767
768
769
770
771
772
773
774
775
    /**
     * 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);

776
    /**
777
     * Retrieve the current telephone tone
778
     * @return AudioLoop*   The audio tone or 0 if no tone (init before calling this function)
779
780
     */
    AudioLoop* getTelephoneTone();
781
782

    /**
783
     * Retrieve the current telephone file
784
     * @return AudioLoop* The audio file or 0 if the wav is stopped
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
     */
    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; }
806

807
808
809
810
811
812
    /*
     * 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
     */
813
    void setSpkrVolume(unsigned short spkr_vol);
814

815
816
817
818
819
820
821
    /*
     * 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;  }
822

823
824
825
826
827
828
    /*
     * 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
     */
829
    void setMicVolume(unsigned short mic_vol);
830
831

    // Manage information about firewall
832

833
    /*
834
     * Get information about firewall
835
836
837
838
839
840
841
842
843
844
845
     * @param  stunSvrAddr: stun server
     * @param  port         port number to open to test the connection
     * @return true if the connection is successful
     */
    bool getStunInfo(StunAddress4& stunSvrAddr, int port);

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

847
848
849
850
851
    /*
     * Inline functions to manage firewall settings
     * @param port The firewall port
     */
    inline void setFirewallPort(int port) 	{ _firewallPort = port; }
852

853
854
855
856
857
858
859
    /*
     * Inline functions to manage firewall settings
     * @return std::string The firewall address
     */
    inline std::string getFirewallAddress (void) 	{ return _firewallAddr; }

    /**
860
861
     * If you are behind a NAT, you have to use STUN server, specified in
     * STUN configuration(you can change this one by default) to give you an
862
863
864
865
866
867
868
869
870
871
872
873
874
     * public IP address and assign a port number.
     * Note: Set firewall port/address retreive
     * @param svr   Server on which to send request
     * @param port  On which port we want to listen to
     * @return true if we are behind a NAT (without error)
     */
    bool behindNat(const std::string& svr, int port);

    /**
     * Init default values for the different fields in the config file.
     * Fills the local _config (Conf::ConfigTree) with the default contents.
     * Called in main.cpp, just before Manager::init().
     */
875
    void initConfigFile ( bool load_user_value=true, std::string alternate="");
876
877
878
879
880
881
882
883

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

884
    /**
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
     * Return a new random callid that is not present in the list
     * @return CallID A brand new callid
     */
    CallID getNewCallID();

    /**
     * Get the current call id
     * @return CallID	The call id or ""
     */
    const CallID& getCurrentCallId();

    /**
     * Check if a call is the current one
     * @param callId the new callid
     * @return bool   True if the id is the current call
     */
    bool isCurrentCall(const CallID& callId);

903
    /**
904
905
906
     * Restart PJSIP
     * @param void
     * @return void
907
     */
Emmanuel Milou's avatar
Emmanuel Milou committed
908
    void restartPJSIP( );
909

910
    void unregisterCurSIPAccounts();
911

Emmanuel Milou's avatar
Emmanuel Milou committed
912
    void registerCurSIPAccounts(VoIPLink *link);
913

914
915
916
917
918
    /*
     * Initialize audiodriver
     */
    bool initAudioDriver(void);

919
  private:
920

921
922
923
924
925
926
927
928
    /**
     * Check if a process is running with the system command
     *
     * @return 0 on success
     *          1 otherelse
     */
    int app_is_running(std::string process);

929
    /**
930
     * Create .PROGNAME directory in home user and create
931
932
933
934
935
936
937
938
939
940
941
942
943
     * configuration tree from the settings file if this file exists.
     *
     * @return	0 if creating file failed
     *			1 if config-file exists
     *			2 if file doesn't exist yet.
     */
    int createSettingsPath (void);

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

944
    
945
946
947
948
949
950
951
    /*
     * Initialize zeroconf module and scanning
     */
    void initZeroconf(void);

    /*
     * Init the volume for speakers/micro from 0 to 100 value
952
     */
953
954
955
956
957
958
959
960
961
962
963
964
965
    void initVolume();

    /**
     * Tell if there is a current call processed
     * @return bool True if there is a current call
     */
    bool hasCurrentCall();

    /**
     * Switch of current call id
     * @param id The new callid
     */
    void switchCall(const CallID& id);
966

967
968
969
970
971
972
973
974
975
976
977
978
979
    /*
     * Play one tone
     * @return false if the driver is uninitialize
     */
    bool playATone(Tone::TONEID toneId);

    /** The configuration tree. It contains accounts parameters, general user settings ,audio settings, ... */
    Conf::ConfigTree _config;

    /** Current Call ID */
    CallID _currentCallId2;

    /** Protected current call access */
980
    ost::Mutex _currentCallMutex;
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997

    /** Vector of CodecDescriptor */
    CodecDescriptor* _codecBuilder;

    /** Audio layer */
    AudioLayer* _audiodriver;

    // Main thread

    DTMF* _dtmfKey;

    // map of codec (for configlist request)
    CodecDescriptor _codecDescriptorMap;

    /////////////////////
    // Protected by Mutex
    /////////////////////
998
    ost::Mutex _toneMutex;
999
1000
    TelephoneTone* _telephoneTone;
    AudioFile _audiofile;