Merge pull request #30 from mutablelogic/v1

Added a CLI interface to the server

Author: djthorpe

Makefile

@@ -14,6 +14,23 @@ BUILD_TAG := ${DOCKER_REGISTRY}/go-whisper-${OS}-${ARCH}:${VERSION}
 ROOT_PATH := $(CURDIR)
 BUILD_DIR := build
 
+# Targets
+all: build server cli
+
+# Make server
+server: mkdir go-tidy libwhisper libggml
+	@echo "Building whisper-server"
+	@CGO_CFLAGS="-I${ROOT_PATH}/third_party/whisper.cpp/include -I${ROOT_PATH}/third_party/whisper.cpp/ggml/include" \
+	 CGO_LDFLAGS="-L${ROOT_PATH}/third_party/whisper.cpp" \
+	 ${GO} build -o ${BUILD_DIR}/whisper-server ./cmd/server
+
+# Make cli
+cli: mkdir go-tidy
+	@echo "Building whisper-cli"
+	@CGO_CFLAGS="-I${ROOT_PATH}/third_party/whisper.cpp/include -I${ROOT_PATH}/third_party/whisper.cpp/ggml/include" \
+	 CGO_LDFLAGS="-L${ROOT_PATH}/third_party/whisper.cpp" \
+	 ${GO} build -o ${BUILD_DIR}/whisper-cli ./cmd/cli
+
 # Build docker container
 docker: docker-dep submodule
 	@echo build docker image: ${BUILD_TAG} for ${OS}/${ARCH}
@@ -25,22 +42,16 @@ docker: docker-dep submodule
 		--build-arg VERSION=${VERSION} \
 		-f etc/Dockerfile.${ARCH} .
 
-# Targets
-all: build server
-
-# Make server
-server: mkdir go-tidy libwhisper libggml
-	@echo "Building whisper-server"
-	@CGO_CFLAGS="-I${ROOT_PATH}/third_party/whisper.cpp/include -I${ROOT_PATH}/third_party/whisper.cpp/ggml/include" \
-	 CGO_LDFLAGS="-L${ROOT_PATH}/third_party/whisper.cpp" \
-	 ${GO} build -o ${BUILD_DIR}/whisper-server ./cmd/server
-
 # Test whisper bindings
 test: go-tidy libwhisper libggml
-	@echo "Running tests"
+	@echo "Running tests (sys)"
 	@CGO_CFLAGS="-I${ROOT_PATH}/third_party/whisper.cpp/include -I${ROOT_PATH}/third_party/whisper.cpp/ggml/include" \
 	 CGO_LDFLAGS="-L${ROOT_PATH}/third_party/whisper.cpp" \
 	 ${GO} test -v ./sys/whisper/...
+	@echo "Running tests (pkg)"
+	@CGO_CFLAGS="-I${ROOT_PATH}/third_party/whisper.cpp/include -I${ROOT_PATH}/third_party/whisper.cpp/ggml/include" \
+	 CGO_LDFLAGS="-L${ROOT_PATH}/third_party/whisper.cpp" \
+	 ${GO} test -v ./pkg/whisper/...
 
 # Build whisper-static-library
 libwhisper: submodule

cmd/cli/delete.go

@@ -0,0 +1,13 @@
+package main
+
+type DeleteCmd struct {
+	Id string `arg:"" required:"" help:"Model Identifier" type:"string"`
+}
+
+func (cmd *DeleteCmd) Run(ctx *Globals) error {
+	err := ctx.api.DeleteModel(ctx.ctx, cmd.Id)
+	if err != nil {
+		return err
+	}
+	return nil
+}

cmd/cli/download.go

@@ -0,0 +1,34 @@
+package main
+
+import "fmt"
+
+type DownloadCmd struct {
+	Path string `arg:"" required:"" help:"Model Path" type:"string"`
+}
+
+func (cmd *DownloadCmd) Run(ctx *Globals) error {
+	type progress struct {
+		Status    string `json:"status" writer:",width:60"`
+		Total     int64  `json:"total,omitempty" writer:",right,width:12,"`
+		Completed int64  `json:"completed,omitempty" writer:",right,width:12,"`
+		Percent   string `json:"percent,omitempty" writer:",width:8,right"`
+	}
+	model, err := ctx.api.DownloadModel(ctx.ctx, cmd.Path, func(status string, cur, total int64) {
+		percent := ""
+		if cur < total {
+			percent = fmt.Sprintf("%.1f%%", float32(cur)*100/float32(total))
+		}
+		if status != "" {
+			ctx.writer.Write(progress{
+				Status:    status,
+				Completed: cur,
+				Total:     total,
+				Percent:   percent,
+			})
+		}
+	})
+	if err != nil {
+		return err
+	}
+	return ctx.writer.Write(model)
+}

cmd/cli/main.go

