media-session-p.h 13.2 KB
Newer Older
1 2
/*
 * media-session-p.h
Ghislain MARY's avatar
Ghislain MARY committed
3
 * Copyright (C) 2010-2017 Belledonne Communications SARL
4
 *
Ghislain MARY's avatar
Ghislain MARY committed
5 6 7 8
 * 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 2
 * of the License, or (at your option) any later version.
9 10 11 12 13 14 15
 *
 * 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
Ghislain MARY's avatar
Ghislain MARY committed
16 17
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39
 */

#ifndef _MEDIA_SESSION_P_H_
#define _MEDIA_SESSION_P_H_

#include <utility>

#include "call-session-p.h"

#include "media-session.h"
#include "port-config.h"
#include "nat/ice-agent.h"
#include "nat/stun-client.h"

#include "linphone/call_stats.h"

// =============================================================================

LINPHONE_BEGIN_NAMESPACE

class MediaSessionPrivate : public CallSessionPrivate {
public:
40
	MediaSessionPrivate () = default;
41 42

public:
43 44
	static int resumeAfterFailedTransfer (void *userData, unsigned int);
	static bool_t startPendingRefer (void *userData);
45 46
	static void stunAuthRequestedCb (void *userData, const char *realm, const char *nonce, const char **username, const char **password, const char **ha1);

47 48
	void accepted () override;
	void ackReceived (LinphoneHeaders *headers) override;
Ghislain MARY's avatar
Ghislain MARY committed
49
	void dtmfReceived (char dtmf);
50
	bool failure () override;
51
	void pauseForTransfer ();
52
	void pausedByRemote ();
53
	void remoteRinging () override;
54
	int resumeAfterFailedTransfer ();
55
	void resumed ();
56
	void startPendingRefer ();
Ghislain MARY's avatar
Ghislain MARY committed
57
	void telephoneEventReceived (int event);
58
	void terminated () override;
59
	void updated (bool isUpdate);
60
	void updating (bool isUpdate) override;
61 62

	void enableSymmetricRtp (bool value);
Ghislain MARY's avatar
Ghislain MARY committed
63
	void oglRender () const;
64 65 66 67 68 69 70
	void sendVfu ();

	void clearIceCheckList (IceCheckList *cl);
	void deactivateIce ();
	void prepareStreamsForIceGathering (bool hasVideo);
	void stopStreamsForIceGathering ();

71
	int getAf () const { return af; }
72

73
	bool getAudioMuted () const { return audioMuted; }
74

75 76 77
	MediaSessionParams *getCurrentParams () const { return static_cast<MediaSessionParams *>(currentParams); }
	MediaSessionParams *getParams () const { return static_cast<MediaSessionParams *>(params); }
	MediaSessionParams *getRemoteParams () const { return static_cast<MediaSessionParams *>(remoteParams); }
78
	void setCurrentParams (MediaSessionParams *msp);
79
	void setParams (MediaSessionParams *msp);
80
	void setRemoteParams (MediaSessionParams *msp);
81

82
	IceSession *getIceSession () const { return iceAgent->getIceSession(); }
83

84
	SalMediaDescription *getLocalDesc () const { return localDesc; }
85

86
	unsigned int getMediaStartCount () const;
87
	MediaStream *getMediaStream (LinphoneStreamType type) const;
88
	LinphoneNatPolicy *getNatPolicy () const { return natPolicy; }
89

90 91
	int getRtcpPort (LinphoneStreamType type) const;
	int getRtpPort (LinphoneStreamType type) const;
92
	LinphoneCallStats *getStats (LinphoneStreamType type) const;
93 94
	int getStreamIndex (LinphoneStreamType type) const;
	int getStreamIndex (MediaStream *ms) const;
95 96
	SalCallOp * getOp () const { return op; }
	void setAudioMuted (bool value) { audioMuted = value; }
97

98 99 100
	// CoreListener
	void onNetworkReachable (bool reachable) override;

101 102 103
private:
	static OrtpJitterBufferAlgorithm jitterBufferNameToAlgo (const std::string &name);

Ghislain MARY's avatar
Ghislain MARY committed
104 105 106 107 108 109
#ifdef VIDEO_ENABLED
	static void videoStreamEventCb (void *userData, const MSFilter *f, const unsigned int eventId, const void *args);
#endif // ifdef VIDEO_ENABLED
#ifdef TEST_EXT_RENDERER
	static void extRendererCb (void *userData, const MSPicture *local, const MSPicture *remote);
#endif // ifdef TEST_EXT_RENDERER
110
	static void realTimeTextCharacterReceived (void *userData, MSFilter *f, unsigned int id, void *arg);
Ghislain MARY's avatar
Ghislain MARY committed
111
	static int sendDtmf (void *data, unsigned int revents);
112 113
	static float aggregateQualityRatings (float audioRating, float videoRating);

114
	std::shared_ptr<Participant> getMe () const;
115
	void setState (LinphoneCallState newState, const std::string &message) override;
116 117 118

