Index

A B C D E F G I L M N O P R S T U V W
All Classes and Interfaces|All Packages

A

assertAvailable(WhisperJNI.WhisperJNIPointer) - Static method in class io.github.givimad.whisperjni.WhisperJNI.WhisperJNIPointer

Asserts the provided pointer is still available.

assertValidGrammar(String) - Static method in class io.github.givimad.whisperjni.WhisperGrammar

Java implementation of a whisper.cpp grammar validator.

assertValidGrammar(Path) - Static method in class io.github.givimad.whisperjni.WhisperGrammar

Java implementation of a GBNF grammar validator.

audioCtx - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Overwrite the audio context size (0 = use default)

B

beamSearchBeamSize - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Specific to bean search sampling strategy

beamSearchPatience - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Specific to bean search sampling strategy

BEAN_SEARCH - Enum constant in enum io.github.givimad.whisperjni.WhisperSamplingStrategy

Similar to OpenAI's BeamSearchDecoder

C

close() - Method in class io.github.givimad.whisperjni.WhisperContext

close() - Method in class io.github.givimad.whisperjni.WhisperGrammar

close() - Method in class io.github.givimad.whisperjni.WhisperState

D

detectLanguage - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Detect language

durationMs - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Audio duration to process in ms

E

entropyThold - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Refer to library

extractLibraryFromJar(String, String, WhisperJNI.LibraryLogger) - Static method in class io.github.givimad.whisperjni.internal.LibraryUtils

Loads library from current JAR archive The file from JAR is copied into system temporary directory and then loaded.

F

free(WhisperContext) - Method in class io.github.givimad.whisperjni.WhisperJNI

Release context memory in native implementation.

free(WhisperGrammar) - Method in class io.github.givimad.whisperjni.WhisperJNI

Release grammar memory in native implementation.

free(WhisperState) - Method in class io.github.givimad.whisperjni.WhisperJNI

Release state memory in native implementation.

full(WhisperContext, WhisperFullParams, float[], int) - Method in class io.github.givimad.whisperjni.WhisperJNI

Run whisper.cpp full audio transcription.

fullGetSegmentText(WhisperContext, int) - Method in class io.github.givimad.whisperjni.WhisperJNI

Gets text segment by index.

fullGetSegmentTextFromState(WhisperState, int) - Method in class io.github.givimad.whisperjni.WhisperJNI

Gets text segment by index.

fullGetSegmentTimestamp0(WhisperContext, int) - Method in class io.github.givimad.whisperjni.WhisperJNI

Gets start timestamp of text segment by index.

fullGetSegmentTimestamp0FromState(WhisperState, int) - Method in class io.github.givimad.whisperjni.WhisperJNI

Gets start timestamp of text segment by index.

fullGetSegmentTimestamp1(WhisperContext, int) - Method in class io.github.givimad.whisperjni.WhisperJNI

Gets end timestamp of text segment by index.

fullGetSegmentTimestamp1FromState(WhisperState, int) - Method in class io.github.givimad.whisperjni.WhisperJNI

Gets end timestamp of text segment by index.

fullNSegments(WhisperContext) - Method in class io.github.givimad.whisperjni.WhisperJNI

Gets the available number of text segments.

fullNSegmentsFromState(WhisperState) - Method in class io.github.givimad.whisperjni.WhisperJNI

Gets the available number of text segments.

fullWithState(WhisperContext, WhisperState, WhisperFullParams, float[], int) - Method in class io.github.givimad.whisperjni.WhisperJNI

Run whisper.cpp full audio transcription.

G

getSystemInfo() - Method in class io.github.givimad.whisperjni.WhisperJNI

Get whisper.cpp system info stream, to check enabled features in whisper.

grammar - Variable in class io.github.givimad.whisperjni.WhisperFullParams

GBNF grammar.

grammarPenalty - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Penalty for non grammar tokens.

GREEDY - Enum constant in enum io.github.givimad.whisperjni.WhisperSamplingStrategy

Similar to OpenAI's GreedyDecoder

greedyBestOf - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Specific to greedy sampling strategy

I

init(Path) - Method in class io.github.givimad.whisperjni.WhisperJNI

Creates a new whisper context.

init(Path, WhisperContextParams) - Method in class io.github.givimad.whisperjni.WhisperJNI

Creates a new whisper context.

initialPrompt - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Initial prompt

initNoState(Path) - Method in class io.github.givimad.whisperjni.WhisperJNI

Creates a new whisper context without state.

initNoState(Path, WhisperContextParams) - Method in class io.github.givimad.whisperjni.WhisperJNI

Creates a new whisper context without state.

initOpenVINO(WhisperContext, String) - Method in class io.github.givimad.whisperjni.WhisperJNI

Initializes OpenVino encoder.

initState(WhisperContext) - Method in class io.github.givimad.whisperjni.WhisperJNI

Creates a new whisper.cpp state for the provided context.

io.github.givimad.whisperjni - package io.github.givimad.whisperjni

io.github.givimad.whisperjni.internal - package io.github.givimad.whisperjni.internal

isMultilingual(WhisperContext) - Method in class io.github.givimad.whisperjni.WhisperJNI

Is multilingual.

isReleased() - Method in class io.github.givimad.whisperjni.WhisperJNI.WhisperJNIPointer

Return true if native memory is free

L

language - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Language

lengthPenalty - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Refer to library

LibraryUtils - Class in io.github.givimad.whisperjni.internal

loadLibrary() - Static method in class io.github.givimad.whisperjni.WhisperJNI

Register the native library, should be called at first.

loadLibrary(WhisperJNI.LoadOptions) - Static method in class io.github.givimad.whisperjni.internal.LibraryUtils

Register the native library, should be called at first.

