mirror of
https://github.com/occ-ai/obs-localvocal
synced 2024-11-07 18:57:14 +00:00
refactor: Add transcription-filter-properties.cpp for managing filter… (#138)
* refactor: Add transcription-filter-properties.cpp for managing filter properties * refactor: Add translation_monitor to transcription filter - Add translation_monitor to the transcription filter data structure - Initialize and stop the translation_monitor in the transcription_filter_update function - Update the send_caption_to_source function to use the translation_monitor for sending translated captions - Clear the translation_monitor when disabling buffered output in the transcription_filter_update function * refactor: Simplify UI and improve error handling in transcription filter
This commit is contained in:
Roy Shilkrot
GitHub
parent
3c3b640bdb
commit
44f072b5ff
@ -88,6 +88,7 @@ target_sources(
|
||||
src/transcription-filter.cpp
|
||||
src/transcription-filter.c
|
||||
src/transcription-filter-callbacks.cpp
|
||||
src/transcription-filter-properties.cpp
|
||||
src/transcription-filter-utils.cpp
|
||||
src/transcription-utils.cpp
|
||||
src/model-utils/model-downloader.cpp
|
||||
|
||||
@ -53,7 +53,7 @@ whisper_translate="Translate to English (Whisper)"
|
||||
buffer_size_msec="Buffer size (ms)"
|
||||
overlap_size_msec="Overlap size (ms)"
|
||||
suppress_sentences="Suppress sentences (each line)"
|
||||
translate_output="Translation output"
|
||||
translate_output="Output Destination"
|
||||
dtw_token_timestamps="DTW token timestamps"
|
||||
buffered_output="Buffered output (Experimental)"
|
||||
translate_model="Model"
|
||||
@ -82,3 +82,4 @@ translate_explaination="Enabling translation will increase the processing load o
|
||||
log_group="Logging"
|
||||
advanced_group="Advanced Configuration"
|
||||
buffered_output_parameters="Buffered Output Configuration"
|
||||
file_output_info="Note: Translation output will be saved to a file in the same directory with the target language added to the name, e.g. 'output_es.srt'."
|
||||
|
||||
@ -63,28 +63,38 @@ std::string send_sentence_to_translation(const std::string &sentence,
|
||||
obs_log(LOG_INFO, "Translation: '%s' -> '%s'", sentence.c_str(),
|
||||
translated_text.c_str());
|
||||
}
|
||||
if (gf->translation_output == "none") {
|
||||
// overwrite the original text with the translated text
|
||||
return translated_text;
|
||||
} else {
|
||||
// send the translation to the selected source
|
||||
send_caption_to_source(gf->translation_output, translated_text, gf);
|
||||
}
|
||||
return translated_text;
|
||||
} else {
|
||||
obs_log(gf->log_level, "Failed to translate text");
|
||||
}
|
||||
}
|
||||
return sentence;
|
||||
return "";
|
||||
}
|
||||
|
||||
void send_sentence_to_file(struct transcription_filter_data *gf,
|
||||
const DetectionResultWithText &result, const std::string &str_copy)
|
||||
const DetectionResultWithText &result, const std::string &str_copy,
|
||||
const std::string &translated_sentence)
|
||||
{
|
||||
// Check if we should save the sentence
|
||||
if (gf->save_only_while_recording && !obs_frontend_recording_active()) {
|
||||
// We are not recording, do not save the sentence to file
|
||||
return;
|
||||
}
|
||||
|
||||
std::string translated_file_path = "";
|
||||
bool write_translations = gf->translate && !translated_sentence.empty();
|
||||
|
||||
// if translation is enabled, save the translated sentence to another file
|
||||
if (write_translations) {
|
||||
// add a postfix to the file name (without extension) with the translation target language
|
||||
std::string output_file_path = gf->output_file_path;
|
||||
std::string file_extension =
|
||||
output_file_path.substr(output_file_path.find_last_of(".") + 1);
|
||||
std::string file_name =
|
||||
output_file_path.substr(0, output_file_path.find_last_of("."));
|
||||
translated_file_path = file_name + "_" + gf->target_lang + "." + file_extension;
|
||||
}
|
||||
|
||||
// should the file be truncated?
|
||||
std::ios_base::openmode openmode = std::ios::out;
|
||||
if (gf->truncate_output_file) {
|
||||
@ -97,6 +107,11 @@ void send_sentence_to_file(struct transcription_filter_data *gf,
|
||||
std::ofstream output_file(gf->output_file_path, openmode);
|
||||
output_file << str_copy << std::endl;
|
||||
output_file.close();
|
||||
if (write_translations) {
|
||||
std::ofstream translated_output_file(translated_file_path, openmode);
|
||||
translated_output_file << translated_sentence << std::endl;
|
||||
translated_output_file.close();
|
||||
}
|
||||
} else {
|
||||
if (result.start_timestamp_ms == 0 && result.end_timestamp_ms == 0) {
|
||||
// No timestamps, do not save the sentence to srt
|
||||
@ -109,7 +124,7 @@ void send_sentence_to_file(struct transcription_filter_data *gf,
|
||||
std::ofstream output_file(gf->output_file_path, openmode);
|
||||
output_file << gf->sentence_number << std::endl;
|
||||
// use the start and end timestamps to calculate the start and end time in srt format
|
||||
auto format_ts_for_srt = [&output_file](uint64_t ts) {
|
||||
auto format_ts_for_srt = [](std::ofstream &output_stream, uint64_t ts) {
|
||||
uint64_t time_s = ts / 1000;
|
||||
uint64_t time_m = time_s / 60;
|
||||
uint64_t time_h = time_m / 60;
|
||||
@ -117,19 +132,37 @@ void send_sentence_to_file(struct transcription_filter_data *gf,
|
||||
uint64_t time_s_rem = time_s % 60;
|
||||
uint64_t time_m_rem = time_m % 60;
|
||||
uint64_t time_h_rem = time_h % 60;
|
||||
output_file << std::setfill('0') << std::setw(2) << time_h_rem << ":"
|
||||
<< std::setfill('0') << std::setw(2) << time_m_rem << ":"
|
||||
<< std::setfill('0') << std::setw(2) << time_s_rem << ","
|
||||
<< std::setfill('0') << std::setw(3) << time_ms_rem;
|
||||
output_stream << std::setfill('0') << std::setw(2) << time_h_rem << ":"
|
||||
<< std::setfill('0') << std::setw(2) << time_m_rem << ":"
|
||||
<< std::setfill('0') << std::setw(2) << time_s_rem << ","
|
||||
<< std::setfill('0') << std::setw(3) << time_ms_rem;
|
||||
};
|
||||
format_ts_for_srt(result.start_timestamp_ms);
|
||||
format_ts_for_srt(output_file, result.start_timestamp_ms);
|
||||
output_file << " --> ";
|
||||
format_ts_for_srt(result.end_timestamp_ms);
|
||||
format_ts_for_srt(output_file, result.end_timestamp_ms);
|
||||
output_file << std::endl;
|
||||
|
||||
output_file << str_copy << std::endl;
|
||||
output_file << std::endl;
|
||||
output_file.close();
|
||||
|
||||
if (write_translations) {
|
||||
obs_log(gf->log_level, "Saving translation to file %s, sentence #%d",
|
||||
translated_file_path.c_str(), gf->sentence_number);
|
||||
|
||||
// Append translated sentence to file in .srt format
|
||||
std::ofstream translated_output_file(translated_file_path, openmode);
|
||||
translated_output_file << gf->sentence_number << std::endl;
|
||||
format_ts_for_srt(translated_output_file, result.start_timestamp_ms);
|
||||
translated_output_file << " --> ";
|
||||
format_ts_for_srt(translated_output_file, result.end_timestamp_ms);
|
||||
translated_output_file << std::endl;
|
||||
|
||||
translated_output_file << translated_sentence << std::endl;
|
||||
translated_output_file << std::endl;
|
||||
translated_output_file.close();
|
||||
}
|
||||
|
||||
gf->sentence_number++;
|
||||
}
|
||||
}
|
||||
@ -185,13 +218,28 @@ void set_text_callback(struct transcription_filter_data *gf,
|
||||
}
|
||||
}
|
||||
|
||||
// send the sentence to translation (if enabled)
|
||||
std::string translated_sentence = send_sentence_to_translation(str_copy, gf);
|
||||
|
||||
if (gf->translate) {
|
||||
if (gf->translation_output == "none") {
|
||||
// overwrite the original text with the translated text
|
||||
str_copy = translated_sentence;
|
||||
} else {
|
||||
if (gf->buffered_output) {
|
||||
gf->translation_monitor.addSentence(translated_sentence);
|
||||
} else {
|
||||
// non-buffered output - send the sentence to the selected source
|
||||
send_caption_to_source(gf->translation_output, translated_sentence,
|
||||
gf);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
if (gf->buffered_output) {
|
||||
gf->captions_monitor.addSentence(str_copy);
|
||||
} else {
|
||||
// non-buffered output
|
||||
// send the sentence to translation (if enabled)
|
||||
str_copy = send_sentence_to_translation(str_copy, gf);
|
||||
// send the sentence to the selected source
|
||||
// non-buffered output - send the sentence to the selected source
|
||||
send_caption_to_source(gf->text_source_name, str_copy, gf);
|
||||
}
|
||||
|
||||
@ -200,7 +248,7 @@ void set_text_callback(struct transcription_filter_data *gf,
|
||||
}
|
||||
|
||||
if (gf->save_to_file && gf->output_file_path != "") {
|
||||
send_sentence_to_file(gf, result, str_copy);
|
||||
send_sentence_to_file(gf, result, str_copy, translated_sentence);
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@ -108,6 +108,7 @@ struct transcription_filter_data {
|
||||
|
||||
bool buffered_output = false;
|
||||
TokenBufferThread captions_monitor;
|
||||
TokenBufferThread translation_monitor;
|
||||
int buffered_output_num_lines = 2;
|
||||
int buffered_output_num_chars = 30;
|
||||
TokenBufferSegmentation buffered_output_output_type =
|
||||
|
||||
493
src/transcription-filter-properties.cpp
Normal file
493
src/transcription-filter-properties.cpp
Normal file
@ -0,0 +1,493 @@
|
||||
|
||||
#include <obs.h>
|
||||
#include <obs-module.h>
|
||||
#include <obs-frontend-api.h>
|
||||
|
||||
#include "transcription-filter-data.h"
|
||||
#include "transcription-filter.h"
|
||||
#include "transcription-filter-utils.h"
|
||||
#include "whisper-utils/whisper-language.h"
|
||||
#include "model-utils/model-downloader-types.h"
|
||||
#include "translation/language_codes.h"
|
||||
#include "ui/filter-replace-dialog.h"
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
bool translation_options_callback(obs_properties_t *props, obs_property_t *property,
|
||||
obs_data_t *settings)
|
||||
{
|
||||
UNUSED_PARAMETER(property);
|
||||
// Show/Hide the translation group
|
||||
const bool translate_enabled = obs_data_get_bool(settings, "translate");
|
||||
const bool is_advanced = obs_data_get_int(settings, "advanced_settings_mode") == 1;
|
||||
for (const auto &prop :
|
||||
{"translate_target_language", "translate_model", "translate_output"}) {
|
||||
obs_property_set_visible(obs_properties_get(props, prop), translate_enabled);
|
||||
}
|
||||
for (const auto &prop :
|
||||
{"translate_source_language", "translate_add_context",
|
||||
"translate_input_tokenization_style", "translation_sampling_temperature",
|
||||
"translation_repetition_penalty", "translation_beam_size",
|
||||
"translation_max_decoding_length", "translation_no_repeat_ngram_size",
|
||||
"translation_max_input_length"}) {
|
||||
obs_property_set_visible(obs_properties_get(props, prop),
|
||||
translate_enabled && is_advanced);
|
||||
}
|
||||
const bool is_external =
|
||||
(strcmp(obs_data_get_string(settings, "translate_model"), "!!!external!!!") == 0);
|
||||
obs_property_set_visible(obs_properties_get(props, "translation_model_path_external"),
|
||||
is_external && translate_enabled);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool advanced_settings_callback(obs_properties_t *props, obs_property_t *property,
|
||||
obs_data_t *settings)
|
||||
{
|
||||
UNUSED_PARAMETER(property);
|
||||
// If advanced settings is enabled, show the advanced settings group
|
||||
const bool show_hide = obs_data_get_int(settings, "advanced_settings_mode") == 1;
|
||||
for (const std::string &prop_name : {"whisper_params_group", "buffered_output_group",
|
||||
"log_group", "advanced_group", "file_output_enable"}) {
|
||||
obs_property_set_visible(obs_properties_get(props, prop_name.c_str()), show_hide);
|
||||
}
|
||||
translation_options_callback(props, NULL, settings);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool file_output_select_changed(obs_properties_t *props, obs_property_t *property,
|
||||
obs_data_t *settings)
|
||||
{
|
||||
UNUSED_PARAMETER(property);
|
||||
// Show or hide the output filename selection input
|
||||
const bool show_hide = obs_data_get_bool(settings, "file_output_enable");
|
||||
for (const std::string &prop_name :
|
||||
{"subtitle_output_filename", "subtitle_save_srt", "truncate_output_file",
|
||||
"only_while_recording", "rename_file_to_match_recording", "file_output_info"}) {
|
||||
obs_property_set_visible(obs_properties_get(props, prop_name.c_str()), show_hide);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool external_model_file_selection(obs_properties_t *props, obs_property_t *property,
|
||||
obs_data_t *settings)
|
||||
{
|
||||
UNUSED_PARAMETER(property);
|
||||
// If the selected model is the external model, show the external model file selection
|
||||
// input
|
||||
const char *new_model_path = obs_data_get_string(settings, "whisper_model_path");
|
||||
const bool is_external = strcmp(new_model_path, "!!!external!!!") == 0;
|
||||
if (is_external) {
|
||||
obs_property_set_visible(obs_properties_get(props, "whisper_model_path_external"),
|
||||
true);
|
||||
} else {
|
||||
obs_property_set_visible(obs_properties_get(props, "whisper_model_path_external"),
|
||||
false);
|
||||
}
|
||||
|
||||
const std::string model_name = new_model_path;
|
||||
// if the model is english-only -> hide all the languages but english
|
||||
const bool is_english_only_internal = (model_name.find("English") != std::string::npos) &&
|
||||
!is_external;
|
||||
// clear the language selection list ("whisper_language_select")
|
||||
obs_property_t *prop_lang = obs_properties_get(props, "whisper_language_select");
|
||||
obs_property_list_clear(prop_lang);
|
||||
if (is_english_only_internal) {
|
||||
// add only the english language
|
||||
obs_property_list_add_string(prop_lang, "English", "en");
|
||||
// set the language to english
|
||||
obs_data_set_string(settings, "whisper_language_select", "en");
|
||||
} else {
|
||||
// add all the languages
|
||||
for (const auto &lang : whisper_available_lang) {
|
||||
obs_property_list_add_string(prop_lang, lang.second.c_str(),
|
||||
lang.first.c_str());
|
||||
}
|
||||
// set the language to auto (default)
|
||||
obs_data_set_string(settings, "whisper_language_select", "auto");
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
bool translation_external_model_selection(obs_properties_t *props, obs_property_t *property,
|
||||
obs_data_t *settings)
|
||||
{
|
||||
UNUSED_PARAMETER(property);
|
||||
// If the selected model is the external model, show the external model file selection
|
||||
// input
|
||||
const char *new_model_path = obs_data_get_string(settings, "translate_model");
|
||||
const bool is_external = (strcmp(new_model_path, "!!!external!!!") == 0);
|
||||
const bool is_whisper = (strcmp(new_model_path, "whisper-based-translation") == 0);
|
||||
const bool is_advanced = obs_data_get_int(settings, "advanced_settings_mode") == 1;
|
||||
obs_property_set_visible(obs_properties_get(props, "translation_model_path_external"),
|
||||
is_external);
|
||||
obs_property_set_visible(obs_properties_get(props, "translate_source_language"),
|
||||
!is_whisper && is_advanced);
|
||||
obs_property_set_visible(obs_properties_get(props, "translate_add_context"),
|
||||
!is_whisper && is_advanced);
|
||||
obs_property_set_visible(obs_properties_get(props, "translate_input_tokenization_style"),
|
||||
!is_whisper && is_advanced);
|
||||
obs_property_set_visible(obs_properties_get(props, "translate_output"), !is_whisper);
|
||||
return true;
|
||||
}
|
||||
|
||||
void add_transcription_group_properties(obs_properties_t *ppts)
|
||||
{
|
||||
// add "Transcription" group
|
||||
obs_properties_t *transcription_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "transcription_group", MT_("transcription_group"),
|
||||
OBS_GROUP_NORMAL, transcription_group);
|
||||
|
||||
// Add a list of available whisper models to download
|
||||
obs_property_t *whisper_models_list = obs_properties_add_list(
|
||||
transcription_group, "whisper_model_path", MT_("whisper_model"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
// Add models from models_info map
|
||||
for (const auto &model_info : models_info) {
|
||||
if (model_info.second.type == MODEL_TYPE_TRANSCRIPTION) {
|
||||
obs_property_list_add_string(whisper_models_list, model_info.first.c_str(),
|
||||
model_info.first.c_str());
|
||||
}
|
||||
}
|
||||
obs_property_list_add_string(whisper_models_list, "Load external model file",
|
||||
"!!!external!!!");
|
||||
|
||||
// Add a file selection input to select an external model file
|
||||
obs_properties_add_path(transcription_group, "whisper_model_path_external",
|
||||
MT_("external_model_file"), OBS_PATH_FILE, "Model (*.bin)", NULL);
|
||||
// Hide the external model file selection input
|
||||
obs_property_set_visible(obs_properties_get(ppts, "whisper_model_path_external"), false);
|
||||
|
||||
// Add a callback to the model list to handle the external model file selection
|
||||
obs_property_set_modified_callback(whisper_models_list, external_model_file_selection);
|
||||
}
|
||||
|
||||
void add_translation_group_properties(obs_properties_t *ppts)
|
||||
{
|
||||
// add translation option group
|
||||
obs_properties_t *translation_group = obs_properties_create();
|
||||
obs_property_t *translation_group_prop = obs_properties_add_group(
|
||||
ppts, "translate", MT_("translate"), OBS_GROUP_CHECKABLE, translation_group);
|
||||
|
||||
// add explaination text
|
||||
obs_properties_add_text(translation_group, "translate_explaination",
|
||||
MT_("translate_explaination"), OBS_TEXT_INFO);
|
||||
|
||||
// add translation model selection
|
||||
obs_property_t *prop_translate_model = obs_properties_add_list(
|
||||
translation_group, "translate_model", MT_("translate_model"), OBS_COMBO_TYPE_LIST,
|
||||
OBS_COMBO_FORMAT_STRING);
|
||||
// Populate the dropdown with the translation models
|
||||
// add "Whisper-Based Translation" option
|
||||
obs_property_list_add_string(prop_translate_model, MT_("Whisper-Based-Translation"),
|
||||
"whisper-based-translation");
|
||||
for (const auto &model_info : models_info) {
|
||||
if (model_info.second.type == MODEL_TYPE_TRANSLATION) {
|
||||
obs_property_list_add_string(prop_translate_model, model_info.first.c_str(),
|
||||
model_info.first.c_str());
|
||||
}
|
||||
}
|
||||
// add external model option
|
||||
obs_property_list_add_string(prop_translate_model, MT_("load_external_model"),
|
||||
"!!!external!!!");
|
||||
// add callback to handle the external model file selection
|
||||
obs_properties_add_path(translation_group, "translation_model_path_external",
|
||||
MT_("external_model_folder"), OBS_PATH_DIRECTORY,
|
||||
"CT2 Model folder", NULL);
|
||||
// Hide the external model file selection input
|
||||
obs_property_set_visible(obs_properties_get(ppts, "translation_model_path_external"),
|
||||
false);
|
||||
// Add a callback to the model list to handle the external model file selection
|
||||
obs_property_set_modified_callback(prop_translate_model,
|
||||
translation_external_model_selection);
|
||||
// add target language selection
|
||||
obs_property_t *prop_tgt = obs_properties_add_list(
|
||||
translation_group, "translate_target_language", MT_("target_language"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
obs_property_t *prop_src = obs_properties_add_list(
|
||||
translation_group, "translate_source_language", MT_("source_language"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
obs_properties_add_bool(translation_group, "translate_add_context",
|
||||
MT_("translate_add_context"));
|
||||
|
||||
// Populate the dropdown with the language codes
|
||||
for (const auto &language : language_codes) {
|
||||
obs_property_list_add_string(prop_tgt, language.second.c_str(),
|
||||
language.first.c_str());
|
||||
obs_property_list_add_string(prop_src, language.second.c_str(),
|
||||
language.first.c_str());
|
||||
}
|
||||
// add option for routing the translation to an output source
|
||||
obs_property_t *prop_output = obs_properties_add_list(translation_group, "translate_output",
|
||||
MT_("translate_output"),
|
||||
OBS_COMBO_TYPE_LIST,
|
||||
OBS_COMBO_FORMAT_STRING);
|
||||
obs_property_list_add_string(prop_output, "Write to captions output", "none");
|
||||
// TODO add file output option
|
||||
// obs_property_list_add_string(...
|
||||
obs_enum_sources(add_sources_to_list, prop_output);
|
||||
|
||||
// add callback to enable/disable translation group
|
||||
obs_property_set_modified_callback(translation_group_prop, translation_options_callback);
|
||||
// add tokenization style options
|
||||
obs_property_t *prop_token_style =
|
||||
obs_properties_add_list(translation_group, "translate_input_tokenization_style",
|
||||
MT_("translate_input_tokenization_style"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(prop_token_style, "M2M100 Tokens", INPUT_TOKENIZAION_M2M100);
|
||||
obs_property_list_add_int(prop_token_style, "T5 Tokens", INPUT_TOKENIZAION_T5);
|
||||
|
||||
// add translation options: beam_size, max_decoding_length, repetition_penalty, no_repeat_ngram_size, max_input_length, sampling_temperature
|
||||
obs_properties_add_float_slider(translation_group, "translation_sampling_temperature",
|
||||
MT_("translation_sampling_temperature"), 0.0, 1.0, 0.05);
|
||||
obs_properties_add_float_slider(translation_group, "translation_repetition_penalty",
|
||||
MT_("translation_repetition_penalty"), 1.0, 5.0, 0.25);
|
||||
obs_properties_add_int_slider(translation_group, "translation_beam_size",
|
||||
MT_("translation_beam_size"), 1, 10, 1);
|
||||
obs_properties_add_int_slider(translation_group, "translation_max_decoding_length",
|
||||
MT_("translation_max_decoding_length"), 1, 100, 5);
|
||||
obs_properties_add_int_slider(translation_group, "translation_max_input_length",
|
||||
MT_("translation_max_input_length"), 1, 100, 5);
|
||||
obs_properties_add_int_slider(translation_group, "translation_no_repeat_ngram_size",
|
||||
MT_("translation_no_repeat_ngram_size"), 1, 10, 1);
|
||||
}
|
||||
|
||||
void add_file_output_group_properties(obs_properties_t *ppts)
|
||||
{
|
||||
// create a file output group
|
||||
obs_properties_t *file_output_group = obs_properties_create();
|
||||
// add a checkbox group for file output
|
||||
obs_property_t *file_output_group_prop =
|
||||
obs_properties_add_group(ppts, "file_output_enable", MT_("file_output_group"),
|
||||
OBS_GROUP_CHECKABLE, file_output_group);
|
||||
|
||||
obs_properties_add_path(file_output_group, "subtitle_output_filename",
|
||||
MT_("output_filename"), OBS_PATH_FILE_SAVE, "Text (*.txt)", NULL);
|
||||
// add info text about the file output
|
||||
obs_properties_add_text(file_output_group, "file_output_info", MT_("file_output_info"),
|
||||
OBS_TEXT_INFO);
|
||||
obs_properties_add_bool(file_output_group, "subtitle_save_srt", MT_("save_srt"));
|
||||
obs_properties_add_bool(file_output_group, "truncate_output_file",
|
||||
MT_("truncate_output_file"));
|
||||
obs_properties_add_bool(file_output_group, "only_while_recording",
|
||||
MT_("only_while_recording"));
|
||||
obs_properties_add_bool(file_output_group, "rename_file_to_match_recording",
|
||||
MT_("rename_file_to_match_recording"));
|
||||
obs_property_set_modified_callback(file_output_group_prop, file_output_select_changed);
|
||||
}
|
||||
|
||||
void add_buffered_output_group_properties(obs_properties_t *ppts)
|
||||
{
|
||||
// add buffered output options group
|
||||
obs_properties_t *buffered_output_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "buffered_output_group", MT_("buffered_output_parameters"),
|
||||
OBS_GROUP_NORMAL, buffered_output_group);
|
||||
obs_properties_add_bool(buffered_output_group, "buffered_output", MT_("buffered_output"));
|
||||
// add buffer "type" character or word
|
||||
obs_property_t *buffer_type_list = obs_properties_add_list(
|
||||
buffered_output_group, "buffer_output_type", MT_("buffer_output_type"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(buffer_type_list, "Character", SEGMENTATION_TOKEN);
|
||||
obs_property_list_add_int(buffer_type_list, "Word", SEGMENTATION_WORD);
|
||||
// add buffer lines parameter
|
||||
obs_properties_add_int_slider(buffered_output_group, "buffer_num_lines",
|
||||
MT_("buffer_num_lines"), 1, 5, 1);
|
||||
// add buffer number of characters per line parameter
|
||||
obs_properties_add_int_slider(buffered_output_group, "buffer_num_chars_per_line",
|
||||
MT_("buffer_num_chars_per_line"), 1, 100, 1);
|
||||
}
|
||||
|
||||
void add_advanced_group_properties(obs_properties_t *ppts, struct transcription_filter_data *gf)
|
||||
{
|
||||
// add a group for advanced configuration
|
||||
obs_properties_t *advanced_config_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "advanced_group", MT_("advanced_group"), OBS_GROUP_NORMAL,
|
||||
advanced_config_group);
|
||||
|
||||
obs_properties_add_bool(advanced_config_group, "caption_to_stream",
|
||||
MT_("caption_to_stream"));
|
||||
|
||||
obs_properties_add_int_slider(advanced_config_group, "min_sub_duration",
|
||||
MT_("min_sub_duration"), 1000, 5000, 50);
|
||||
obs_properties_add_float_slider(advanced_config_group, "sentence_psum_accept_thresh",
|
||||
MT_("sentence_psum_accept_thresh"), 0.0, 1.0, 0.05);
|
||||
|
||||
obs_properties_add_bool(advanced_config_group, "process_while_muted",
|
||||
MT_("process_while_muted"));
|
||||
|
||||
obs_properties_add_bool(advanced_config_group, "vad_enabled", MT_("vad_enabled"));
|
||||
// add vad threshold slider
|
||||
obs_properties_add_float_slider(advanced_config_group, "vad_threshold",
|
||||
MT_("vad_threshold"), 0.0, 1.0, 0.05);
|
||||
|
||||
// add button to open filter and replace UI dialog
|
||||
obs_properties_add_button2(
|
||||
advanced_config_group, "open_filter_ui", MT_("open_filter_ui"),
|
||||
[](obs_properties_t *props, obs_property_t *property, void *data_) {
|
||||
UNUSED_PARAMETER(props);
|
||||
UNUSED_PARAMETER(property);
|
||||
struct transcription_filter_data *gf_ =
|
||||
static_cast<struct transcription_filter_data *>(data_);
|
||||
FilterReplaceDialog *filter_replace_dialog = new FilterReplaceDialog(
|
||||
(QWidget *)obs_frontend_get_main_window(), gf_);
|
||||
filter_replace_dialog->exec();
|
||||
// store the filter data on the source settings
|
||||
obs_data_t *settings = obs_source_get_settings(gf_->context);
|
||||
// serialize the filter data
|
||||
const std::string filter_data =
|
||||
serialize_filter_words_replace(gf_->filter_words_replace);
|
||||
obs_data_set_string(settings, "filter_words_replace", filter_data.c_str());
|
||||
obs_data_release(settings);
|
||||
return true;
|
||||
},
|
||||
gf);
|
||||
}
|
||||
|
||||
void add_logging_group_properties(obs_properties_t *ppts)
|
||||
{
|
||||
// add a group for Logging options
|
||||
obs_properties_t *log_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "log_group", MT_("log_group"), OBS_GROUP_NORMAL, log_group);
|
||||
|
||||
obs_properties_add_bool(log_group, "log_words", MT_("log_words"));
|
||||
obs_property_t *list = obs_properties_add_list(log_group, "log_level", MT_("log_level"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(list, "DEBUG (Won't show)", LOG_DEBUG);
|
||||
obs_property_list_add_int(list, "INFO", LOG_INFO);
|
||||
obs_property_list_add_int(list, "WARNING", LOG_WARNING);
|
||||
}
|
||||
|
||||
void add_whisper_params_group_properties(obs_properties_t *ppts)
|
||||
{
|
||||
obs_properties_t *whisper_params_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "whisper_params_group", MT_("whisper_parameters"),
|
||||
OBS_GROUP_NORMAL, whisper_params_group);
|
||||
|
||||
obs_property_t *whisper_sampling_method_list = obs_properties_add_list(
|
||||
whisper_params_group, "whisper_sampling_method", MT_("whisper_sampling_method"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(whisper_sampling_method_list, "Beam search",
|
||||
WHISPER_SAMPLING_BEAM_SEARCH);
|
||||
obs_property_list_add_int(whisper_sampling_method_list, "Greedy", WHISPER_SAMPLING_GREEDY);
|
||||
|
||||
// int n_threads;
|
||||
obs_properties_add_int_slider(whisper_params_group, "n_threads", MT_("n_threads"), 1, 8, 1);
|
||||
// int n_max_text_ctx; // max tokens to use from past text as prompt for the decoder
|
||||
obs_properties_add_int_slider(whisper_params_group, "n_max_text_ctx", MT_("n_max_text_ctx"),
|
||||
0, 16384, 100);
|
||||
// int offset_ms; // start offset in ms
|
||||
// int duration_ms; // audio duration to process in ms
|
||||
// bool translate;
|
||||
obs_properties_add_bool(whisper_params_group, "whisper_translate",
|
||||
MT_("whisper_translate"));
|
||||
// bool no_context; // do not use past transcription (if any) as initial prompt for the decoder
|
||||
obs_properties_add_bool(whisper_params_group, "no_context", MT_("no_context"));
|
||||
// bool single_segment; // force single segment output (useful for streaming)
|
||||
obs_properties_add_bool(whisper_params_group, "single_segment", MT_("single_segment"));
|
||||
// bool print_special; // print special tokens (e.g. <SOT>, <EOT>, <BEG>, etc.)
|
||||
obs_properties_add_bool(whisper_params_group, "print_special", MT_("print_special"));
|
||||
// bool print_progress; // print progress information
|
||||
obs_properties_add_bool(whisper_params_group, "print_progress", MT_("print_progress"));
|
||||
// bool print_realtime; // print results from within whisper.cpp (avoid it, use callback instead)
|
||||
obs_properties_add_bool(whisper_params_group, "print_realtime", MT_("print_realtime"));
|
||||
// bool print_timestamps; // print timestamps for each text segment when printing realtime
|
||||
obs_properties_add_bool(whisper_params_group, "print_timestamps", MT_("print_timestamps"));
|
||||
// bool token_timestamps; // enable token-level timestamps
|
||||
obs_properties_add_bool(whisper_params_group, "token_timestamps", MT_("token_timestamps"));
|
||||
// enable DTW timestamps
|
||||
obs_properties_add_bool(whisper_params_group, "dtw_token_timestamps",
|
||||
MT_("dtw_token_timestamps"));
|
||||
// float thold_pt; // timestamp token probability threshold (~0.01)
|
||||
obs_properties_add_float_slider(whisper_params_group, "thold_pt", MT_("thold_pt"), 0.0f,
|
||||
1.0f, 0.05f);
|
||||
// float thold_ptsum; // timestamp token sum probability threshold (~0.01)
|
||||
obs_properties_add_float_slider(whisper_params_group, "thold_ptsum", MT_("thold_ptsum"),
|
||||
0.0f, 1.0f, 0.05f);
|
||||
// int max_len; // max segment length in characters
|
||||
obs_properties_add_int_slider(whisper_params_group, "max_len", MT_("max_len"), 0, 100, 1);
|
||||
// bool split_on_word; // split on word rather than on token (when used with max_len)
|
||||
obs_properties_add_bool(whisper_params_group, "split_on_word", MT_("split_on_word"));
|
||||
// int max_tokens; // max tokens per segment (0 = no limit)
|
||||
obs_properties_add_int_slider(whisper_params_group, "max_tokens", MT_("max_tokens"), 0, 100,
|
||||
1);
|
||||
// bool speed_up; // speed-up the audio by 2x using Phase Vocoder
|
||||
obs_properties_add_bool(whisper_params_group, "speed_up", MT_("speed_up"));
|
||||
// const char * initial_prompt;
|
||||
obs_properties_add_text(whisper_params_group, "initial_prompt", MT_("initial_prompt"),
|
||||
OBS_TEXT_DEFAULT);
|
||||
// bool suppress_blank
|
||||
obs_properties_add_bool(whisper_params_group, "suppress_blank", MT_("suppress_blank"));
|
||||
// bool suppress_non_speech_tokens
|
||||
obs_properties_add_bool(whisper_params_group, "suppress_non_speech_tokens",
|
||||
MT_("suppress_non_speech_tokens"));
|
||||
// float temperature
|
||||
obs_properties_add_float_slider(whisper_params_group, "temperature", MT_("temperature"),
|
||||
0.0f, 1.0f, 0.05f);
|
||||
// float max_initial_ts
|
||||
obs_properties_add_float_slider(whisper_params_group, "max_initial_ts",
|
||||
MT_("max_initial_ts"), 0.0f, 1.0f, 0.05f);
|
||||
// float length_penalty
|
||||
obs_properties_add_float_slider(whisper_params_group, "length_penalty",
|
||||
MT_("length_penalty"), -1.0f, 1.0f, 0.1f);
|
||||
}
|
||||
|
||||
void add_general_group_properties(obs_properties_t *ppts)
|
||||
{
|
||||
// add "General" group
|
||||
obs_properties_t *general_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "general_group", MT_("general_group"), OBS_GROUP_NORMAL,
|
||||
general_group);
|
||||
|
||||
obs_property_t *subs_output =
|
||||
obs_properties_add_list(general_group, "subtitle_sources", MT_("subtitle_sources"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
// Add "none" option
|
||||
obs_property_list_add_string(subs_output, MT_("none_no_output"), "none");
|
||||
// Add text sources
|
||||
obs_enum_sources(add_sources_to_list, subs_output);
|
||||
|
||||
// Add language selector
|
||||
obs_property_t *whisper_language_select_list =
|
||||
obs_properties_add_list(general_group, "whisper_language_select", MT_("language"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
// iterate over all available languages and add them to the list
|
||||
for (auto const &pair : whisper_available_lang_reverse) {
|
||||
obs_property_list_add_string(whisper_language_select_list, pair.first.c_str(),
|
||||
pair.second.c_str());
|
||||
}
|
||||
}
|
||||
|
||||
obs_properties_t *transcription_filter_properties(void *data)
|
||||
{
|
||||
struct transcription_filter_data *gf =
|
||||
static_cast<struct transcription_filter_data *>(data);
|
||||
|
||||
obs_properties_t *ppts = obs_properties_create();
|
||||
|
||||
// add a drop down selection for advanced vs simple settings
|
||||
obs_property_t *advanced_settings = obs_properties_add_list(ppts, "advanced_settings_mode",
|
||||
MT_("advanced_settings_mode"),
|
||||
OBS_COMBO_TYPE_LIST,
|
||||
OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(advanced_settings, MT_("simple_mode"), 0);
|
||||
obs_property_list_add_int(advanced_settings, MT_("advanced_mode"), 1);
|
||||
obs_property_set_modified_callback(advanced_settings, advanced_settings_callback);
|
||||
|
||||
add_general_group_properties(ppts);
|
||||
add_transcription_group_properties(ppts);
|
||||
add_translation_group_properties(ppts);
|
||||
add_file_output_group_properties(ppts);
|
||||
add_buffered_output_group_properties(ppts);
|
||||
add_advanced_group_properties(ppts, gf);
|
||||
add_logging_group_properties(ppts);
|
||||
add_whisper_params_group_properties(ppts);
|
||||
|
||||
// Add a informative text about the plugin
|
||||
obs_properties_add_text(
|
||||
ppts, "info",
|
||||
QString(PLUGIN_INFO_TEMPLATE).arg(PLUGIN_VERSION).toStdString().c_str(),
|
||||
OBS_TEXT_INFO);
|
||||
|
||||
UNUSED_PARAMETER(data);
|
||||
return ppts;
|
||||
}
|
||||
@ -162,6 +162,9 @@ void transcription_filter_destroy(void *data)
|
||||
if (gf->captions_monitor.isEnabled()) {
|
||||
gf->captions_monitor.stopThread();
|
||||
}
|
||||
if (gf->translation_monitor.isEnabled()) {
|
||||
gf->translation_monitor.stopThread();
|
||||
}
|
||||
|
||||
bfree(gf);
|
||||
}
|
||||
@ -226,14 +229,21 @@ void transcription_filter_update(void *data, obs_data_t *s)
|
||||
gf);
|
||||
}
|
||||
},
|
||||
[gf](const std::string &sentence) {
|
||||
obs_log(LOG_INFO, "sentence: %s", sentence.c_str());
|
||||
if (gf->buffered_output && gf->translate) {
|
||||
send_sentence_to_translation(sentence, gf);
|
||||
[gf](const std::string &) {}, new_buffer_num_lines,
|
||||
new_buffer_num_chars_per_line, std::chrono::seconds(3),
|
||||
new_buffer_output_type);
|
||||
gf->translation_monitor.initialize(
|
||||
gf,
|
||||
[gf](const std::string &translated_text) {
|
||||
if (gf->buffered_output &&
|
||||
gf->translation_output != "none") {
|
||||
send_caption_to_source(gf->translation_output,
|
||||
translated_text, gf);
|
||||
}
|
||||
},
|
||||
new_buffer_num_lines, new_buffer_num_chars_per_line,
|
||||
std::chrono::seconds(3), new_buffer_output_type);
|
||||
[gf](const std::string &) {}, new_buffer_num_lines,
|
||||
new_buffer_num_chars_per_line, std::chrono::seconds(3),
|
||||
new_buffer_output_type);
|
||||
} else {
|
||||
if (new_buffer_num_lines != gf->buffered_output_num_lines ||
|
||||
new_buffer_num_chars_per_line != gf->buffered_output_num_chars ||
|
||||
@ -245,6 +255,11 @@ void transcription_filter_update(void *data, obs_data_t *s)
|
||||
gf->captions_monitor.setNumPerSentence(
|
||||
new_buffer_num_chars_per_line);
|
||||
gf->captions_monitor.setSegmentation(new_buffer_output_type);
|
||||
gf->translation_monitor.clear();
|
||||
gf->translation_monitor.setNumSentences(new_buffer_num_lines);
|
||||
gf->translation_monitor.setNumPerSentence(
|
||||
new_buffer_num_chars_per_line);
|
||||
gf->translation_monitor.setSegmentation(new_buffer_output_type);
|
||||
}
|
||||
}
|
||||
gf->buffered_output_num_lines = new_buffer_num_lines;
|
||||
@ -257,6 +272,8 @@ void transcription_filter_update(void *data, obs_data_t *s)
|
||||
if (gf->captions_monitor.isEnabled()) {
|
||||
gf->captions_monitor.clear();
|
||||
gf->captions_monitor.stopThread();
|
||||
gf->translation_monitor.clear();
|
||||
gf->translation_monitor.stopThread();
|
||||
}
|
||||
gf->buffered_output = false;
|
||||
}
|
||||
@ -506,20 +523,6 @@ void *transcription_filter_create(obs_data_t *settings, obs_source_t *filter)
|
||||
return gf;
|
||||
}
|
||||
|
||||
bool file_output_select_changed(obs_properties_t *props, obs_property_t *property,
|
||||
obs_data_t *settings)
|
||||
{
|
||||
UNUSED_PARAMETER(property);
|
||||
// Show or hide the output filename selection input
|
||||
const bool show_hide = obs_data_get_bool(settings, "file_output_enable");
|
||||
for (const std::string &prop_name :
|
||||
{"subtitle_output_filename", "subtitle_save_srt", "truncate_output_file",
|
||||
"only_while_recording", "rename_file_to_match_recording"}) {
|
||||
obs_property_set_visible(obs_properties_get(props, prop_name.c_str()), show_hide);
|
||||
}
|
||||
return true;
|
||||
}
|
||||
|
||||
void transcription_filter_activate(void *data)
|
||||
{
|
||||
struct transcription_filter_data *gf =
|
||||
@ -618,440 +621,3 @@ void transcription_filter_defaults(obs_data_t *s)
|
||||
obs_data_set_default_double(s, "max_initial_ts", 1.0);
|
||||
obs_data_set_default_double(s, "length_penalty", -1.0);
|
||||
}
|
||||
|
||||
bool translation_options_callback(obs_properties_t *props, obs_property_t *property,
|
||||
obs_data_t *settings)
|
||||
{
|
||||
UNUSED_PARAMETER(property);
|
||||
// Show/Hide the translation group
|
||||
const bool translate_enabled = obs_data_get_bool(settings, "translate");
|
||||
const bool is_advanced = obs_data_get_int(settings, "advanced_settings_mode") == 1;
|
||||
for (const auto &prop : {"translate_target_language", "translate_model"}) {
|
||||
obs_property_set_visible(obs_properties_get(props, prop), translate_enabled);
|
||||
}
|
||||
for (const auto &prop :
|
||||
{"translate_source_language", "translate_add_context", "translate_output",
|
||||
"translate_input_tokenization_style", "translation_sampling_temperature",
|
||||
"translation_repetition_penalty", "translation_beam_size",
|
||||
"translation_max_decoding_length", "translation_no_repeat_ngram_size",
|
||||
"translation_max_input_length"}) {
|
||||
obs_property_set_visible(obs_properties_get(props, prop),
|
||||
translate_enabled && is_advanced);
|
||||
}
|
||||
const bool is_external =
|
||||
(strcmp(obs_data_get_string(settings, "translate_model"), "!!!external!!!") == 0);
|
||||
obs_property_set_visible(obs_properties_get(props, "translation_model_path_external"),
|
||||
is_external && translate_enabled);
|
||||
return true;
|
||||
}
|
||||
|
||||
bool advanced_settings_callback(obs_properties_t *props, obs_property_t *property,
|
||||
obs_data_t *settings)
|
||||
{
|
||||
UNUSED_PARAMETER(property);
|
||||
// If advanced settings is enabled, show the advanced settings group
|
||||
const bool show_hide = obs_data_get_int(settings, "advanced_settings_mode") == 1;
|
||||
for (const std::string &prop_name : {"whisper_params_group", "buffered_output_group",
|
||||
"log_group", "advanced_group", "file_output_enable"}) {
|
||||
obs_property_set_visible(obs_properties_get(props, prop_name.c_str()), show_hide);
|
||||
}
|
||||
translation_options_callback(props, NULL, settings);
|
||||
return true;
|
||||
}
|
||||
|
||||
obs_properties_t *transcription_filter_properties(void *data)
|
||||
{
|
||||
struct transcription_filter_data *gf =
|
||||
static_cast<struct transcription_filter_data *>(data);
|
||||
|
||||
obs_properties_t *ppts = obs_properties_create();
|
||||
|
||||
// add a drop down selection for advanced vs simple settings
|
||||
obs_property_t *advanced_settings = obs_properties_add_list(ppts, "advanced_settings_mode",
|
||||
MT_("advanced_settings_mode"),
|
||||
OBS_COMBO_TYPE_LIST,
|
||||
OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(advanced_settings, MT_("simple_mode"), 0);
|
||||
obs_property_list_add_int(advanced_settings, MT_("advanced_mode"), 1);
|
||||
obs_property_set_modified_callback(advanced_settings, advanced_settings_callback);
|
||||
|
||||
// add "General" group
|
||||
obs_properties_t *general_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "general_group", MT_("general_group"), OBS_GROUP_NORMAL,
|
||||
general_group);
|
||||
|
||||
obs_property_t *subs_output =
|
||||
obs_properties_add_list(general_group, "subtitle_sources", MT_("subtitle_sources"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
// Add "none" option
|
||||
obs_property_list_add_string(subs_output, MT_("none_no_output"), "none");
|
||||
// Add text sources
|
||||
obs_enum_sources(add_sources_to_list, subs_output);
|
||||
|
||||
// Add language selector
|
||||
obs_property_t *whisper_language_select_list =
|
||||
obs_properties_add_list(general_group, "whisper_language_select", MT_("language"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
// iterate over all available languages and add them to the list
|
||||
for (auto const &pair : whisper_available_lang_reverse) {
|
||||
obs_property_list_add_string(whisper_language_select_list, pair.first.c_str(),
|
||||
pair.second.c_str());
|
||||
}
|
||||
|
||||
// add "Transcription" group
|
||||
obs_properties_t *transcription_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "transcription_group", MT_("transcription_group"),
|
||||
OBS_GROUP_NORMAL, transcription_group);
|
||||
|
||||
// Add a list of available whisper models to download
|
||||
obs_property_t *whisper_models_list = obs_properties_add_list(
|
||||
transcription_group, "whisper_model_path", MT_("whisper_model"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
// Add models from models_info map
|
||||
for (const auto &model_info : models_info) {
|
||||
if (model_info.second.type == MODEL_TYPE_TRANSCRIPTION) {
|
||||
obs_property_list_add_string(whisper_models_list, model_info.first.c_str(),
|
||||
model_info.first.c_str());
|
||||
}
|
||||
}
|
||||
obs_property_list_add_string(whisper_models_list, "Load external model file",
|
||||
"!!!external!!!");
|
||||
|
||||
// Add a file selection input to select an external model file
|
||||
obs_properties_add_path(transcription_group, "whisper_model_path_external",
|
||||
MT_("external_model_file"), OBS_PATH_FILE, "Model (*.bin)", NULL);
|
||||
// Hide the external model file selection input
|
||||
obs_property_set_visible(obs_properties_get(ppts, "whisper_model_path_external"), false);
|
||||
|
||||
// Add a callback to the model list to handle the external model file selection
|
||||
obs_property_set_modified_callback(whisper_models_list, [](obs_properties_t *props,
|
||||
obs_property_t *property,
|
||||
obs_data_t *settings) {
|
||||
UNUSED_PARAMETER(property);
|
||||
// If the selected model is the external model, show the external model file selection
|
||||
// input
|
||||
const char *new_model_path = obs_data_get_string(settings, "whisper_model_path");
|
||||
const bool is_external = strcmp(new_model_path, "!!!external!!!") == 0;
|
||||
if (is_external) {
|
||||
obs_property_set_visible(
|
||||
obs_properties_get(props, "whisper_model_path_external"), true);
|
||||
} else {
|
||||
obs_property_set_visible(
|
||||
obs_properties_get(props, "whisper_model_path_external"), false);
|
||||
}
|
||||
|
||||
const std::string model_name = new_model_path;
|
||||
// if the model is english-only -> hide all the languages but english
|
||||
const bool is_english_only_internal =
|
||||
(model_name.find("English") != std::string::npos) && !is_external;
|
||||
// clear the language selection list ("whisper_language_select")
|
||||
obs_property_t *prop_lang = obs_properties_get(props, "whisper_language_select");
|
||||
obs_property_list_clear(prop_lang);
|
||||
if (is_english_only_internal) {
|
||||
// add only the english language
|
||||
obs_property_list_add_string(prop_lang, "English", "en");
|
||||
// set the language to english
|
||||
obs_data_set_string(settings, "whisper_language_select", "en");
|
||||
} else {
|
||||
// add all the languages
|
||||
for (const auto &lang : whisper_available_lang) {
|
||||
obs_property_list_add_string(prop_lang, lang.second.c_str(),
|
||||
lang.first.c_str());
|
||||
}
|
||||
// set the language to auto (default)
|
||||
obs_data_set_string(settings, "whisper_language_select", "auto");
|
||||
}
|
||||
return true;
|
||||
});
|
||||
|
||||
// add translation option group
|
||||
obs_properties_t *translation_group = obs_properties_create();
|
||||
obs_property_t *translation_group_prop = obs_properties_add_group(
|
||||
ppts, "translate", MT_("translate"), OBS_GROUP_CHECKABLE, translation_group);
|
||||
|
||||
// add explaination text
|
||||
obs_properties_add_text(translation_group, "translate_explaination",
|
||||
MT_("translate_explaination"), OBS_TEXT_INFO);
|
||||
|
||||
// add translation model selection
|
||||
obs_property_t *prop_translate_model = obs_properties_add_list(
|
||||
translation_group, "translate_model", MT_("translate_model"), OBS_COMBO_TYPE_LIST,
|
||||
OBS_COMBO_FORMAT_STRING);
|
||||
// Populate the dropdown with the translation models
|
||||
// add "Whisper-Based Translation" option
|
||||
obs_property_list_add_string(prop_translate_model, MT_("Whisper-Based-Translation"),
|
||||
"whisper-based-translation");
|
||||
for (const auto &model_info : models_info) {
|
||||
if (model_info.second.type == MODEL_TYPE_TRANSLATION) {
|
||||
obs_property_list_add_string(prop_translate_model, model_info.first.c_str(),
|
||||
model_info.first.c_str());
|
||||
}
|
||||
}
|
||||
// add external model option
|
||||
obs_property_list_add_string(prop_translate_model, MT_("load_external_model"),
|
||||
"!!!external!!!");
|
||||
// add callback to handle the external model file selection
|
||||
obs_properties_add_path(translation_group, "translation_model_path_external",
|
||||
MT_("external_model_folder"), OBS_PATH_DIRECTORY,
|
||||
"CT2 Model folder", NULL);
|
||||
// Hide the external model file selection input
|
||||
obs_property_set_visible(obs_properties_get(ppts, "translation_model_path_external"),
|
||||
false);
|
||||
// Add a callback to the model list to handle the external model file selection
|
||||
obs_property_set_modified_callback(prop_translate_model, [](obs_properties_t *props,
|
||||
obs_property_t *property,
|
||||
obs_data_t *settings) {
|
||||
UNUSED_PARAMETER(property);
|
||||
// If the selected model is the external model, show the external model file selection
|
||||
// input
|
||||
const char *new_model_path = obs_data_get_string(settings, "translate_model");
|
||||
const bool is_external = (strcmp(new_model_path, "!!!external!!!") == 0);
|
||||
const bool is_whisper = (strcmp(new_model_path, "whisper-based-translation") == 0);
|
||||
const bool is_advanced = obs_data_get_int(settings, "advanced_settings_mode") == 1;
|
||||
obs_property_set_visible(
|
||||
obs_properties_get(props, "translation_model_path_external"), is_external);
|
||||
obs_property_set_visible(obs_properties_get(props, "translate_source_language"),
|
||||
!is_whisper && is_advanced);
|
||||
obs_property_set_visible(obs_properties_get(props, "translate_add_context"),
|
||||
!is_whisper && is_advanced);
|
||||
obs_property_set_visible(obs_properties_get(props,
|
||||
"translate_input_tokenization_style"),
|
||||
!is_whisper && is_advanced);
|
||||
obs_property_set_visible(obs_properties_get(props, "translate_output"),
|
||||
!is_whisper && is_advanced);
|
||||
return true;
|
||||
});
|
||||
// add target language selection
|
||||
obs_property_t *prop_tgt = obs_properties_add_list(
|
||||
translation_group, "translate_target_language", MT_("target_language"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
obs_property_t *prop_src = obs_properties_add_list(
|
||||
translation_group, "translate_source_language", MT_("source_language"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_STRING);
|
||||
obs_properties_add_bool(translation_group, "translate_add_context",
|
||||
MT_("translate_add_context"));
|
||||
|
||||
// Populate the dropdown with the language codes
|
||||
for (const auto &language : language_codes) {
|
||||
obs_property_list_add_string(prop_tgt, language.second.c_str(),
|
||||
language.first.c_str());
|
||||
obs_property_list_add_string(prop_src, language.second.c_str(),
|
||||
language.first.c_str());
|
||||
}
|
||||
// add option for routing the translation to an output source
|
||||
obs_property_t *prop_output = obs_properties_add_list(translation_group, "translate_output",
|
||||
MT_("translate_output"),
|
||||
OBS_COMBO_TYPE_LIST,
|
||||
OBS_COMBO_FORMAT_STRING);
|
||||
obs_property_list_add_string(prop_output, "Write to captions output", "none");
|
||||
// TODO add file output option
|
||||
// obs_property_list_add_string(...
|
||||
obs_enum_sources(add_sources_to_list, prop_output);
|
||||
|
||||
// add callback to enable/disable translation group
|
||||
obs_property_set_modified_callback(translation_group_prop, translation_options_callback);
|
||||
// add tokenization style options
|
||||
obs_property_t *prop_token_style =
|
||||
obs_properties_add_list(translation_group, "translate_input_tokenization_style",
|
||||
MT_("translate_input_tokenization_style"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(prop_token_style, "M2M100 Tokens", INPUT_TOKENIZAION_M2M100);
|
||||
obs_property_list_add_int(prop_token_style, "T5 Tokens", INPUT_TOKENIZAION_T5);
|
||||
|
||||
// add translation options: beam_size, max_decoding_length, repetition_penalty, no_repeat_ngram_size, max_input_length, sampling_temperature
|
||||
obs_properties_add_float_slider(translation_group, "translation_sampling_temperature",
|
||||
MT_("translation_sampling_temperature"), 0.0, 1.0, 0.05);
|
||||
obs_properties_add_float_slider(translation_group, "translation_repetition_penalty",
|
||||
MT_("translation_repetition_penalty"), 1.0, 5.0, 0.25);
|
||||
obs_properties_add_int_slider(translation_group, "translation_beam_size",
|
||||
MT_("translation_beam_size"), 1, 10, 1);
|
||||
obs_properties_add_int_slider(translation_group, "translation_max_decoding_length",
|
||||
MT_("translation_max_decoding_length"), 1, 100, 5);
|
||||
obs_properties_add_int_slider(translation_group, "translation_max_input_length",
|
||||
MT_("translation_max_input_length"), 1, 100, 5);
|
||||
obs_properties_add_int_slider(translation_group, "translation_no_repeat_ngram_size",
|
||||
MT_("translation_no_repeat_ngram_size"), 1, 10, 1);
|
||||
|
||||
// create a file output group
|
||||
obs_properties_t *file_output_group = obs_properties_create();
|
||||
obs_property_t *file_output_group_prop =
|
||||
obs_properties_add_group(ppts, "file_output_enable", MT_("file_output_group"),
|
||||
OBS_GROUP_CHECKABLE, file_output_group);
|
||||
|
||||
// add a checkbox for file output
|
||||
obs_properties_add_path(file_output_group, "subtitle_output_filename",
|
||||
MT_("output_filename"), OBS_PATH_FILE_SAVE, "Text (*.txt)", NULL);
|
||||
obs_properties_add_bool(file_output_group, "subtitle_save_srt", MT_("save_srt"));
|
||||
obs_properties_add_bool(file_output_group, "truncate_output_file",
|
||||
MT_("truncate_output_file"));
|
||||
obs_properties_add_bool(file_output_group, "only_while_recording",
|
||||
MT_("only_while_recording"));
|
||||
obs_properties_add_bool(file_output_group, "rename_file_to_match_recording",
|
||||
MT_("rename_file_to_match_recording"));
|
||||
obs_property_set_modified_callback(file_output_group_prop, file_output_select_changed);
|
||||
|
||||
// add buffered output options group
|
||||
obs_properties_t *buffered_output_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "buffered_output_group", MT_("buffered_output_parameters"),
|
||||
OBS_GROUP_NORMAL, buffered_output_group);
|
||||
obs_property_t *buffered_output_prop = obs_properties_add_bool(
|
||||
buffered_output_group, "buffered_output", MT_("buffered_output"));
|
||||
// add buffer "type" character or word
|
||||
obs_property_t *buffer_type_list = obs_properties_add_list(
|
||||
buffered_output_group, "buffer_output_type", MT_("buffer_output_type"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(buffer_type_list, "Character", SEGMENTATION_TOKEN);
|
||||
obs_property_list_add_int(buffer_type_list, "Word", SEGMENTATION_WORD);
|
||||
// add buffer lines parameter
|
||||
obs_properties_add_int_slider(buffered_output_group, "buffer_num_lines",
|
||||
MT_("buffer_num_lines"), 1, 5, 1);
|
||||
// add buffer number of characters per line parameter
|
||||
obs_properties_add_int_slider(buffered_output_group, "buffer_num_chars_per_line",
|
||||
MT_("buffer_num_chars_per_line"), 1, 100, 1);
|
||||
|
||||
// on enable/disable buffered output, show/hide the group
|
||||
obs_property_set_modified_callback(buffered_output_prop, [](obs_properties_t *props,
|
||||
obs_property_t *property,
|
||||
obs_data_t *settings) {
|
||||
UNUSED_PARAMETER(property);
|
||||
// If buffered output is enabled, show the buffered output group
|
||||
const bool show_hide = obs_data_get_bool(settings, "buffered_output");
|
||||
obs_property_set_visible(obs_properties_get(props, "buffered_output_group"),
|
||||
show_hide);
|
||||
return true;
|
||||
});
|
||||
|
||||
// add a group for advanced configuration
|
||||
obs_properties_t *advanced_config_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "advanced_group", MT_("advanced_group"), OBS_GROUP_NORMAL,
|
||||
advanced_config_group);
|
||||
|
||||
obs_properties_add_bool(advanced_config_group, "caption_to_stream",
|
||||
MT_("caption_to_stream"));
|
||||
|
||||
obs_properties_add_int_slider(advanced_config_group, "min_sub_duration",
|
||||
MT_("min_sub_duration"), 1000, 5000, 50);
|
||||
obs_properties_add_float_slider(advanced_config_group, "sentence_psum_accept_thresh",
|
||||
MT_("sentence_psum_accept_thresh"), 0.0, 1.0, 0.05);
|
||||
|
||||
obs_properties_add_bool(advanced_config_group, "process_while_muted",
|
||||
MT_("process_while_muted"));
|
||||
|
||||
obs_properties_add_bool(advanced_config_group, "vad_enabled", MT_("vad_enabled"));
|
||||
// add vad threshold slider
|
||||
obs_properties_add_float_slider(advanced_config_group, "vad_threshold",
|
||||
MT_("vad_threshold"), 0.0, 1.0, 0.05);
|
||||
|
||||
// add a group for Logging options
|
||||
obs_properties_t *log_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "log_group", MT_("log_group"), OBS_GROUP_NORMAL, log_group);
|
||||
|
||||
obs_properties_add_bool(log_group, "log_words", MT_("log_words"));
|
||||
obs_property_t *list = obs_properties_add_list(log_group, "log_level", MT_("log_level"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(list, "DEBUG (Won't show)", LOG_DEBUG);
|
||||
obs_property_list_add_int(list, "INFO", LOG_INFO);
|
||||
obs_property_list_add_int(list, "WARNING", LOG_WARNING);
|
||||
|
||||
// add button to open filter and replace UI dialog
|
||||
obs_properties_add_button2(
|
||||
advanced_config_group, "open_filter_ui", MT_("open_filter_ui"),
|
||||
[](obs_properties_t *props, obs_property_t *property, void *data_) {
|
||||
UNUSED_PARAMETER(props);
|
||||
UNUSED_PARAMETER(property);
|
||||
struct transcription_filter_data *gf_ =
|
||||
static_cast<struct transcription_filter_data *>(data_);
|
||||
FilterReplaceDialog *filter_replace_dialog = new FilterReplaceDialog(
|
||||
(QWidget *)obs_frontend_get_main_window(), gf_);
|
||||
filter_replace_dialog->exec();
|
||||
// store the filter data on the source settings
|
||||
obs_data_t *settings = obs_source_get_settings(gf_->context);
|
||||
// serialize the filter data
|
||||
const std::string filter_data =
|
||||
serialize_filter_words_replace(gf_->filter_words_replace);
|
||||
obs_data_set_string(settings, "filter_words_replace", filter_data.c_str());
|
||||
obs_data_release(settings);
|
||||
return true;
|
||||
},
|
||||
gf);
|
||||
|
||||
obs_properties_t *whisper_params_group = obs_properties_create();
|
||||
obs_properties_add_group(ppts, "whisper_params_group", MT_("whisper_parameters"),
|
||||
OBS_GROUP_NORMAL, whisper_params_group);
|
||||
|
||||
obs_property_t *whisper_sampling_method_list = obs_properties_add_list(
|
||||
whisper_params_group, "whisper_sampling_method", MT_("whisper_sampling_method"),
|
||||
OBS_COMBO_TYPE_LIST, OBS_COMBO_FORMAT_INT);
|
||||
obs_property_list_add_int(whisper_sampling_method_list, "Beam search",
|
||||
WHISPER_SAMPLING_BEAM_SEARCH);
|
||||
obs_property_list_add_int(whisper_sampling_method_list, "Greedy", WHISPER_SAMPLING_GREEDY);
|
||||
|
||||
// int n_threads;
|
||||
obs_properties_add_int_slider(whisper_params_group, "n_threads", MT_("n_threads"), 1, 8, 1);
|
||||
// int n_max_text_ctx; // max tokens to use from past text as prompt for the decoder
|
||||
obs_properties_add_int_slider(whisper_params_group, "n_max_text_ctx", MT_("n_max_text_ctx"),
|
||||
0, 16384, 100);
|
||||
// int offset_ms; // start offset in ms
|
||||
// int duration_ms; // audio duration to process in ms
|
||||
// bool translate;
|
||||
obs_properties_add_bool(whisper_params_group, "whisper_translate",
|
||||
MT_("whisper_translate"));
|
||||
// bool no_context; // do not use past transcription (if any) as initial prompt for the decoder
|
||||
obs_properties_add_bool(whisper_params_group, "no_context", MT_("no_context"));
|
||||
// bool single_segment; // force single segment output (useful for streaming)
|
||||
obs_properties_add_bool(whisper_params_group, "single_segment", MT_("single_segment"));
|
||||
// bool print_special; // print special tokens (e.g. <SOT>, <EOT>, <BEG>, etc.)
|
||||
obs_properties_add_bool(whisper_params_group, "print_special", MT_("print_special"));
|
||||
// bool print_progress; // print progress information
|
||||
obs_properties_add_bool(whisper_params_group, "print_progress", MT_("print_progress"));
|
||||
// bool print_realtime; // print results from within whisper.cpp (avoid it, use callback instead)
|
||||
obs_properties_add_bool(whisper_params_group, "print_realtime", MT_("print_realtime"));
|
||||
// bool print_timestamps; // print timestamps for each text segment when printing realtime
|
||||
obs_properties_add_bool(whisper_params_group, "print_timestamps", MT_("print_timestamps"));
|
||||
// bool token_timestamps; // enable token-level timestamps
|
||||
obs_properties_add_bool(whisper_params_group, "token_timestamps", MT_("token_timestamps"));
|
||||
// enable DTW timestamps
|
||||
obs_properties_add_bool(whisper_params_group, "dtw_token_timestamps",
|
||||
MT_("dtw_token_timestamps"));
|
||||
// float thold_pt; // timestamp token probability threshold (~0.01)
|
||||
obs_properties_add_float_slider(whisper_params_group, "thold_pt", MT_("thold_pt"), 0.0f,
|
||||
1.0f, 0.05f);
|
||||
// float thold_ptsum; // timestamp token sum probability threshold (~0.01)
|
||||
obs_properties_add_float_slider(whisper_params_group, "thold_ptsum", MT_("thold_ptsum"),
|
||||
0.0f, 1.0f, 0.05f);
|
||||
// int max_len; // max segment length in characters
|
||||
obs_properties_add_int_slider(whisper_params_group, "max_len", MT_("max_len"), 0, 100, 1);
|
||||
// bool split_on_word; // split on word rather than on token (when used with max_len)
|
||||
obs_properties_add_bool(whisper_params_group, "split_on_word", MT_("split_on_word"));
|
||||
// int max_tokens; // max tokens per segment (0 = no limit)
|
||||
obs_properties_add_int_slider(whisper_params_group, "max_tokens", MT_("max_tokens"), 0, 100,
|
||||
1);
|
||||
// bool speed_up; // speed-up the audio by 2x using Phase Vocoder
|
||||
obs_properties_add_bool(whisper_params_group, "speed_up", MT_("speed_up"));
|
||||
// const char * initial_prompt;
|
||||
obs_properties_add_text(whisper_params_group, "initial_prompt", MT_("initial_prompt"),
|
||||
OBS_TEXT_DEFAULT);
|
||||
// bool suppress_blank
|
||||
obs_properties_add_bool(whisper_params_group, "suppress_blank", MT_("suppress_blank"));
|
||||
// bool suppress_non_speech_tokens
|
||||
obs_properties_add_bool(whisper_params_group, "suppress_non_speech_tokens",
|
||||
MT_("suppress_non_speech_tokens"));
|
||||
// float temperature
|
||||
obs_properties_add_float_slider(whisper_params_group, "temperature", MT_("temperature"),
|
||||
0.0f, 1.0f, 0.05f);
|
||||
// float max_initial_ts
|
||||
obs_properties_add_float_slider(whisper_params_group, "max_initial_ts",
|
||||
MT_("max_initial_ts"), 0.0f, 1.0f, 0.05f);
|
||||
// float length_penalty
|
||||
obs_properties_add_float_slider(whisper_params_group, "length_penalty",
|
||||
MT_("length_penalty"), -1.0f, 1.0f, 0.1f);
|
||||
|
||||
// Add a informative text about the plugin
|
||||
obs_properties_add_text(
|
||||
ppts, "info",
|
||||
QString(PLUGIN_INFO_TEMPLATE).arg(PLUGIN_VERSION).toStdString().c_str(),
|
||||
OBS_TEXT_INFO);
|
||||
|
||||
UNUSED_PARAMETER(data);
|
||||
return ppts;
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user