refactor: transcription logic to whisper module

Author: Robitx

lua/gp/config.lua

@@ -364,35 +364,39 @@ local config = {
 	-- by eliminating silence and speeding up the tempo of the recording
 	-- we can reduce the cost by 50% or more and get the results faster
 
-	-- OpenAI audio/transcriptions api endpoint to transcribe audio to text
-	whisper_api_endpoint = "https://api.openai.com/v1/audio/transcriptions",
-	-- directory for storing whisper files
-	whisper_dir = (os.getenv("TMPDIR") or os.getenv("TEMP") or "/tmp") .. "/gp_whisper",
-	-- multiplier of RMS level dB for threshold used by sox to detect silence vs speech
-	-- decibels are negative, the recording is normalized to -3dB =>
-	-- increase this number to pick up more (weaker) sounds as possible speech
-	-- decrease this number to pick up only louder sounds as possible speech
-	-- you can disable silence trimming by setting this a very high number (like 1000.0)
-	whisper_silence = "1.75",
-	-- whisper tempo (1.0 is normal speed)
-	whisper_tempo = "1.75",
-	-- The language of the input audio, in ISO-639-1 format.
-	whisper_language = "en",
-	-- command to use for recording can be nil (unset) for automatic selection
-	-- string ("sox", "arecord", "ffmpeg") or table with command and arguments:
-	-- sox is the most universal, but can have start/end cropping issues caused by latency
-	-- arecord is linux only, but has no cropping issues and is faster
-	-- ffmpeg in the default configuration is macos only, but can be used on any platform
-	-- (see https://trac.ffmpeg.org/wiki/Capture/Desktop for more info)
-	-- below is the default configuration for all three commands:
-	-- whisper_rec_cmd = {"sox", "-c", "1", "--buffer", "32", "-d", "rec.wav", "trim", "0", "60:00"},
-	-- whisper_rec_cmd = {"arecord", "-c", "1", "-f", "S16_LE", "-r", "48000", "-d", "3600", "rec.wav"},
-	-- whisper_rec_cmd = {"ffmpeg", "-y", "-f", "avfoundation", "-i", ":0", "-t", "3600", "rec.wav"},
-	whisper_rec_cmd = nil,
+	whisper = {
+		-- you can disable whisper completely by whisper = {disable = true}
+		disable = false,
+		-- OpenAI audio/transcriptions api endpoint to transcribe audio to text
+		endpoint = "https://api.openai.com/v1/audio/transcriptions",
+		-- directory for storing whisper files
+		store_dir = (os.getenv("TMPDIR") or os.getenv("TEMP") or "/tmp") .. "/gp_whisper",
+		-- multiplier of RMS level dB for threshold used by sox to detect silence vs speech
+		-- decibels are negative, the recording is normalized to -3dB =>
+		-- increase this number to pick up more (weaker) sounds as possible speech
+		-- decrease this number to pick up only louder sounds as possible speech
+		-- you can disable silence trimming by setting this a very high number (like 1000.0)
+		silence = "1.75",
+		-- whisper tempo (1.0 is normal speed)
+		tempo = "1.75",
+		-- The language of the input audio, in ISO-639-1 format.
+		language = "en",
+		-- command to use for recording can be nil (unset) for automatic selection
+		-- string ("sox", "arecord", "ffmpeg") or table with command and arguments:
+		-- sox is the most universal, but can have start/end cropping issues caused by latency
+		-- arecord is linux only, but has no cropping issues and is faster
+		-- ffmpeg in the default configuration is macos only, but can be used on any platform
+		-- (see https://trac.ffmpeg.org/wiki/Capture/Desktop for more info)
+		-- below is the default configuration for all three commands:
+		-- whisper_rec_cmd = {"sox", "-c", "1", "--buffer", "32", "-d", "rec.wav", "trim", "0", "60:00"},
+		-- whisper_rec_cmd = {"arecord", "-c", "1", "-f", "S16_LE", "-r", "48000", "-d", "3600", "rec.wav"},
+		-- whisper_rec_cmd = {"ffmpeg", "-y", "-f", "avfoundation", "-i", ":0", "-t", "3600", "rec.wav"},
+		rec_cmd = nil,
+	},
 
 	-- image generation settings
 	image = {
-		-- you can disable image generation logic completely by image.disable = true
+		-- you can disable image generation logic completely by image = {disable = true}
 		disable = false,
 
 		-- required openai api key (string or table with command and arguments)

lua/gp/deprecator.lua

@@ -11,11 +11,11 @@ M._deprecated = {}
 
 local switch_to_agent = "Please use `agents` table and switch agents in runtime via `:GpAgent XY`"
 
-local image_nested = function(variable)
-	local new_variable = variable:gsub("image_", "")
+local nested = function(variable, prefix)
+	local new_variable = variable:gsub(prefix .. "_", "")
 	return render.template(
-		"`{{old}}`\nPlease use `image = { {{new}} = ... }`",
-		{ ["{{old}}"] = variable, ["{{new}}"] = new_variable }
+		"`{{old}}`\nPlease use `{{prefix}} = { {{new}} = ... }`",
+		{ ["{{old}}"] = variable, ["{{new}}"] = new_variable, ["{{prefix}}"] = prefix }
 	)
 end
 
@@ -44,6 +44,8 @@ local deprecated = {
 		.. "\nThe `openai_api_key` is still supported for backwards compatibility,\n"
 		.. "and automatically converted to `providers.openai.secret` if the new config is not set.",
 	image_dir = "`image_dir`\nPlease use `image = { store_dir = ... }`",
+	whisper_dir = "`whisper_dir`\nPlease use `whisper = { store_dir = ... }`",
+	whisper_api_endpoint = "`whisper_api_endpoint`\nPlease use `whisper = { endpoint = ... }`",
 }
 
 M.is_valid = function(k, v)
@@ -52,7 +54,11 @@ M.is_valid = function(k, v)
 		return false
 	end
 	if helpers.starts_with(k, "image_") then
-		table.insert(M._deprecated, { name = k, msg = image_nested(k), value = v })
+		table.insert(M._deprecated, { name = k, msg = nested(k, "image"), value = v })
+		return false
+	end
+	if helpers.starts_with(k, "whisper_") then
+		table.insert(M._deprecated, { name = k, msg = nested(k, "whisper"), value = v })
 		return false
 	end
 	return true

lua/gp/imager.lua

@@ -11,6 +11,7 @@ local I = {
 	config = {},
 	_state = {},
 	cmd = {},
+	disabled = false,
 }
 
 ---@param opts table # user config
@@ -20,6 +21,7 @@ I.setup = function(opts)
 	I.config = vim.deepcopy(default_config.image)
 
 	if opts.disable then
+		I.disabled = true
 		logger.debug("imager is disabled")
 		return
 	end
@@ -69,6 +71,7 @@ I.setup = function(opts)
 	I.refresh()
 
 	for cmd, _ in pairs(I.cmd) do
+		-- TODO: this could be a helper function
 		vim.api.nvim_create_user_command(I.config.cmd_prefix .. cmd, function(params)
 			I.cmd[cmd](params)
 		end, {