@@ -0,0 +1,87 @@
+package main
+
+import (
+	"context"
+	"os"
+	"path/filepath"
+	"syscall"
+
+	// Packages
+	kong "github.com/alecthomas/kong"
+	tablewriter "github.com/djthorpe/go-tablewriter"
+	client "github.com/mutablelogic/go-client"
+	ctx "github.com/mutablelogic/go-server/pkg/context"
+	api "github.com/mutablelogic/go-whisper/pkg/client"
+)
+
+type Globals struct {
+	Debug    bool   `name:"debug" help:"Enable debug output"`
+	Endpoint string `name:"endpoint" help:"HTTP endpoint for whisper service (set WHISPER_URL environment variable to use as default)" default:"${WHISPER_URL}"`
+
+	// Writer, client and context
+	writer *tablewriter.Writer
+	api    *api.Client
+	ctx    context.Context
+}
+
+type CLI struct {
+	Globals
+	Models     ModelsCmd     `cmd:"models" help:"List available models"`
+	Delete     DeleteCmd     `cmd:"delete" help:"Delete a model"`
+	Download   DownloadCmd   `cmd:"download" help:"Download a model"`
+	Transcribe TranscribeCmd `cmd:"transcribe" help:"Transcribe a file"`
+	Translate  TranslateCmd  `cmd:"translate" help:"Translate a file"`
+}
+
+func main() {
+	// The name of the executable
+	name, err := os.Executable()
+	if err != nil {
+		panic(err)
+	} else {
+		name = filepath.Base(name)
+	}
+
+	// Create a cli parser
+	cli := CLI{}
+	cmd := kong.Parse(&cli,
+		kong.Name(name),
+		kong.Description("speech transcription and translation service"),
+		kong.UsageOnError(),
+		kong.ConfigureHelp(kong.HelpOptions{Compact: true}),
+		kong.Vars{
+			"WHISPER_URL": endpointEnvOrDefault(),
+		},
+	)
+
+	// Create a whisper client
+	opts := []client.ClientOpt{}
+	if cli.Globals.Debug {
+		opts = append(opts, client.OptTrace(os.Stderr, true))
+	}
+	client, err := api.New(cli.Globals.Endpoint, opts...)
+	if err != nil {
+		cmd.FatalIfErrorf(err)
+	} else {
+		cli.Globals.api = client
+	}
+
+	// Create a tablewriter object with text output
+	writer := tablewriter.New(os.Stdout, tablewriter.OptOutputText())
+	cli.Globals.writer = writer
+
+	// Create a context
+	cli.Globals.ctx = ctx.ContextForSignal(os.Interrupt, syscall.SIGQUIT)
+
+	// Run the command
+	if err := cmd.Run(&cli.Globals); err != nil {
+		cmd.FatalIfErrorf(err)
+	}
+}
+
+func endpointEnvOrDefault() string {
+	if endpoint := os.Getenv("WHISPER_URL"); endpoint != "" {
+		return endpoint
+	}
+	return "http://localhost:8080/v1"
+}

cmd/cli/models.go

@@ -0,0 +1,13 @@
+package main
+
+import tablewriter "github.com/djthorpe/go-tablewriter"
+
+type ModelsCmd struct{}
+
+func (_ *ModelsCmd) Run(ctx *Globals) error {
+	models, err := ctx.api.ListModels(ctx.ctx)
+	if err != nil {
+		return err
+	}
+	return ctx.writer.Write(models, tablewriter.OptHeader())
+}

cmd/cli/transcribe.go

@@ -0,0 +1,41 @@
+package main
+
+import (
+	"os"
+
+	"github.com/djthorpe/go-tablewriter"
+	"github.com/mutablelogic/go-whisper/pkg/client"
+)
+
+type TranscribeCmd struct {
+	Model       string   `arg:"" required:"" help:"Model Identifier" type:"string"`
+	Path        string   `arg:"" required:"" help:"Audio File Path" type:"string"`
+	Language    string   `flag:"language" help:"Source Language" type:"string"`
+	Prompt      string   `flag:"prompt" help:"Initial Prompt Identifier" type:"string"`
+	Temperature *float32 `flag:"temperature" help:"Temperature" type:"float32"`
+}
+
+func (cmd *TranscribeCmd) Run(ctx *Globals) error {
+	r, err := os.Open(cmd.Path)
+	if err != nil {
+		return err
+	}
+	defer r.Close()
+
+	opts := []client.Opt{}
+	if cmd.Language != "" {
+		opts = append(opts, client.OptLanguage(cmd.Language))
+	}
+	if cmd.Prompt != "" {
+		opts = append(opts, client.OptPrompt(cmd.Prompt))
+	}
+	if cmd.Temperature != nil {
+		opts = append(opts, client.OptTemperature(*cmd.Temperature))
+	}
+
+	transcription, err := ctx.api.Transcribe(ctx.ctx, cmd.Model, r, opts...)
+	if err != nil {
+		return err
+	}
+	return ctx.writer.Write(transcription, tablewriter.OptHeader())
+}

cmd/cli/translate.go

