commandmediaio.h

Go to the documentation of this file.

 
#pragma once
 
 
#include <promeki/config.h>
#if PROMEKI_ENABLE_PROAV
#include <promeki/clock.h>
#include <promeki/mediaio.h>
#include <promeki/mediaiocommand.h>
 
PROMEKI_NAMESPACE_BEGIN
 
class MediaIOPortGroup;
class MediaIOSource;
class MediaIOSink;
 
class CommandMediaIO : public MediaIO {
                PROMEKI_OBJECT(CommandMediaIO, MediaIO)
        public:
                CommandMediaIO(ObjectBase *parent = nullptr);
 
                ~CommandMediaIO() override;
 
        protected:
                Error dispatch(MediaIOCommand::Ptr cmd);
 
                virtual Error executeCmd(MediaIOCommandOpen &cmd);
 
                virtual Error executeCmd(MediaIOCommandClose &cmd);
 
                virtual Error executeCmd(MediaIOCommandRead &cmd);
 
                virtual Error executeCmd(MediaIOCommandWrite &cmd);
 
                virtual Error executeCmd(MediaIOCommandSeek &cmd);
 
                virtual Error executeCmd(MediaIOCommandParams &cmd);
 
                virtual Error getParam(MediaIOParamsID id, Variant &out);
 
                virtual Error setParam(MediaIOParamsID id, const Variant &value);
 
                virtual Error validateParam(MediaIOParamsID id, const Variant &value);
 
                virtual Error executeCmd(MediaIOCommandStats &cmd);
 
                virtual Error executeCmd(MediaIOCommandSetClock &cmd);
 
                virtual void configChanged(const MediaConfig &delta);
 
                // ---- Port-construction helpers ----
                //
                // Backends call these from @c executeCmd(MediaIOCommandOpen)
                // to declare the ports they expose.  Every port belongs
                // to a @ref MediaIOPortGroup; backends with a single
                // independent port make a single-port group first.
                // All ports are auto-destroyed on close via the
                // ObjectBase parent/child cascade rooted at this MediaIO.
 
                MediaIOPortGroup *addPortGroup(const String &name, const Clock::Ptr &clock);
 
                MediaIOPortGroup *addPortGroup(const String &name = String());
 
                MediaIOSource *addSource(MediaIOPortGroup *group, const MediaDesc &desc,
                                         const String &name = String());
 
                MediaIOSink *addSink(MediaIOPortGroup *group, const MediaDesc &desc,
                                     const String &name = String());
 
                // ---- Live-telemetry helpers ----
                //
                // Forwards to the per-group atomic counters.  Safe to
                // call from any thread.  Cheap (one atomic increment).
                // No-op when @p group is null.
 
                void noteFrameDropped(MediaIOPortGroup *group);
 
                void noteFrameRepeated(MediaIOPortGroup *group);
 
                void noteFrameLate(MediaIOPortGroup *group);
};
 
PROMEKI_NAMESPACE_END
 
#endif // PROMEKI_ENABLE_PROAV