Add C API for WhisperPipeline #2414

BrandonWeng · 2025-07-09T23:08:25Z

Following the LLM pipeline PR: 5636312#diff-38c2966d1144b82978ca2cfe7650879fb15bd6da5845a3c616e8d152b29317f1

./build/samples/c/whisper_speech_recognition/whisper_speech_recognition_c -m "/home/brandon/openvino.genai/ov_cache0/test_models/WhisperTiny/openai/whisper-tiny" -i "/home/brandon/openvino.genai/ov_cache0/test_data/how_are_you_doing_today.wav" --timestamps
 How are you doing today?
timestamps: [0.00, 2.00] text: How are you doing today?

~/openvino.genai$   SAMPLES_CPP_DIR=/home/brandon/openvino.genai/build/samples/cpp SAMPLES_C_DIR=/home/brandon/openvino.genai/build/samples/c python -m pytest tests/python_tests/samples -m whisper
========================================================================================== test session starts ===========================================================================================
platform linux -- Python 3.12.3, pytest-8.4.1, pluggy-1.6.0
rootdir: /home/brandon/openvino.genai/tests/python_tests
configfile: pytest.ini
plugins: langsmith-0.4.4, html-4.1.1, anyio-4.9.0, metadata-3.1.1
collected 77 items / 74 deselected / 3 selected

tests/python_tests/samples/test_whisper_speech_recognition.py ...                                                                                                                                  [100%]

============================================================================================ warnings summary ============================================================================================
../../../usr/lib/python3.12/multiprocessing/popen_fork.py:66
  /usr/lib/python3.12/multiprocessing/popen_fork.py:66: DeprecationWarning: This process (pid=2217) is multi-threaded, use of fork() may lead to deadlocks in the child.
    self.pid = os.fork()

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
============================================================================== 3 passed, 74 deselected, 1 warning in 2.14s ===============================================================================

ps: would be great to get access to NPU from WSL2 - its sooo much easier to debug compared to Powershell
intel/linux-npu-driver#56

samples/c/whisper_speech_recognition/whisper_speech_recognition.c

rkazants · 2025-07-10T11:16:46Z

src/c/include/openvino/genai/c/generation_config.h

-OPENVINO_GENAI_C_EXPORTS ov_status_e ov_genai_generation_config_set_num_beam_groups(ov_genai_generation_config* config,
-                                                                                    const size_t value);
+OPENVINO_GENAI_C_EXPORTS ov_status_e ov_genai_generation_config_set_num_beam_group(ov_genai_generation_config* config,
+                                                                                   const size_t value);

 /**
 * @brief Set the number of beams for beam search. 1 disables beam search.
 * @param handle A pointer to the ov_genai_generation_config instance.
 * @param value The number of beams for beam search.
 * @return ov_status_e A status code, return OK(0) if successful.
 */
-OPENVINO_GENAI_C_EXPORTS ov_status_e ov_genai_generation_config_set_num_beam_groups(ov_genai_generation_config* config,
-                                                                                    const size_t value);
+OPENVINO_GENAI_C_EXPORTS ov_status_e ov_genai_generation_config_set_num_beams(ov_genai_generation_config* config,
+                                                                              const size_t value);


why is it changed? Our API should be backward-compatible

I was confused here - the previous signatures were exactly the same but the comments mention different functionality. Perhaps only the second one should change

src/c/include/openvino/genai/c/generation_config.h

src/c/src/generation_config.cpp

samples/c/whisper_speech_recognition/CMakeLists.txt

samples/c/whisper_speech_recognition/whisper_speech_recognition.c

tests/python_tests/samples/test_whisper_speech_recognition.py

Wovchena · 2025-07-18T06:38:02Z

samples/c/whisper_speech_recognition/whisper_utils.c