loadLibrary(WhisperJNI.LoadOptions) - Static method in class io.github.givimad.whisperjni.WhisperJNI

Register the native library, should be called at first.

LoadOptions() - Constructor for class io.github.givimad.whisperjni.WhisperJNI.LoadOptions

log(String) - Method in interface io.github.givimad.whisperjni.WhisperJNI.LibraryLogger

log(String) - Static method in class io.github.givimad.whisperjni.WhisperJNI

Called from the cpp side of the library to proxy the whisper.cpp logs.

logger - Variable in class io.github.givimad.whisperjni.WhisperJNI.LoadOptions

Logs the library registration process (platform detection and library extraction).

logprobThold - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Refer to library

M

maxInitialTs - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Refer to library

N

nMaxTextCtx - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Max tokens to use from past text as prompt for the decoder

noContext - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Do not use past transcription (if any) as initial prompt for the decoder

noSpeechThold - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Refer to library

noTimestamps - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Do not generate timestamps

nThreads - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Number of thread, 0 for max cores

O

offsetMs - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Start offset in ms

P

parseGrammar(String) - Method in class io.github.givimad.whisperjni.WhisperJNI

parseGrammar(Path) - Method in class io.github.givimad.whisperjni.WhisperJNI

printProgress - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Print progress information

printRealtime - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Print results from within whisper.cpp (avoid it, use callback instead)

printSpecial - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Print special tokens

printTimestamps - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Print timestamps for each text segment when printing realtime

R

ref - Variable in class io.github.givimad.whisperjni.WhisperJNI.WhisperJNIPointer

Native pointer reference identifier.

release() - Method in class io.github.givimad.whisperjni.WhisperJNI.WhisperJNIPointer

Mark the point as released

S

setLibraryLogger(WhisperJNI.LibraryLogger) - Static method in class io.github.givimad.whisperjni.WhisperJNI

Proxy whisper.cpp logger.

singleSegment - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Force single segment output (useful for streaming)

speedUp - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Speed-up the audio by 2x using Phase Vocoder

suppressBlank - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Decoder option

suppressNonSpeechTokens - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Tokenizer option

T

temperature - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Initial decoding temperature

temperatureInc - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Refer to library

translate - Variable in class io.github.givimad.whisperjni.WhisperFullParams

Translate

U

useGPU - Variable in class io.github.givimad.whisperjni.WhisperContextParams

Enables GPU usage.

V

valueOf(String) - Static method in enum io.github.givimad.whisperjni.WhisperSamplingStrategy

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.github.givimad.whisperjni.WhisperSamplingStrategy

Returns an array containing the constants of this enum type, in the order they are declared.

W

WhisperContext - Class in io.github.givimad.whisperjni

The WhisperContext class represents a native whisper.cpp context.

WhisperContext(WhisperJNI, int) - Constructor for class io.github.givimad.whisperjni.WhisperContext

Internal context constructor

WhisperContextParams - Class in io.github.givimad.whisperjni

The WhisperContextParams class contains the WhisperContext params.

WhisperContextParams() - Constructor for class io.github.givimad.whisperjni.WhisperContextParams

Public constructor.

WhisperFullParams - Class in io.github.givimad.whisperjni

The WhisperFullParams instances needed to configure full whisper execution

WhisperFullParams() - Constructor for class io.github.givimad.whisperjni.WhisperFullParams

Creates a new WhisperFullParams instance using the greedy WhisperSamplingStrategy

WhisperFullParams(WhisperSamplingStrategy) - Constructor for class io.github.givimad.whisperjni.WhisperFullParams

Creates a new WhisperFullParams instance using the provided WhisperSamplingStrategy

WhisperGrammar - Class in io.github.givimad.whisperjni

The WhisperGrammar class represents a native whisper.cpp parsed grammar.

WhisperGrammar(WhisperJNI, int, String) - Constructor for class io.github.givimad.whisperjni.WhisperGrammar

Internal context constructor

WhisperJNI - Class in io.github.givimad.whisperjni

The WhisperJNI class allows to use whisper.cpp thought the JNI.

WhisperJNI() - Constructor for class io.github.givimad.whisperjni.WhisperJNI

WhisperJNI.LibraryLogger - Interface in io.github.givimad.whisperjni

The class WhisperJNI.LibraryLogger allows to proxy the whisper.cpp logger.

WhisperJNI.LoadOptions - Class in io.github.givimad.whisperjni

The class WhisperJNI.LoadOptions allows to customize the load of the required shared libraries.

WhisperJNI.WhisperJNIPointer - Class in io.github.givimad.whisperjni

In order to avoid sharing pointers between the c++ and java, we use this util base class which holds a random integer id generated in the whisper.cpp wrapper.

whisperJNILib - Variable in class io.github.givimad.whisperjni.WhisperJNI.LoadOptions

Path to whisper jni library (so/dll/dylib).

WhisperJNIPointer(int) - Constructor for class io.github.givimad.whisperjni.WhisperJNI.WhisperJNIPointer

Creates a new object used to represent a struct pointer on the native library.

whisperLib - Variable in class io.github.givimad.whisperjni.WhisperJNI.LoadOptions

Path to whisper library (so/dylib).

WhisperSamplingStrategy - Enum in io.github.givimad.whisperjni

The WhisperContext enum to configure whisper's sampling strategy

WhisperState - Class in io.github.givimad.whisperjni

The WhisperState represents a whisper_state, useful for thread safe context sharing.

WhisperState(WhisperJNI, int, WhisperContext) - Constructor for class io.github.givimad.whisperjni.WhisperState

The internal constructor for WhisperState

A B C D E F G I L M N O P R S T U V W
All Classes and Interfaces|All Packages