framebridge.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_NETWORK
#include <cstddef>
#include <cstdint>
#include <promeki/namespace.h>
#include <promeki/objectbase.h>
#include <promeki/error.h>
#include <promeki/string.h>
#include <promeki/uniqueptr.h>
#include <promeki/uuid.h>
#include <promeki/mediadesc.h>
#include <promeki/audiodesc.h>
#include <promeki/frame.h>
#include <promeki/timestamp.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class FrameBridge : public ObjectBase {
                PROMEKI_OBJECT(FrameBridge, ObjectBase)
        public:
                using UPtr = UniquePtr<FrameBridge>;
 
                static constexpr uint32_t WireMajor = 1;
 
                static constexpr uint32_t WireMinor = 0;
 
                static constexpr size_t DefaultMetadataReserveBytes = 64u * 1024u;
 
                static constexpr double DefaultAudioHeadroomFraction = 0.20;
 
                static constexpr int DefaultRingDepth = 2;
 
                static constexpr uint32_t DefaultAccessMode = 0600;
 
                struct Config {
                                MediaDesc mediaDesc;
 
                                AudioDesc audioDesc;
 
                                int ringDepth = DefaultRingDepth;
 
                                size_t metadataReserveBytes = DefaultMetadataReserveBytes;
 
                                double audioHeadroomFraction = DefaultAudioHeadroomFraction;
 
                                uint32_t accessMode = DefaultAccessMode;
 
                                String groupName;
 
                                bool waitForConsumer = true;
                };
 
                FrameBridge(ObjectBase *parent = nullptr);
 
                ~FrameBridge() override;
 
                Error openOutput(const String &name, const Config &config);
 
                Error openInput(const String &name, bool sync = true);
 
                bool isSyncInput() const;
 
                void close();
 
                void abort();
 
                bool isAborted() const;
 
                bool isOpen() const;
 
                bool isOutput() const;
 
                const UUID &uuid() const;
 
                const String &name() const;
 
                const MediaDesc &mediaDesc() const;
 
                const AudioDesc &audioDesc() const;
 
                int ringDepth() const;
 
                TimeStamp lastFrameTimeStamp() const;
 
                // ========== Output-side ==========
 
                Error writeFrame(const Frame &frame);
 
                size_t connectionCount() const;
 
                void service();
 
                // ========== Input-side ==========
 
                Frame readFrame(Error *err = nullptr);
 
                PROMEKI_SIGNAL(frameAvailable);
 
                PROMEKI_SIGNAL(framesMissed, uint64_t);
 
                PROMEKI_SIGNAL(peerDisconnected);
 
        private:
                class Impl;
                using ImplPtr = UniquePtr<Impl>;
                ImplPtr _d;
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_NETWORK