Class NativeMiniAudioBackend

java.lang.Object

org.episteme.nativ.media.audio.backends.NativeMiniAudioBackend

All Implemented Interfaces:

AudioAlgorithmProvider<AudioBuffer>, AudioBackend, AlgorithmProvider, Backend, ComputeBackend, CPUBackend, NativeBackend

@AutoService({Backend.class,ComputeBackend.class,AudioBackend.class,NativeBackend.class,CPUBackend.class,AudioAlgorithmProvider.class})
public class NativeMiniAudioBackend
extends Object
implements AudioBackend, NativeBackend, CPUBackend

Native Audio Backend using standalone miniaudio library (via Panama FFM). This backend provides direct access to audio hardware.

Since:

1.2

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Constructor Summary

Constructors

Constructor	Description
NativeMiniAudioBackend()

Method Summary

Modifier and Type	Method	Description
ExecutionContext	createContext()	Creates an execution context for running operations.
HardwareAccelerator	getAcceleratorType()	Returns the type of hardware accelerator used by this backend.
String	getAlgorithmType()	Returns the unique category of the algorithm.
String	getBackendName()	Returns the friendly name of this backend instance.
String	getDescription()	Returns a description of the backend.
double	getDuration()
String	getId()	Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").
String	getName()	Returns the display name for UI presentation.
String	getNativeLibraryName()	Returns the name of the native library this backend depends on.
int	getPriority()	Returns the priority for auto-selection (higher = preferred).
float[]	getSpectrum()	Returns the current frequency spectrum.
String	getStatusMessage()	Returns a human-readable status message for this backend.
double	getTime()
String	getType()	Returns the backend type category (e.g., "plotting", "molecular", "tensor", "math").
boolean	isAvailable()	Checks if this backend is currently available (libraries loaded, etc.).
boolean	isLoaded()	Checks if the native library is loaded and available.
void	load(String path)	Loads an audio resource.
void	pause()
void	play()
void	stop()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface AlgorithmProvider

description, getMetadata, score

Methods inherited from interface AudioBackend

apply, createAudio, createBackend, shutdown

Methods inherited from interface Backend

getAlgorithmProviders, isExplicitlyDisabled

Methods inherited from interface CPUBackend

supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Constructor Details

NativeMiniAudioBackend

public NativeMiniAudioBackend()

Method Details

isAvailable

public boolean isAvailable()

Description copied from interface: Backend

Checks if this backend is currently available (libraries loaded, etc.).

Default implementation checks Backend.isExplicitlyDisabled() and returns false if it is.

Specified by:

isAvailable in interface AlgorithmProvider

Specified by:

isAvailable in interface AudioBackend

Specified by:

isAvailable in interface Backend

getStatusMessage

public String getStatusMessage()

Description copied from interface: Backend

Returns a human-readable status message for this backend. Useful for debugging "Unavailable" states.

Specified by:

getStatusMessage in interface Backend

Returns:

status message (e.g., "Ready", "Native library missing", etc.)

getType

public String getType()

Description copied from interface: Backend

Returns the backend type category (e.g., "plotting", "molecular", "tensor", "math").

Specified by:

getType in interface AudioBackend

Specified by:

getType in interface Backend

Specified by:

getType in interface ComputeBackend

Specified by:

getType in interface CPUBackend

getId

public String getId()

Description copied from interface: Backend

Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").

Specified by:

getId in interface AudioBackend

Specified by:

getId in interface Backend

Specified by:

getId in interface ComputeBackend

getDescription

public String getDescription()

Description copied from interface: Backend

Returns a description of the backend.

Specified by:

getDescription in interface AudioBackend

Specified by:

getDescription in interface Backend

Specified by:

getDescription in interface ComputeBackend

getPriority

public int getPriority()

Description copied from interface: Backend

Returns the priority for auto-selection (higher = preferred). Used when multiple backends are available.

Specified by:

getPriority in interface AlgorithmProvider

Specified by:

getPriority in interface AudioBackend

Specified by:

getPriority in interface Backend

getAlgorithmType

public String getAlgorithmType()

Description copied from interface: AlgorithmProvider

Returns the unique category of the algorithm.

Specified by:

getAlgorithmType in interface AlgorithmProvider

Specified by:

getAlgorithmType in interface AudioAlgorithmProvider<AudioBuffer>

isLoaded

public boolean isLoaded()

Description copied from interface: NativeBackend

Checks if the native library is loaded and available.

Specified by:

isLoaded in interface NativeBackend

Returns:

true if the native library has been successfully loaded

getNativeLibraryName

public String getNativeLibraryName()

Description copied from interface: NativeBackend

Returns the name of the native library this backend depends on.

Specified by:

getNativeLibraryName in interface NativeBackend

Returns:

library name (e.g., "openblas", "cuda", "fftw3")

createContext

public ExecutionContext createContext()

Description copied from interface: ComputeBackend

Creates an execution context for running operations.

The context should be used within a try-with-resources block to ensure proper cleanup of resources.

Specified by:

createContext in interface AudioBackend

Specified by:

createContext in interface ComputeBackend

Returns:

new execution context

getAcceleratorType

public HardwareAccelerator getAcceleratorType()

Description copied from interface: ComputeBackend

Returns the type of hardware accelerator used by this backend.

Specified by:

getAcceleratorType in interface AudioBackend

Specified by:

getAcceleratorType in interface ComputeBackend

Specified by:

getAcceleratorType in interface CPUBackend

Returns:

the accelerator type

getName

public String getName()

Description copied from interface: Backend

Returns the display name for UI presentation.

Specified by:

getName in interface AlgorithmProvider

Specified by:

getName in interface AudioAlgorithmProvider<AudioBuffer>

Specified by:

getName in interface AudioBackend

Specified by:

getName in interface Backend

getBackendName

public String getBackendName()

Description copied from interface: AudioBackend

Returns the friendly name of this backend instance.

Specified by:

getBackendName in interface AudioBackend

load

public void load(String path)
          throws Exception

Description copied from interface: AudioBackend

Loads an audio resource.

Specified by:

load in interface AudioBackend

Parameters:

path - File path or URL

Throws:

Exception

play

public void play()

Specified by:

play in interface AudioBackend

pause

public void pause()

Specified by:

pause in interface AudioBackend

stop

public void stop()

Specified by:

stop in interface AudioBackend

getTime

public double getTime()

Specified by:

getTime in interface AudioBackend

getDuration

public double getDuration()

Specified by:

getDuration in interface AudioBackend

getSpectrum

public float[] getSpectrum()

Description copied from interface: AudioBackend

Returns the current frequency spectrum.

Specified by:

getSpectrum in interface AudioBackend

Returns:

Array of magnitudes (usually 128 or 256 bands)