Class NativeVideoBackend

java.lang.Object

org.episteme.nativ.media.video.backends.NativeVideoBackend

All Implemented Interfaces:

VideoAlgorithmProvider, VideoBackend, AlgorithmProvider, Backend, ComputeBackend, CPUBackend, NativeBackend

@AutoService({Backend.class,ComputeBackend.class,VideoBackend.class,CPUBackend.class,NativeBackend.class})
public class NativeVideoBackend
extends Object
implements VideoBackend, CPUBackend, NativeBackend

Native Video Backend using Project Panama (FFM API).

Since:

1.2

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Constructor Summary

Constructors

Constructor	Description
NativeVideoBackend()

Method Summary

Modifier and Type	Method	Description
Object	createBackend()	Creates and returns the backend instance (or returns self if it is the backend).
ExecutionContext	createContext()	Creates an execution context for running operations.
HardwareAccelerator	getAcceleratorType()	Returns the type of hardware accelerator used by this backend.
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	getNativeLibraryName()	Returns the name of the native library this backend depends on.
double	getTime()
String	getType()	Returns the backend type category (e.g., "plotting", "molecular", "tensor", "math").
<T> T	grabFrame()	Grabs the current frame as an image.
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 a video resource.
void	pause()
void	play()
void	shutdown()	Called when the application is shutting down or the backend is being replaced.
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 Backend

getAlgorithmProviders, getStatusMessage, isExplicitlyDisabled

Methods inherited from interface CPUBackend

supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Methods inherited from interface VideoAlgorithmProvider

detectMotion, detectTransitions, getAlgorithmType

Methods inherited from interface VideoBackend

getName, getPriority

Constructor Details

NativeVideoBackend

public NativeVideoBackend()

Method Details

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")

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 Backend

Specified by:

getType in interface ComputeBackend

Specified by:

getType in interface CPUBackend

Specified by:

getType in interface VideoBackend

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 Backend

Specified by:

getId in interface ComputeBackend

Specified by:

getId in interface VideoBackend

getBackendName

public String getBackendName()

Description copied from interface: VideoBackend

Returns the friendly name of this backend instance.

Specified by:

getBackendName in interface VideoBackend

getDescription

public 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

Specified by:

getDescription in interface VideoBackend

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 Backend

Specified by:

isAvailable in interface VideoBackend

shutdown

public 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

Specified by:

shutdown in interface VideoBackend

createBackend

public 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

Specified by:

createBackend in interface VideoBackend

Returns:

The backend implementation object

load

public void load(String path)
          throws Exception

Description copied from interface: VideoBackend

Loads a video resource.

Specified by:

load in interface VideoBackend

Parameters:

path - File path or URL

Throws:

Exception

play

public void play()

Specified by:

play in interface VideoBackend

pause

public void pause()

Specified by:

pause in interface VideoBackend

stop

public void stop()

Specified by:

stop in interface VideoBackend

getTime

public double getTime()

Specified by:

getTime in interface VideoBackend

getDuration

public double getDuration()

Specified by:

getDuration in interface VideoBackend

grabFrame

public <T> T grabFrame()

Description copied from interface: VideoBackend

Grabs the current frame as an image.

Specified by:

grabFrame in interface VideoBackend

Type Parameters:

T - the image type

Returns:

the current frame

getAcceleratorType

public HardwareAccelerator getAcceleratorType()

Description copied from interface: ComputeBackend

Returns the type of hardware accelerator used by this backend.

Specified by:

getAcceleratorType in interface ComputeBackend

Specified by:

getAcceleratorType in interface CPUBackend

Specified by:

getAcceleratorType in interface VideoBackend

Returns:

the accelerator type

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 ComputeBackend

Specified by:

createContext in interface VideoBackend

Returns:

new execution context