cvedia::rt::iface::InputHandler

Inherits from ModuleImpl, Module

Inherited by ImageReader, LiveReader, VODReader, VideoReader

Public Functions

	Name
	InputHandler(std::string const & moduleName)
virtual expected< void >	openUri(std::string const & uri) =0
virtual void	close() =0
virtual expected< cvec >	readFrame(bool ignoreSkipFrame =false, cmap frameSettings ={}) =0
virtual bool	canRead()
virtual expected< void >	start()
virtual void	stop()
virtual void	pause(bool state)
virtual void	setFrameCallback(std::function< void(cmap &&)> cb)
virtual int	getCurrentFrameIndex() =0
virtual float	getCurrentFps(FPSType fpsType =FPSType::FPSType_TARGET) =0
virtual double	getCurrentTimestamp() =0
virtual bool	isEnded() =0
virtual std::vector< InputFormat >	getSupportedFormats() =0
virtual void	setSourceFormat(InputFormat fmt) =0
virtual InputFormat	getSourceFormat() =0
virtual std::optional< Codec >	getSourceCodec() =0
virtual std::pair< int, int >	getSourceResolution()

Protected Functions

	Name
void	emitFramePayload(cmap && payload)
std::function< void(cmap &&)> const &	frameCallback() const

Protected Attributes

	Name
std::function< void(cmap &&)>	frameCallback_
std::thread	pullThread_
std::atomic< bool >	pullRunning_
std::atomic< bool >	pullPaused_
std::condition_variable	pullCv_
std::mutex	pullCvMutex_

Additional inherited members

Public Functions inherited from ModuleImpl

	Name
	ModuleImpl(std::string moduleName)
virtual void *	getPtr() override
virtual void	verifyConfig(pCValue instanceConfig, ConfigCheckResults & configCheckResults) override
virtual pCValue	getConfigSpecs() const override
virtual std::string const &	getName() const override
virtual void	setName(std::string const & name) override
virtual void	setParent(iface::Module * parent) override
virtual iface::Module *	getParent() const override
virtual expected< pCValue >	getValue(std::string const & key, int dictType) const override
virtual expected< cvec >	getValue(std::vector< std::string > const & keys, int dictType) const override
virtual expected< void >	setValue(std::string const & key, pCValue const & value, int dictType) override
virtual expected< void >	setValue(cmap const & values, int dictType) override
expected< void >	unsetKey(std::string const & key, int const dictType)
virtual expected< std::unique_ptr< iface::CVDictRoot > >	getStateDict() const override
virtual expected< std::unique_ptr< iface::CVDictRoot > >	getConfigDict() const override
virtual expected< void >	setConfig(pCValue const & conf) const override
virtual std::string	getRootNode() const override

Public Attributes inherited from ModuleImpl

	Name
std::shared_mutex	pluginMut_

Public Functions inherited from Module

	Name
	Module() =default
virtual	~Module() =default
	Module(Module const & other) =default
Module &	operator=(Module const & other) =default
	Module(Module && other) =default
Module &	operator=(Module && other) =default
virtual void *	getPtr() =0
virtual void	verifyConfig(pCValue instanceConfig, ConfigCheckResults & configCheckResults) =0
virtual pCValue	getConfigSpecs() const =0
virtual std::map< std::string, std::shared_ptr< ConfigDescriptor > >	getConfigDescriptors() const
virtual std::string const &	getName() const =0
virtual void	setName(std::string const & name) =0
virtual void	setParent(iface::Module * ) =0
virtual iface::Module *	getParent() const =0
virtual expected< pCValue >	getValue(std::string const & key, int dictType) const =0
virtual expected< cvec >	getValue(std::vector< std::string > const & keys, int dictType) const =0
virtual expected< void >	setValue(std::string const & key, pCValue const & value, int dictType) =0
virtual expected< void >	setValue(cmap const & values, int dictType) =0
virtual expected< std::unique_ptr< iface::CVDictRoot > >	getStateDict() const =0
virtual expected< std::unique_ptr< iface::CVDictRoot > >	getConfigDict() const =0
virtual expected< void >	setConfig(pCValue const & conf) const =0
virtual std::string	getRootNode() const =0

Public Functions Documentation

function InputHandler

inline InputHandler(
    std::string const & moduleName
)

function openUri

virtual expected< void > openUri(
    std::string const & uri
) =0

function close

virtual void close() =0

function readFrame

virtual expected< cvec > readFrame(
    bool ignoreSkipFrame =false,
    cmap frameSettings ={}
) =0

function canRead

inline virtual bool canRead()

function start

inline virtual expected< void > start()

function stop

inline virtual void stop()

Reimplements: cvedia::rt::iface::Module::stop

function pause

inline virtual void pause(
    bool state
)

function setFrameCallback

inline virtual void setFrameCallback(
    std::function< void(cmap &&)> cb
)

function getCurrentFrameIndex

virtual int getCurrentFrameIndex() =0

function getCurrentFps

virtual float getCurrentFps(
    FPSType fpsType =FPSType::FPSType_TARGET
) =0

function getCurrentTimestamp

virtual double getCurrentTimestamp() =0

function isEnded

virtual bool isEnded() =0

Reimplemented by: cvedia::rt::iface::VideoReader::isEnded

function getSupportedFormats

virtual std::vector< InputFormat > getSupportedFormats() =0

function setSourceFormat

virtual void setSourceFormat(
    InputFormat fmt
) =0

function getSourceFormat

virtual InputFormat getSourceFormat() =0

function getSourceCodec

virtual std::optional< Codec > getSourceCodec() =0

function getSourceResolution

inline virtual std::pair< int, int > getSourceResolution()

Reimplemented by: cvedia::rt::iface::AppSrc::getSourceResolution

Protected Functions Documentation

function emitFramePayload

inline void emitFramePayload(
    cmap && payload
)

function frameCallback

inline std::function< void(cmap &&)> const & frameCallback() const

Protected Attributes Documentation

variable frameCallback_

std::function< void(cmap &&)> frameCallback_;

variable pullThread_

std::thread pullThread_;

variable pullRunning_

std::atomic< bool > pullRunning_ {false};

variable pullPaused_

std::atomic< bool > pullPaused_ {false};

variable pullCv_

std::condition_variable pullCv_;

variable pullCvMutex_

std::mutex pullCvMutex_;

---