transcriptionengine.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <promeki/namespace.h>
#include <promeki/audioformat.h>
#include <promeki/backendweight.h>
#include <promeki/enums_transcription.h>
#include <promeki/error.h>
#include <promeki/function.h>
#include <promeki/list.h>
#include <promeki/pcmaudiopayload.h>
#include <promeki/result.h>
#include <promeki/string.h>
#include <promeki/transcript.h>
#include <promeki/uniqueptr.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class Frame;
class MediaConfig;
 
class TranscriptionEngine {
        public:
                using UPtr = UniquePtr<TranscriptionEngine>;
 
                using Factory = Function<UPtr()>;
 
                struct BackendRecord {
                                String name;
 
                                String description;
 
                                int weight = BackendWeight::Vendored;
 
                                List<int> supportedInputs;
 
                                List<int> supportedModes;
 
                                Factory factory;
                };
 
                virtual ~TranscriptionEngine();
 
                const String &name() const { return _name; }
 
                void configure(const MediaConfig &config);
 
                virtual Error submitFrame(const Frame &frame) = 0;
 
                virtual Frame receiveFrame() = 0;
 
                virtual Error flush() = 0;
 
                virtual Error reset() = 0;
 
                Error lastError() const { return _lastError; }
 
                const String &lastErrorMessage() const { return _lastErrorMessage; }
 
                // ---- Backend registry ----
 
                static Error registerBackend(BackendRecord record);
 
                static List<BackendRecord> registeredBackends();
 
                static Result<BackendRecord> lookupBackend(const String &name);
 
                static Result<UPtr> create(const String &name, const MediaConfig *config = nullptr);
 
                // ---- Frame-shaped helpers (public so backends can use them) ----
 
                static PcmAudioPayload::Ptr selectInputPayload(const Frame &frame, int streamIndex = -1);
 
                static Frame buildOutputFrame(const Frame &source, const Transcript &transcript);
 
                static TimeStamp wordTimestamp(const PcmAudioPayload &payload, size_t sampleOffset);
 
        protected:
                TranscriptionEngine() = default;
 
                void setName(String name) { _name = std::move(name); }
 
                virtual void onConfigure(const MediaConfig &config);
 
                const MediaConfig &config() const;
 
                Error  _lastError;
                String _lastErrorMessage;
 
                void setError(Error err, const String &msg = String());
 
                void clearError();
 
        private:
                UniquePtr<MediaConfig> _stashedConfig;
                String                 _name;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV