twilio-video 2.26.0 → 2.26.2

package/lib/webrtc/getstats.js

@@ -53,9 +53,7 @@ function _getStats(peerConnection, options) {
     [remoteVideoTracks, 'remoteVideoTrackStats', true]
   ], ([tracks, statsArrayName, isRemote]) => {
     return tracks.map(track => {
-      return getTrackStats(peerConnection, track, Object.assign({
-        isRemote: isRemote
-      }, options)).then(trackStatsArray => {
+      return getTrackStats(peerConnection, track, Object.assign({ isRemote }, options)).then(trackStatsArray => {
         trackStatsArray.forEach(trackStats => {
           trackStats.trackId = track.id;
           statsResponse[statsArrayName].push(trackStats);
@@ -296,14 +294,14 @@ function getTracks(peerConnection, kind, localOrRemote) {
  */
 function getTrackStats(peerConnection, track, options = {}) {
   if (typeof options.testForChrome !== 'undefined' || isChrome) {
-    return chromeOrSafariGetTrackStats(peerConnection, track);
+    return chromeOrSafariGetTrackStats(peerConnection, track, options);
   }
   if (typeof options.testForFirefox  !== 'undefined' || isFirefox) {
-    return firefoxGetTrackStats(peerConnection, track, options.isRemote);
+    return firefoxGetTrackStats(peerConnection, track, options);
   }
   if (typeof options.testForSafari  !== 'undefined' || isSafari) {
     if (typeof options.testForSafari  !== 'undefined' || getSdpFormat() === 'unified') {
-      return chromeOrSafariGetTrackStats(peerConnection, track);
+      return chromeOrSafariGetTrackStats(peerConnection, track, options);
     }
     // NOTE(syerrapragada): getStats() is not supported on
     // Safari versions where plan-b is the SDP format
@@ -320,19 +318,19 @@ function getTrackStats(peerConnection, track, options = {}) {
  * Get the standardized statistics for a particular MediaStreamTrack in Chrome or Safari.
  * @param {RTCPeerConnection} peerConnection
  * @param {MediaStreamTrack} track
+ * @param {object} options - Used for testing
  * @returns {Promise.<Array<StandardizedTrackStatsReport>>}
  */
-function chromeOrSafariGetTrackStats(peerConnection, track) {
-  return new Promise((resolve, reject) => {
-    if (chromeMajorVersion && chromeMajorVersion < 67) {
+function chromeOrSafariGetTrackStats(peerConnection, track, options) {
+  if (chromeMajorVersion && chromeMajorVersion < 67) {
+    return new Promise((resolve, reject) => {
       peerConnection.getStats(response => {
         resolve([standardizeChromeLegacyStats(response, track)]);
       }, null, reject);
-      return;
-    }
-    peerConnection.getStats(track).then(response =>  {
-      resolve(standardizeChromeOrSafariStats(response));
-    }, reject);
+    });
+  }
+  return peerConnection.getStats(track).then(response => {
+    return standardizeChromeOrSafariStats(response, options);
   });
 }
 
@@ -340,14 +338,12 @@ function chromeOrSafariGetTrackStats(peerConnection, track) {
  * Get the standardized statistics for a particular MediaStreamTrack in Firefox.
  * @param {RTCPeerConnection} peerConnection
  * @param {MediaStreamTrack} track
- * @param {boolean} isRemote
+ * @param {object} options
  * @returns {Promise.<Array<StandardizedTrackStatsReport>>}
  */
-function firefoxGetTrackStats(peerConnection, track, isRemote) {
-  return new Promise((resolve, reject) => {
-    peerConnection.getStats(track).then(response => {
-      resolve([standardizeFirefoxStats(response, isRemote)]);
-    }, reject);
+function firefoxGetTrackStats(peerConnection, track, options) {
+  return peerConnection.getStats(track).then(response => {
+    return [standardizeFirefoxStats(response, options)];
   });
 }
 
@@ -428,9 +424,13 @@ function standardizeChromeLegacyStats(response, track) {
 /**
  * Standardize the MediaStreamTrack's statistics in Chrome or Safari.
  * @param {RTCStatsResponse} response
+ * @param {object} options - Used for testing
  * @returns {Array<StandardizedTrackStatsReport>}
  */
-function standardizeChromeOrSafariStats(response) {
+function standardizeChromeOrSafariStats(response, { simulateExceptionWhileStandardizingStats = false }) {
+  if (simulateExceptionWhileStandardizingStats) {
+    throw new Error('Error while gathering stats');
+  }
   let inbound = null;
 
   // NOTE(mpatwardhan): We should expect more than one "outbound-rtp" stats for a
@@ -470,7 +470,7 @@ function standardizeChromeOrSafariStats(response) {
     }
   });
 
-  const isRemote = track && track.remoteSource;
+  const isRemote = track ? track.remoteSource : !localMedia;
   const mainSources = isRemote ? [inbound] : outbound;
   const stats = [];
   const remoteSource = isRemote ? remoteOutbound : remoteInbound; // remote rtp stats
@@ -523,7 +523,7 @@ function standardizeChromeOrSafariStats(response) {
         standardizedStats.frameWidthReceived = frameWidth;
       } else {
         standardizedStats.frameWidthSent = frameWidth;
-        standardizedStats.frameWidthInput = track.frameWidth;
+        standardizedStats.frameWidthInput = track ? track.frameWidth : localMedia.width;
       }
     }
 
@@ -533,7 +533,7 @@ function standardizeChromeOrSafariStats(response) {
         standardizedStats.frameHeightReceived = frameHeight;
       } else {
         standardizedStats.frameHeightSent = frameHeight;
-        standardizedStats.frameHeightInput = track.frameHeight;
+        standardizedStats.frameHeightInput = track ? track.frameHeight : localMedia.height;
       }
     }
 
@@ -626,10 +626,13 @@ function standardizeChromeOrSafariStats(response) {
 /**
  * Standardize the MediaStreamTrack's statistics in Firefox.
  * @param {RTCStatsReport} response
- * @param {boolean} isRemote
+ * @param {object} options - Used for testing
  * @returns {StandardizedTrackStatsReport}
  */
-function standardizeFirefoxStats(response = new Map(), isRemote) {
+function standardizeFirefoxStats(response = new Map(), { isRemote, simulateExceptionWhileStandardizingStats = false }) {
+  if (simulateExceptionWhileStandardizingStats) {
+    throw new Error('Error while gathering stats');
+  }
   // NOTE(mroberts): If getStats is called on a closed RTCPeerConnection,
   // Firefox returns undefined instead of an RTCStatsReport. We workaround this
   // here. See the following bug for more details:

package/lib/webrtc/util/index.js

@@ -307,6 +307,67 @@ function support() {
     && typeof RTCPeerConnection === 'function';
 }
 
+/**
+ * Create a Set of supported codecs for a certain kind of media.
+ * @param {'audio'|'video'} kind
+ * @returns {Promise<Set<AudioCodec|VideoCodec>>}
+ */
+function createSupportedCodecsSet(kind) {
+  if (typeof RTCRtpSender !== 'undefined'
+    && typeof RTCRtpSender.getCapabilities === 'function') {
+    return Promise.resolve(new Set(
+      RTCRtpSender
+        .getCapabilities(kind)
+        .codecs
+        .map(({ mimeType }) => mimeType.split('/')[1].toLowerCase())
+    ));
+  }
+  if (typeof RTCPeerConnection === 'undefined'
+    || typeof RTCPeerConnection.prototype === 'undefined'
+    || typeof RTCPeerConnection.prototype.addTransceiver !== 'function'
+    || typeof RTCPeerConnection.prototype.close !== 'function'
+    || typeof RTCPeerConnection.prototype.createOffer !== 'function') {
+    return Promise.resolve(new Set());
+  }
+  const pc = new RTCPeerConnection();
+  pc.addTransceiver(kind);
+  return pc.createOffer().then(({ sdp }) => {
+    pc.close();
+    return new Set((sdp.match(/^a=rtpmap:.+$/gm) || [])
+      .map(line => line.match(/^a=rtpmap:.+ ([^/]+)/)[1].toLowerCase()));
+  }, () => {
+    pc.close();
+    return new Set();
+  });
+}
+
+// NOTE(mmalavalli): Cache the supported audio and video codecs here.
+const supportedCodecs = new Map();
+
+/**
+ * Check whether a given codec for a certain kind of media is supported.
+ * @param {AudioCodec|VideoCodec} codec
+ * @param {'audio'|'video'} kind
+ * @returns {Promise<boolean>}
+ */
+function isCodecSupported(codec, kind) {
+  const codecs = supportedCodecs.get(kind);
+  if (codecs) {
+    return Promise.resolve(codecs.has(codec.toLowerCase()));
+  }
+  return createSupportedCodecsSet(kind).then(codecs => {
+    supportedCodecs.set(kind, codecs);
+    return codecs.has(codec.toLowerCase());
+  });
+}
+
+/**
+ * Clear cached supported codecs (unit tests only).
+ */
+function clearCachedSupportedCodecs() {
+  supportedCodecs.clear();
+}
+
 /**
  * @typedef {object} Deferred
  * @property {Promise} promise
@@ -314,12 +375,14 @@ function support() {
  * @property {function} resolve
  */
 
+exports.clearCachedSupportedCodecs = clearCachedSupportedCodecs;
 exports.defer = defer;
 exports.delegateMethods = delegateMethods;
 exports.difference = difference;
 exports.flatMap = flatMap;
 exports.guessBrowser = guessBrowser;
 exports.guessBrowserVersion = guessBrowserVersion;
+exports.isCodecSupported = isCodecSupported;
 exports.isIOSChrome = isIOSChrome;
 exports.interceptEvent = interceptEvent;
 exports.legacyPromise = legacyPromise;

package/package.json

@@ -2,7 +2,7 @@
   "name": "twilio-video",
   "title": "Twilio Video",
   "description": "Twilio Video JavaScript Library",
-  "version": "2.26.0",
+  "version": "2.26.2",
   "homepage": "https://twilio.com",
   "author": "Mark Andrus Roberts <mroberts@twilio.com>",
   "contributors": [

package/tsdef/AudioTrack.d.ts

@@ -1,16 +1,5 @@
-import { Track } from './Track';
+import { MediaTrack } from './MediaTrack';
 
-export class AudioTrack extends Track {
-  isStarted: boolean;
-  isEnabled: boolean;
+export class AudioTrack extends MediaTrack {
   kind: 'audio';
-  mediaStreamTrack: MediaStreamTrack;
-
-  attach(element?: HTMLMediaElement | string): HTMLMediaElement;
-  detach(element?: HTMLMediaElement | string): HTMLMediaElement[];
-
-  on(event: 'disabled', listener: (track: this) => void): this;
-  on(event: 'enabled', listener: (track: this) => void): this;
-  on(event: 'started', listener: (track: this) => void): this;
-  on(event: string, listener: (...args: any[]) => void): this;
 }

package/tsdef/MediaTrack.d.ts

@@ -0,0 +1,16 @@
+import { Track } from './Track';
+
+export class MediaTrack extends Track {
+  isStarted: boolean;
+  isEnabled: boolean;
+  mediaStreamTrack: MediaStreamTrack;
+
+  attach(element?: HTMLMediaElement | string): HTMLMediaElement;
+  detach(element: HTMLMediaElement | string): HTMLMediaElement;
+  detach(): HTMLMediaElement[];
+
+  on(event: 'disabled', listener: (track: this) => void): this;
+  on(event: 'enabled', listener: (track: this) => void): this;
+  on(event: 'started', listener: (track: this) => void): this;
+  on(event: string, listener: (...args: any[]) => void): this;
+}

package/tsdef/VideoTrack.d.ts

@@ -1,4 +1,4 @@
-import { Track } from './Track';
+import { MediaTrack } from './MediaTrack';
 import { VideoProcessor } from './VideoProcessor';
 
 export namespace VideoTrack {
@@ -8,22 +8,12 @@ export namespace VideoTrack {
   }
 }
 
-export class VideoTrack extends Track {
-  isStarted: boolean;
-  isEnabled: boolean;
+export class VideoTrack extends MediaTrack {
   dimensions: VideoTrack.Dimensions;
   kind: 'video';
   processor: VideoProcessor | null;
-  mediaStreamTrack: MediaStreamTrack;
   processedTrack: MediaStreamTrack | null;
 
   addProcessor(processor: VideoProcessor): this;
   removeProcessor(processor: VideoProcessor): this;
-  attach(element?: HTMLMediaElement | string): HTMLVideoElement;
-  detach(element?: HTMLMediaElement | string): HTMLVideoElement[];
-
-  on(event: 'disabled', listener: (track: this) => void): this;
-  on(event: 'enabled', listener: (track: this) => void): this;
-  on(event: 'started', listener: (track: this) => void): this;
-  on(event: string, listener: (...args: any[]) => void): this;
 }

package/tsdef/index.d.ts

@@ -12,7 +12,7 @@ export const isSupported: boolean;
 export const version:string;
 export const Logger: Log.RootLogger;
 export function connect(token: string, options?: ConnectOptions): CancelablePromise<Room>;
-export function createLocalAudioTrack(options?: CreateLocalTracksOptions|CreateLocalAudioTrackOptions): Promise<LocalAudioTrack>;
+export function createLocalAudioTrack(options?: CreateLocalTrackOptions|CreateLocalAudioTrackOptions): Promise<LocalAudioTrack>;
 export function createLocalTracks(options?: CreateLocalTracksOptions): Promise<LocalTrack[]>;
 export function createLocalVideoTrack(options?: CreateLocalTrackOptions): Promise<LocalVideoTrack>;
 export function runPreflight(token: string, options?: PreflightOptions): PreflightTest;
@@ -43,6 +43,9 @@ export { Room } from './Room';
 export { Track } from './Track';
 export { TrackPublication } from './TrackPublication';
 export { TwilioError } from './TwilioError';
+export { VideoProcessor } from './VideoProcessor';
+export { VideoTrack } from './VideoTrack';
+
 export {
   AudioCodec,
   AudioCodecSettings,
@@ -93,5 +96,3 @@ export {
   VideoTrackPublication,
   VP8CodecSettings
 } from './types';
-export { VideoProcessor } from './VideoProcessor';
-export { VideoTrack } from './VideoTrack';

package/tsdef/twilio-video-tests.ts

@@ -346,6 +346,9 @@ function trackSubscribed(track: Video.VideoTrack | Video.AudioTrack) {
 }
 
 function trackUnsubscribed(track: Video.VideoTrack | Video.AudioTrack) {
+  const element = document.createElement(track.kind);
+  track.detach('#foo').remove();
+  track.detach(element).remove();
   track.detach().forEach(element => element.remove());
 }