Class NativeOpenCLVisionBackend

java.lang.Object

org.episteme.nativ.media.vision.backends.NativeOpenCLVisionBackend

All Implemented Interfaces:

VisionAlgorithmProvider<BufferedImage>, VisionBackend, AlgorithmProvider, Backend, ComputeBackend, GPUBackend, NativeBackend

@AutoService({Backend.class,ComputeBackend.class,VisionBackend.class,VisionAlgorithmProvider.class,GPUBackend.class,NativeBackend.class})
public class NativeOpenCLVisionBackend
extends Object
implements VisionBackend, GPUBackend, NativeBackend

OpenCL-accelerated Vision Backend.

This class handles GPU-accelerated image processing using OpenCL. Implements GPUBackend and NativeBackend.

Since:

2.0

Author:

Silvere Martin-Michiellot, Gemini AI (Google DeepMind)

Nested Class Summary

Nested classes/interfaces inherited from interface GPUBackend

GPUBackend.DeviceInfo

Constructor Summary

Constructors

Constructor	Description
NativeOpenCLVisionBackend()

Method Summary

Modifier and Type	Method	Description
long	allocateGPUMemory(long sizeBytes)	Allocates GPU memory and returns a handle.
BufferedImage	apply(BufferedImage image, ImageOp<BufferedImage> op)	Applies a generic operation to an image.
void	copyFromGPU(long gpuHandle, DoubleBuffer hostBuffer, long sizeBytes)	Copies data from GPU to host.
void	copyToGPU(long gpuHandle, DoubleBuffer hostBuffer, long sizeBytes)	Copies data from host to GPU.
ExecutionContext	createContext()	Creates an execution context for running operations.
BufferedImage	createImage(Object data, int width, int height)	Creates a new image from the given data.
SceneTransitionDetector.Transition	detectMotion(float[][] prev, float[][] curr, float threshold)
void	freeGPUMemory(long gpuHandle)	Frees GPU memory.
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.
GPUBackend.DeviceInfo[]	getDevices()	Returns information about available GPU devices.
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).
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	isExplicitlyDisabled()	Checks if this backend is specifically disabled via a system property: "episteme.backend.disable." + getId().
boolean	isLoaded()	Checks if the native library is loaded and available.
void	matrixMultiply(DoubleBuffer A, DoubleBuffer B, DoubleBuffer C, int m, int n, int k)	Performs matrix multiplication C = A * B on the GPU.
void	selectDevice(int deviceId)	Selects a GPU device for computation.
void	shutdown()	Called when the application is shutting down or the backend is being replaced.
void	synchronize()	Synchronizes GPU execution (waits for all kernels to complete).

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

Methods inherited from interface ComputeBackend

supportsComplexNumbers, supportsFloatingPoint, supportsParallelOps

Methods inherited from interface VisionAlgorithmProvider

getAlgorithmType

Methods inherited from interface VisionBackend

createBackend

Constructor Details

NativeOpenCLVisionBackend

public NativeOpenCLVisionBackend()

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 VisionBackend

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 VisionBackend

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 VisionBackend

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 VisionBackend

isExplicitlyDisabled

public boolean isExplicitlyDisabled()

Description copied from interface: Backend

Checks if this backend is specifically disabled via a system property: "episteme.backend.disable." + getId().

It also checks specialized properties like "episteme.linearalgebra.disable." + getId().

Specified by:

isExplicitlyDisabled in interface Backend

Returns:

true if explicitly disabled

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 VisionBackend

apply

public BufferedImage apply(BufferedImage image,
 ImageOp<BufferedImage> op)

Description copied from interface: VisionAlgorithmProvider

Applies a generic operation to an image.

Specified by:

apply in interface VisionAlgorithmProvider<BufferedImage>

createImage

public BufferedImage createImage(Object data,
 int width,
 int height)

Description copied from interface: VisionAlgorithmProvider

Creates a new image from the given data.

Specified by:

createImage in interface VisionAlgorithmProvider<BufferedImage>

getBackendName

public String getBackendName()

Description copied from interface: VisionBackend

Returns the friendly name of this backend instance.

Specified by:

getBackendName in interface VisionBackend

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 Backend

Specified by:

getName in interface VisionAlgorithmProvider<BufferedImage>

Specified by:

getName in interface VisionBackend

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 Backend

Specified by:

getPriority in interface VisionBackend

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 VisionBackend

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 VisionBackend

Returns:

new execution context

detectMotion

public SceneTransitionDetector.Transition detectMotion(float[][] prev,
 float[][] curr,
 float threshold)

getDevices

public GPUBackend.DeviceInfo[] getDevices()

Description copied from interface: GPUBackend

Returns information about available GPU devices.

Specified by:

getDevices in interface GPUBackend

selectDevice

public void selectDevice(int deviceId)

Description copied from interface: GPUBackend

Selects a GPU device for computation.

Specified by:

selectDevice in interface GPUBackend

Parameters:

deviceId - Device index (0-based)

allocateGPUMemory

public long allocateGPUMemory(long sizeBytes)

Description copied from interface: GPUBackend

Allocates GPU memory and returns a handle.

Specified by:

allocateGPUMemory in interface GPUBackend

Parameters:

sizeBytes - Size in bytes

Returns:

GPU memory handle (opaque pointer)

copyToGPU

public void copyToGPU(long gpuHandle,
 DoubleBuffer hostBuffer,
 long sizeBytes)

Description copied from interface: GPUBackend

Copies data from host to GPU.

Specified by:

copyToGPU in interface GPUBackend

Parameters:

gpuHandle - GPU memory handle

hostBuffer - Host buffer

sizeBytes - Number of bytes to copy

copyFromGPU

public void copyFromGPU(long gpuHandle,
 DoubleBuffer hostBuffer,
 long sizeBytes)

Description copied from interface: GPUBackend

Copies data from GPU to host.

Specified by:

copyFromGPU in interface GPUBackend

Parameters:

gpuHandle - GPU memory handle

hostBuffer - Host buffer

sizeBytes - Number of bytes to copy

freeGPUMemory

public void freeGPUMemory(long gpuHandle)

Description copied from interface: GPUBackend

Frees GPU memory.

Specified by:

freeGPUMemory in interface GPUBackend

Parameters:

gpuHandle - GPU memory handle

synchronize

public void synchronize()

Description copied from interface: GPUBackend

Synchronizes GPU execution (waits for all kernels to complete).

Specified by:

synchronize in interface GPUBackend

matrixMultiply

public void matrixMultiply(DoubleBuffer A,
 DoubleBuffer B,
 DoubleBuffer C,
 int m,
 int n,
 int k)

Description copied from interface: GPUBackend

Performs matrix multiplication C = A * B on the GPU. Dimensions: A(m x k), B(k x n), C(m x n).

Specified by:

matrixMultiply in interface GPUBackend