1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
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
237
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
|
/*
* Copyright (C) 2004-2013 Savoir-Faire Linux Inc.
*
* Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
* Author: Yun Liu <yun.liu@savoirfairelinux.com>
* Author: Pierre-Luc Bacon <pierre-luc.bacon@savoirfairelinux.com>
* Author: Alexandre Savard <alexandre.savard@savoirfairelinux.com>
*
* 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
* the Free Software Foundation; either version 3 of the License, or
* (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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* 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.
*/
#ifndef SIPVOIPLINK_H_
#define SIPVOIPLINK_H_
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include "voiplink.h"
#include "sipaccount.h"
#include "siptransport.h"
#include <pjsip.h>
#include <pjlib.h>
#include <pjsip_ua.h>
#include <pjlib-util.h>
#include <pjnath.h>
#include <pjnath/stun_config.h>
#ifdef SFL_VIDEO
#include <queue>
#endif
#include <map>
#include <mutex>
#include <memory>
class SIPCall;
class SIPAccount;
typedef std::map<std::string, std::shared_ptr<SIPCall> > SipCallMap;
/**
* @file sipvoiplink.h
* @brief Specific VoIPLink for SIP (SIP core for incoming and outgoing events).
* This class is based on the singleton design pattern.
* One SIPVoIPLink can handle multiple SIP accounts, but all the SIP accounts have all the same SIPVoIPLink
*/
class SIPVoIPLink : public VoIPLink {
public:
/**
* Singleton method. Enable to retrieve the unique static instance
* @return SIPVoIPLink* A pointer on the object
*/
static SIPVoIPLink& instance();
/**
* Destroy the singleton instance
*/
static void destroy();
/**
* Set pjsip's log level based on the SIPLOGLEVEL environment variable.
* SIPLOGLEVEL = 0 minimum logging
* SIPLOGLEVEL = 6 maximum logging
*/
static void setSipLogLevel();
#ifdef __ANDROID__
static void setSipLogger();
#endif
/**
* Event listener. Each event send by the call manager is received and handled from here
*/
virtual bool handleEvents();
/* Returns a list of all callIDs */
std::vector<std::string>
getCallIDs();
/**
* Return the internal account map for this VOIP link
*/
AccountMap &
getAccounts() { return sipAccountMap_; }
virtual std::vector<std::shared_ptr<Call> > getCalls(const std::string &account_id) const;
/**
* Build and send SIP registration request
*/
virtual void sendRegister(Account& a);
/**
* Build and send SIP unregistration request
* @param destroy_transport If true, attempt to destroy the transport.
*/
virtual void sendUnregister(Account& a, std::function<void(bool)> cb = std::function<void(bool)>());
/**
* Register a new keepalive registration timer to this endpoint
*/
void registerKeepAliveTimer(pj_timer_entry& timer, pj_time_val& delay);
/**
* Abort currently registered timer
*/
void cancelKeepAliveTimer(pj_timer_entry& timer);
/**
* Place a new call
* @param id The call identifier
* @param toUrl The Sip address of the recipient of the call
* @return Call* The current call
*/
virtual std::shared_ptr<Call> newOutgoingCall(const std::string& id, const std::string& toUrl, const std::string &account_id);
/**
* Start a new SIP call using the IP2IP profile
* @param The call id
* @param The target sip uri
*/
std::shared_ptr<Call> SIPNewIpToIpCall(const std::string& id, const std::string& to);
/**
* Place a call using the currently selected account
* @param The call id
* @param The target sip uri
*/
std::shared_ptr<Call> newRegisteredAccountCall(const std::string& id,
const std::string& toUrl,
const std::string &account_id);
/**
* Answer the call
* @param c The call
*/
virtual void answer(Call *c);
/**
* Hang up the call
* @param id The call identifier
*/
virtual void hangup(const std::string& id, int reason);
/**
* Hang up the call
* @param id The call identifier
*/
virtual void peerHungup(const std::string& id);
/**
* Put the call on hold
* @param id The call identifier
* @return bool True on success
*/
virtual void onhold(const std::string& id);
/**
* Put the call off hold
* @param id The call identifier
* @return bool True on success
*/
virtual void offhold(const std::string& id);
/**
* Transfer method used for both type of transfer
*/
bool transferCommon(SIPCall *call, pj_str_t *dst);
/**
* Transfer the call
* @param id The call identifier
* @param to The recipient of the transfer
*/
virtual void transfer(const std::string& id, const std::string& to);
/**
* Attended transfer
* @param The transfered call id
* @param The target call id
* @return True on success
*/
virtual bool attendedTransfer(const std::string&, const std::string&);
/**
* Refuse the call
* @param id The call identifier
*/
virtual void refuse(const std::string& id);
/**
* Send DTMF refering to account configuration
* @param id The call identifier
* @param code The char code
*/
virtual void carryingDTMFdigits(const std::string& id, char code);
/**
* Tell the user that the call was answered
* @param
*/
void SIPCallAnswered(SIPCall *call, pjsip_rx_data *rdata);
/**
* Handling 5XX/6XX error
* @param
*/
void SIPCallServerFailure(SIPCall *call);
/**
* Peer close the connection
* @param
*/
void SIPCallClosed(SIPCall *call);
/**
* Get the memory pool factory since each calls has its own memory pool
*/
pj_caching_pool *getMemoryPoolFactory();
/**
* Retrive useragent name from account
*/
std::string getUseragentName(SIPAccount *) const;
/**
* Send a SIP message to a call identified by its callid
*
* @param The Id of the call to send the message to
* @param The actual message to be transmitted
* @param The sender of this message (could be another participant of a conference)
*/
#if HAVE_INSTANT_MESSAGING
void sendTextMessage(const std::string& callID,
const std::string& message,
const std::string& from);
#endif
void clearSipCallMap();
void addSipCall(std::shared_ptr<SIPCall>& call);
std::shared_ptr<SIPCall> getSipCall(const std::string& id);
/**
* A non-blocking SIPCall accessor
*
* Will return NULL if the callMapMutex could not be locked
*
* @param id The call identifier
* @return SIPCall* A pointer to the SIPCall object
*/
std::shared_ptr<SIPCall> tryGetSIPCall(const std::string &id);
void removeSipCall(const std::string &id);
/**
* Create the default UDP transport according ot Ip2Ip profile settings
*/
void createDefaultSipUdpTransport();
public:
void loadIP2IPSettings();
/**
* Instance that maintain and manage transport (UDP, TLS)
*/
std::unique_ptr<SipTransport> sipTransport;
#ifdef SFL_VIDEO
static void enqueueKeyframeRequest(const std::string &callID);
#endif
std::string
guessAccountIdFromNameAndServer(const std::string &userName,
const std::string &server) const;
int getModId();
pjsip_endpoint * getEndpoint();
pjsip_module * getMod();
private:
NON_COPYABLE(SIPVoIPLink);
SIPVoIPLink();
~SIPVoIPLink();
/**
* Contains a list of all SIP account
*/
AccountMap sipAccountMap_;
mutable std::mutex sipCallMapMutex_;
SipCallMap sipCallMap_;
/**
* Start a SIP Call
* @param call The current call
* @return true if all is correct
*/
bool SIPStartCall(std::shared_ptr<SIPCall>& call);
#ifdef SFL_VIDEO
void dequeKeyframeRequests();
void requestKeyframe(const std::string &callID);
std::mutex keyframeRequestsMutex_;
std::queue<std::string> keyframeRequests_;
#endif
static SIPVoIPLink * instance_;
friend class SIPTest;
};
#endif // SIPVOIPLINK_H_
|