Merge pull request #45 from millicast/develop

Release v0.0.1-beta.6

Author: emilsas

packages/millicast-sdk-js/src/MillicastPublish.js

@@ -3,7 +3,6 @@ import reemit from 're-emitter'
 import MillicastLogger from './MillicastLogger'
 import MillicastSignaling, { MillicastVideoCodec } from './MillicastSignaling'
 import MillicastWebRTC, { webRTCEvents } from './MillicastWebRTC.js'
-import SdpParser from './utils/SdpParser'
 
 const logger = MillicastLogger.get('MillicastPublish')
 
@@ -46,7 +45,9 @@ export default class MillicastPublish extends EventEmitter {
    * @param {Boolean} [options.disableVideo = false] - Disable the opportunity to send video stream.
    * @param {Boolean} [options.disableAudio = false] - Disable the opportunity to send audio stream.
    * @param {MillicastVideoCodec} options.codec - Codec for publish stream.
-   * @param {Boolean} options.simulcast - Enable simulcast.
+   * @param {Boolean} options.simulcast - Enable simulcast. **Only available in Google Chrome and with H.264 or VP8 video codecs.**
+   * @param {String} options.scalabilityMode - Selected scalability mode. You can get the available capabilities using <a href="MillicastWebRTC#.getCapabilities">MillicastWebRTC.getCapabilities</a> method.
+   * **Only available in Google Chrome.**
    * @returns {Promise<void>} Promise object which resolves when the broadcast started successfully.
    * @fires MillicastWebRTC#connectionStateChange
    * @example await millicastPublish.broadcast(options)
@@ -85,7 +86,8 @@ export default class MillicastPublish extends EventEmitter {
       disableVideo: false,
       disableAudio: false,
       codec: MillicastVideoCodec.H264,
-      simulcast: false
+      simulcast: false,
+      scalabilityMode: null
     }
   ) {
     logger.debug('Broadcast option values: ', options)
@@ -114,11 +116,9 @@ export default class MillicastPublish extends EventEmitter {
       offerToReceiveVideo: !options.disableVideo,
       offerToReceiveAudio: !options.disableAudio
     }
-    const localSdp = await this.webRTCPeer.getRTCLocalSDP({ mediaStream: options.mediaStream, simulcast: options.simulcast, codec: options.codec })
+    const localSdp = await this.webRTCPeer.getRTCLocalSDP({ mediaStream: options.mediaStream, simulcast: options.simulcast, codec: options.codec, scalabilityMode: options.scalabilityMode })
     let remoteSdp = await this.millicastSignaling.publish(localSdp, options.codec)
-    if (remoteSdp?.indexOf('\na=extmap-allow-mixed') !== -1) {
-      remoteSdp = SdpParser.removeSdpLine(remoteSdp, 'a=extmap-allow-mixed')
-    }
+
     if (!options.disableVideo && options.bandwidth > 0) {
       remoteSdp = this.webRTCPeer.updateBandwidthRestriction(remoteSdp, options.bandwidth)
     }
@@ -136,6 +136,7 @@ export default class MillicastPublish extends EventEmitter {
     logger.info('Stopping broadcast')
     this.webRTCPeer.closeRTCPeer()
     this.millicastSignaling?.close()
+    this.millicastSignaling = null
   }
 
   /**

packages/millicast-sdk-js/src/MillicastSignaling.js

@@ -237,6 +237,11 @@ export default class MillicastSignaling extends EventEmitter {
         result.sdp = SdpParser.adaptCodecName(result.sdp, MillicastVideoCodec.AV1, 'AV1X')
       }
 
+      // remove a=extmap-allow-mixed for Chrome < M71
+      if (result.sdp?.indexOf('\na=extmap-allow-mixed') !== -1) {
+        result.sdp = SdpParser.removeSdpLine(result.sdp, 'a=extmap-allow-mixed')
+      }
+
       logger.info('Command sent, publisherId: ', result.publisherId)
       logger.debug('Command result: ', result)
       return result.sdp

packages/millicast-sdk-js/src/MillicastView.js

@@ -83,8 +83,8 @@ export default class MillicastView extends EventEmitter {
       throw new Error('Subscriber data required')
     }
     if (this.isActive()) {
-      logger.warn('Viewer currently subscriber')
-      throw new Error('Viewer currently subscriber')
+      logger.warn('Viewer currently subscribed')
+      throw new Error('Viewer currently subscribed')
     }
 
     this.millicastSignaling = new MillicastSignaling({
@@ -102,14 +102,10 @@ export default class MillicastView extends EventEmitter {
     const localSdp = await this.webRTCPeer.getRTCLocalSDP({ stereo: true })
 
     const sdpSubscriber = await this.millicastSignaling.subscribe(localSdp)
-    if (sdpSubscriber) {
-      reemit(this.millicastSignaling, this, [signalingEvents.broadcastEvent])
-      await this.webRTCPeer.setRTCRemoteSDP(sdpSubscriber)
-      logger.info('Connected to streamName: ', this.streamName)
-    } else {
-      logger.error('Failed to connect to publisher: ', sdpSubscriber)
-      throw new Error('Failed to connect to publisher: ', sdpSubscriber)
-    }
+    reemit(this.millicastSignaling, this, [signalingEvents.broadcastEvent])
+
+    await this.webRTCPeer.setRTCRemoteSDP(sdpSubscriber)
+    logger.info('Connected to streamName: ', this.streamName)
   }
 
   /**
@@ -121,6 +117,7 @@ export default class MillicastView extends EventEmitter {
     logger.info('Stopping connection')
     this.webRTCPeer.closeRTCPeer()
     this.millicastSignaling?.close()
+    this.millicastSignaling = null
   }
 
   /**

packages/millicast-sdk-js/src/MillicastWebRTC.js

@@ -1,6 +1,7 @@
 import axios from 'axios'
 import EventEmitter from 'events'
 import SdpParser from './utils/SdpParser'
+import UserAgent from './utils/UserAgent'
 import MillicastLogger from './MillicastLogger'
 import { MillicastVideoCodec, MillicastAudioCodec } from './MillicastSignaling'
 
@@ -133,15 +134,18 @@ export default class MillicastWebRTC extends EventEmitter {
    * @param {Boolean} options.stereo - True to modify SDP for support stereo. Otherwise False.
    * @param {MediaStream|Array<MediaStreamTrack>} options.mediaStream - MediaStream to offer in a stream. This object must have
    * 1 audio track and 1 video track, or at least one of them. Alternative you can provide both tracks in an array.
-   * @param {'h264'|'vp8'|'vp9'|'av1'} options.codec - Selected codec for support simulcast.
-   * @param {Boolean} options.simulcast - True to modify SDP for support simulcast.
+   * @param {MillicastVideoCodec} options.codec - Selected codec for support simulcast.
+   * @param {Boolean} options.simulcast - True to modify SDP for support simulcast. **Only available in Google Chrome and with H.264 or VP8 video codecs.**
+   * @param {String} options.scalabilityMode - Selected scalability mode. You can get the available capabilities using <a href="MillicastWebRTC#.getCapabilities">MillicastWebRTC.getCapabilities</a> method.
+   * **Only available in Google Chrome.**
    * @returns {Promise<String>} Promise object which represents the SDP information of the created offer.
    */
   async getRTCLocalSDP (options = {
     stereo: false,
     mediaStream: null,
     codec: 'h264',
-    simulcast: false
+    simulcast: false,
+    scalabilityMode: null
   }) {
     logger.info('Getting RTC Local SDP')
     logger.debug('Stereo value: ', options.stereo)
@@ -151,7 +155,20 @@ export default class MillicastWebRTC extends EventEmitter {
     if (mediaStream) {
       logger.info('Adding mediaStream tracks to RTCPeerConnection')
       for (const track of mediaStream.getTracks()) {
-        this.peer.addTrack(track, mediaStream)
+        if (track.kind === 'video' && options.scalabilityMode && new UserAgent(window.navigator.userAgent).isChrome()) {
+          logger.debug(`Video track with scalability mode: ${options.scalabilityMode}, adding as transceiver.`)
+          this.peer.addTransceiver(track, {
+            streams: [mediaStream],
+            sendEncodings: [
+              { scalabilityMode: options.scalabilityMode }
+            ]
+          })
+        } else {
+          if (track.kind === 'video' && options.scalabilityMode) {
+            logger.warn('SVC is only supported in Google Chrome')
+          }
+          this.peer.addTrack(track, mediaStream)
+        }
         logger.info(`Track '${track.label}' added: `, `id: ${track.id}`, `kind: ${track.kind}`)
       }
     }
@@ -162,6 +179,7 @@ export default class MillicastWebRTC extends EventEmitter {
     logger.debug('Peer offer response: ', response.sdp)
 
     this.sessionDescription = response
+    this.sessionDescription.sdp = SdpParser.setMultiopus(this.sessionDescription.sdp)
     if (options.simulcast) {
       this.sessionDescription.sdp = SdpParser.setSimulcast(this.sessionDescription.sdp, options.codec)
     }
@@ -253,13 +271,18 @@ export default class MillicastWebRTC extends EventEmitter {
     const browserCapabilites = RTCRtpSender.getCapabilities(kind)
 
     if (browserCapabilites) {
+      const codecs = {}
       let regex = new RegExp(`^video/(${Object.values(MillicastVideoCodec).join('|')})x?$`, 'i')
 
       if (kind === 'audio') {
         regex = new RegExp(`^audio/(${Object.values(MillicastAudioCodec).join('|')})$`, 'i')
+        const browserData = new UserAgent(window.navigator.userAgent)
+
+        if (browserData.isChrome()) {
+          codecs.multiopus = { mimeType: 'audio/multiopus', channels: 6 }
+        }
       }
 
-      const codecs = {}
       for (const codec of browserCapabilites.codecs) {
         const matches = codec.mimeType.match(regex)
         if (matches) {

packages/millicast-sdk-js/src/utils/SdpParser.js

@@ -1,6 +1,6 @@
-import UAParser from 'ua-parser-js'
 import SemanticSDP from 'semantic-sdp'
 import MillicastLogger from '../MillicastLogger'
+import UserAgent from './UserAgent'
 
 const logger = MillicastLogger.get('SdpParser')
 
@@ -12,15 +12,17 @@ const logger = MillicastLogger.get('SdpParser')
 export default class SdpParser {
   /**
    * Parse SDP for support simulcast.
+   *
+   * **Only available in Google Chrome.**
    * @param {String} sdp - Current SDP.
    * @param {String} codec - Codec.
    * @returns {String} SDP parsed with simulcast support.
    * @example SdpParser.setSimulcast(sdp, 'h264')
    */
   static setSimulcast (sdp, codec) {
     logger.info('Setting simulcast. Codec: ', codec)
-    const browserData = new UAParser(window.navigator.userAgent).getBrowser()
-    if (!browserData.name.match(/Chrome/)) {
+    const browserData = new UserAgent(window.navigator.userAgent)
+    if (!browserData.isChrome()) {
       logger.warn('Simulcast is only available in Google Chrome browser')
       return sdp
     }
@@ -105,14 +107,14 @@ export default class SdpParser {
       logger.info('Remove bitrate restrictions')
       sdp = sdp.replace(/b=AS:.*\r\n/, '').replace(/b=TIAS:.*\r\n/, '')
     } else {
-      const browserData = new UAParser(window.navigator.userAgent).getBrowser()
+      const browserData = new UserAgent(window.navigator.userAgent)
       const offer = SemanticSDP.SDPInfo.parse(sdp)
       const videoOffer = offer.getMedia('video')
 
       logger.info('Setting video bitrate')
       videoOffer.setBitrate(bitrate)
       sdp = offer.toString()
-      if (sdp.indexOf('b=AS:') > -1 && browserData.name === 'Firefox') {
+      if (sdp.indexOf('b=AS:') > -1 && browserData.isFirefox()) {
         logger.info('Updating SDP for firefox browser')
         sdp = sdp.replace('b=AS:', 'b=TIAS:')
         logger.debug('SDP updated for firefox: ', sdp)
@@ -155,4 +157,34 @@ export default class SdpParser {
 
     return sdp.replace(regex, newCodecName)
   }
+
+  /**
+   * Parse SDP for support multiopus.
+   *
+   * **Only available in Google Chrome.**
+   * @param {String} sdp - Current SDP.
+   * @returns {String} SDP parsed with multiopus support.
+   * @example SdpParser.setMultiopus(sdp)
+   */
+  static setMultiopus (sdp) {
+    const browserData = new UserAgent(window.navigator.userAgent)
+    if (browserData.isChrome()) {
+      logger.info('Setting multiopus')
+      // Find the audio m-line
+      const res = /m=audio 9 UDP\/TLS\/RTP\/SAVPF (.*)\r\n/.exec(sdp)
+      // Get audio line
+      const audio = res[0]
+      // Get free payload number for multiopus
+      const pt = Math.max(...res[1].split(' ').map(Number)) + 1
+      // Add multiopus
+      const multiopus = audio.replace('\r\n', ' ') + pt + '\r\n' +
+            'a=rtpmap:' + pt + ' multiopus/48000/6\r\n' +
+            'a=fmtp:' + pt + ' channel_mapping=0,4,1,2,3,5;coupled_streams=2;minptime=10;num_streams=4;useinbandfec=1\r\n'
+      // Change sdp
+      sdp = sdp.replace(audio, multiopus)
+      logger.info('Multiopus offer created')
+      logger.debug('SDP parsed for multioups: ', sdp)
+    }
+    return sdp
+  }
 }

packages/millicast-sdk-js/src/utils/UserAgent.js

@@ -0,0 +1,22 @@
+import UAParser from 'ua-parser-js'
+
+export default class UserAgent extends UAParser {
+  isChrome (excludedOS = ['iOS']) {
+    const browserData = this.getBrowser()
+    const osData = this.getOS()
+
+    let osAllowed = true
+    if (excludedOS.length > 0) {
+      const regex = new RegExp(excludedOS.join('|'), 'i')
+      osAllowed = !regex.test(osData.name)
+    }
+
+    return browserData.name.match(/Chrome/i) && osAllowed
+  }
+
+  isFirefox () {
+    const browserData = this.getBrowser()
+
+    return browserData.name.match(/Firefox/i)
+  }
+}

packages/millicast-sdk-js/tests/features/GetCapabilities.feature

@@ -20,10 +20,20 @@ Feature: As a user I want to get browser audio/video capabilities so I can choos
     When I get video capabilities
     Then returns VP9 with all scalability modes available
 
-  Scenario: Get audio capabilities
+  Scenario: Get audio capabilities in Chrome
     Given my browser audio capabilities
     When I get audio capabilities
-    Then returns same capabilities as browser
+    Then returns opus and multiopus codecs
+
+  Scenario: Get audio capabilities in iOS Chrome
+    Given my browser audio capabilities
+    When I get audio capabilities
+    Then returns opus codec
+
+  Scenario: Get audio capabilities in other Browser
+    Given my browser audio capabilities
+    When I get audio capabilities
+    Then returns opus codec
 
   Scenario: Get capabilities from inexistent kind
     When I get data capabilities

packages/millicast-sdk-js/tests/features/MillicastPublish.feature

@@ -0,0 +1,56 @@
+Feature: As a user I want to publish a stream without managing connections
+
+  Scenario: Instance publisher without streamName
+    Given no stream name
+    When I instance a MillicastPublish
+    Then throws an error
+
+  Scenario: Broadcast stream
+    Given an instance of MillicastPublish
+    When I broadcast a stream with a connection path and media stream
+    Then peer connection state is connected
+
+  Scenario: Broadcast stream default options
+    Given an instance of MillicastPublish
+    When I broadcast a stream without options
+    Then throws an error
+
+  Scenario: Broadcast without connection path
+    Given an instance of MillicastPublish
+    When I broadcast a stream without a connection path
+    Then throws an error
+  
+  Scenario: Broadcast without mediaStream
+    Given an instance of MillicastPublish
+    When I broadcast a stream without a mediaStream
+    Then throws an error
+
+  Scenario: Broadcast to active publisher
+    Given an instance of MillicastPublish already connected
+    When I broadcast again to the stream
+    Then throws an error
+
+  Scenario: Broadcast stream with bandwidth restriction
+    Given an instance of MillicastPublish
+    When I broadcast a stream with bandwidth restriction
+    Then peer connection state is connected
+
+  Scenario: Stop publish
+    Given I am publishing a stream
+    When I stop the publish
+    Then peer connection and WebSocket are null
+
+  Scenario: Stop inactive publish
+    Given I am not publishing a stream
+    When I stop the publish
+    Then peer connection and WebSocket are null
+
+  Scenario: Check status of active publish
+    Given I am publishing a stream
+    When I check if publish is active
+    Then returns true
+
+  Scenario: Check status of inactive publish
+    Given I am not publishing a stream
+    When I check if publish is active
+    Then returns false