LiveStreamingAlgorithm Class Reference

#include <ImFusion/Stream/LiveStreamingAlgorithm.h>

Takes images from ImageStream (8bit images) encodes them and sends them via a web socket. More...

Inheritance diagram for LiveStreamingAlgorithm:

Detailed Description

Takes images from ImageStream (8bit images) encodes them and sends them via a web socket.

The compute method starts a server which encodes and sends images if a client is connected. Invoking stopServers after calling compute will stop streaming. For now, only 3 color channel stream is supported. Only one client is supported.

Public Member Functions
	LiveStreamingAlgorithm (ImageStream &is)
	Internally it connects with the client through two different port on the same IP address one channel is used to send video frame data, and other one for sending control messages.
void	compute () override
	Starts a server, listening on the given 'host' and 'port', Queue an image from ImageStream to be encoded and served to all clients.
void	stopServers ()
	Stops the servers, incoming connections will be refused unless compute is called again.
int	videoTransferPort () const
void	setVideoTransferPort (int port)
	Port dedicated for video data transfer should be between 1025 and 50000 in order to avoid conflicting with other known ports.
int	controlTransferPort () const
void	setControlTransferPort (int port)
	Port dedicated for control data transfer should be between 1025 and 50000, and must be different to video transfer port.
void	setEncoderId (VideoEncoder::Codec codecId)
	set the Codec ID to used for encoding
std::string	host () const
void	setHost (const std::string &host)
VideoEncoder::Preset	preset () const
void	setPreset (VideoEncoder::Preset preset)
bool	isCurrentlyStreaming () const
	Get if currently streaming.
bool	isServerRunning () const
	Return true if the server is running. A running server does not necessarily mean we are streaming to a client.
void	configure (const Properties *p) override
	Configure this object instance by de-serializing the given Properties.
void	configuration (Properties *p) const override
	Serialize the current object configuration into the given Properties object.
Public Member Functions inherited from Algorithm
	Algorithm ()
	Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual OwningDataList	takeOutput ()
	Return any new Data that was created by the Algorithm during the last call to compute().
virtual void	setProgress (Progress *progress)
	Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progress *	progress () const
	Returns the progress interface if set.
virtual int	status () const
	Indicates the status of the last call to compute().
virtual bool	survivesDataDeletion (const Data *) const
	Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfo &	factoryInfo () const
	Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void	setFactoryInfo (const FactoryInfo &value)
	Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status	runAction (const std::string &id)
	Run the action with name id if it exists.
const std::vector< Action > &	actions ()
	Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from Configurable
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Static Public Member Functions
static bool	createCompatible (const DataList &data, Algorithm **a=0)
Static Public Member Functions inherited from Algorithm
static bool	createCompatible (const DataList &data, Algorithm **a=nullptr)
	Factory function to check algorithm compatibility with input data and optionally instantiate it.

Protected Attributes
ImageStream &	m_stream
int	m_videoPort = 3888
	stream of the camera video
int	m_controlPort = 4051
	port used for transferring video streaming
VideoEncoder::Preset	m_preset {VideoEncoder::Preset::LowLatency}
	port used for transferring control commands
std::string	m_host = "localhost"
std::unique_ptr< std::thread >	m_controlChannelHeartbeat
std::atomic< bool >	m_currentlyStreaming = false
std::shared_ptr< SignalConnection >	m_dataConnection
	indicate if currently streaming or not
std::shared_ptr< SignalConnection >	m_controlConnection
std::shared_ptr< SignalConnection >	m_restartConnection
std::mutex	m_mutex
VideoEncoder	m_encoder
VideoEncoder::Codec	m_encoderId = VideoEncoder::Codec::HEVC_NVENC
std::unique_ptr< Network::WebsocketServer< ByteBuffer > >	m_server
std::unique_ptr< Network::WebsocketServer< std::string > >	m_controlServer
LoggingTimer	m_onStreamDataTimer {"onStreamData", "LiveStreamingAlgorithm", false}
std::string	m_remoteControlHost
std::string	m_remoteVideoHost
int	m_remoteControlPort = -1
int	m_remoteVideoPort = -1
StreamFps	m_actualFPS
Protected Attributes inherited from Algorithm
std::string	m_name
	Algorithm name.
Progress *	m_progress = nullptr
	Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo	m_factoryInfo = {}
	Record describing how this algorithm was instantiated by the AlgorithmFactory.
int	m_status = Status::Unknown
	Algorithm status after last call to compute()
std::vector< Action >	m_actions
	Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Additional Inherited Members
Public Types inherited from Algorithm
enum	Status {   Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,   IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,   UnknownAction , AbortedByUser , User = 1000 }
	Status codes. More...
Public Attributes inherited from Algorithm
Signal	signalOutputChanged
	Signal should be emitted by Algorithms when their output/result has changed.
Signal	signalParametersChanged
	Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.
Protected Member Functions inherited from Algorithm
void	loadDefaults ()
void	registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
	Register an action to be run via runAction.
template<typename D>
void	registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
	Template version of runAction that can be used with a pointer to a member function.
void	registerAction (const Action &action)
	Register an action.

Member Function Documentation

compute()

void compute ( )

overridevirtual

Starts a server, listening on the given 'host' and 'port', Queue an image from ImageStream to be encoded and served to all clients.

Implements Algorithm.

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

configuration()

void configuration ( Properties * p ) const

overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configure() for the inverse functionality

Reimplemented from Configurable.

---

The documentation for this class was generated from the following file:

• ImFusion/Stream/LiveStreamingAlgorithm.h