Interface AudioBackend

All Superinterfaces:

AlgorithmProvider, AudioAlgorithmProvider<AudioBuffer>, Backend, ComputeBackend

All Known Implementing Classes:

JavaCVMediaBackend, JavaSoundAudioBackend, MinimAudioBackend, MulticoreAudioBackend, NativeJavaCVMediaBackend, NativeMiniAudioBackend, TarsosAudioBackend, VLCJMediaBackend

public interface AudioBackend
extends ComputeBackend, AudioAlgorithmProvider<AudioBuffer>

Universal interface for audio backends (standard, scientific, creative).

Extends ComputeBackend to integrate with the standard backend discovery system (BackendDiscovery).

Since:

1.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Method Summary

Modifier and Type	Method	Description
default AudioBuffer	apply(AudioBuffer audio, AudioOp<AudioBuffer> op)	Applies an operation to audio data.
default AudioBuffer	createAudio(Object data, int channels, int sampleRate)
default Object	createBackend()	Creates and returns the backend instance (or returns self if it is the backend).
default ExecutionContext	createContext()	Creates an execution context for running operations.
default HardwareAccelerator	getAcceleratorType()	Returns the type of hardware accelerator used by this backend.
String	getBackendName()	Returns the friendly name of this backend instance.
default String	getDescription()	Returns a description of the backend.
double	getDuration()
default String	getId()	Returns the unique identifier for this backend (e.g., "javafx", "jmol", "cuda").
default String	getName()	Returns the display name for UI presentation.
default int	getPriority()	Returns the priority for auto-selection (higher = preferred).
float[]	getSpectrum()	Returns the current frequency spectrum.
double	getTime()
default String	getType()	Returns the backend type category (e.g., "plotting", "molecular", "tensor", "math").
default boolean	isAvailable()	Checks if this backend is currently available (libraries loaded, etc.).
void	load(String path)	Loads an audio resource.
void	pause()
void	play()
default void	shutdown()	Called when the application is shutting down or the backend is being replaced.
void	stop()

Methods inherited from interface AlgorithmProvider

description, getMetadata, score

Methods inherited from interface AudioAlgorithmProvider

getAlgorithmType

Methods inherited from interface Backend

getAlgorithmProviders, getStatusMessage, isExplicitlyDisabled

Methods inherited from interface ComputeBackend

supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Method Details

getType

default String getType()

Description copied from interface: Backend

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

Specified by:

getType in interface Backend

Specified by:

getType in interface ComputeBackend

createContext

default 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 ComputeBackend

Returns:

new execution context

getAcceleratorType

default HardwareAccelerator getAcceleratorType()

Description copied from interface: ComputeBackend

Returns the type of hardware accelerator used by this backend.

Specified by:

getAcceleratorType in interface ComputeBackend

Returns:

the accelerator type

getId

default String getId()

Description copied from interface: Backend

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

Specified by:

getId in interface Backend

Specified by:

getId in interface ComputeBackend

getName

default 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 Backend

getDescription

default String getDescription()

Description copied from interface: Backend

Returns a description of the backend.

Specified by:

getDescription in interface Backend

Specified by:

getDescription in interface ComputeBackend

isAvailable

default 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 Backend

getPriority

default 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 Backend

shutdown

default void shutdown()

Description copied from interface: Backend

Called when the application is shutting down or the backend is being replaced. Use this to release hardware resources, close file handles, or stop background threads.

Specified by:

shutdown in interface AlgorithmProvider

Specified by:

shutdown in interface Backend

createBackend

default Object createBackend()

Description copied from interface: Backend

Creates and returns the backend instance (or returns self if it is the backend).

Specified by:

createBackend in interface Backend

Specified by:

createBackend in interface ComputeBackend

Returns:

The backend implementation object

load

void load(String path)
   throws Exception

Loads an audio resource.

Parameters:

path - File path or URL

Throws:

Exception

play

void play()

pause

void pause()

stop

void stop()

getTime

double getTime()

getDuration

double getDuration()

getSpectrum

float[] getSpectrum()

Returns the current frequency spectrum.

Returns:

Array of magnitudes (usually 128 or 256 bands)

getBackendName

String getBackendName()

Returns the friendly name of this backend instance.

apply

default AudioBuffer apply(AudioBuffer audio,
 AudioOp<AudioBuffer> op)

Description copied from interface: AudioAlgorithmProvider

Applies an operation to audio data.

Specified by:

apply in interface AudioAlgorithmProvider<AudioBuffer>

createAudio

default AudioBuffer createAudio(Object data,
 int channels,
 int sampleRate)

Specified by:

createAudio in interface AudioAlgorithmProvider<AudioBuffer>