@@ -0,0 +1,41 @@
+package main
+
+import (
+	"os"
+
+	"github.com/djthorpe/go-tablewriter"
+	"github.com/mutablelogic/go-whisper/pkg/client"
+)
+
+type TranslateCmd struct {
+	Model       string   `arg:"" required:"" help:"Model Identifier" type:"string"`
+	Path        string   `arg:"" required:"" help:"Audio File Path" type:"string"`
+	Language    string   `flag:"language" required:"" help:"Target Language" type:"string"`
+	Prompt      string   `flag:"prompt" help:"Initial Prompt Identifier" type:"string"`
+	Temperature *float32 `flag:"temperature" help:"Temperature" type:"float32"`
+}
+
+func (cmd *TranslateCmd) Run(ctx *Globals) error {
+	r, err := os.Open(cmd.Path)
+	if err != nil {
+		return err
+	}
+	defer r.Close()
+
+	opts := []client.Opt{}
+	if cmd.Language != "" {
+		opts = append(opts, client.OptLanguage(cmd.Language))
+	}
+	if cmd.Prompt != "" {
+		opts = append(opts, client.OptPrompt(cmd.Prompt))
+	}
+	if cmd.Temperature != nil {
+		opts = append(opts, client.OptTemperature(*cmd.Temperature))
+	}
+
+	transcription, err := ctx.api.Translate(ctx.ctx, cmd.Model, r, opts...)
+	if err != nil {
+		return err
+	}
+	return ctx.writer.Write(transcription, tablewriter.OptHeader())
+}

cmd/server/main.go

@@ -6,9 +6,13 @@ import (
 	"net/http"
 	"os"
 	"path/filepath"
+	"strconv"
 	"strings"
+	"syscall"
 
 	// Packages
+	context "github.com/mutablelogic/go-server/pkg/context"
+	httpserver "github.com/mutablelogic/go-server/pkg/httpserver"
 	api "github.com/mutablelogic/go-whisper/pkg/api"
 	whisper "github.com/mutablelogic/go-whisper/pkg/whisper"
 	sys "github.com/mutablelogic/go-whisper/sys/whisper"
@@ -27,7 +31,7 @@ func main() {
 
 	// Set logging
 	sys.Whisper_log_set(func(level sys.LogLevel, text string) {
-		if flags.Debug() && level == sys.LogLevelDebug || level == sys.LogLevelInfo || level == sys.LogLevelWarn {
+		if flags.Debug() && (level == sys.LogLevelDebug || level == sys.LogLevelInfo || level == sys.LogLevelWarn) {
 			return
 		}
 		log.Println(level, strings.TrimSpace(text))
@@ -58,13 +62,44 @@ func main() {
 		os.Exit(-2)
 	}
 
-	// Register the endpoints
-	api.RegisterEndpoints(flags.Endpoint(), http.DefaultServeMux, whisper)
+	// Display models
+	var models []string
+	for _, model := range whisper.ListModels() {
+		models = append(models, strconv.Quote(model.Id))
+	}
+	if len(models) > 0 {
+		log.Println("Models:", strings.Join(models, ", "))
+	} else {
+		log.Println("No models")
+	}
+
+	// Create a mux for serving requests, then register the endpoints with the mux
+	mux := http.NewServeMux()
+	api.RegisterEndpoints(flags.Endpoint(), mux, whisper)
 
-	// Start the server
-	log.Println("Listening on", flags.Listen())
-	if err := http.ListenAndServe(flags.Listen(), nil); err != nil {
+	// Create a new HTTP server
+	log.Println("List address", flags.Listen())
+	server, err := httpserver.Config{
+		Listen: flags.Listen(),
+		Router: mux,
+	}.New()
+	if err != nil {
 		log.Println(err)
 		os.Exit(-2)
 	}
+
+	// Run the server until CTRL+C
+	log.Println("Press CTRL+C to exit")
+	ctx := context.ContextForSignal(os.Interrupt, syscall.SIGQUIT)
+	if err := server.Run(ctx); err != nil {
+		log.Println(err)
+		os.Exit(-3)
+	}
+
+	// Release whisper resources
+	log.Println("Terminating")
+	if err := whisper.Close(); err != nil {
+		log.Println(err)
+		os.Exit(-4)
+	}
 }

go.mod

@@ -3,15 +3,23 @@ module github.com/mutablelogic/go-whisper
 go 1.22
 
 require (
+	github.com/alecthomas/kong v0.9.0
+	github.com/djthorpe/go-tablewriter v0.0.7
 	github.com/go-audio/wav v1.1.0
+	github.com/mutablelogic/go-client v1.0.8
+	github.com/mutablelogic/go-server v1.4.10
 	github.com/stretchr/testify v1.9.0
-	golang.org/x/exp v0.0.0-20240719175910-8a7402abbf56
 )
 
 require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
+	github.com/djthorpe/go-errors v1.0.3 // indirect
 	github.com/go-audio/audio v1.0.0 // indirect
 	github.com/go-audio/riff v1.0.0 // indirect
+	github.com/mattn/go-runewidth v0.0.15 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rivo/uniseg v0.4.7 // indirect
+	golang.org/x/sys v0.21.0 // indirect
+	golang.org/x/term v0.21.0 // indirect
 	gopkg.in/yaml.v3 v3.0.1 // indirect
 )