@stream-io/video-client 1.13.1 → 1.15.0

package/src/helpers/sdp-munging.ts

@@ -1,265 +0,0 @@
-import * as SDP from 'sdp-transform';
-
-type Media = {
-  original: string;
-  mediaWithPorts: string;
-  codecOrder: string;
-};
-
-type RtpMap = {
-  original: string;
-  payload: string;
-  codec: string;
-};
-
-type Fmtp = {
-  original: string;
-  payload: string;
-  config: string;
-};
-
-const getRtpMap = (line: string): RtpMap | undefined => {
-  // Example: a=rtpmap:110 opus/48000/2
-  const rtpRegex = /^a=rtpmap:(\d*) ([\w\-.]*)(?:\s*\/(\d*)(?:\s*\/(\S*))?)?/;
-  // The first captured group is the payload type number, the second captured group is the encoding name, the third captured group is the clock rate, and the fourth captured group is any additional parameters.
-  const rtpMatch = rtpRegex.exec(line);
-  if (rtpMatch) {
-    return {
-      original: rtpMatch[0],
-      payload: rtpMatch[1],
-      codec: rtpMatch[2],
-    };
-  }
-};
-
-const getFmtp = (line: string): Fmtp | undefined => {
-  // Example: a=fmtp:111 minptime=10; useinbandfec=1
-  const fmtpRegex = /^a=fmtp:(\d*) (.*)/;
-  const fmtpMatch = fmtpRegex.exec(line);
-  // The first captured group is the payload type number, the second captured group is any additional parameters.
-  if (fmtpMatch) {
-    return {
-      original: fmtpMatch[0],
-      payload: fmtpMatch[1],
-      config: fmtpMatch[2],
-    };
-  }
-};
-
-/**
- * gets the media section for the specified media type.
- * The media section contains the media type, port, codec, and payload type.
- * Example: m=video 9 UDP/TLS/RTP/SAVPF 100 101 96 97 35 36 102 125 127
- */
-const getMedia = (line: string, mediaType: string): Media | undefined => {
-  const regex = new RegExp(`(m=${mediaType} \\d+ [\\w/]+) ([\\d\\s]+)`);
-  const match = regex.exec(line);
-  if (match) {
-    return {
-      original: match[0],
-      mediaWithPorts: match[1],
-      codecOrder: match[2],
-    };
-  }
-};
-
-const getMediaSection = (sdp: string, mediaType: 'video' | 'audio') => {
-  let media: Media | undefined;
-  const rtpMap: RtpMap[] = [];
-  const fmtp: Fmtp[] = [];
-  let isTheRequiredMediaSection = false;
-  sdp.split(/(\r\n|\r|\n)/).forEach((line) => {
-    const isValidLine = /^([a-z])=(.*)/.test(line);
-    if (!isValidLine) return;
-    /*
-      NOTE: according to https://www.rfc-editor.org/rfc/rfc8866.pdf
-      Each media description starts with an "m=" line and continues to the next media description or the end of the whole session description, whichever comes first
-    */
-    const type = line[0];
-    if (type === 'm') {
-      const _media = getMedia(line, mediaType);
-      isTheRequiredMediaSection = !!_media;
-      if (_media) {
-        media = _media;
-      }
-    } else if (isTheRequiredMediaSection && type === 'a') {
-      const rtpMapLine = getRtpMap(line);
-      const fmtpLine = getFmtp(line);
-      if (rtpMapLine) {
-        rtpMap.push(rtpMapLine);
-      } else if (fmtpLine) {
-        fmtp.push(fmtpLine);
-      }
-    }
-  });
-  if (media) {
-    return {
-      media,
-      rtpMap,
-      fmtp,
-    };
-  }
-};
-
-/**
- * Gets the fmtp line corresponding to opus
- */
-const getOpusFmtp = (sdp: string): Fmtp | undefined => {
-  const section = getMediaSection(sdp, 'audio');
-  const rtpMap = section?.rtpMap.find((r) => r.codec.toLowerCase() === 'opus');
-  const codecId = rtpMap?.payload;
-  if (codecId) {
-    return section?.fmtp.find((f) => f.payload === codecId);
-  }
-};
-
-/**
- * Returns an SDP with DTX enabled or disabled.
- */
-export const toggleDtx = (sdp: string, enable: boolean): string => {
-  const opusFmtp = getOpusFmtp(sdp);
-  if (!opusFmtp) return sdp;
-
-  const matchDtx = /usedtx=(\d)/.exec(opusFmtp.config);
-  const requiredDtxConfig = `usedtx=${enable ? '1' : '0'}`;
-  const newFmtp = matchDtx
-    ? opusFmtp.original.replace(/usedtx=(\d)/, requiredDtxConfig)
-    : `${opusFmtp.original};${requiredDtxConfig}`;
-
-  return sdp.replace(opusFmtp.original, newFmtp);
-};
-
-/**
- * Returns and SDP with all the codecs except the given codec removed.
- */
-export const preserveCodec = (
-  sdp: string,
-  mid: string,
-  codec: RTCRtpCodec,
-): string => {
-  const [kind, codecName] = codec.mimeType.toLowerCase().split('/');
-
-  const toSet = (fmtpLine: string) =>
-    new Set(fmtpLine.split(';').map((f) => f.trim().toLowerCase()));
-
-  const equal = (a: Set<string>, b: Set<string>) => {
-    if (a.size !== b.size) return false;
-    for (const item of a) if (!b.has(item)) return false;
-    return true;
-  };
-
-  const codecFmtp = toSet(codec.sdpFmtpLine || '');
-  const parsedSdp = SDP.parse(sdp);
-  for (const media of parsedSdp.media) {
-    if (media.type !== kind || String(media.mid) !== mid) continue;
-
-    // find the payload id of the desired codec
-    const payloads = new Set<number>();
-    for (const rtp of media.rtp) {
-      if (rtp.codec.toLowerCase() !== codecName) continue;
-      const match =
-        // vp8 doesn't have any fmtp, we preserve it without any additional checks
-        codecName === 'vp8'
-          ? true
-          : media.fmtp.some(
-              (f) =>
-                f.payload === rtp.payload && equal(toSet(f.config), codecFmtp),
-            );
-      if (match) {
-        payloads.add(rtp.payload);
-      }
-    }
-
-    // find the corresponding rtx codec by matching apt=<preserved-codec-payload>
-    for (const fmtp of media.fmtp) {
-      const match = fmtp.config.match(/(apt)=(\d+)/);
-      if (!match) continue;
-      const [, , preservedCodecPayload] = match;
-      if (payloads.has(Number(preservedCodecPayload))) {
-        payloads.add(fmtp.payload);
-      }
-    }
-
-    media.rtp = media.rtp.filter((r) => payloads.has(r.payload));
-    media.fmtp = media.fmtp.filter((f) => payloads.has(f.payload));
-    media.rtcpFb = media.rtcpFb?.filter((f) => payloads.has(f.payload));
-    media.payloads = Array.from(payloads).join(' ');
-  }
-  return SDP.write(parsedSdp);
-};
-
-/**
- * Enables high-quality audio through SDP munging for the given trackMid.
- *
- * @param sdp the SDP to munge.
- * @param trackMid the trackMid.
- * @param maxBitrate the max bitrate to set.
- */
-export const enableHighQualityAudio = (
-  sdp: string,
-  trackMid: string,
-  maxBitrate: number = 510000,
-): string => {
-  maxBitrate = Math.max(Math.min(maxBitrate, 510000), 96000);
-
-  const parsedSdp = SDP.parse(sdp);
-  const audioMedia = parsedSdp.media.find(
-    (m) => m.type === 'audio' && String(m.mid) === trackMid,
-  );
-
-  if (!audioMedia) return sdp;
-
-  const opusRtp = audioMedia.rtp.find((r) => r.codec === 'opus');
-  if (!opusRtp) return sdp;
-
-  const opusFmtp = audioMedia.fmtp.find((f) => f.payload === opusRtp.payload);
-  if (!opusFmtp) return sdp;
-
-  // enable stereo, if not already enabled
-  if (opusFmtp.config.match(/stereo=(\d)/)) {
-    opusFmtp.config = opusFmtp.config.replace(/stereo=(\d)/, 'stereo=1');
-  } else {
-    opusFmtp.config = `${opusFmtp.config};stereo=1`;
-  }
-
-  // set maxaveragebitrate, to the given value
-  if (opusFmtp.config.match(/maxaveragebitrate=(\d*)/)) {
-    opusFmtp.config = opusFmtp.config.replace(
-      /maxaveragebitrate=(\d*)/,
-      `maxaveragebitrate=${maxBitrate}`,
-    );
-  } else {
-    opusFmtp.config = `${opusFmtp.config};maxaveragebitrate=${maxBitrate}`;
-  }
-
-  return SDP.write(parsedSdp);
-};
-
-/**
- * Extracts the mid from the transceiver or the SDP.
- *
- * @param transceiver the transceiver.
- * @param transceiverInitIndex the index of the transceiver in the transceiver's init array.
- * @param sdp the SDP.
- */
-export const extractMid = (
-  transceiver: RTCRtpTransceiver,
-  transceiverInitIndex: number,
-  sdp: string | undefined,
-): string => {
-  if (transceiver.mid) return transceiver.mid;
-  if (!sdp) return '';
-
-  const track = transceiver.sender.track!;
-  const parsedSdp = SDP.parse(sdp);
-  const media = parsedSdp.media.find((m) => {
-    return (
-      m.type === track.kind &&
-      // if `msid` is not present, we assume that the track is the first one
-      (m.msid?.includes(track.id) ?? true)
-    );
-  });
-  if (typeof media?.mid !== 'undefined') return String(media.mid);
-  if (transceiverInitIndex === -1) return '';
-  return String(transceiverInitIndex);
-};

