transcribe-cpp-sys 0.4.0

Native FFI bindings for transcribe.cpp, a C/C++ speech-to-text library built on ggml
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

/*
 * include/transcribe/diarize.h - DIARIZE role: who spoke when.
 *
 * Includes transcribe.h; safe to include in C or C++ TUs. For models whose
 * product is speaker turns rather than text (transcribe_model_roles() has
 * TRANSCRIBE_ROLE_DIARIZE). ASR models that attribute speakers inside a
 * transcript keep using transcribe_run_params::diarize instead.
 *
 * Open a transcribe_diarize_session on a loaded model, run, then read the
 * speaker segments. Threading and lifetime rules: docs/roles.md.
 */

#ifndef TRANSCRIBE_DIARIZE_H
#define TRANSCRIBE_DIARIZE_H

#include "transcribe.h"

#ifdef __cplusplus
extern "C" {
#endif

struct transcribe_diarize_session;

/* Static facts about a diarization model. */
struct transcribe_diarize_info {
    uint64_t struct_size;
    int32_t  sample_rate;  /* input PCM rate (16000) */
    int32_t  max_speakers; /* speaker_id is in [1, max_speakers] */
};

struct transcribe_diarize_session_params {
    uint64_t struct_size;
    int32_t  n_threads; /* 0 = library default */
};

struct transcribe_diarize_params {
    uint64_t                      struct_size;
    /* Typed family extension on TRANSCRIBE_EXT_SLOT_DIARIZE_RUN, or NULL. */
    const struct transcribe_ext * family;
};

TRANSCRIBE_API void transcribe_diarize_info_init(struct transcribe_diarize_info * out);
TRANSCRIBE_API void transcribe_diarize_session_params_init(struct transcribe_diarize_session_params * params);
TRANSCRIBE_API void transcribe_diarize_params_init(struct transcribe_diarize_params * params);

/* UNSUPPORTED_ROLE when the model does not serve TRANSCRIBE_ROLE_DIARIZE. */
TRANSCRIBE_API transcribe_status transcribe_diarize_get_info(const struct transcribe_model *  model,
                                                             struct transcribe_diarize_info * out);

/* params may be NULL for defaults. UNSUPPORTED_ROLE when the model does not
 * serve TRANSCRIBE_ROLE_DIARIZE. On failure *out_session is NULL. */
TRANSCRIBE_API transcribe_status
transcribe_diarize_session_init(struct transcribe_model *                        model,
                                const struct transcribe_diarize_session_params * params,
                                struct transcribe_diarize_session **             out_session);

/* NULL is a no-op. */
TRANSCRIBE_API void transcribe_diarize_session_free(struct transcribe_diarize_session * session);

/* Polled during a run; returning true stops it with TRANSCRIBE_ERR_ABORTED. */
TRANSCRIBE_API void transcribe_diarize_set_abort_callback(struct transcribe_diarize_session * session,
                                                          transcribe_abort_callback           cb,
                                                          void *                              user_data);

/*
 * Diarize one recording: 16 kHz mono float32 PCM, every sample finite.
 * params may be NULL for defaults. Replaces the previous result. Malformed
 * input (NULL pointers, n_samples <= 0, NaN / Inf, a bad extension) returns
 * an error before the previous result is touched.
 */
TRANSCRIBE_API transcribe_status transcribe_diarize_run(struct transcribe_diarize_session *      session,
                                                        const float *                            pcm,
                                                        int                                      n_samples,
                                                        const struct transcribe_diarize_params * params);

/*
 * Speaker segments of the last run, grouped by speaker and time-ordered
 * within a speaker; segments of different speakers may overlap. 0 before any
 * run, and 0 after a run that passed input validation but then failed
 * (aborted, backend error). An out-of-range index returns OK with a zeroed row.
 */
TRANSCRIBE_API int               transcribe_diarize_n_segments(const struct transcribe_diarize_session * session);
TRANSCRIBE_API transcribe_status transcribe_diarize_get_segment(const struct transcribe_diarize_session * session,
                                                                int                                       i,
                                                                struct transcribe_speaker_segment *       out);

/* load_ms plus the last run's stage times. */
TRANSCRIBE_API transcribe_status transcribe_diarize_get_timings(const struct transcribe_diarize_session * session,
                                                                struct transcribe_timings *               out);

#ifdef __cplusplus
}
#endif

#endif /* TRANSCRIBE_DIARIZE_H */