Package org.opencastproject.speechtotext.impl.engine

Class WhisperCppEngine

java.lang.Object

org.opencastproject.speechtotext.impl.engine.WhisperCppEngine

All Implemented Interfaces:

SpeechToTextEngine

public class WhisperCppEngine
extends Object
implements SpeechToTextEngine

WhisperC++ implementation of the Speech-to-text engine interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.speechtotext.api.SpeechToTextEngine

SpeechToTextEngine.Result

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_FFMPEG_BINARY	The default path to the ffmpeg binary
static final String	FFMPEG_BINARY_CONFIG_KEY	The key to look for in the service configuration file to override the DEFAULT_FFMPEG_BINARY
protected String	ffmpegBinary	Path to the executable
static final String	WHISPERCPP_EXECUTABLE_DEFAULT_PATH	Default path to WhisperC++.
static final String	WHISPERCPP_MODEL_DEFAULT	Default whispercpp model

Constructor Summary

Constructors

Constructor	Description
WhisperCppEngine()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)
SpeechToTextEngine.Result	generateSubtitlesFile(File mediaFile, File workingDirectory, String language, Boolean translate)	Generates the subtitles file.
String	getEngineName()	Returns the name of the implemented engine.

Methods inherited from class java.lang.Object

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

Field Details

WHISPERCPP_EXECUTABLE_DEFAULT_PATH

public static final String WHISPERCPP_EXECUTABLE_DEFAULT_PATH

Default path to WhisperC++.

See Also:

• Constant Field Values

WHISPERCPP_MODEL_DEFAULT

public static final String WHISPERCPP_MODEL_DEFAULT

Default whispercpp model

See Also:

• Constant Field Values

FFMPEG_BINARY_CONFIG_KEY

public static final String FFMPEG_BINARY_CONFIG_KEY

The key to look for in the service configuration file to override the DEFAULT_FFMPEG_BINARY

See Also:

• Constant Field Values

DEFAULT_FFMPEG_BINARY

public static final String DEFAULT_FFMPEG_BINARY

The default path to the ffmpeg binary

See Also:

• Constant Field Values

ffmpegBinary

protected String ffmpegBinary

Path to the executable

Constructor Details

WhisperCppEngine

public WhisperCppEngine()

Method Details

getEngineName

public String getEngineName()

Description copied from interface: SpeechToTextEngine

Returns the name of the implemented engine.

Specified by:

getEngineName in interface SpeechToTextEngine

Returns:

The name of the implemented engine.

activate

public void activate(org.osgi.service.component.ComponentContext cc)

generateSubtitlesFile

public SpeechToTextEngine.Result generateSubtitlesFile(File mediaFile,
 File workingDirectory,
 String language,
 Boolean translate)
                                                throws SpeechToTextEngineException

Generates the subtitles file.

Specified by:

generateSubtitlesFile in interface SpeechToTextEngine

Parameters:

mediaFile - The media package containing the audio track.

workingDirectory - A unique working directory to safely operate in.

language - The language of the audio track.

translate - If the subtitles should be translated into english

Returns:

Result containing the language code and the subtitles file path.

Throws:

SpeechToTextEngineException - Thrown when an error occurs at the process.

See Also:

• SpeechToTextEngine.generateSubtitlesFile(File, File, String, Boolean)