feat: add sharedTexture module to import shared texture (#47317)

feat: add `sharedTexture` module.

lib/browser/api/module-list.ts

@@ -31,6 +31,7 @@ export const browserModuleList: ElectronInternal.ModuleEntry[] = [
   { name: 'screen', loader: () => require('./screen') },
   { name: 'ServiceWorkerMain', loader: () => require('./service-worker-main') },
   { name: 'session', loader: () => require('./session') },
+  { name: 'sharedTexture', loader: () => require('./shared-texture') },
   { name: 'ShareMenu', loader: () => require('./share-menu') },
   { name: 'systemPreferences', loader: () => require('./system-preferences') },
   { name: 'TouchBar', loader: () => require('./touch-bar') },

lib/browser/api/shared-texture.ts

@@ -0,0 +1,191 @@
+import ipcMain from '@electron/internal/browser/api/ipc-main';
+import * as ipcMainInternalUtils from '@electron/internal/browser/ipc-main-internal-utils';
+import { IPC_MESSAGES } from '@electron/internal/common/ipc-messages';
+
+import { randomUUID } from 'crypto';
+
+const transferTimeout = 1000;
+const sharedTextureNative = process._linkedBinding('electron_common_shared_texture');
+const managedSharedTextures = new Map<string, SharedTextureImportedWrapper>();
+
+type AllReleasedCallback = (imported: Electron.SharedTextureImported) => void;
+
+type SharedTextureImportedWrapper = {
+  texture: Electron.SharedTextureImported;
+  allReferencesReleased: AllReleasedCallback | undefined;
+  mainReference: boolean;
+  rendererFrameReferences: Map<number, { count: number, reference: Electron.WebFrameMain }>;
+}
+
+ipcMain.handle(IPC_MESSAGES.IMPORT_SHARED_TEXTURE_RELEASE_RENDERER_TO_MAIN, (event: Electron.IpcMainInvokeEvent, textureId: string) => {
+  const frameTreeNodeId = event.frameTreeNodeId ?? event.sender.mainFrame.frameTreeNodeId;
+  wrapperReleaseFromRenderer(textureId, frameTreeNodeId);
+});
+
+let checkManagedSharedTexturesInterval: NodeJS.Timeout | null = null;
+
+function scheduleCheckManagedSharedTextures () {
+  if (checkManagedSharedTexturesInterval === null) {
+    checkManagedSharedTexturesInterval = setInterval(checkManagedSharedTextures, 1000);
+  }
+}
+
+function unscheduleCheckManagedSharedTextures () {
+  if (checkManagedSharedTexturesInterval !== null) {
+    clearInterval(checkManagedSharedTexturesInterval);
+    checkManagedSharedTexturesInterval = null;
+  }
+}
+
+function checkManagedSharedTextures () {
+  const texturesToRemoveTracking = new Set<string>();
+  for (const [, wrapper] of managedSharedTextures) {
+    for (const [frameTreeNodeId, entry] of wrapper.rendererFrameReferences) {
+      const frame = entry.reference;
+      if (!frame || frame.isDestroyed()) {
+        console.error(`The imported shared texture ${wrapper.texture.textureId} is referenced by a destroyed webContent/webFrameMain, this means a imported shared texture in renderer process is not released before the process is exited. Releasing that dangling reference now.`);
+        wrapper.rendererFrameReferences.delete(frameTreeNodeId);
+      }
+    }
+
+    if (wrapper.rendererFrameReferences.size === 0 && !wrapper.mainReference) {
+      texturesToRemoveTracking.add(wrapper.texture.textureId);
+      wrapper.texture.subtle.release(() => {
+        wrapper.allReferencesReleased?.(wrapper.texture);
+      });
+    }
+  }
+
+  for (const id of texturesToRemoveTracking) {
+    managedSharedTextures.delete(id);
+  }
+
+  if (managedSharedTextures.size === 0) {
+    unscheduleCheckManagedSharedTextures();
+  }
+}
+
+function wrapperReleaseFromRenderer (id: string, frameTreeNodeId: number) {
+  const wrapper = managedSharedTextures.get(id);
+  if (!wrapper) {
+    throw new Error(`Shared texture with id ${id} not found`);
+  }
+
+  const entry = wrapper.rendererFrameReferences.get(frameTreeNodeId);
+  if (!entry) {
+    throw new Error(`Shared texture ${id} is not referenced by renderer frame ${frameTreeNodeId}`);
+  }
+
+  entry.count -= 1;
+  if (entry.count === 0) {
+    wrapper.rendererFrameReferences.delete(frameTreeNodeId);
+  } else {
+    wrapper.rendererFrameReferences.set(frameTreeNodeId, entry);
+  }
+
+  // Actually release the texture if no one is referencing it
+  if (wrapper.rendererFrameReferences.size === 0 && !wrapper.mainReference) {
+    managedSharedTextures.delete(id);
+    wrapper.texture.subtle.release(() => {
+      wrapper.allReferencesReleased?.(wrapper.texture);
+    });
+  }
+}
+
+function wrapperReleaseFromMain (id: string) {
+  const wrapper = managedSharedTextures.get(id);
+  if (!wrapper) {
+    throw new Error(`Shared texture with id ${id} not found`);
+  }
+
+  // Actually release the texture if no one is referencing it
+  wrapper.mainReference = false;
+  if (wrapper.rendererFrameReferences.size === 0) {
+    managedSharedTextures.delete(id);
+    wrapper.texture.subtle.release(() => {
+      wrapper.allReferencesReleased?.(wrapper.texture);
+    });
+  }
+}
+
+async function sendSharedTexture (options: Electron.SendSharedTextureOptions, ...args: any[]) {
+  const imported = options.importedSharedTexture;
+  const transfer = imported.subtle.startTransferSharedTexture();
+
+  let timeoutHandle: NodeJS.Timeout | null = null;
+  const timeoutPromise = new Promise<never>((resolve, reject) => {
+    timeoutHandle = setTimeout(() => {
+      reject(new Error(`transfer shared texture timed out after ${transferTimeout}ms, ensure you have registered receiver at renderer process.`));
+    }, transferTimeout);
+  });
+
+  const targetFrame: Electron.WebFrameMain | undefined = options.frame;
+  if (!targetFrame) {
+    throw new Error('`frame` should be provided');
+  }
+
+  const invokePromise: Promise<Electron.SharedTextureSyncToken> = ipcMainInternalUtils.invokeInWebFrameMain<Electron.SharedTextureSyncToken>(
+    targetFrame,
+    IPC_MESSAGES.IMPORT_SHARED_TEXTURE_TRANSFER_MAIN_TO_RENDERER,
+    transfer,
+    imported.textureId,
+    ...args
+  );
+
+  try {
+    const syncToken = await Promise.race([invokePromise, timeoutPromise]);
+    imported.subtle.setReleaseSyncToken(syncToken);
+
+    const wrapper = managedSharedTextures.get(imported.textureId);
+    if (!wrapper) {
+      throw new Error(`Shared texture with id ${imported.textureId} not found`);
+    }
+
+    const key = targetFrame.frameTreeNodeId;
+    const existing = wrapper.rendererFrameReferences.get(key);
+    if (existing) {
+      existing.count += 1;
+      wrapper.rendererFrameReferences.set(key, existing);
+    } else {
+      wrapper.rendererFrameReferences.set(key, { count: 1, reference: targetFrame });
+    }
+  } finally {
+    if (timeoutHandle) {
+      clearTimeout(timeoutHandle);
+    }
+  }
+
+  // Schedule a check to see if any texture is referenced by any dangling renderer
+  scheduleCheckManagedSharedTextures();
+}
+
+function importSharedTexture (options: Electron.ImportSharedTextureOptions) {
+  const id = randomUUID();
+  const imported = sharedTextureNative.importSharedTexture(Object.assign(options.textureInfo, { id }));
+  const ret: Electron.SharedTextureImported = {
+    textureId: id,
+    subtle: imported,
+    getVideoFrame: imported.getVideoFrame,
+    release: () => {
+      wrapperReleaseFromMain(id);
+    }
+  };
+
+  const wrapper: SharedTextureImportedWrapper = {
+    texture: ret,
+    allReferencesReleased: options.allReferencesReleased,
+    mainReference: true,
+    rendererFrameReferences: new Map()
+  };
+  managedSharedTextures.set(id, wrapper);
+
+  return ret;
+}
+
+const sharedTexture = {
+  subtle: sharedTextureNative,
+  importSharedTexture,
+  sendSharedTexture
+};
+
+export default sharedTexture;

lib/browser/ipc-main-internal-utils.ts

@@ -36,3 +36,27 @@ export function invokeInWebContents<T> (sender: Electron.WebContents, command: s
     sender._sendInternal(command, requestId, ...args);
   });
 }
