transcriptiontypes.h

Go to the documentation of this file.

#pragma once
 
#include <QMetaType>
#include <QString>
#include <QStringList>
 
#include <cstdint>
#include <vector>
 
enum class RuntimeErrorCode : std::uint8_t {
    None,
    Cancelled,
    InvalidConfig,
    ModelNotFound,
    InvalidModelPackage,
    UnsupportedModelPackageVersion,
    ModelIntegrityFailed,
    IncompatibleModelPackage,
    ModelTooLarge,
    ModelLoadFailed,
    AudioNormalizationFailed,
    UnsupportedLanguage,
    DecodeFailed,
    InternalRuntimeError,
};
 
struct RuntimeError {
    RuntimeErrorCode code = RuntimeErrorCode::None;
    QString message;
    QString detail;
 
    [[nodiscard]] bool isOk() const { return code == RuntimeErrorCode::None; }
};
 
struct BackendCapabilities {
    QString backendName;
    QStringList supportedLanguages;
    bool supportsAutoLanguage = false;
    bool supportsTranslation = false;
    bool supportsWarmup = false;
};
 
struct RuntimeDiagnostics {
    QString backendName;
    QString selectionReason;
    QString runtimeDescription;
    QString loadedModelDescription;
};
 
struct ModelMetadata {
    QString packageId;
    QString displayName;
    QString packageVersion;
    QString runtimeFamily;
    QString sourceFormat;
    QString modelFormat;
    QString architecture;
    QString languageProfile;
    QString quantization;
    QString tokenizer;
    bool legacyCompatibility = false;
    int vocabularySize = 0;
    int audioContext = 0;
    int audioState = 0;
    int audioHeadCount = 0;
    int audioLayerCount = 0;
    int textContext = 0;
    int textState = 0;
    int textHeadCount = 0;
    int textLayerCount = 0;
    int melCount = 0;
    int formatType = 0;
};
 
struct NormalizedAudio {
    std::vector<float> samples;
    int sampleRate = 16000;
    int channels = 1;
 
    [[nodiscard]] bool isValid() const { return !samples.empty(); }
};
 
struct AudioChunk {
    std::vector<float> samples;
    int sampleRate = 16000;
    int channels = 1;
    std::int64_t streamOffsetFrames = 0;
 
    [[nodiscard]] bool isValid() const { return !samples.empty(); }
};
 
enum class TranscriptEventKind : std::uint8_t {
    Partial,
    Final,
};
 
struct TranscriptEvent {
    TranscriptEventKind kind = TranscriptEventKind::Partial;
    QString text;
    std::int64_t startMs = -1;
    std::int64_t endMs = -1;
};
 
struct TranscriptUpdate {
    std::vector<TranscriptEvent> events;
    RuntimeError error;
 
    [[nodiscard]] bool isOk() const { return error.isOk(); }
};
 
struct TranscriptionResult {
    bool success = false;
    QString text;
    RuntimeError error;
};
 
Q_DECLARE_METATYPE(RuntimeErrorCode)
Q_DECLARE_METATYPE(RuntimeError)
Q_DECLARE_METATYPE(BackendCapabilities)
Q_DECLARE_METATYPE(ModelMetadata)