Skip to content

Commit

Permalink
ref(TPCUtils) Alpha sort the methods.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jallamsetty1
jallamsetty1 committed Nov 13, 2023
1 parent 5a68ae9 commit 4588cc7
Showing 1 changed file with 117 additions and 130 deletions.
247 changes: 117 additions & 130 deletions modules/RTC/TPCUtils.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -283,130 +283,6 @@ export class TPCUtils {
return sender.setParameters(parameters);
}

/**
* Ensures that the ssrcs associated with a FID ssrc-group appear in the correct order, i.e.,
* the primary ssrc first and the secondary rtx ssrc later. This is important for unified
* plan since we have only one FID group per media description.
* @param {Object} description the webRTC session description instance for the remote
* description.
* @private
*/
ensureCorrectOrderOfSsrcs(description) {
const parsedSdp = transform.parse(description.sdp);

parsedSdp.media.forEach(mLine => {
if (mLine.type === MediaType.AUDIO) {
return;
}
if (!mLine.ssrcGroups || !mLine.ssrcGroups.length) {
return;
}
let reorderedSsrcs = [];

const ssrcs = new Set();

mLine.ssrcGroups.map(group =>
group.ssrcs
.split(' ')
.filter(Boolean)
.forEach(ssrc => ssrcs.add(ssrc))
);

ssrcs.forEach(ssrc => {
const sources = mLine.ssrcs.filter(source => source.id.toString() === ssrc);

reorderedSsrcs = reorderedSsrcs.concat(sources);
});
mLine.ssrcs = reorderedSsrcs;
});

return new RTCSessionDescription({
type: description.type,
sdp: transform.write(parsedSdp)
});
}

/**
* Returns the transceiver associated with a given RTCRtpSender/RTCRtpReceiver.
*
* @param {string} mediaType - type of track associated with the transceiver 'audio' or 'video'.
* @param {JitsiLocalTrack} localTrack - local track to be used for lookup.
* @returns {RTCRtpTransceiver}
*/
findTransceiver(mediaType, localTrack = null) {
const transceiver = localTrack?.track && localTrack.getOriginalStream()
? this.pc.peerconnection.getTransceivers().find(t => t.sender?.track?.id === localTrack.getTrackId())
: this.pc.peerconnection.getTransceivers().find(t => t.receiver?.track?.kind === mediaType);

return transceiver;
}

/**
* Takes in a *unified plan* offer and inserts the appropriate parameters for adding simulcast receive support.
* @param {Object} desc - A session description object
* @param {String} desc.type - the type (offer/answer)
* @param {String} desc.sdp - the sdp content
*
* @return {Object} A session description (same format as above) object with its sdp field modified to advertise
* simulcast receive support.
*/
insertUnifiedPlanSimulcastReceive(desc) {
// a=simulcast line is not needed on browsers where we SDP munging is used for enabling on simulcast.
// Remove this check when the client switches to RID/MID based simulcast on all browsers.
if (browser.usesSdpMungingForSimulcast()) {
return desc;
}
const rids = [
{
id: SIM_LAYER_1_RID,
direction: 'recv'
},
{
id: SIM_LAYER_2_RID,
direction: 'recv'
},
{
id: SIM_LAYER_3_RID,
direction: 'recv'
}
];

// Firefox 72 has stopped parsing the legacy rid= parameters in simulcast attributes.
// eslint-disable-next-line max-len
// https://www.fxsitecompat.dev/en-CA/docs/2019/pt-and-rid-in-webrtc-simulcast-attributes-are-no-longer-supported/
const simulcastLine = browser.isFirefox() && browser.isVersionGreaterThan(71)
? `recv ${SIM_LAYER_RIDS.join(';')}`
: `recv rid=${SIM_LAYER_RIDS.join(';')}`;
const sdp = transform.parse(desc.sdp);
const mLines = sdp.media.filter(m => m.type === MediaType.VIDEO);
const senderMids = Array.from(this.pc._localTrackTransceiverMids.values());

mLines.forEach((mLine, idx) => {
// Make sure the simulcast recv line is only set on video descriptions that are associated with senders.
if (senderMids.find(sender => mLine.mid.toString() === sender.toString()) || idx === 0) {
if (!mLine.simulcast_03 || !mLine.simulcast) {
mLine.rids = rids;

// eslint-disable-next-line camelcase
mLine.simulcast_03 = {
value: simulcastLine
};
}
} else {
mLine.rids = undefined;
mLine.simulcast = undefined;

// eslint-disable-next-line camelcase
mLine.simulcast_03 = undefined;
}
});

return new RTCSessionDescription({
type: desc.type,
sdp: transform.write(sdp)
});
}

