transcriptionengine.h

Go to the documentation of this file.

#pragma once
 
#include "config.h"
#include "transcription/transcriptiontypes.h"
 
#include <memory>
 
struct Recording;
 
class TranscriptionModelHandle
{
public:
    virtual ~TranscriptionModelHandle() = default;
    TranscriptionModelHandle(const TranscriptionModelHandle &) = delete;
    TranscriptionModelHandle &operator=(const TranscriptionModelHandle &) = delete;
    TranscriptionModelHandle(TranscriptionModelHandle &&) = delete;
    TranscriptionModelHandle &operator=(TranscriptionModelHandle &&) = delete;
 
    [[nodiscard]] virtual QString backendName() const = 0;
 
    [[nodiscard]] virtual ModelMetadata metadata() const = 0;
 
    [[nodiscard]] virtual QString modelDescription() const = 0;
 
protected:
    TranscriptionModelHandle() = default;
};
 
class TranscriptionSession
{
public:
    virtual ~TranscriptionSession() = default;
    TranscriptionSession(const TranscriptionSession &) = delete;
    TranscriptionSession &operator=(const TranscriptionSession &) = delete;
    TranscriptionSession(TranscriptionSession &&) = delete;
    TranscriptionSession &operator=(TranscriptionSession &&) = delete;
 
    [[nodiscard]] virtual QString backendName() const = 0;
 
    virtual bool warmup(RuntimeError *error = nullptr) = 0;
 
    [[nodiscard]] virtual TranscriptUpdate pushAudioChunk(const AudioChunk &chunk) = 0;
 
    [[nodiscard]] virtual TranscriptUpdate finish() = 0;
 
    [[nodiscard]] virtual TranscriptUpdate cancel() = 0;
 
protected:
    TranscriptionSession() = default;
};
 
class TranscriptionEngine
{
public:
    virtual ~TranscriptionEngine() = default;
    TranscriptionEngine(const TranscriptionEngine &) = delete;
    TranscriptionEngine &operator=(const TranscriptionEngine &) = delete;
    TranscriptionEngine(TranscriptionEngine &&) = delete;
    TranscriptionEngine &operator=(TranscriptionEngine &&) = delete;
 
    [[nodiscard]] virtual BackendCapabilities capabilities() const = 0;
 
    [[nodiscard]] virtual RuntimeDiagnostics diagnostics() const = 0;
 
    [[nodiscard]] virtual std::shared_ptr<const TranscriptionModelHandle> loadModel(RuntimeError *error = nullptr) const = 0;
 
    [[nodiscard]] virtual std::unique_ptr<TranscriptionSession>
    createSession(std::shared_ptr<const TranscriptionModelHandle> model) const = 0;
 
protected:
    TranscriptionEngine() = default;
};
 
[[nodiscard]] std::shared_ptr<const TranscriptionEngine> createTranscriptionEngine(const TranscriberConfig &config);