/**
* Creates a <tt>MediaFormat</tt> for the specified <tt>encoding</tt>, <tt>clockRate</tt>,
* <tt>channels</tt> and set of format parameters. If <tt>encoding</tt> is known to this
* <tt>MediaFormatFactory</tt>, returns a <tt>MediaFormat</tt> which is either an
* <tt>AudioMediaFormat</tt> or a <tt>VideoMediaFormat</tt> instance. Otherwise, returns
* <tt>null</tt>.
*
* @param encoding the well-known encoding (name) to create a <tt>MediaFormat</tt> for
* @param clockRate the clock rate in Hz to create a <tt>MediaFormat</tt> for
* @param frameRate the frame rate in number of frames per second to create a <tt>MediaFormat</tt>
* for
* @param channels the number of available channels (1 for mono, 2 for stereo) if it makes sense
* for the <tt>MediaFormat</tt> with the specified <tt>encoding</tt>; otherwise, ignored
* @param formatParams any codec specific parameters which have been received via SIP/SDP or
* XMPP/Jingle
* @param advancedParams any parameters which have been received via SIP/SDP or XMPP/Jingle
* @return a <tt>MediaFormat</tt> with the specified <tt>encoding</tt>, <tt>clockRate</tt>,
* <tt>channels</tt> and set of format parameters which is either an <tt>AudioMediaFormat</tt>
* or a <tt>VideoMediaFormat</tt> instance if <tt>encoding</tt> is known to this
* <tt>MediaFormatFactory</tt>; otherwise, <tt>null</tt>
* @see MediaFormatFactory#createMediaFormat(String, double, int, float, Map, Map)
*/
public MediaFormat createMediaFormat(
String encoding,
double clockRate,
int channels,
float frameRate,
Map<String, String> formatParams,
Map<String, String> advancedParams) {
MediaFormat mediaFormat = createMediaFormat(encoding, clockRate, channels, formatParams);
if (mediaFormat == null) return null;
/*
* MediaFormatImpl is immutable so if the caller wants to change the
* format parameters and/or the advanced attributes, we'll have to
* create a new MediaFormatImpl.
*/
Map<String, String> formatParameters = null;
Map<String, String> advancedParameters = null;
if ((formatParams != null) && !formatParams.isEmpty()) formatParameters = formatParams;
if ((advancedParams != null) && !advancedParams.isEmpty()) advancedParameters = advancedParams;
if ((formatParameters != null) || (advancedParameters != null)) {
switch (mediaFormat.getMediaType()) {
case AUDIO:
mediaFormat =
new AudioMediaFormatImpl(
((AudioMediaFormatImpl) mediaFormat).getFormat(),
formatParameters,
advancedParameters);
break;
case VIDEO:
VideoMediaFormatImpl videoMediaFormatImpl = (VideoMediaFormatImpl) mediaFormat;
/*
* If the format of VideoMediaFormatImpl is
* a ParameterizedVideoFormat, it's possible for the format
* parameters of that ParameterizedVideoFormat and of the new
* VideoMediaFormatImpl (to be created) to be out of sync. While
* it's not technically perfect, it should be practically safe
* for the format parameters which distinguish VideoFormats with
* the same encoding and clock rate because mediaFormat has
* already been created in sync with formatParams (with respect
* to the format parameters which distinguish VideoFormats with
* the same encoding and clock rate).
*/
mediaFormat =
new VideoMediaFormatImpl(
videoMediaFormatImpl.getFormat(),
videoMediaFormatImpl.getClockRate(),
frameRate,
formatParameters,
advancedParameters);
break;
default:
mediaFormat = null;
}
}
return mediaFormat;
}
/** {@inheritDoc} */
public synchronized Result createConference(String creator, String mucRoomName) {
Conference conference = conferenceMap.get(mucRoomName);
if (conference == null) {
// Create new conference
try {
ApiResult result = api.createNewConference(creator, mucRoomName);
if (result.getError() == null) {
conference = result.getConference();
conferenceMap.put(mucRoomName, conference);
} else if (result.getStatusCode() == 409 && result.getError().getConflictId() != null) {
Number conflictId = result.getError().getConflictId();
// Conference already exists(check if we have it locally)
conference = findConferenceForId(conflictId);
logger.info("Conference '" + mucRoomName + "' already " + "allocated, id: " + conflictId);
// do GET conflict conference
if (conference == null) {
ApiResult getResult = api.getConference(conflictId);
if (getResult.getConference() != null) {
conference = getResult.getConference();
// Fill full room name as it is not transferred
// over REST API
conference.setMucRoomName(mucRoomName);
conferenceMap.put(mucRoomName, conference);
} else {
logger.error("API error: " + result);
return new Result(RESULT_INTERNAL_ERROR, result.getError().getMessage());
}
}
} else {
// Other error
logger.error("API error: " + result);
return new Result(RESULT_INTERNAL_ERROR, result.getError().getMessage());
}
} catch (FaultTolerantRESTRequest.RetryExhaustedException e) {
logger.error(e, e);
return new Result(RESULT_INTERNAL_ERROR, e.getMessage());
} catch (UnsupportedEncodingException e) {
logger.error(e, e);
return new Result(RESULT_INTERNAL_ERROR, e.getMessage());
}
}
// Verify owner == creator
if (creator.equals(conference.getOwner())) {
return new Result(RESULT_OK);
} else {
logger.error(
"Room " + mucRoomName + ", conflict : " + creator + " != " + conference.getOwner());
return new Result(RESULT_CONFLICT);
}
}
/** {@inheritDoc} */
public long getLocalTime(long ssrc, long rtp0) {
// don't use getSSRCDesc, because we don't want to create an instance
SSRCDesc ssrcDesc = ssrcs.get(ssrc);
if (ssrcDesc == null) {
return -1;
}
// get all required times
long clockRate; // the clock rate for the RTP clock for the given SSRC
long rtp1; // some time X in the RTP clock for the given SSRC
double ntp1; // the same time X in the source's wallclock
String endpointId;
synchronized (ssrcDesc) {
clockRate = ssrcDesc.clockRate;
rtp1 = ssrcDesc.rtpTime;
ntp1 = ssrcDesc.ntpTime;
endpointId = ssrcDesc.endpointId;
}
// if something is missing, we can't calculate the time
if (clockRate == -1 || rtp1 == -1 || ntp1 == -1.0 || endpointId == null) {
return -1;
}
Endpoint endpoint = endpoints.get(ssrcDesc.endpointId);
if (endpoint == null) {
return -1;
}
double ntp2; // some time Y in the source's wallclock (same clock as for ntp1)
long local2; // the same time Y in the local clock
synchronized (endpoint) {
ntp2 = endpoint.ntpTime;
local2 = endpoint.localTime;
}
if (ntp2 == -1.0 || local2 == -1) {
return -1;
}
// crunch the numbers. we're looking for 'local0',
// the local time corresponding to 'rtp0'
long local0;
double diff1S = ntp1 - ntp2;
double diff2S = ((double) TimeUtils.rtpDiff(rtp0, rtp1)) / clockRate;
long diffMs = Math.round((diff1S + diff2S) * 1000);
local0 = local2 + diffMs;
return local0;
}
/**
* Returns the sequence number to use for a specific RTX packet, which is based on the packet's
* original sequence number.
*
* <p>Because we terminate the RTX format, and with simulcast we might translate RTX packets from
* multiple SSRCs into the same SSRC, we keep count of the RTX packets (and their sequence
* numbers) which we sent for each SSRC.
*
* @param ssrc the SSRC of the RTX stream for the packet.
* @return the sequence number which should be used for the next RTX packet sent using SSRC
* <tt>ssrc</tt>.
*/
private int getNextRtxSequenceNumber(long ssrc) {
Integer seq;
synchronized (rtxSequenceNumbers) {
seq = rtxSequenceNumbers.get(ssrc);
if (seq == null) seq = new Random().nextInt(0xffff);
else seq++;
rtxSequenceNumbers.put(ssrc, seq);
}
return seq;
}
/**
* Returns the sequence number to use for a specific RTX packet, which is based on the packet's
* original sequence number.
*
* <p>Because we terminate the RTX format, and with simulcast we might translate RTX packets from
* multiple SSRCs into the same SSRC, we keep count of the RTX packets (and their sequence
* numbers) which we sent for each SSRC.
*
* @param ssrc the SSRC of the RTX stream for the packet.
* @param defaultSeq the default sequence number to use in case we don't (yet) have any
* information about <tt>ssrc</tt>.
* @return the sequence number which should be used for the next RTX packet sent using SSRC
* <tt>ssrc</tt>.
*/
private int getNextRtxSequenceNumber(long ssrc, int defaultSeq) {
Integer seq;
synchronized (rtxSequenceNumbers) {
seq = rtxSequenceNumbers.get(ssrc);
if (seq == null) seq = defaultSeq;
else seq++;
rtxSequenceNumbers.put(ssrc, seq);
}
return seq;
}
/**
* Returns the <tt>SSRCDesc</tt> instance mapped to the SSRC <tt>ssrc</tt>. If no instance is
* mapped to <tt>ssrc</tt>, create one and inserts it in the map. Always returns non-null.
*
* @param ssrc the ssrc to get the <tt>SSRCDesc</tt> for.
* @return the <tt>SSRCDesc</tt> instance mapped to the SSRC <tt>ssrc</tt>.
*/
private SSRCDesc getSSRCDesc(long ssrc) {
SSRCDesc ssrcDesc = ssrcs.get(ssrc);
if (ssrcDesc == null) {
synchronized (ssrcs) {
ssrcDesc = ssrcs.get(ssrc);
if (ssrcDesc == null) {
ssrcDesc = new SSRCDesc();
ssrcs.put(ssrc, ssrcDesc);
}
}
}
return ssrcDesc;
}
/**
* Removes the RTP-NTP mapping for a given SSRC.
*
* @param ssrc the SSRC for which to remove the RTP-NTP mapping
*/
void removeMapping(long ssrc) {
if (ssrcs.containsKey(ssrc)) {
synchronized (ssrcs) {
SSRCDesc ssrcDesc = ssrcs.get(ssrc);
if (ssrcDesc != null) {
synchronized (ssrcDesc) {
ssrcDesc.ntpTime = -1.0;
ssrcDesc.rtpTime = -1;
}
}
}
}
}
/**
* Returns the <tt>Endpoint</tt> with id <tt>endpointId</tt>. Creates an <tt>Endpoint</tt> if
* necessary. Always returns non-null.
*
* @param endpointId the string identifying the endpoint.
* @return the <tt>Endpoint</tt> with id <tt>endpointId</tt>. Creates an <tt>Endpoint</tt> if
* necessary.
*/
private Endpoint getEndpoint(String endpointId) {
Endpoint endpoint = endpoints.get(endpointId);
if (endpoint == null) {
synchronized (endpoints) {
endpoint = endpoints.get(endpointId);
if (endpoint == null) {
endpoint = new Endpoint();
endpoints.put(endpointId, endpoint);
}
}
}
return endpoint;
}
/**
* Allocates new focus for given MUC room.
*
* @param room the name of MUC room for which new conference has to be allocated.
* @param properties configuration properties map included in the request.
* @return <tt>true</tt> if conference focus is in the room and ready to handle session
* participants.
* @throws Exception if for any reason we have failed to create the conference
*/
public synchronized boolean conferenceRequest(String room, Map<String, String> properties)
throws Exception {
if (StringUtils.isNullOrEmpty(room)) return false;
if (shutdownInProgress && !conferences.containsKey(room)) return false;
if (!conferences.containsKey(room)) {
createConference(room, properties);
}
JitsiMeetConference conference = conferences.get(room);
return conference.isInTheRoom();
}
/**
* Returns default <tt>WebRtcDataStream</tt> if it's ready or <tt>null</tt> otherwise.
*
* @return <tt>WebRtcDataStream</tt> if it's ready or <tt>null</tt> otherwise.
* @throws IOException
*/
public WebRtcDataStream getDefaultDataStream() throws IOException {
WebRtcDataStream def;
synchronized (this) {
if (sctpSocket == null) {
def = null;
} else {
// Channel that runs on sid 0
def = channels.get(0);
if (def == null) {
def = openChannel(0, 0, 0, 0, "default");
}
// Pawel Domas: Must be acknowledged before use
/*
* XXX Lyubomir Marinov: We're always sending ordered. According
* to "WebRTC Data Channel Establishment Protocol", we can start
* sending messages containing user data after the
* DATA_CHANNEL_OPEN message has been sent without waiting for
* the reception of the corresponding DATA_CHANNEL_ACK message.
*/
// if (!def.isAcknowledged())
// def = null;
}
}
return def;
}
/**
* Makes sure that conference is allocated for given <tt>room</tt>.
*
* @param room name of the MUC room of Jitsi Meet conference.
* @param properties configuration properties, see {@link JitsiMeetConfig} for the list of valid
* properties.
* @throws Exception if any error occurs.
*/
private void createConference(String room, Map<String, String> properties) throws Exception {
JitsiMeetConfig config = new JitsiMeetConfig(properties);
JitsiMeetConference conference =
new JitsiMeetConference(room, focusUserName, protocolProviderHandler, this, config);
conferences.put(room, conference);
StringBuilder options = new StringBuilder();
for (Map.Entry<String, String> option : properties.entrySet()) {
options.append("\n ").append(option.getKey()).append(": ").append(option.getValue());
}
logger.info(
"Created new focus for "
+ room
+ "@"
+ focusUserDomain
+ " conferences count: "
+ conferences.size()
+ " options:"
+ options.toString());
// Send focus created event
EventAdmin eventAdmin = FocusBundleActivator.getEventAdmin();
if (eventAdmin != null) {
eventAdmin.sendEvent(EventFactory.focusCreated(conference.getId(), conference.getRoomName()));
}
try {
conference.start();
} catch (Exception e) {
logger.info("Exception while trying to start the conference", e);
// stop() method is called by the conference automatically in order
// to not release the lock on JitsiMeetConference instance and avoid
// a deadlock. It may happen when this thread is about to call
// conference.stop() and another thread has entered the method
// before us. That other thread will try to call
// FocusManager.conferenceEnded, but we're still holding the lock
// on FocusManager instance.
// conference.stop();
throw e;
}
}
/**
* Finds conference for given ID assigned by the reservation system.
*
* @param id identifier of the conference to find.
* @return <tt>Conference</tt> for given <tt>id</tt> or <tt>null</tt> if not found.
*/
private Conference findConferenceForId(Number id) {
for (Conference conference : conferenceMap.values()) {
if (conference.getId().equals(id)) {
return conference;
}
}
return null;
}
/** Deletes conference for given <tt>mucRoomName</tt> through the API. */
Result deleteConference(String mucRoomName) {
Conference conference = conferenceMap.get(mucRoomName);
if (conference != null) {
// Delete conference
Number id = conference.getId();
int result = deleteConference(id);
if (result == RESULT_OK) {
conferenceMap.remove(mucRoomName);
} else {
// Other error
return new Result(result);
}
}
return new Result(RESULT_OK);
}
/**
* Returns {@link JitsiMeetConference} for given MUC {@code roomName} or {@code null} if no
* conference has been allocated yet.
*
* @param roomName the name of MUC room for which we want get the {@code JitsiMeetConference}
* instance.
* @return the {@code JitsiMeetConference} for the specified {@code roomName} or {@code null} if
* no conference has been allocated yet
*/
public JitsiMeetConference getConference(String roomName) {
roomName = roomName.toLowerCase();
// Other public methods which read from and/or write to the field
// conferences are sychronized (e.g. conferenceEnded, conferenceRequest)
// so synchronization is necessary here as well.
synchronized (this) {
return conferences.get(roomName);
}
}
private void maybeDoShutdown() {
if (shutdownInProgress && conferences.size() == 0) {
logger.info("Focus is shutting down NOW");
ShutdownService shutdownService =
ServiceUtils.getService(FocusBundleActivator.bundleContext, ShutdownService.class);
shutdownService.beginShutdown();
}
}
/** {@inheritDoc} */
@Override
public synchronized void conferenceEnded(JitsiMeetConference conference) {
String roomName = conference.getRoomName();
conferences.remove(roomName);
logger.info(
"Disposed conference for room: " + roomName + " conference count: " + conferences.size());
if (focusAllocListener != null) {
focusAllocListener.onFocusDestroyed(roomName);
}
// Send focus destroyed event
FocusBundleActivator.getEventAdmin()
.sendEvent(EventFactory.focusDestroyed(conference.getId(), conference.getRoomName()));
maybeDoShutdown();
}
/**
* Makes sure that conference is allocated for given <tt>room</tt>.
*
* @param room name of the MUC room of Jitsi Meet conference.
* @param properties configuration properties, see {@link JitsiMeetConfig} for the list of valid
* properties.
* @throws Exception if any error occurs.
*/
private void createConference(String room, Map<String, String> properties) throws Exception {
JitsiMeetConfig config = new JitsiMeetConfig(properties);
JitsiMeetConference conference =
new JitsiMeetConference(room, focusUserName, protocolProviderHandler, this, config);
conferences.put(room, conference);
StringBuilder options = new StringBuilder();
for (Map.Entry<String, String> option : properties.entrySet()) {
options.append("\n ").append(option.getKey()).append(": ").append(option.getValue());
}
logger.info(
"Created new focus for "
+ room
+ "@"
+ focusUserDomain
+ " conferences count: "
+ conferences.size()
+ " options:"
+ options.toString());
// Send focus created event
EventAdmin eventAdmin = FocusBundleActivator.getEventAdmin();
if (eventAdmin != null) {
eventAdmin.sendEvent(EventFactory.focusCreated(conference.getId(), conference.getRoomName()));
}
try {
conference.start();
} catch (Exception e) {
logger.info("Exception while trying to start the conference", e);
conference.stop();
throw e;
}
}
/**
* Notifies this instance that the dynamic payload types of the associated {@link MediaStream}
* have changed.
*/
public void onDynamicPayloadTypesChanged() {
rtxPayloadType = -1;
rtxAssociatedPayloadType = -1;
MediaStream mediaStream = channel.getStream();
Map<Byte, MediaFormat> mediaFormatMap = mediaStream.getDynamicRTPPayloadTypes();
Iterator<Map.Entry<Byte, MediaFormat>> it = mediaFormatMap.entrySet().iterator();
while (it.hasNext() && rtxPayloadType == -1) {
Map.Entry<Byte, MediaFormat> entry = it.next();
MediaFormat format = entry.getValue();
if (!Constants.RTX.equalsIgnoreCase(format.getEncoding())) {
continue;
}
// XXX(gp) we freak out if multiple codecs with RTX support are
// present.
rtxPayloadType = entry.getKey();
rtxAssociatedPayloadType = Byte.parseByte(format.getFormatParameters().get("apt"));
}
}
/**
* Implements in order to listen for ended conferences and remove them from the reservation
* system.
*
* <p>{@inheritDoc}
*/
@Override
public synchronized void onFocusDestroyed(String roomName) {
// roomName = MucUtil.extractName(roomName);
// Focus destroyed
Conference conference = conferenceMap.get(roomName);
if (conference == null) {
logger.info("Conference " + roomName + " already destroyed");
return;
}
Result result = deleteConference(roomName);
if (result.getCode() == RESULT_OK) {
logger.info("Deleted conference from the reservation system: " + roomName);
} else {
logger.error("Failed to delete room: " + roomName + ", error code: " + result);
}
}
/**
* {@inheritDoc}
*
* <p>SCTP input data callback.
*/
@Override
public void onSctpPacket(
byte[] data, int sid, int ssn, int tsn, long ppid, int context, int flags) {
if (ppid == WEB_RTC_PPID_CTRL) {
// Channel control PPID
try {
onCtrlPacket(data, sid);
} catch (IOException e) {
logger.error("IOException when processing ctrl packet", e);
}
} else if (ppid == WEB_RTC_PPID_STRING || ppid == WEB_RTC_PPID_BIN) {
WebRtcDataStream channel;
synchronized (this) {
channel = channels.get(sid);
}
if (channel == null) {
logger.error("No channel found for sid: " + sid);
return;
}
if (ppid == WEB_RTC_PPID_STRING) {
// WebRTC String
String str;
String charsetName = "UTF-8";
try {
str = new String(data, charsetName);
} catch (UnsupportedEncodingException uee) {
logger.error("Unsupported charset encoding/name " + charsetName, uee);
str = null;
}
channel.onStringMsg(str);
} else {
// WebRTC Binary
channel.onBinaryMsg(data);
}
} else {
logger.warn("Got message on unsupported PPID: " + ppid);
}
}
/**
* Estimate the <tt>RemoteClock</tt> of a given RTP stream (identified by its SSRC) at a given
* time.
*
* @param ssrc the SSRC of the RTP stream whose <tt>RemoteClock</tt> we want to estimate.
* @param time the local time that will be mapped to a remote time.
* @return An estimation of the <tt>RemoteClock</tt> at time "time".
*/
public RemoteClock estimate(int ssrc, long time) {
ReceivedRemoteClock receivedRemoteClock = receivedClocks.get(ssrc);
if (receivedRemoteClock == null || receivedRemoteClock.getFrequencyHz() == -1) {
// We can't continue if we don't have NTP and RTP timestamps
// and/or the original sender frequency, so move to the next
// one.
return null;
}
long delayMillis = time - receivedRemoteClock.getReceivedTime();
// Estimate the remote wall clock.
long remoteTime = receivedRemoteClock.getRemoteClock().getRemoteTime();
long estimatedRemoteTime = remoteTime + delayMillis;
// Drift the RTP timestamp.
int rtpTimestamp =
receivedRemoteClock.getRemoteClock().getRtpTimestamp()
+ ((int) delayMillis) * (receivedRemoteClock.getFrequencyHz() / 1000);
return new RemoteClock(estimatedRemoteTime, rtpTimestamp);
}
/**
* Inspect an <tt>RTCPCompoundPacket</tt> and build-up the state for future estimations.
*
* @param pkt
*/
public void apply(RTCPCompoundPacket pkt) {
if (pkt == null || pkt.packets == null || pkt.packets.length == 0) {
return;
}
for (RTCPPacket rtcpPacket : pkt.packets) {
switch (rtcpPacket.type) {
case RTCPPacket.SR:
RTCPSRPacket srPacket = (RTCPSRPacket) rtcpPacket;
// The media sender SSRC.
int ssrc = srPacket.ssrc;
// Convert 64-bit NTP timestamp to Java standard time.
// Note that java time (milliseconds) by definition has
// less precision then NTP time (picoseconds) so
// converting NTP timestamp to java time and back to NTP
// timestamp loses precision. For example, Tue, Dec 17
// 2002 09:07:24.810 EST is represented by a single
// Java-based time value of f22cd1fc8a, but its NTP
// equivalent are all values ranging from
// c1a9ae1c.cf5c28f5 to c1a9ae1c.cf9db22c.
// Use round-off on fractional part to preserve going to
// lower precision
long fraction = Math.round(1000D * srPacket.ntptimestamplsw / 0x100000000L);
/*
* If the most significant bit (MSB) on the seconds
* field is set we use a different time base. The
* following text is a quote from RFC-2030 (SNTP v4):
*
* If bit 0 is set, the UTC time is in the range
* 1968-2036 and UTC time is reckoned from 0h 0m 0s UTC
* on 1 January 1900. If bit 0 is not set, the time is
* in the range 2036-2104 and UTC time is reckoned from
* 6h 28m 16s UTC on 7 February 2036.
*/
long msb = srPacket.ntptimestampmsw & 0x80000000L;
long remoteTime =
(msb == 0)
// use base: 7-Feb-2036 @ 06:28:16 UTC
? msb0baseTime + (srPacket.ntptimestampmsw * 1000) + fraction
// use base: 1-Jan-1900 @ 01:00:00 UTC
: msb1baseTime + (srPacket.ntptimestampmsw * 1000) + fraction;
// Estimate the clock rate of the sender.
int frequencyHz = -1;
if (receivedClocks.containsKey(ssrc)) {
// Calculate the clock rate.
ReceivedRemoteClock oldStats = receivedClocks.get(ssrc);
RemoteClock oldRemoteClock = oldStats.getRemoteClock();
frequencyHz =
Math.round(
(float)
(((int) srPacket.rtptimestamp - oldRemoteClock.getRtpTimestamp())
& 0xffffffffl)
/ (remoteTime - oldRemoteClock.getRemoteTime()));
}
// Replace whatever was in there before.
receivedClocks.put(
ssrc,
new ReceivedRemoteClock(
ssrc, remoteTime, (int) srPacket.rtptimestamp, frequencyHz));
break;
case RTCPPacket.SDES:
break;
}
}
}
/**
* Opens new WebRTC data channel using specified parameters.
*
* @param type channel type as defined in control protocol description. Use 0 for "reliable".
* @param prio channel priority. The higher the number, the lower the priority.
* @param reliab Reliability Parameter<br>
* This field is ignored if a reliable channel is used. If a partial reliable channel with
* limited number of retransmissions is used, this field specifies the number of
* retransmissions. If a partial reliable channel with limited lifetime is used, this field
* specifies the maximum lifetime in milliseconds. The following table summarizes this:<br>
* </br>
* <p>+------------------------------------------------+------------------+ | Channel Type |
* Reliability | | | Parameter |
* +------------------------------------------------+------------------+ |
* DATA_CHANNEL_RELIABLE | Ignored | | DATA_CHANNEL_RELIABLE_UNORDERED | Ignored | |
* DATA_CHANNEL_PARTIAL_RELIABLE_REXMIT | Number of RTX | |
* DATA_CHANNEL_PARTIAL_RELIABLE_REXMIT_UNORDERED | Number of RTX | |
* DATA_CHANNEL_PARTIAL_RELIABLE_TIMED | Lifetime in ms | |
* DATA_CHANNEL_PARTIAL_RELIABLE_TIMED_UNORDERED | Lifetime in ms |
* +------------------------------------------------+------------------+
* @param sid SCTP stream id that will be used by new channel (it must not be already used).
* @param label text label for the channel.
* @return new instance of <tt>WebRtcDataStream</tt> that represents opened WebRTC data channel.
* @throws IOException if IO error occurs.
*/
public synchronized WebRtcDataStream openChannel(
int type, int prio, long reliab, int sid, String label) throws IOException {
if (channels.containsKey(sid)) {
throw new IOException("Channel on sid: " + sid + " already exists");
}
// Label Length & Label
byte[] labelBytes;
int labelByteLength;
if (label == null) {
labelBytes = null;
labelByteLength = 0;
} else {
labelBytes = label.getBytes("UTF-8");
labelByteLength = labelBytes.length;
if (labelByteLength > 0xFFFF) labelByteLength = 0xFFFF;
}
// Protocol Length & Protocol
String protocol = WEBRTC_DATA_CHANNEL_PROTOCOL;
byte[] protocolBytes;
int protocolByteLength;
if (protocol == null) {
protocolBytes = null;
protocolByteLength = 0;
} else {
protocolBytes = protocol.getBytes("UTF-8");
protocolByteLength = protocolBytes.length;
if (protocolByteLength > 0xFFFF) protocolByteLength = 0xFFFF;
}
ByteBuffer packet = ByteBuffer.allocate(12 + labelByteLength + protocolByteLength);
// Message open new channel on current sid
// Message Type
packet.put((byte) MSG_OPEN_CHANNEL);
// Channel Type
packet.put((byte) type);
// Priority
packet.putShort((short) prio);
// Reliability Parameter
packet.putInt((int) reliab);
// Label Length
packet.putShort((short) labelByteLength);
// Protocol Length
packet.putShort((short) protocolByteLength);
// Label
if (labelByteLength != 0) {
packet.put(labelBytes, 0, labelByteLength);
}
// Protocol
if (protocolByteLength != 0) {
packet.put(protocolBytes, 0, protocolByteLength);
}
int sentCount = sctpSocket.send(packet.array(), true, sid, WEB_RTC_PPID_CTRL);
if (sentCount != packet.capacity()) {
throw new IOException("Failed to open new chanel on sid: " + sid);
}
WebRtcDataStream channel = new WebRtcDataStream(sctpSocket, sid, label, false);
channels.put(sid, channel);
return channel;
}
/**
* Handles control packet.
*
* @param data raw packet data that arrived on control PPID.
* @param sid SCTP stream id on which the data has arrived.
*/
private synchronized void onCtrlPacket(byte[] data, int sid) throws IOException {
ByteBuffer buffer = ByteBuffer.wrap(data);
int messageType = /* 1 byte unsigned integer */ 0xFF & buffer.get();
if (messageType == MSG_CHANNEL_ACK) {
if (logger.isDebugEnabled()) {
logger.debug(getEndpoint().getID() + " ACK received SID: " + sid);
}
// Open channel ACK
WebRtcDataStream channel = channels.get(sid);
if (channel != null) {
// Ack check prevents from firing multiple notifications
// if we get more than one ACKs (by mistake/bug).
if (!channel.isAcknowledged()) {
channel.ackReceived();
notifyChannelOpened(channel);
} else {
logger.warn("Redundant ACK received for SID: " + sid);
}
} else {
logger.error("No channel exists on sid: " + sid);
}
} else if (messageType == MSG_OPEN_CHANNEL) {
int channelType = /* 1 byte unsigned integer */ 0xFF & buffer.get();
int priority = /* 2 bytes unsigned integer */ 0xFFFF & buffer.getShort();
long reliability = /* 4 bytes unsigned integer */ 0xFFFFFFFFL & buffer.getInt();
int labelLength = /* 2 bytes unsigned integer */ 0xFFFF & buffer.getShort();
int protocolLength = /* 2 bytes unsigned integer */ 0xFFFF & buffer.getShort();
String label;
String protocol;
if (labelLength == 0) {
label = "";
} else {
byte[] labelBytes = new byte[labelLength];
buffer.get(labelBytes);
label = new String(labelBytes, "UTF-8");
}
if (protocolLength == 0) {
protocol = "";
} else {
byte[] protocolBytes = new byte[protocolLength];
buffer.get(protocolBytes);
protocol = new String(protocolBytes, "UTF-8");
}
if (logger.isDebugEnabled()) {
logger.debug(
"!!! "
+ getEndpoint().getID()
+ " data channel open request on SID: "
+ sid
+ " type: "
+ channelType
+ " prio: "
+ priority
+ " reliab: "
+ reliability
+ " label: "
+ label
+ " proto: "
+ protocol);
}
if (channels.containsKey(sid)) {
logger.error("Channel on sid: " + sid + " already exists");
}
WebRtcDataStream newChannel = new WebRtcDataStream(sctpSocket, sid, label, true);
channels.put(sid, newChannel);
sendOpenChannelAck(sid);
notifyChannelOpened(newChannel);
} else {
logger.error("Unexpected ctrl msg type: " + messageType);
}
}
/**
* Maybe send a data channel command to the associated <tt>Endpoint</tt> to make it start
* streaming its hq stream, if it's being watched by some receiver.
*/
public void maybeSendStartHighQualityStreamCommand() {
if (nativeSimulcast || !hasLayers()) {
// In native simulcast the client adjusts its layers autonomously so
// we don't need (nor we can) to control it with data channel
// messages.
return;
}
Endpoint newEndpoint = getSimulcastEngine().getVideoChannel().getEndpoint();
SimulcastLayer[] newSimulcastLayers = getSimulcastLayers();
SctpConnection sctpConnection;
if (newSimulcastLayers == null
|| newSimulcastLayers.length <= 1
/* newEndpoint != null is implied */
|| (sctpConnection = newEndpoint.getSctpConnection()) == null
|| !sctpConnection.isReady()
|| sctpConnection.isExpired()) {
return;
}
// we have a new endpoint and it has an SCTP connection that is
// ready and not expired. if somebody else is watching the new
// endpoint, start its hq stream.
boolean startHighQualityStream = false;
for (Endpoint e :
getSimulcastEngine().getVideoChannel().getContent().getConference().getEndpoints()) {
// TODO(gp) need some synchronization here. What if the
// selected endpoint changes while we're in the loop?
if (e == newEndpoint) continue;
Endpoint eSelectedEndpoint = e.getEffectivelySelectedEndpoint();
if (newEndpoint == eSelectedEndpoint) {
// somebody is watching the new endpoint or somebody has not
// yet signaled its selected endpoint to the bridge, start
// the hq stream.
if (logger.isDebugEnabled()) {
Map<String, Object> map = new HashMap<String, Object>(3);
map.put("e", e);
map.put("newEndpoint", newEndpoint);
map.put("maybe", eSelectedEndpoint == null ? "(maybe) " : "");
StringCompiler sc =
new StringCompiler(map).c("{e.id} is {maybe} watching {newEndpoint.id}.");
logDebug(sc.toString().replaceAll("\\s+", " "));
}
startHighQualityStream = true;
break;
}
}
if (startHighQualityStream) {
// TODO(gp) this assumes only a single hq stream.
logDebug(
getSimulcastEngine().getVideoChannel().getEndpoint().getID()
+ " notifies "
+ newEndpoint.getID()
+ " to start its HQ stream.");
SimulcastLayer hqLayer = newSimulcastLayers[newSimulcastLayers.length - 1];
;
StartSimulcastLayerCommand command = new StartSimulcastLayerCommand(hqLayer);
String json = mapper.toJson(command);
try {
newEndpoint.sendMessageOnDataChannel(json);
} catch (IOException e) {
logError(newEndpoint.getID() + " failed to send message on data channel.", e);
}
}
}
/**
* Returns {@link JitsiMeetConference} for given MUC <tt>roomName</tt> or <tt>null</tt> if no
* conference has been allocated yet.
*
* @param roomName the name of MUC room for which we want get the {@link JitsiMeetConference}
* instance.
*/
public JitsiMeetConference getConference(String roomName) {
return conferences.get(roomName);
}
/** Returns the number of currently allocated focus instances. */
public int getConferenceCount() {
return conferences.size();
}