@foxglove/extension 2.39.2 → 2.40.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxglove/extension",
-  "version": "2.39.2",
+  "version": "2.40.0",
   "license": "MIT",
   "author": {
     "name": "Foxglove Technologies",

package/src/experimental.ts

@@ -80,6 +80,55 @@ export namespace Experimental {
     source: string;
   };
 
+  /**
+   * The arguments you pass to {@link ExtensionContext.registerVideoDecoder}
+   * when you want to register a custom video decoder.
+   *
+   * @category Video decoders
+   */
+  export type RegisterVideoDecoderArgs = {
+    /**
+     * Builder function that creates decoder instances, provided as a string. The function receives
+     * callbacks for output frames and errors, and returns a decoder backend instance.
+     *
+     * See {@link VideoFrameDecoderBuilder} for the function signature of the builder function,
+     *
+     * IMPORTANT: The factory must be serializable (no imports or external closures). Extensions
+     * must embed or otherwise manage any external resources (e.g., WASM or script assets) required
+     * by the decoder.
+     */
+    decoderBuilderSource: string;
+
+    /** Human-readable name for display in the app interface. */
+    displayName: string;
+
+    /**
+     * Unique identifier for this decoder.
+     *
+     * Must be stable across extension versions and unique across all extensions. Recommended
+     * format: "org.example.decoder-name" or similar namespaced format.
+     */
+    id: string;
+  };
+
+  /**
+   * Abstract video decoder interface that both native VideoDecoder and custom decoders can
+   * implement.
+   *
+   * @category Video decoders
+   */
+  export type VideoFrameDecoder = Pick<
+    VideoDecoder,
+    "close" | "configure" | "decode" | "reset" | "state"
+  >;
+
+  /**
+   * Factory function that creates decoder instances
+   *
+   * @category Video decoders
+   */
+  export type VideoFrameDecoderBuilder = (init: VideoDecoderInit) => VideoFrameDecoder;
+
   export interface ExtensionContext extends BaseExtensionContext {
     /**
      * Register a data loader to add support for additional file formats.
@@ -147,6 +196,14 @@ export namespace Experimental {
      * @param source
      */
     registerUserScriptUtility(args: RegisterUserScriptUtilityArgs): void;
+
+    /**
+     * Register a custom video decoder backend.
+     *
+     * This allows extensions to provide custom video decoders for codecs that may not be supported
+     * by the native WebCodecs API.
+     */
+    registerVideoDecoder(args: RegisterVideoDecoderArgs): void;
   }
 
   export interface ExtensionModule {