	void computeStreamsIndexes (const SalMediaDescription *md);
	void fixCallParams (SalMediaDescription *rmd);
119
	void initializeParamsAccordingToIncomingCallParams () override;
120 121 122 123 124 125 126
	void setCompatibleIncomingCallParams (SalMediaDescription *md);
	void updateBiggestDesc (SalMediaDescription *md);
	void updateRemoteSessionIdAndVer ();

	void initStats (LinphoneCallStats *stats, LinphoneStreamType type);
	void notifyStatsUpdated (int streamIndex) const;

127 128 129
	OrtpEvQueue *getEventQueue (int streamIndex) const;
	MediaStream *getMediaStream (int streamIndex) const;
	MSWebCam *getVideoDevice () const;
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

	void fillMulticastMediaAddresses ();
	int selectFixedPort (int streamIndex, std::pair<int, int> portRange);
	int selectRandomPort (int streamIndex, std::pair<int, int> portRange);
	void setPortConfig (int streamIndex, std::pair<int, int> portRange);
	void setPortConfigFromRtpSession (int streamIndex, RtpSession *session);
	void setRandomPortConfig (int streamIndex);

	void discoverMtu (const Address &remoteAddr);
	std::string getBindIpForStream (int streamIndex);
	void getLocalIp (const Address &remoteAddr);
	std::string getPublicIpForStream (int streamIndex);
	void runStunTestsIfNeeded ();
	void selectIncomingIpVersion ();
	void selectOutgoingIpVersion ();

	void forceStreamsDirAccordingToState (SalMediaDescription *md);
	bool generateB64CryptoKey (size_t keyLength, char *keyOut, size_t keyOutSize);
	void makeLocalMediaDescription ();
	int setupEncryptionKey (SalSrtpCryptoAlgo *crypto, MSCryptoSuite suite, unsigned int tag);
	void setupDtlsKeys (SalMediaDescription *md);
	void setupEncryptionKeys (SalMediaDescription *md);
	void setupRtcpFb (SalMediaDescription *md);
	void setupRtcpXr (SalMediaDescription *md);
	void setupZrtpHash (SalMediaDescription *md);
	void transferAlreadyAssignedPayloadTypes (SalMediaDescription *oldMd, SalMediaDescription *md);
	void updateLocalMediaDescriptionFromIce ();

	SalMulticastRole getMulticastRole (SalStreamType type);
	void joinMulticastGroup (int streamIndex, MediaStream *ms);

	int findCryptoIndexFromTag (const SalSrtpCryptoAlgo crypto[], unsigned char tag);
	void setDtlsFingerprint (MSMediaStreamSessions *sessions, const SalStreamDescription *sd, const SalStreamDescription *remote);
	void setDtlsFingerprintOnAllStreams ();
	void setupDtlsParams (MediaStream *ms);
	void setZrtpCryptoTypesParameters (MSZrtpParams *params);
	void startDtls (MSMediaStreamSessions *sessions, const SalStreamDescription *sd, const SalStreamDescription *remote);
	void startDtlsOnAllStreams ();
	void updateCryptoParameters (SalMediaDescription *oldMd, SalMediaDescription *newMd);
	bool updateStreamCryptoParameters (const SalStreamDescription *localStreamDesc, SalStreamDescription *oldStream, SalStreamDescription *newStream, MediaStream *ms);