/**
* Adds {@link JitsiLocalTrack} to the WebRTC peerconnection for the first time.
* @param {JitsiLocalTrack} track - track to be added to the peerconnection.
Expand Down Expand Up @@ -588,6 +464,49 @@ export class TPCUtils {
return scaleResolutionDownBy;
}

/**
* Ensures that the ssrcs associated with a FID ssrc-group appear in the correct order, i.e.,
* the primary ssrc first and the secondary rtx ssrc later. This is important for unified
* plan since we have only one FID group per media description.
* @param {Object} description the webRTC session description instance for the remote
* description.
* @private
*/
ensureCorrectOrderOfSsrcs(description) {
const parsedSdp = transform.parse(description.sdp);

parsedSdp.media.forEach(mLine => {
if (mLine.type === MediaType.AUDIO) {
return;
}
if (!mLine.ssrcGroups || !mLine.ssrcGroups.length) {
return;
}
let reorderedSsrcs = [];

const ssrcs = new Set();

mLine.ssrcGroups.map(group =>
group.ssrcs
.split(' ')
.filter(Boolean)
.forEach(ssrc => ssrcs.add(ssrc))
);

ssrcs.forEach(ssrc => {
const sources = mLine.ssrcs.filter(source => source.id.toString() === ssrc);

reorderedSsrcs = reorderedSsrcs.concat(sources);
});
mLine.ssrcs = reorderedSsrcs;
});

return new RTCSessionDescription({
type: description.type,
sdp: transform.write(parsedSdp)
});
}

/**
* Returns the max resolution that the client is configured to encode for a given local video track. The actual
* send resolution might be downscaled based on cpu and bandwidth constraints.
Expand Down Expand Up @@ -650,6 +569,72 @@ export class TPCUtils {
return maxHeight;
}

/**
* Takes in a *unified plan* offer and inserts the appropriate parameters for adding simulcast receive support.
* @param {Object} desc - A session description object
* @param {String} desc.type - the type (offer/answer)
* @param {String} desc.sdp - the sdp content
*
* @return {Object} A session description (same format as above) object with its sdp field modified to advertise
* simulcast receive support.
*/
insertUnifiedPlanSimulcastReceive(desc) {
// a=simulcast line is not needed on browsers where we SDP munging is used for enabling on simulcast.
// Remove this check when the client switches to RID/MID based simulcast on all browsers.
if (browser.usesSdpMungingForSimulcast()) {
return desc;
}
const rids = [
{
id: SIM_LAYER_1_RID,
direction: 'recv'
},
{
id: SIM_LAYER_2_RID,
direction: 'recv'
},
{
id: SIM_LAYER_3_RID,
direction: 'recv'
}
];

// Firefox 72 has stopped parsing the legacy rid= parameters in simulcast attributes.
// eslint-disable-next-line max-len
// https://www.fxsitecompat.dev/en-CA/docs/2019/pt-and-rid-in-webrtc-simulcast-attributes-are-no-longer-supported/
const simulcastLine = browser.isFirefox() && browser.isVersionGreaterThan(71)
? `recv ${SIM_LAYER_RIDS.join(';')}`
: `recv rid=${SIM_LAYER_RIDS.join(';')}`;
const sdp = transform.parse(desc.sdp);
const mLines = sdp.media.filter(m => m.type === MediaType.VIDEO);
const senderMids = Array.from(this.pc._localTrackTransceiverMids.values());

mLines.forEach((mLine, idx) => {
// Make sure the simulcast recv line is only set on video descriptions that are associated with senders.
if (senderMids.find(sender => mLine.mid.toString() === sender.toString()) || idx === 0) {
if (!mLine.simulcast_03 || !mLine.simulcast) {
mLine.rids = rids;

// eslint-disable-next-line camelcase
mLine.simulcast_03 = {
value: simulcastLine
};
}
} else {
mLine.rids = undefined;
mLine.simulcast = undefined;

// eslint-disable-next-line camelcase
mLine.simulcast_03 = undefined;
}
});

return new RTCSessionDescription({
type: desc.type,
sdp: transform.write(sdp)
});
}

/**
* Returns a boolean indicating whether the video encoder is running in Simulcast mode, i.e., three encodings need
* to be configured in 4:2:1 resolution order with temporal scalability.
Expand Down Expand Up @@ -739,13 +724,15 @@ export class TPCUtils {

/**
* Set the simulcast stream encoding properties on the RTCRtpSender.
* @param {JitsiLocalTrack} track - the current track in use for which
* the encodings are to be set.
*
* @param {JitsiLocalTrack} localTrack - the current track in use for which the encodings are to be set.
* @returns {Promise<void>} - resolved when done.
*/
setEncodings(track) {
const mediaType = track.getType();
const transceiver = this.findTransceiver(mediaType, track);
setEncodings(localTrack) {
const mediaType = localTrack.getType();
const transceiver = localTrack?.track && localTrack.getOriginalStream()
? this.pc.peerconnection.getTransceivers().find(t => t.sender?.track?.id === localTrack.getTrackId())
: this.pc.peerconnection.getTransceivers().find(t => t.receiver?.track?.kind === mediaType);
const parameters = transceiver?.sender?.getParameters();

// Resolve if the encodings are not available yet. This happens immediately after the track is added to the
Expand All @@ -754,7 +741,7 @@ export class TPCUtils {
if (!parameters?.encodings?.length) {
return Promise.resolve();
}
parameters.encodings = this._getStreamEncodings(track);
parameters.encodings = this._getStreamEncodings(localTrack);

if (mediaType === MediaType.VIDEO) {
return this.pc._updateVideoSenderParameters(() => transceiver.sender.setParameters(parameters));
Expand Down

0 comments on commit 4588cc7

Please sign in to comment.