+
+export function invokeInWebFrameMain<T> (sender: Electron.WebFrameMain, command: string, ...args: any[]) {
+  return new Promise<T>((resolve, reject) => {
+    const requestId = ++nextId;
+    const channel = `${command}_RESPONSE_${requestId}`;
+    const frameTreeNodeId = sender.frameTreeNodeId;
+    ipcMainInternal.on(channel, function handler (event, error: Error, result: any) {
+      if (event.type === 'frame' && event.frameTreeNodeId !== frameTreeNodeId) {
+        console.error(`Reply to ${command} sent by unexpected WebFrameMain (${event.frameTreeNodeId})`);
+        return;
+      }
+
+      ipcMainInternal.removeListener(channel, handler);
+
+      if (error) {
+        reject(error);
+      } else {
+        resolve(result);
+      }
+    });
+
+    sender._sendInternal(command, requestId, ...args);
+  });
+}

lib/common/ipc-messages.ts

@@ -25,4 +25,7 @@ export const enum IPC_MESSAGES {
   INSPECTOR_CONFIRM = 'INSPECTOR_CONFIRM',
   INSPECTOR_CONTEXT_MENU = 'INSPECTOR_CONTEXT_MENU',
   INSPECTOR_SELECT_FILE = 'INSPECTOR_SELECT_FILE',
+
+  IMPORT_SHARED_TEXTURE_TRANSFER_MAIN_TO_RENDERER = 'IMPORT_SHARED_TEXTURE_TRANSFER_MAIN_TO_RENDERER',
+  IMPORT_SHARED_TEXTURE_RELEASE_RENDERER_TO_MAIN = 'IMPORT_SHARED_TEXTURE_RELEASE_RENDERER_TO_MAIN',
 }