package/src/rtc/__tests__/bitrateLookup.test.ts

@@ -1,12 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import { getOptimalBitrate } from '../bitrateLookup';
-
-describe('bitrateLookup', () => {
-  it('should return optimal bitrate', () => {
-    expect(getOptimalBitrate('vp9', 720)).toBe(1_250_000);
-  });
-
-  it('should return nearest bitrate for exotic dimensions', () => {
-    expect(getOptimalBitrate('vp9', 1000)).toBe(1_500_000);
-  });
-});

package/src/rtc/__tests__/codecs.test.ts

@@ -1,145 +0,0 @@
-import { describe, expect, it, vi } from 'vitest';
-import { getPreferredCodecs } from '../codecs';
-import './mocks/webrtc.mocks';
-
-describe('codecs', () => {
-  it('should return preferred audio codec', () => {
-    RTCRtpReceiver.getCapabilities = vi.fn().mockReturnValue(audioCodecs);
-    const codecs = getPreferredCodecs('audio', 'red', undefined, 'receiver');
-    expect(codecs).toBeDefined();
-    expect(codecs?.map((c) => c.mimeType)).toEqual([
-      'audio/red',
-      'audio/opus',
-      'audio/G722',
-      'audio/PCMU',
-      'audio/PCMA',
-      'audio/CN',
-      'audio/telephone-event',
-    ]);
-  });
-
-  it('should return preferred video codec', () => {
-    RTCRtpReceiver.getCapabilities = vi.fn().mockReturnValue(videoCodecs);
-    const codecs = getPreferredCodecs('video', 'vp8', undefined, 'receiver');
-    expect(codecs).toBeDefined();
-    // prettier-ignore
-    expect(codecs?.map((c) => [c.mimeType, c.sdpFmtpLine])).toEqual([
-      ['video/VP8', undefined],
-      ['video/H264', 'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=640c1f'],
-      ['video/rtx', undefined],
-      ['video/H264', 'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=42e01f'],
-      ['video/H264', 'level-asymmetry-allowed=1;packetization-mode=0;profile-level-id=640c1f'],
-      ['video/H264', 'level-asymmetry-allowed=1;packetization-mode=0;profile-level-id=42e01f'],
-      ['video/VP9', 'profile-id=0'],
-      ['video/VP9', 'profile-id=2'],
-      ['video/red', undefined],
-      ['video/ulpfec', undefined],
-      ['video/flexfec-03', 'repair-window=10000000'],
-    ]);
-  });
-
-  it('should pick the baseline H264 codec', () => {
-    RTCRtpReceiver.getCapabilities = vi.fn().mockReturnValue(videoCodecs);
-    const codecs = getPreferredCodecs('video', 'h264', undefined, 'receiver');
-    expect(codecs).toBeDefined();
-    // prettier-ignore
-    expect(codecs?.map((c) => [c.mimeType, c.sdpFmtpLine])).toEqual([
-      ['video/H264', 'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=42e01f'],
-      ['video/H264', 'level-asymmetry-allowed=1;packetization-mode=0;profile-level-id=42e01f'],
-      ['video/H264', 'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=640c1f'],
-      ['video/H264', 'level-asymmetry-allowed=1;packetization-mode=0;profile-level-id=640c1f'],
-      ['video/rtx', undefined],
-      ['video/VP8', undefined],
-      ['video/VP9', 'profile-id=0'],
-      ['video/VP9', 'profile-id=2'],
-      ['video/red', undefined],
-      ['video/ulpfec', undefined],
-      ['video/flexfec-03', 'repair-window=10000000'],
-    ]);
-  });
-
-  it('should pick the baseline H264 codec with optional packetization-mode', () => {
-    RTCRtpReceiver.getCapabilities = vi
-      .fn()
-      .mockReturnValue(videoCodecsFirefox);
-    const codecs = getPreferredCodecs('video', 'h264', undefined, 'receiver');
-    expect(codecs).toBeDefined();
-    // prettier-ignore
-    expect(codecs?.map((c) => [c.mimeType, c.sdpFmtpLine])).toEqual([
-      ['video/H264', 'profile-level-id=42e01f;level-asymmetry-allowed=1;packetization-mode=1'],
-      ['video/H264', 'profile-level-id=42e01f;level-asymmetry-allowed=1'],
-      ['video/VP8', 'max-fs=12288;max-fr=60'],
-      ['video/rtx', undefined],
-      ['video/VP9', 'max-fs=12288;max-fr=60'],
-      ['video/ulpfec', undefined],
-      ['video/red', undefined],
-    ]);
-  });
-});
-
-// prettier-ignore
-const videoCodecsFirefox: RTCRtpCapabilities = {
-  codecs: [
-    { mimeType: 'video/VP8', sdpFmtpLine: 'max-fs=12288;max-fr=60', clockRate: 90000 },
-    { mimeType: 'video/rtx', clockRate: 90000 },
-    { mimeType: 'video/VP9', sdpFmtpLine: 'max-fs=12288;max-fr=60', clockRate: 90000 },
-    { mimeType: 'video/H264', sdpFmtpLine: 'profile-level-id=42e01f;level-asymmetry-allowed=1;packetization-mode=1', clockRate: 90000 },
-    { mimeType: 'video/H264', sdpFmtpLine: 'profile-level-id=42e01f;level-asymmetry-allowed=1', clockRate: 90000 },
-    { mimeType: 'video/ulpfec', clockRate: 90000 },
-    { mimeType: 'video/red', clockRate: 90000 },
-  ],
-  headerExtensions: [
-    { uri: 'urn:ietf:params:rtp-hdrext:sdes:mid' },
-    { uri: 'http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time' },
-    { uri: 'urn:ietf:params:rtp-hdrext:toffset' },
-    { uri: 'http://www.webrtc.org/experiments/rtp-hdrext/playout-delay' },
-  ],
-};
-
-// prettier-ignore
-const videoCodecs: RTCRtpCapabilities = {
-  codecs: [
-    { mimeType: 'video/H264', sdpFmtpLine: 'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=640c1f', clockRate: 90000 },
-    { mimeType: 'video/rtx', clockRate: 90000 },
-    { mimeType: 'video/H264', sdpFmtpLine: 'level-asymmetry-allowed=1;packetization-mode=1;profile-level-id=42e01f', clockRate: 90000 },
-    { mimeType: 'video/H264', sdpFmtpLine: 'level-asymmetry-allowed=1;packetization-mode=0;profile-level-id=640c1f', clockRate: 90000 },
-    { mimeType: 'video/H264', sdpFmtpLine: 'level-asymmetry-allowed=1;packetization-mode=0;profile-level-id=42e01f', clockRate: 90000 },
-    { mimeType: 'video/VP8', clockRate: 90000 },
-    { mimeType: 'video/VP9', sdpFmtpLine: 'profile-id=0', clockRate: 90000 },
-    { mimeType: 'video/VP9', sdpFmtpLine: 'profile-id=2', clockRate: 90000 },
-    { mimeType: 'video/red', clockRate: 90000 },
-    { mimeType: 'video/ulpfec', clockRate: 90000 },
-    { mimeType: 'video/flexfec-03', sdpFmtpLine: 'repair-window=10000000', clockRate: 90000 },
-  ],
-  headerExtensions: [
-    { uri: 'urn:ietf:params:rtp-hdrext:toffset' },
-    { uri: 'http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time' },
-    { uri: 'urn:3gpp:video-orientation' },
-    { uri: 'http://www.ietf.org/id/draft-holmer-rmcat-transport-wide-cc-extensions-01' },
-    { uri: 'http://www.webrtc.org/experiments/rtp-hdrext/playout-delay' },
-    { uri: 'http://www.webrtc.org/experiments/rtp-hdrext/video-content-type' },
-    { uri: 'http://www.webrtc.org/experiments/rtp-hdrext/video-timing' },
-    { uri: 'http://www.webrtc.org/experiments/rtp-hdrext/color-space' },
-    { uri: 'urn:ietf:params:rtp-hdrext:sdes:mid' },
-    { uri: 'urn:ietf:params:rtp-hdrext:sdes:rtp-stream-id' },
-    { uri: 'urn:ietf:params:rtp-hdrext:sdes:repaired-rtp-stream-id' },
-  ],
-};
-
-// prettier-ignore
-const audioCodecs: RTCRtpCapabilities = {
-  codecs: [
-    { mimeType: 'audio/opus', sdpFmtpLine: 'minptime=10;useinbandfec=1', clockRate: 48000 },
-    { mimeType: 'audio/red', sdpFmtpLine: '=111/111', clockRate: 48000 },
-    { mimeType: 'audio/G722', clockRate: 8000, channels: 1 },
-    { mimeType: 'audio/PCMU', clockRate: 8000, channels: 1 },
-    { mimeType: 'audio/PCMA', clockRate: 8000, channels: 1 },
-    { mimeType: 'audio/CN', clockRate: 8000, channels: 1 },
-    { mimeType: 'audio/telephone-event', clockRate: 8000, channels: 1 },
-  ],
-  headerExtensions: [
-    { uri: 'urn:ietf:params:rtp-hdrext:ssrc-audio-level' },
-    { uri: 'http://www.webrtc.org/experiments/rtp-hdrext/abs-send-time' },
-    { uri: 'urn:ietf:params:rtp-hdrext:sdes:mid' },
-  ],
-};