	int getIdealAudioBandwidth (const SalMediaDescription *md, const SalStreamDescription *desc);
	int getVideoBandwidth (const SalMediaDescription *md, const SalStreamDescription *desc);
173
	RtpProfile *makeProfile (const SalMediaDescription *md, const SalStreamDescription *desc, int *usedPt);
174 175 176 177 178 179 180 181 182
	void unsetRtpProfile (int streamIndex);
	void updateAllocatedAudioBandwidth (const PayloadType *pt, int maxbw);

	void applyJitterBufferParams (RtpSession *session, LinphoneStreamType type);
	void clearEarlyMediaDestination (MediaStream *ms);
	void clearEarlyMediaDestinations ();
	void configureAdaptiveRateControl (MediaStream *ms, const OrtpPayloadType *pt, bool videoWillBeUsed);
	void configureRtpSessionForRtcpFb (const SalStreamDescription *stream);
	void configureRtpSessionForRtcpXr (SalStreamType type);
183 184
	RtpSession *createAudioRtpIoSession ();
	RtpSession *createVideoRtpIoSession ();
185 186 187 188 189 190 191 192 193 194 195 196 197
	void freeResources ();
	void handleIceEvents (OrtpEvent *ev);
	void handleStreamEvents (int streamIndex);
	void initializeAudioStream ();
	void initializeStreams ();
	void initializeTextStream ();
	void initializeVideoStream ();
	void parameterizeEqualizer (AudioStream *stream);
	void prepareEarlyMediaForking ();
	void postConfigureAudioStream (AudioStream *stream, bool muted);
	void postConfigureAudioStreams (bool muted);
	void setPlaybackGainDb (AudioStream *stream, float gain);
	void setSymmetricRtp (bool value);
198
	void setupRingbackPlayer ();
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217
	void startAudioStream (LinphoneCallState targetState, bool videoWillBeUsed);
	void startStreams (LinphoneCallState targetState);
	void startTextStream ();
	void startVideoStream (LinphoneCallState targetState);
	void stopAudioStream ();
	void stopStreams ();
	void stopTextStream ();
	void stopVideoStream ();
	void tryEarlyMediaForking (SalMediaDescription *md);
	void updateFrozenPayloads (SalMediaDescription *result);
	void updateStreams (SalMediaDescription *newMd, LinphoneCallState targetState);
	void updateStreamsDestinations (SalMediaDescription *oldMd, SalMediaDescription *newMd);

	bool allStreamsAvpfEnabled () const;
	bool allStreamsEncrypted () const;
	bool atLeastOneStreamStarted () const;
	void audioStreamAuthTokenReady (const std::string &authToken, bool verified);
	void audioStreamEncryptionChanged (bool encrypted);
	uint16_t getAvpfRrInterval () const;
Benjamin REIS's avatar
Benjamin REIS committed
218
	unsigned int getNbActiveStreams () const;
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
	bool isEncryptionMandatory () const;
	int mediaParametersChanged (SalMediaDescription *oldMd, SalMediaDescription *newMd);
	void propagateEncryptionChanged ();

	void fillLogStats (MediaStream *st);
	void updateLocalStats (LinphoneCallStats *stats, MediaStream *stream) const;
	void updateRtpStats (LinphoneCallStats *stats, int streamIndex);

	bool mediaReportEnabled (int statsType);
	bool qualityReportingEnabled () const;
	void updateReportingCallState ();
	void updateReportingMediaInfo (int statsType);

