@4players/odin-plugin-web 1.0.0-alpha.9 → 1.0.1

package/README.md

@@ -14,7 +14,7 @@ Contact us through the listed methods below to receive answers to your questions
 
 Join our official Discord server to chat with us directly and become a part of the 4Players ODIN community.
 
-[![Join us on Discord](https://developers.4players.io/images/join_discord.png)](https://4np.de/discord)
+[![Join us on Discord](https://www.4players.io/images/join_discord.png)](https://4np.de/discord)
 
 ### Twitter
 

package/cmake/dependencies.cmake

@@ -0,0 +1,31 @@
+include(FetchContent)
+
+### Opus audio codec
+
+message(STATUS "Installing Opus audio codec")
+
+set(OPUS_BUILD_SHARED_LIBRARY CACHE BOOL OFF FORCE)
+set(OPUS_BUILD_PROGRAMS CACHE BOOL ON FORCE)
+set(OPUS_BUILD_TESTING CACHE BOOL OFF FORCE)
+set(BUILD_TESTING CACHE BOOL OFF FORCE)
+set(STACK_PROTECTOR_SUPPORTED CACHE BOOL OFF FORCE)
+set(FORTIFY_SOURCE_SUPPORTED CACHE BOOL OFF FORCE)
+
+FetchContent_Declare(
+    opus
+    GIT_REPOSITORY https://gitlab.4players.de/odin/deps/opus.git
+    GIT_TAG        v1.5.2
+)
+FetchContent_MakeAvailable(opus)
+target_link_libraries(${CMAKE_EXECUTABLE_NAME} PUBLIC opus)
+
+### RNN VAD
+
+message(STATUS "Installing RNN VAD")
+
+FetchContent_Declare(
+    rnn_vad
+    GIT_REPOSITORY https://gitlab.4players.de/odin/deps/rnn-vad.git
+)
+FetchContent_MakeAvailable(rnn_vad)
+target_link_libraries(${CMAKE_EXECUTABLE_NAME} PUBLIC rnn_vad)

package/cmake/options.cmake

@@ -0,0 +1,53 @@
+### Set global compiler flags
+
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall")
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -Wall")
+
+### Set compiler flags for the release configuration
+
+set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O3")
+set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -O3")
+set(CMAKE_EXE_LINKER_FLAGS_RELEASE "${CMAKE_EXE_LINKER_FLAGS_RELEASE} -O3")
+
+### Set compiler flags for the debug configuration
+
+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g")
+set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -g")
+set(CMAKE_EXE_LINKER_FLAGS_DEBUG "${CMAKE_EXE_LINKER_FLAGS_DEBUG} -g")
+
+### Conditional logic to include pthread when SharedArrayBuffer is enabled
+
+if(NOT DEFINED SHARED_MEMORY)
+    message(STATUS "Enabling SharedArrayBuffer")
+
+    set(EXPORT_NAME "OdinWasmUnsharedMemory")
+    set(SHARED_MEMORY 0)
+else()
+    message(STATUS "Disabling SharedArrayBuffer")
+
+    set(EXPORT_NAME "OdinWasmSharedMemory")
+    set(SHARED_MEMORY 1)
+
+    set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -pthread")
+    set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -pthread")
+    set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -pthread")
+    set(CMAKE_C_FLAGS_DEBUG "${CMAKE_C_FLAGS_DEBUG} -pthread")
+endif()
+
+### Set flags for WebAssembly target output 
+
+set_target_properties(${CMAKE_EXECUTABLE_NAME} PROPERTIES
+    CXX_STANDARD 20
+    LINK_FLAGS "--bind \
+                -s SHARED_MEMORY=${SHARED_MEMORY} \
+                -s EXPORT_NAME=Load${EXPORT_NAME} \
+                -s MODULARIZE=1 \
+                -s WASM=1 \
+                -s SINGLE_FILE=1 \
+                -s ALLOW_TABLE_GROWTH=1 \
+                -s BINARYEN_ASYNC_COMPILATION=0 \
+                -s FILESYSTEM=0 \
+                -s ENVIRONMENT=web,worker \
+                -s EXPORTED_FUNCTIONS=_malloc,_free \
+                -s EXPORTED_RUNTIME_METHODS=HEAPU8,HEAPF32,HEAPU32,HEAP32"
+)

package/esbuild.config.ts

@@ -0,0 +1,49 @@
+import * as esbuild from 'esbuild';
+import type { BuildOptions } from 'esbuild'; // Optional: for type safety
+
+const packageVersion = process.env.npm_package_version;
+const distPath = 'dist/plugin';
+
+if (!packageVersion) {
+  console.error(
+    'Error: npm_package_version is not set. Please run this script using an npm script (e.g., npm run bundle).'
+  );
+  process.exit(1);
+}
+
+const sharedConfig: BuildOptions = {
+  entryPoints: ['lib/plugin/index.js'],
+  bundle: true,
+  minify: true,
+  platform: 'browser',
+};
+
+async function main() {
+  console.log(`Starting esbuild for version: ${packageVersion}`);
+  try {
+    // IIFE Build
+    let path = `${distPath}/${packageVersion}/odin-plugin.js`;
+    await esbuild.build({
+      ...sharedConfig,
+      format: 'iife',
+      globalName: 'ODIN_PLUGIN',
+      outfile: path,
+    });
+    console.log(`Successfully built: ${path}`);
+    path = `${distPath}/${packageVersion}/odin-plugin.esm.js`;
+    // ESM Build
+    await esbuild.build({
+      ...sharedConfig,
+      format: 'esm',
+      outfile: path,
+    });
+    console.log(`Successfully built: ${path}.js`);
+    console.log('Build completed successfully.');
+  } catch (error) {
+    console.error('Build failed:');
+    console.error(error);
+    process.exit(1);
+  }
+}
+
+main().catch(console.error);

package/lib/plugin/index.d.ts

@@ -1,52 +1,45 @@
-import { ConnectionPool } from './connectionPool';
-import { Backend } from '@4players/odin-common';
-import { AudioCapture, AudioContextFactory, AudioPlayback, CreateAudioCaptureParameters, CreateAudioPlaybackParameters, Device, Volume } from './audioController';
-import { MainConnection } from './mainConnection';
-export type Media = Backend.Media;
-export type JoinRoomParameters = Backend.JoinRoomParameters;
-export interface DeviceParameters {
-    readonly device?: Device;
-    onStatusChanged?: Backend.OnStatusChanged;
+import { Backend, LogRecord, Logger } from '@4players/odin-common';
+
+export type OnLogMessage = (formattedString: string, record: LogRecord) => void;
+export type VifConfig = {
+	enabled: true;
+	attenuationLimit: number;
+	postFilterBeta: number;
+} | {
+	enabled: false;
+};
+export type CreateAudioCaptureParameters = Backend.CreateAudioCaptureParameters & {
+	readonly device?: WebDevice;
+};
+export type AudioContextFactory = (sampleRate: number | undefined) => Promise<AudioContext>;
+export type DeviceInfo = {
+	name: string;
+	deviceId: string;
+	kind: "audioinput" | "audiooutput";
+};
+export interface WebDevice extends Backend.Device {
+	readonly device: DeviceInfo;
 }
-export declare class WebPlugin implements Backend.Plugin {
-    readonly version = "1";
-    private _NextRoomId;
-    private _PlaybackVolume;
-    private readonly _ConnectionPool;
-    private readonly _AudioController;
-    get playbackVolume(): Backend.Volume;
-    static create(audioContextFactory: AudioContextFactory): Promise<WebPlugin>;
-    private constructor();
-    joinRoom(parameters: JoinRoomParameters): Room;
-    createAudioPlayback(parameters: CreateAudioPlaybackParameters): Promise<AudioPlayback>;
-    createAudioCapture(parameters: CreateAudioCaptureParameters): Promise<AudioCapture>;
-    enumerateDevices(): Promise<Device[]>;
-    setOutputVolume(volume: Volume): void;
-    setOutputDevice(device: DeviceParameters): Promise<void>;
-    close(): void;
+export interface WebDeviceParameters extends Backend.DeviceParameters {
+	readonly device?: WebDevice;
+	onStatusChanged?: Backend.OnStatusChanged;
 }
-export declare class Room implements Backend.Room {
-    private readonly _Id;
-    private readonly _Connection;
-    private readonly _OnEvent;
-    private readonly _Captures;
-    private readonly _Playbacks;
-    private readonly _Peers;
-    private readonly _AvailableMediaIds;
-    get mainConnection(): MainConnection | undefined;
-    constructor(id: number, connectionPool: ConnectionPool, parameters: JoinRoomParameters);
-    request(method: string, properties: unknown): Promise<unknown>;
-    link(media: Media): void;
-    unlink(media: Media): void;
-    close(): void;
-    private _HandleEvent;
-    private _HandleKnownEvent;
-    private _HandleConnectionLost;
-    private _HandleRoomUpdate;
-    private _HandleRoomJoined;
-    private _HandlePeerUpdate;
-    private _HandlePeerJoined;
-    private _HandlePeerLeft;
-    private _HandleMediaStart;
-    private _HandleMediaStopped;
+export declare function createPlugin(audioContextFactory: AudioContextFactory, options?: WebPluginOptions): WebPlugin;
+export interface WebPluginOptions {
+	logger?: Logger;
+	onLogMessage?: OnLogMessage;
 }
+export declare const SESSION_ID: string;
+export interface WebPlugin extends Backend.Plugin {
+	joinRoom(parameters: Backend.JoinRoomParameters): WebRoom;
+	enumerateDevices(): Promise<WebDevice[]>;
+	setOutputDevice(device: WebDeviceParameters): Promise<void>;
+	createAudioCapture(parameters: CreateAudioCaptureParameters): Promise<WebAudioCapture>;
+}
+export interface WebRoom extends Backend.Room {
+}
+export interface WebAudioCapture extends Backend.AudioCapture {
+	setVif(config: VifConfig): void;
+}
+
+export {};