+    options->sample_rate = DEFAULT_SAMPLE_RATE;
+
+    for (int i = 1; i < argc; i++) {
+        if (strcmp(argv[i], "-m") == 0 || strcmp(argv[i], "--model") == 0) {


С++ has simpler cmd interface inviting readers to modify the implementation themselves. Is there a reason to deviate from that? Of not, align them

Fair point, initially I also had benchmarking in this file so arguments was based on the benchmark_genai_c file .

But the performance benchmarks was removed from here so no point of the complicated arguments anymore . Let me remove

Addressed: #2414 (comment)

src/c/include/openvino/genai/c/generation_config.h

samples/c/whisper_speech_recognition/whisper_speech_recognition.c

BrandonWeng · 2025-07-19T00:00:04Z

Simplified the arguments. Thanks for the review @Wovchena - ready for another go 🙏🏻

[ 98%] Built target openvino_genai_c
[100%] Building C object samples/c/whisper_speech_recognition/CMakeFiles/whisper_speech_recognition_c.dir/whisper_speech_recognition.c.o
[100%] Building C object samples/c/whisper_speech_recognition/CMakeFiles/whisper_speech_recognition_c.dir/whisper_utils.c.o
[100%] Linking C executable whisper_speech_recognition_c
[100%] Built target whisper_speech_recognition_c
> ./samples_bin/whisper_speech_recognition_c 'ov_cache0/test_models/WhisperTiny/openai/whisper-tiny' 'ov_cache0/test_data/how_are_you_doing_today.wav'
 How are you doing today?
timestamps: [0.00, 2.00] text:  How are you doing today?


> export SAMPLES_CPP_DIR="$(pwd)/samples_bin" && export SAMPLES_C_DIR="$(pwd)/samples_bin" && source .venv/bin/activate && python -m pytest
  tests/python_tests/samples/test_whisper_speech_recognition.py -v -m whisper
========================================================================================= test session starts =========================================================================================
platform linux -- Python 3.12.3, pytest-8.4.1, pluggy-1.6.0 -- /home/brandon/openvino.genai/.venv/bin/python
cachedir: .pytest_cache
metadata: {'Python': '3.12.3', 'Platform': 'Linux-5.15.167.4-microsoft-standard-WSL2-x86_64-with-glibc2.39', 'Packages': {'pytest': '8.4.1', 'pluggy': '1.6.0'}, 'Plugins': {'langsmith': '0.4.4', 'html': '4.1.1', 'anyio': '4.9.0', 'metadata': '3.1.1'}}
rootdir: /home/brandon/openvino.genai/tests/python_tests
configfile: pytest.ini
plugins: langsmith-0.4.4, html-4.1.1, anyio-4.9.0, metadata-3.1.1
collected 1 item

tests/python_tests/samples/test_whisper_speech_recognition.py::TestWhisperSpeechRecognition::test_sample_whisper_speech_recognition[download_test_content=how_are_you_doing_today.wav-convert_model=WhisperTiny] PASSED [100%]

========================================================================================== warnings summary ===========================================================================================
../../../usr/lib/python3.12/multiprocessing/popen_fork.py:66
  /usr/lib/python3.12/multiprocessing/popen_fork.py:66: DeprecationWarning: This process (pid=114380) is multi-threaded, use of fork() may lead to deadlocks in the child.
    self.pid = os.fork()

-- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html
==================================================================================== 1 passed, 1 warning in 2.36s =====================================================================================

Wovchena · 2025-07-21T07:05:38Z

samples/c/whisper_speech_recognition/whisper_speech_recognition.c

Add README.md (I missed that earlier. I hope this is going to be the last change request)

Good catch.

Added README (based off the C++ whisper and the C LLM Pipeline one) :
55a36e9

Wovchena

Thank you! There're CI problems, so this PR will hang unmerged for some time similar to others. Is that OK for you?

BrandonWeng · 2025-07-22T13:58:19Z

Thank you! There're CI problems, so this PR will hang unmerged for some time similar to others. Is that OK for you?

Woo! Thanks for all the reviews. Should be fine, I have what I need to continue .NET wrapper for whisper

https://github.com/FluidInference/OpenVINO.GenAI.NET

Wovchena · 2025-07-24T16:43:45Z

build_jenkins

Wovchena · 2025-07-25T07:21:38Z

Strangely I don't have permission to update your branch. Can you merge master yourself?

BrandonWeng · 2025-07-25T12:18:58Z

Strangely I don't have permission to update your branch. Can you merge master yourself?

Weird, I wonder if it’s because it’s my fork. updated

Wovchena · 2025-07-25T12:35:47Z

build_jenkins

BrandonWeng · 2025-07-26T01:45:45Z

@Wovchena it might be easiest if I just give you write access to our fork. Seems like the timing matters quite a bit here :'(

bweng-Google Chrome-2025-07-25-at-21 44 52

Also these tests seem a bit flakey?

Wovchena · 2025-07-26T08:21:59Z

build_jenkins

BrandonWeng and others added 6 commits July 9, 2025 12:00

Whisper C API

81ce0fc

Match LLM pipeline standards

e2dcb98

Merge branch 'openvinotoolkit:master' into master

86afc96

Revert version

1f08477

Revert backt o knownexception

675016d

Revert beam group name change

dccb28e

github-actions bot added category: whisper Whisper pipeline category: cmake / build Cmake scripts no-match-files category: C API labels Jul 9, 2025

BrandonWeng mentioned this pull request Jul 9, 2025

Support for WhisperPipeline for C API? #2412

Closed

BrandonWeng added 2 commits July 9, 2025 21:49

Tests pass

09bf23b

C API runs locally now

4773c58

BrandonWeng changed the title ~~[WIP] Add C API for WhisperPipeline~~ Add C API for WhisperPipeline Jul 10, 2025

Wovchena requested review from as-suvorov and Copilot July 10, 2025 07:38

This comment was marked as outdated.

Sign in to view

rkazants reviewed Jul 10, 2025

View reviewed changes

samples/c/whisper_speech_recognition/whisper_speech_recognition.c Outdated Show resolved Hide resolved

rkazants reviewed Jul 10, 2025

View reviewed changes

BrandonWeng commented Jul 10, 2025

View reviewed changes

src/c/include/openvino/genai/c/generation_config.h Outdated Show resolved Hide resolved

BrandonWeng commented Jul 10, 2025

View reviewed changes

src/c/src/generation_config.cpp Outdated Show resolved Hide resolved

BrandonWeng and others added 5 commits July 10, 2025 10:40

revert ov_genai_generation_config_set_num_beam_groups change

3a596ce

Fix parameter typo

c667f49

Remove benchmarking code from samples

3cd3086

Merge branch 'master' into master

e476414

Exit code

02297e2

BrandonWeng requested a review from rkazants July 10, 2025 15:19

update CMakelist to match text generation

40a7136

as-suvorov reviewed Jul 11, 2025

View reviewed changes

samples/c/whisper_speech_recognition/CMakeLists.txt Outdated Show resolved Hide resolved

samples/c/whisper_speech_recognition/whisper_speech_recognition.c Show resolved Hide resolved

tests/python_tests/samples/test_whisper_speech_recognition.py Show resolved Hide resolved

Addresss PR comments

9ebcfa7

BrandonWeng requested a review from Wovchena July 18, 2025 02:03

Wovchena requested changes Jul 18, 2025

View reviewed changes

BrandonWeng and others added 6 commits July 18, 2025 18:18

Merge branch 'master' into master

b6529d6

revert formatting for ov_genai_generation_config_set_num_beam_groups

2d80e36

goto error instead of continue for mem err

abfaec3

Simplify samples

fdb7ce9

Arg count

e20c1c4

Fix build error

e97fe28

BrandonWeng requested a review from Wovchena July 19, 2025 00:00

Wovchena reviewed Jul 21, 2025

View reviewed changes

BrandonWeng added 2 commits July 21, 2025 18:01

Add Readme

55a36e9

for eaxample

6742023

BrandonWeng requested a review from Wovchena July 21, 2025 22:04

Wovchena approved these changes Jul 22, 2025

View reviewed changes

Merge branch 'master' into master

59189bf

Wovchena enabled auto-merge July 24, 2025 16:43

Merge branch 'master' into master

2848ff8

Merge branch 'master' into master

1e274a6

Wovchena disabled auto-merge July 28, 2025 06:42

Wovchena merged commit 454e4d1 into openvinotoolkit:master Jul 28, 2025
194 of 212 checks passed

as-suvorov linked an issue Jul 29, 2025 that may be closed by this pull request

Support for WhisperPipeline for C API? #2412

Closed

mlukasze added this to the 2025.3 milestone Aug 19, 2025

Add C API for WhisperPipeline #2414

Add C API for WhisperPipeline #2414

Uh oh!

Conversation

BrandonWeng commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

rkazants Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BrandonWeng Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Wovchena Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

BrandonWeng Jul 18, 2025

Choose a reason for hiding this comment

Uh oh!

BrandonWeng Jul 19, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

BrandonWeng commented Jul 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wovchena Jul 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

BrandonWeng Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Wovchena left a comment

Choose a reason for hiding this comment

Uh oh!

BrandonWeng commented Jul 22, 2025

Uh oh!

Wovchena commented Jul 24, 2025

Uh oh!

Wovchena commented Jul 25, 2025

Uh oh!

BrandonWeng commented Jul 25, 2025

Uh oh!

Wovchena commented Jul 25, 2025

Uh oh!

BrandonWeng commented Jul 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wovchena commented Jul 26, 2025

Uh oh!

Uh oh!

Uh oh!

BrandonWeng commented Jul 9, 2025 •

edited

Loading

rkazants Jul 10, 2025 •

edited

Loading

BrandonWeng Jul 10, 2025 •

edited

Loading

BrandonWeng commented Jul 19, 2025 •

edited

Loading

Wovchena Jul 21, 2025 •

edited

Loading

BrandonWeng commented Jul 26, 2025 •

edited

Loading