	void executeBackgroundTasks (bool oneSecondElapsed);
	void reportBandwidth ();
	void reportBandwidthForStream (MediaStream *ms, LinphoneStreamType type);

236 237 238
	void abort (const std::string &errorMsg) override;
	void handleIncomingReceivedStateInIncomingNotification () override;
	bool isReadyForInvite () const override;
239
	LinphoneStatus pause ();
240
	int restartInvite () override;
241 242
	void setTerminated () override;
	LinphoneStatus startAcceptUpdate (LinphoneCallState nextState, const std::string &stateInfo) override;
243
	LinphoneStatus startUpdate (const std::string &subject = "") override;
244
	void terminate () override;
245
	void updateCurrentParams () const override;
246

247
	void accept (const MediaSessionParams *params, bool wasRinging);
248
	LinphoneStatus acceptUpdate (const CallSessionParams *csp, LinphoneCallState nextState, const std::string &stateInfo) override;
249

250 251 252
	void refreshSockets ();
	void reinviteToRecoverFromConnectionLoss () override;

Ghislain MARY's avatar
Ghislain MARY committed
253 254 255
#ifdef VIDEO_ENABLED
	void videoStreamEventCb (const MSFilter *f, const unsigned int eventId, const void *args);
#endif // ifdef VIDEO_ENABLED
256
	void realTimeTextCharacterReceived (MSFilter *f, unsigned int id, void *arg);
Ghislain MARY's avatar
Ghislain MARY committed
257
	int sendDtmf ();
258 259 260 261 262 263 264

	void stunAuthRequestedCb (const char *realm, const char *nonce, const char **username, const char **password, const char **ha1);

private:
	static const std::string ecStateStore;
	static const int ecStateMaxLen;

265 266
	std::weak_ptr<Participant> me;

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288
	AudioStream *audioStream = nullptr;
	OrtpEvQueue *audioStreamEvQueue = nullptr;
	LinphoneCallStats *audioStats = nullptr;
	RtpProfile *audioProfile = nullptr;
	RtpProfile *rtpIoAudioProfile = nullptr;
	int mainAudioStreamIndex = LINPHONE_CALL_STATS_AUDIO;

	VideoStream *videoStream = nullptr;
	OrtpEvQueue *videoStreamEvQueue = nullptr;
	LinphoneCallStats *videoStats = nullptr;
	RtpProfile *rtpIoVideoProfile = nullptr;
	RtpProfile *videoProfile = nullptr;
	int mainVideoStreamIndex = LINPHONE_CALL_STATS_VIDEO;
	void *videoWindowId = nullptr;
	bool cameraEnabled = true;

	TextStream *textStream = nullptr;
	OrtpEvQueue *textStreamEvQueue = nullptr;
	LinphoneCallStats *textStats = nullptr;
	RtpProfile *textProfile = nullptr;
	int mainTextStreamIndex = LINPHONE_CALL_STATS_TEXT;

289
	LinphoneNatPolicy *natPolicy = nullptr;
290 291 292
	StunClient *stunClient = nullptr;
	IceAgent *iceAgent = nullptr;

293 294 295
	// The address family to prefer for RTP path, guessed from signaling path.
	int af;

Ghislain MARY's avatar
Ghislain MARY committed
296 297 298
	std::string dtmfSequence;
	belle_sip_source_t *dtmfTimer = nullptr;

299 300 301
	std::string mediaLocalIp;
	PortConfig mediaPorts[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];
	bool needMediaLocalIpRefresh = false;
302 303 304 305

	// The rtp, srtp, zrtp contexts for each stream.
	MSMediaStreamSessions sessions[SAL_MEDIA_DESCRIPTION_MAX_STREAMS];

306 307 308 309 310 311 312 313 314 315 316 317
	SalMediaDescription *localDesc = nullptr;
	int localDescChanged = 0;
	SalMediaDescription *biggestDesc = nullptr;
	SalMediaDescription *resultDesc = nullptr;
	bool expectMediaInAck = false;
	unsigned int remoteSessionId = 0;
	unsigned int remoteSessionVer = 0;

	std::string authToken;
	bool authTokenVerified = false;
	std::string dtlsCertificateFingerprint;

318
	unsigned int mediaStartCount = 0;
319 320 321 322 323 324

	// Upload bandwidth setting at the time the call is started. Used to detect if it changes during a call.
	int upBandwidth = 0;

	// Upload bandwidth used by audio.
	int audioBandwidth = 0;
325 326 327

	bool allMuted = false;
	bool audioMuted = false;
328
	bool automaticallyPaused = false;
329 330 331 332 333 334 335 336 337 338 339
	bool pausedByApp = false;
	bool recordActive = false;

	std::string onHoldFile;

	L_DECLARE_PUBLIC(MediaSession);
};

LINPHONE_END_NAMESPACE

#endif // ifndef _MEDIA_SESSION_P_H_