Ruby

[ggerganov]

General discussion about the ruby bindings for whisper.cpp

Current state: bindings/ruby

Initial merge: #500
CC: @taf2

[taf2]

Working on getting a gem published to rubygems so people can just

gem install whispercpp

[taf2]

Looks like someone already published a gem named whisper... So I think if we go with whispercpp - that would make sense and is available. Will work on pushing a gem and pull request.

[taf2]

@ggerganov I'm looking for good solution to interrupt whisper_full_parallel. In ruby we can wrap the call to this in an unlock method, since ruby has a global interpreter lock it is ideal to unlock while the c++ code runs allowing ruby to run other threads and even be interrupted via ctrl+c and other interrupt signals. It looks whisper_full_parallel calls whisper_full in each thread or just calls whisper_full, if there was a maybe volatile stop variable we added to the context then we could toggle that to false/0 and cause the while loop to break. thoughts?

[ggerganov]

There is currently an existing abort mechanism via the "encoder_begin" callback:

whisper.cpp/whisper.h

Lines 240 to 245 in f420de1

	// Encoder begin callback
	// If not NULL, called before the encoder starts
	// If it returns false, the computation is aborted
	typedef bool (*whisper_encoder_begin_callback)(struct whisper_context * ctx, void * user_data);

Would this work?

[taf2]

ah perfect - i'll dig into this and rework the ruby bindings to use that shortly.

[ggerganov]

Usage of the abort mechanism is demonstrated here:

whisper.cpp/examples/main/main.cpp

Lines 603 to 616 in b4ebdb6

	// example for abort mechanism
	// in this example, we do not abort the processing, but we could if the flag is set to true
	// the callback is called before every encoder run - if it returns false, the processing is aborted
	{
	static bool is_aborted = false; // NOTE: this should be atomic to avoid data race
	wparams.encoder_begin_callback = [](struct whisper_context * /*ctx*/, void * user_data) {
	bool is_aborted = *(bool*)user_data;
	return !is_aborted;
	};
	wparams.encoder_begin_callback_user_data = &is_aborted;
	}

[brauliobo]

am I missing something? It doesn't install here. I have whisper.cpp AUR package installed on the system

braulio @ bhavapower ➜  ruby-whisper.cpp git:(main) ✗  LANG=en gem install whispercpp
Building native extensions. This could take a while...
ERROR:  Error installing whispercpp:
        ERROR: Failed to build gem native extension.

    current directory: /home/braulio/.rvm/gems/ruby-3.1.2/gems/whispercpp-1.3.0/ext
/home/braulio/.rvm/rubies/ruby-3.1.2/bin/ruby -I /home/braulio/.rvm/rubies/ruby-3.1.2/lib/ruby/3.1.0 -r ./siteconf20240926-2567174-n68uhi.rb extconf.rb
cp: cannot stat './../../../whisper.cpp': No such file or directory
cp: cannot stat './../../../whisper.h': No such file or directory
cp: cannot stat './../../../ggml.h': No such file or directory
cp: cannot stat './../../../ggml.c': No such file or directory
cp: cannot stat './../../../ggml-impl.h': No such file or directory
cp: cannot stat './../../../ggml-alloc.h': No such file or directory
cp: cannot stat './../../../ggml-alloc.c': No such file or directory
cp: cannot stat './../../../ggml-backend-impl.h': No such file or directory
cp: cannot stat './../../../ggml-backend.h': No such file or directory
cp: cannot stat './../../../ggml-backend.c': No such file or directory
cp: cannot stat './../../../ggml-common.h': No such file or directory
cp: cannot stat './../../../ggml-quants.h': No such file or directory
cp: cannot stat './../../../ggml-quants.c': No such file or directory
cp: cannot stat './../../../examples/dr_wav.h': No such file or directory
creating Makefile

current directory: /home/braulio/.rvm/gems/ruby-3.1.2/gems/whispercpp-1.3.0/ext
make DESTDIR\= clean

current directory: /home/braulio/.rvm/gems/ruby-3.1.2/gems/whispercpp-1.3.0/ext
make DESTDIR\=
compiling ggml.c
ggml.c:4:10: fatal error: ggml-impl.h: No such file or directory
    4 | #include "ggml-impl.h"
      |          ^~~~~~~~~~~~~
compilation terminated.
make: *** [Makefile:246: ggml.o] Error 1

make failed, exit code 2

Gem files will remain installed in /home/braulio/.rvm/gems/ruby-3.1.2/gems/whispercpp-1.3.0 for inspection.
Results logged to /home/braulio/.rvm/gems/ruby-3.1.2/extensions/x86_64-linux/3.1.0/whispercpp-1.3.0/gem_make.out

[brauliobo]

just pushed a new gem at https://rubygems.org/gems/whisper.cpp