lib/renderer/api/module-list.ts

@@ -4,6 +4,7 @@ export const rendererModuleList: ElectronInternal.ModuleEntry[] = [
   { name: 'contextBridge', loader: () => require('./context-bridge') },
   { name: 'crashReporter', loader: () => require('./crash-reporter') },
   { name: 'ipcRenderer', loader: () => require('./ipc-renderer') },
+  { name: 'sharedTexture', loader: () => require('./shared-texture') },
   { name: 'webFrame', loader: () => require('./web-frame') },
   { name: 'webUtils', loader: () => require('./web-utils') }
 ];

lib/renderer/api/shared-texture.ts

@@ -0,0 +1,45 @@
+import { IPC_MESSAGES } from '@electron/internal/common/ipc-messages';
+import ipcRenderer from '@electron/internal/renderer/api/ipc-renderer';
+import { ipcRendererInternal } from '@electron/internal/renderer/ipc-renderer-internal';
+
+const sharedTextureNative = process._linkedBinding('electron_common_shared_texture');
+const transferChannelName = IPC_MESSAGES.IMPORT_SHARED_TEXTURE_TRANSFER_MAIN_TO_RENDERER;
+
+type SharedTextureReceiverCallback = (data: Electron.ReceivedSharedTextureData, ...args: any[]) => Promise<void>;
+let sharedTextureReceiverCallback: SharedTextureReceiverCallback | null = null;
+
+ipcRendererInternal.on(transferChannelName, async (event, requestId, ...args) => {
+  const replyChannel = `${transferChannelName}_RESPONSE_${requestId}`;
+  try {
+    const transfer = args[0] as Electron.SharedTextureTransfer;
+    const textureId = args[1] as string;
+    const imported = sharedTextureNative.finishTransferSharedTexture(Object.assign(transfer, { id: textureId }));
+    const syncToken = imported.getFrameCreationSyncToken();
+    event.sender.send(replyChannel, null, syncToken);
+
+    const wrapper: Electron.SharedTextureImported = {
+      textureId,
+      subtle: imported,
+      getVideoFrame: imported.getVideoFrame,
+      release: () => {
+        imported.release(async () => {
+          await ipcRenderer.invoke(IPC_MESSAGES.IMPORT_SHARED_TEXTURE_RELEASE_RENDERER_TO_MAIN, textureId);
+        });
+      }
+    };
+
+    const data: Electron.ReceivedSharedTextureData = { importedSharedTexture: wrapper };
+    await sharedTextureReceiverCallback?.(data, ...args.slice(2));
+  } catch (error) {
+    event.sender.send(replyChannel, error);
+  }
+});
+
+const sharedTexture = {
+  subtle: sharedTextureNative,
+  setSharedTextureReceiver: (callback: SharedTextureReceiverCallback) => {
+    sharedTextureReceiverCallback = callback;
+  }
+};
+
+export default sharedTexture;

lib/sandboxed_renderer/api/module-list.ts

@@ -15,6 +15,10 @@ export const moduleList: ElectronInternal.ModuleEntry[] = [
     name: 'nativeImage',
     loader: () => require('@electron/internal/common/api/native-image')
   },
+  {
+    name: 'sharedTexture',
+    loader: () => require('@electron/internal/renderer/api/shared-texture')
+  },
   {
     name: 'webFrame',
     loader: () => require('@electron/internal/renderer/api/web-frame')