@pexip/media 20.3.4 → 21.0.0

package/api-docs/variables/isInitial.mdx

@@ -0,0 +1,3 @@
+```ts
+const isInitial: UserMediaValidator;
+```

package/api-docs/variables/isInitialPermissions.mdx

@@ -0,0 +1,3 @@
+```ts
+const isInitialPermissions: UserMediaValidator;
+```

package/api-docs/variables/isInitialPermissionsGranted.mdx

@@ -0,0 +1,3 @@
+```ts
+const isInitialPermissionsGranted: UserMediaValidator;
+```

package/api-docs/variables/isInitialPermissionsNotGranted.mdx

@@ -0,0 +1,3 @@
+```ts
+const isInitialPermissionsNotGranted: UserMediaValidator;
+```

package/api-docs/variables/isOnlyAudioError.mdx

@@ -0,0 +1,3 @@
+```ts
+const isOnlyAudioError: UserMediaValidator;
+```

package/api-docs/variables/isOnlyVideoError.mdx

@@ -0,0 +1,3 @@
+```ts
+const isOnlyVideoError: UserMediaValidator;
+```

package/api-docs/variables/isOverConstrained.mdx

@@ -0,0 +1,3 @@
+```ts
+const isOverConstrained: UserMediaValidator;
+```

package/api-docs/variables/isPromptAudio.mdx

@@ -0,0 +1,3 @@
+```ts
+const isPromptAudio: UserMediaValidator;
+```

package/api-docs/variables/isPromptVideo.mdx

@@ -0,0 +1,3 @@
+```ts
+const isPromptVideo: UserMediaValidator;
+```

package/api-docs/variables/isRejected.mdx

@@ -0,0 +1,3 @@
+```ts
+const isRejected: UserMediaValidator;
+```

package/api-docs/variables/isRejectedOnlyAudio.mdx

@@ -0,0 +1,3 @@
+```ts
+const isRejectedOnlyAudio: UserMediaValidator;
+```

package/api-docs/variables/isRejectedOnlyVideo.mdx

@@ -0,0 +1,3 @@
+```ts
+const isRejectedOnlyVideo: UserMediaValidator;
+```

package/api-docs/variables/isRequestPermissionNeeded.mdx

@@ -0,0 +1,3 @@
+```ts
+const isRequestPermissionNeeded: UserMediaValidator;
+```

package/api-docs/variables/isUnknownError.mdx

@@ -0,0 +1,3 @@
+```ts
+const isUnknownError: UserMediaValidator;
+```

package/api-docs/variables/isVideoDeviceInUse.mdx

@@ -0,0 +1,3 @@
+```ts
+const isVideoDeviceInUse: UserMediaValidator;
+```

package/dist/constants.d.ts

@@ -6,3 +6,4 @@ export declare const PROCESSOR_LABELS: Readonly<{
 }>;
 export declare const GET_USER_MEDIA_TIMEOUT_MS = 10000;
 export declare const DEVICE_CHANGE_DEBOUNCE_TIMEOUT_MS = 500;
+export declare const MAX_TENT_BLUR_SIZE = 9;

package/dist/constants.js

@@ -6,3 +6,4 @@ export const PROCESSOR_LABELS = Object.freeze({
 });
 export const GET_USER_MEDIA_TIMEOUT_MS = 10000;
 export const DEVICE_CHANGE_DEBOUNCE_TIMEOUT_MS = 500;
+export const MAX_TENT_BLUR_SIZE = 9;

package/dist/index.d.ts

@@ -4,7 +4,7 @@ export * from './signals';
 export * from './status';
 export * from './typeGuard';
 export * from './types';
-export { applyContentHint } from './utils';
+export { applyContentHint, getBlurKernelSize, getTentBlurSize } from './utils';
 export { createAudioMixingProcess } from './audioMixingProcessor';
 export { createAudioStreamProcess } from './audioProcessor';
 export { createMedia } from './media';

package/dist/index.js

@@ -4,7 +4,7 @@ export * from './signals';
 export * from './status';
 export * from './typeGuard';
 export * from './types';