package/src/rtc/bitrateLookup.ts

@@ -1,61 +0,0 @@
-import { PreferredCodec } from '../types';
-
-const bitrateLookupTable: Record<
-  PreferredCodec,
-  Record<number | 'default', number | undefined> | undefined
-> = {
-  h264: {
-    2160: 5_000_000,
-    1440: 3_000_000,
-    1080: 2_000_000,
-    720: 1_250_000,
-    540: 750_000,
-    360: 400_000,
-    default: 1_250_000,
-  },
-  vp8: {
-    2160: 5_000_000,
-    1440: 2_750_000,
-    1080: 2_000_000,
-    720: 1_250_000,
-    540: 600_000,
-    360: 350_000,
-    default: 1_250_000,
-  },
-  vp9: {
-    2160: 3_000_000,
-    1440: 2_000_000,
-    1080: 1_500_000,
-    720: 1_250_000,
-    540: 500_000,
-    360: 275_000,
-    default: 1_250_000,
-  },
-  av1: {
-    2160: 2_000_000,
-    1440: 1_550_000,
-    1080: 1_000_000,
-    720: 600_000,
-    540: 350_000,
-    360: 200_000,
-    default: 600_000,
-  },
-};
-
-export const getOptimalBitrate = (
-  codec: PreferredCodec,
-  frameHeight: number,
-): number => {
-  const codecLookup = bitrateLookupTable[codec];
-  if (!codecLookup) throw new Error(`Unknown codec: ${codec}`);
-
-  let bitrate = codecLookup[frameHeight];
-  if (!bitrate) {
-    const keys = Object.keys(codecLookup).map(Number);
-    const nearest = keys.reduce((a, b) =>
-      Math.abs(b - frameHeight) < Math.abs(a - frameHeight) ? b : a,
-    );
-    bitrate = codecLookup[nearest];
-  }
-  return bitrate ?? codecLookup.default!;
-};

package/src/rtc/helpers/iceCandidate.ts

@@ -1,16 +0,0 @@
-import { ICETrickle } from '../../gen/video/sfu/models/models';
-
-export function getIceCandidate(
-  candidate: RTCIceCandidate,
-): ICETrickle['iceCandidate'] {
-  if (!candidate.usernameFragment) {
-    // react-native-webrtc doesn't include usernameFragment in the candidate
-    const splittedCandidate = candidate.candidate.split(' ');
-    const ufragIndex =
-      splittedCandidate.findIndex((s: string) => s === 'ufrag') + 1;
-    const usernameFragment = splittedCandidate[ufragIndex];
-    return JSON.stringify({ ...candidate, usernameFragment });
-  } else {
-    return JSON.stringify(candidate.toJSON());
-  }
-}