-export { applyContentHint } from './utils';
+export { applyContentHint, getBlurKernelSize, getTentBlurSize } from './utils';
 export { createAudioMixingProcess } from './audioMixingProcessor';
 export { createAudioStreamProcess } from './audioProcessor';
 export { createMedia } from './media';

package/dist/previewController.js

@@ -373,7 +373,7 @@ export const createPreviewStreamController = ({ getCurrentDevices, getCurrentMed
             const audioSettings = extractFeaturesToConstraints(AUDIO_SETTINGS_KEYS, previewAudio);
             // Omit the width & height settings from the preview so that the one
             // from the main can be applied
-            const { width: _width, height: _height, ...videoSettings } = extractFeaturesToConstraints(VIDEO_SETTINGS_KEYS, previewVideo);
+            const { width: _width, height: _height, edgeBlurAmount: _edgeBlurAmount, lightWrapBlurAmount: _lightWrapBlurAmount, backgroundBlurAmount: _backgroundBlurAmount, ...videoSettings } = extractFeaturesToConstraints(VIDEO_SETTINGS_KEYS, previewVideo);
             logger.info({ audioInput, videoInput, audioSettings, videoSettings }, 'Apply changes to main');
             try {
                 await replaceMainStream({

package/dist/types.d.ts

@@ -531,7 +531,7 @@ export interface MediaController {
      */
     tryAndGetUserMedia: (constraints: MediaDeviceRequest) => void;
 }
-export type VideoRenderParams = Omit<RendererOptions, 'effects'> & {
+export type VideoRenderParams = Omit<RendererOptions, 'effects' | 'personCenter'> & {
     /**
      * Target frame rate for the video segmentation
      */
@@ -545,6 +545,8 @@ export type VideoRenderParams = Omit<RendererOptions, 'effects'> & {
     pan?: boolean;
     tilt?: boolean;
     zoom?: boolean;
+    personCenterX?: number;
+    personCenterY?: number;
 };
 export interface MediaChangesSignals {
     onAddTrack: Signal<MediaStreamTrack>;

package/dist/userMedia.d.ts

@@ -11,7 +11,10 @@ export declare const toSameDeviceStatus: ({ audio, video, }: {
     audio: boolean;
     video: boolean;
 }) => UserMediaStatus.PermissionsGranted | UserMediaStatus.PermissionsGrantedFallback | UserMediaStatus.PermissionsGrantedFallbackAudioinput | UserMediaStatus.PermissionsGrantedFallbackVideoinput;
-export declare const toOnlyDeviceStatus: (kind: "audioinput" | "videoinput", matched: boolean, devices: IndexedDevices) => UserMediaStatus.PermissionsRejectedAudioInput | UserMediaStatus.PermissionsRejectedVideoInput | UserMediaStatus.PermissionsOnlyAudioinput | UserMediaStatus.PermissionsOnlyAudioinputNoVideoDevices | UserMediaStatus.PermissionsOnlyAudioinputFallback | UserMediaStatus.PermissionsOnlyAudioinputFallbackNoVideoDevices | UserMediaStatus.PermissionsOnlyVideoinput | UserMediaStatus.PermissionsOnlyVideoinputNoAudioDevices | UserMediaStatus.PermissionsOnlyVideoinputFallback | UserMediaStatus.PermissionsOnlyVideoinputFallbackNoAudioDevices;
+export declare const toOnlyDeviceStatus: (kind: "audioinput" | "videoinput", streamedRequestedDevices: {
+    audio: boolean;
+    video: boolean;
+}, devices: IndexedDevices) => UserMediaStatus.PermissionsRejectedAudioInput | UserMediaStatus.PermissionsRejectedVideoInput | UserMediaStatus.PermissionsOnlyAudioinput | UserMediaStatus.PermissionsOnlyAudioinputNoVideoDevices | UserMediaStatus.PermissionsOnlyAudioinputFallback | UserMediaStatus.PermissionsOnlyAudioinputFallbackNoVideoDevices | UserMediaStatus.PermissionsOnlyVideoinput | UserMediaStatus.PermissionsOnlyVideoinputNoAudioDevices | UserMediaStatus.PermissionsOnlyVideoinputFallback | UserMediaStatus.PermissionsOnlyVideoinputFallbackNoAudioDevices;
 /**
  * Check if there is any track match with the `kind`
  */

package/dist/userMedia.js

@@ -71,12 +71,16 @@ export const toSameDeviceStatus = ({ audio, video, }) => {
     }
     return UserMediaStatus.PermissionsGrantedFallback;
 };
-export const toOnlyDeviceStatus = (kind, matched, devices) => {
-    const hasAnotherTypeOfAuthorizedDevice = devices.anyAuthorizedDevice(kind === 'audioinput' ? 'videoinput' : 'audioinput');
-    const hasAnotherTypeOfDevice = devices.size(kind === 'audioinput' ? 'videoinput' : 'audioinput') > 0;
+export const toOnlyDeviceStatus = (kind, streamedRequestedDevices, devices) => {
+    const [self, other] = kind === 'audioinput' ? ['audio', 'video'] : ['video', 'audio'];
+    const otherKind = kind === 'audioinput' ? 'videoinput' : 'audioinput';
+    const matched = streamedRequestedDevices[self];
+    const anotherDeviceRequested = streamedRequestedDevices[other];
+    const hasAnotherTypeOfAuthorizedDevice = devices.anyAuthorizedDevice(otherKind);
+    const hasAnotherTypeOfDevice = devices.size(otherKind) > 0;
     if (matched) {
         if (hasAnotherTypeOfDevice) {
-            if (hasAnotherTypeOfAuthorizedDevice) {
+            if (hasAnotherTypeOfAuthorizedDevice || !anotherDeviceRequested) {
                 return kind === 'audioinput'
                     ? UserMediaStatus.PermissionsOnlyAudioinput
                     : UserMediaStatus.PermissionsOnlyVideoinput;
@@ -90,7 +94,7 @@ export const toOnlyDeviceStatus = (kind, matched, devices) => {
             : UserMediaStatus.PermissionsOnlyVideoinputNoAudioDevices;
     }
     if (hasAnotherTypeOfDevice) {
-        if (hasAnotherTypeOfAuthorizedDevice) {
+        if (hasAnotherTypeOfAuthorizedDevice || !anotherDeviceRequested) {
             return kind === 'audioinput'
                 ? UserMediaStatus.PermissionsOnlyAudioinputFallback
                 : UserMediaStatus.PermissionsOnlyVideoinputFallback;
@@ -421,10 +425,10 @@ export const requestUserMedia = (getCurrentDevices, getMedia = getUserMedia) =>
                 ? constraints.video
                 : false,
         });
-        const { audio, video } = isStreamingRequestedDevices(constraints, stream, devices);
-        const onlyAudioStatus = toOnlyDeviceStatus('audioinput', audio, devices);
-        const onlyVideoStatus = toOnlyDeviceStatus('videoinput', video, devices);
-        const status = deriveDeviceStatus(onlyAudioStatus, onlyVideoStatus, toSameDeviceStatus({ audio, video }));
+        const streamedRequestedDevices = isStreamingRequestedDevices(constraints, stream, devices);
+        const onlyAudioStatus = toOnlyDeviceStatus('audioinput', streamedRequestedDevices, devices);
+        const onlyVideoStatus = toOnlyDeviceStatus('videoinput', streamedRequestedDevices, devices);
+        const status = deriveDeviceStatus(onlyAudioStatus, onlyVideoStatus, toSameDeviceStatus(streamedRequestedDevices));
         return [stream, status];
     }
     catch (error) {
@@ -521,10 +525,10 @@ export const createGetUserMediaProcess = ({ getCurrentDevices, getUserMedia, sco
                 }));
         }
         const relaxedConstraints = {};
-        if (constraints.audio) {
+        if (constraints.audio !== undefined) {
             relaxedConstraints.audio = relaxInputConstraint('audioinput', constraints.audio, currentDevices);
         }
-        if (constraints.video) {
+        if (constraints.video !== undefined) {
             relaxedConstraints.video = relaxInputConstraint('videoinput', constraints.video, currentDevices);
         }
         const [stream, status] = await getUserMedia(relaxedConstraints);

package/dist/utils.d.ts

@@ -54,17 +54,28 @@ export declare const getSettingsFromKeys: (keys: ExtendedMediaTrackSettingsKey[]
 export declare const diffSettings: (keysToLookFor: ExtendedMediaTrackSettingsKey[]) => (settingsA: ExtendedMediaTrackSettings | undefined, settingsB: ExtendedMediaTrackSettings | undefined) => ExtendedMediaTrackSettings | undefined;
 export declare const mergeSettings: (settingsA: ExtendedMediaTrackSettings | undefined, settingsB: ExtendedMediaTrackSettings | undefined) => ExtendedMediaTrackSettings | undefined;
 /**
- * A function to get the blur kernel size of image height
+ * A function to get the blur kernel size of image height based on
+ * Kawase blur algorithm
  *
- * @param percentage - The percentage of image height to calculate the blur
- * kernel size
- * @param height - The image height
- * @param lowestProcessingHeight - The lowest image height that is processed by the consumer, used to adjust the blur kernel size across different resolutions
+ * @param norm - [0-100] The normalized blur amount
+ * @param heightRef - The reference image height
+ * @param height - The current image height
  * @param max - The upper bound
  *
  * @returns blur kernel size
  */
-export declare const getBlurKernelSize: (percentage: number, height: number, lowestProcessingHeight?: number, max?: number) => number;
+export declare const getBlurKernelSize: (norm: number, heightRef: number, height: number, max?: number) => number;
+/**
+ * A function to get the Tent blur size of image height
+ *
+ * @param norm - [0-100] The normalized blur amount
+ * @param heightRef - The reference image height
+ * @param height - The current image height
+ * @param max - The upper bound
+ *
+ * @returns tent blur size
+ */
+export declare const getTentBlurSize: (norm: number, heightRef: number, height: number, max?: number) => number;
 /**
  * Apply the content hint to the track
  *

package/dist/utils.js

@@ -1,7 +1,8 @@
 import { createStreamTrackEventSubscriptions, createTrackDevicesChanges, extractConstraintsWithKeys, findDeviceFromConstraints, relaxInputConstraint, resolveMediaDeviceConstraints, shouldRequestDevice, toMediaDeviceInputKind, } from '@pexip/media-control';
-import { calculateMaxBlurPass } from '@pexip/media-processor';
+import { calculateMaxBlurPass, clamping, } from '@pexip/media-processor';
 import { hasOwn, assert, isEmpty } from '@pexip/utils';
 import { internalSignals } from './signals';
+import { MAX_TENT_BLUR_SIZE } from './constants';
 export const makeDeriveDeviceStatus = (constraints) => (audio, video, both) => {
     if (constraints.audio) {
         if (constraints.video) {
@@ -684,26 +685,39 @@ export const mergeSettings = (settingsA, settingsB) => {
     }
     return { ...settingsA, ...settingsB };
 };
+const clampNorm = clamping(0, 100);
 /**
- * A function to get the blur kernel size of image height
+ * A function to get the blur kernel size of image height based on
+ * Kawase blur algorithm
  *
- * @param percentage - The percentage of image height to calculate the blur
- * kernel size
- * @param height - The image height
- * @param lowestProcessingHeight - The lowest image height that is processed by the consumer, used to adjust the blur kernel size across different resolutions
+ * @param norm - [0-100] The normalized blur amount
+ * @param heightRef - The reference image height
+ * @param height - The current image height
  * @param max - The upper bound
  *
  * @returns blur kernel size
  */
-export const getBlurKernelSize = (percentage, height, lowestProcessingHeight, max = calculateMaxBlurPass(height)) => {
-    if (height <= 0 || percentage <= 0 || max <= 0) {
+export const getBlurKernelSize = (norm, heightRef, height, max = calculateMaxBlurPass(height)) => {
+    if (height <= 0 || norm <= 0 || max <= 0 || heightRef <= 0) {
         return 0;
     }
-    const minHeightMaxBlurPass = lowestProcessingHeight
-        ? calculateMaxBlurPass(lowestProcessingHeight)
-        : max;
-    return Math.min(Math.ceil(percentage * 0.01 * max) +
-        Math.max(0, max - minHeightMaxBlurPass), max);
+    return clamping(0, max)(Math.round(clampNorm(norm) * 0.01 * max - Math.log2(heightRef / height)));
+};
+/**
+ * A function to get the Tent blur size of image height
+ *
+ * @param norm - [0-100] The normalized blur amount
+ * @param heightRef - The reference image height
+ * @param height - The current image height
+ * @param max - The upper bound
+ *
+ * @returns tent blur size
+ */
+export const getTentBlurSize = (norm, heightRef, height, max = MAX_TENT_BLUR_SIZE) => {
+    if (height <= 0 || norm <= 0 || heightRef <= 0 || max <= 0) {
+        return 0;
+    }
+    return clamping(0, max)(Math.round((norm * 0.01 * max * height) / heightRef));
 };
 /**
  * Apply the content hint to the track

package/dist/videoProcessor.d.ts

@@ -18,7 +18,7 @@ interface VideoStreamProcessOptions extends Partial<VideoRenderParams>, Omit<Pro
      * Whether or to enable this processor
      */
     shouldEnable: () => boolean;
-    lowestProcessingHeight?: number;
+    referenceProcessingHeight?: number;
     processingWidth: number;
     processingHeight: number;
     hasInitializedDeps?: boolean;
@@ -34,9 +34,9 @@ interface VideoStreamProcessProps extends Partial<VideoRenderParams>, Required<P
     hasInitialized: boolean;
     contentHint?: VideoContentHint;
 }
-declare const FEATURE_KEYS: readonly ["backgroundBlurAmount", "backgroundImageUrl", "maskCombineRatio", "edgeBlurAmount", "foregroundThreshold", "frameRate", "videoSegmentation", "videoSegmentationModel", "width", "height", "pan", "tilt", "zoom", "contentHint"];
+declare const FEATURE_KEYS: readonly ["backgroundBlurAmount", "backgroundImageUrl", "backgroundThreshold", "maskCombineRatio", "edgeBlurAmount", "foregroundThreshold", "frameRate", "videoSegmentation", "videoSegmentationModel", "width", "height", "pan", "tilt", "zoom", "contentHint", "sigmaSpace", "sigmaRangeLo", "sigmaRangeHi", "excludeBystanders", "personCenterX", "personCenterY", "morphErodeRadiusPx", "morphPass", "morphDilateRadiusPx", "lightWrapIntensity", "lightWrapTightness", "lightWrapEdgeBand", "lightWrapBlurAmount", "downSampleFactor"];
 type FeaturePropKeys = (typeof FEATURE_KEYS)[number];
 type FeatureProps = Pick<Partial<VideoStreamProcessProps>, FeaturePropKeys>;
 export declare const updateFeatureProps: (constraints: MediaDeviceRequest["video"], props: FeatureProps) => FeatureProps;
-export declare const createVideoStreamProcess: ({ backgroundImageUrl, dynamicProcessingDimensions, edgeBlurAmount, foregroundThreshold, frameRate, gpuAPI, label, lowestProcessingHeight, maskCombineRatio, processingHeight, processingWidth, shouldEnable, stopAsMute, trackProcessorAPI, videoSegmentation, signals, ...options }: VideoStreamProcessOptions) => TrackProcessor;
+export declare const createVideoStreamProcess: ({ backgroundImageUrl, dynamicProcessingDimensions, backgroundThreshold, downSampleFactor, foregroundThreshold, lightWrapEdgeBand, lightWrapIntensity, lightWrapTightness, morphDilateRadiusPx, morphErodeRadiusPx, morphPass, personCenterX, personCenterY, sigmaSpace, sigmaRangeHi, sigmaRangeLo, frameRate, gpuAPI, label, referenceProcessingHeight, maskCombineRatio, processingHeight, processingWidth, shouldEnable, stopAsMute, trackProcessorAPI, videoSegmentation, signals, ...options }: VideoStreamProcessOptions) => TrackProcessor;
 export {};