#include <ImFusion/Stream/VideoFileStream.h>

Stream images from a video file. More...

Inheritance diagram for VideoFileStream:

Detailed Description

Stream images from a video file.

Just like other streams of the ImFusionStream framework, VideoFileStream will also work in a multithreaded fashion where grabbing images from the video file is performed in a separate background thread.

Note: This algorithm requires the ImFusionLib to be built with OpenCV support.

Public Member Functions
bool	openImpl () override
	Open stream.

bool	reset () override
	Reverts stream to first frame, if possible. Returns whether the operation was successful.

bool	startImpl () override
	Start stream.

std::string	uuid () override
	Unique identifier for stream.

std::string	describe () const override
	Short description of the stream including latest state and update rate information.

bool	supportsPausing () const override
	Override and return true if this stream implements the pausing and resume operations.

bool	pauseImpl () override
	Pause stream (not required to be supported).

bool	resumeImpl () override
	Resume stream from pause (only required to be supported when pauseImpl() is supported).

Stream::ThreadingMode	threadingMode () const override
	Configures threading mode of stream.

int	height () const

int	width () const

double	framerate () const

void	setFilename (const std::string &f)
	Set the source file to stream the video from, must be called prior to open().

std::string	filename () const
	Return the source file to stream the video from.

void	setLooping (bool v)
	Set whether to play the video in a continuous loop.

bool	looping () const

int	numFrames () const
	Return the total number of frames.

int	lastFrame () const
	Return the last played frame.

void	setNextFrame (int idx)
	Set the next frame to play. If the stream is paused, the frame is read immediately.

void	extractFrames (const Selection &sel, const std::function< void(std::shared_ptr< const ImageStreamData >)> &callback, Progress *p=nullptr)
	Extracts selected frames from the video and feeds them into the callback.

std::unique_ptr< SharedImageSet >	extractFrames (const Selection &sel, Progress *progress=nullptr)
	Extract selected frames from the video stream into a SharedImageSet.

std::string	describeSegment (int frames) const
	Return duration and uncompressed memory size of a segment with given number of frames.

void	setPlaySelected (bool isSet)
	Makes the stream play on the selected only.

void	setFocus (int index) override
	Set focus of the selection.

int	size () const override
	Returns the number of images of the image stream per emission.

Public Member Functions inherited from VideoStreamBackendOpenCV
bool	closeImpl () override
	Stops and closes the stream, freeing the resource.

bool	startImpl () override
	Starts streaming on an already opened resource.

bool	stopImpl () override
	Stops the stream, but keeps hold of the resource.

Public Member Functions inherited from ImageStream
	ImageStream (const std::string &name="")

Data::Kind	kind () const override final
	Returns the kind (typically IMAGESTREAM or VOLUMESTREAM)

void	setModality (Modality m)
	Set the modality descriptor of this stream.

Modality	modality () const override final
	Return the modality of this stream.

virtual bool	topDown () const
	Specify whether the first line of the image data is to be displayed on top.

Public Member Functions inherited from Stream
	Stream (const std::string &name="")
	Constructor with the `name` for this stream.

virtual bool	supportsAsyncOperation ()
	Returns true if xxxAsync() methods support execution in a background thread.

std::shared_future< bool >	openAsync ()
	Open stream in an asynchronous fashion (wait on the returned future before taking further actions). Returns whether the operation was successful.

std::shared_future< bool >	closeAsync ()
	Close stream in an asynchronous fashion (wait on the returned future before taking further actions). Returns whether the operation was successful.

std::shared_future< bool >	startAsync ()
	Start stream in an asynchronous fashion (wait on the returned future before taking further actions). Returns whether the operation was successful.

std::shared_future< bool >	stopAsync ()
	Stop stream in an asynchronous fashion (wait on the returned future before taking further actions). Returns whether the operation was successful.

std::shared_future< bool >	pauseAsync ()
	Pause stream in an asynchronous fashion (wait on the returned future before taking further actions). Returns whether the operation was successful.

std::shared_future< bool >	resumeAsync ()
	Resume stream in an asynchronous fashion (wait on the returned future before taking further actions). Returns whether the operation was successful.

bool	open ()
	Open stream and wait for the operation to complete. Returns whether the operation was successful.

bool	close ()
	Close stream and wait for the operation to complete. Returns whether the operation was successful.

bool	start ()
	Start stream and wait for the operation to complete. Returns whether the operation was successful.

bool	stop ()
	Stop stream and wait for the operation to complete. Returns whether the operation was successful.

bool	pause ()
	Pause stream and wait for the operation to complete. Returns whether the operation was successful.

bool	resume ()
	Resume stream and wait for the operation to complete. Returns whether the operation was successful.

bool	restart ()
	Stops, closes, opens and starts the stream. Returns whether the operation was successful.

virtual bool	isRunning () const
	Return whether stream is currently running.

State	currentState () const

bool	isStateOneOf (const std::vector< State > &states) const

Geometry::AlignedBox	bounds () const override
	Per default a Stream has empty/invalid bounds.

Pose::TransformationConvention	matrixConvention () const override
	Matrices of streams by default map to the world coordinate system.

virtual bool	createDefaultStreamController ()
	Indicates whether a StreamController should be created for the stream (by default returns true).

double	updateRate () const
	Average update rate in Hz of the `signalStreamData`.

Public Member Functions inherited from Data
	Data (const std::string &name="")

	Data (const Data &other)

Data &	operator= (const Data &other)

virtual	~Data ()
	Mandatory virtual destructor.

const std::string &	name () const
	Return the name of this data.

void	setName (const std::string &name)
	Sets the name of this data.

virtual bool	isAnnotationType () const
	Return whether this data type is visualized through an annotation (e.g. mesh)

const DataComponentList &	components () const
	Returns the list of DataComponents for this data.

DataComponentList &	components ()

virtual void	setMatrixFromWorld (const mat4 &m)
	Set matrix mapping from the world coordinate system to the data coordinate system.

virtual void	setMatrixToWorld (const mat4 &m)
	Set matrix mapping from the data coordinate system to the world coordinate system.

virtual mat4	matrixFromWorld () const
	Get matrix mapping from the world coordinate system to the data coordinate system.

virtual mat4	matrixToWorld () const
	Get matrix mapping from the data coordinate system to the world coordinate system.

virtual mat4	matrix () const
	Return the transformation matrix.

virtual void	setMatrix (const mat4 &m)
	Set the transformation matrix.

Public Member Functions inherited from Configurable
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.

virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.

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

Public Member Functions inherited from Selectable
	Selectable (const Selectable &)

	Selectable (Selectable &&)

Selectable &	operator= (const Selectable &)

Selectable &	operator= (Selectable &&)

virtual Selection	selection () const

virtual int	focus () const

virtual void	setSelection (const Selection &sel)
	Set the underlying selection.

Additional Inherited Members
Public Types inherited from Stream
enum class	ThreadingMode { BaseClassRunsWorkerThread , DerivedClassHandlesThreading }
	This flag represents the two supported threading modes of a Stream. More...

enum class	State { Closed , Opening , Open , Starting , Running , Pausing , Paused , Resuming , Stopping , Closing }

Public Types inherited from Data
enum	Kind { UNKNOWN = 0 , IMAGE = 1 , VOLUME = 2 , IMAGESET = 3 , VOLUMESET = 4 , IMAGESTREAM = 5 , VOLUMESTREAM = 6 , POINTSET = 7 , SURFACE = 8 , TRACKINGSTREAM = 9 , LIVETRACKINGSTREAM = TRACKINGSTREAM , TRACKINGDATA = 10 , TREE = 11 , TENSOR = 12 , POLYDATASTREAM = 13 , STEREOIMAGESET = 14 , STEREOIMAGESTREAM = 15 , VOLUMETRICMESH = 16 }
	Kind of data. More...

enum	Modality { NA = 0 , XRAY = 1 , CT = 2 , MRI = 3 , ULTRASOUND = 4 , VIDEO = 5 , NM = 6 , OCT = 7 , LABEL = 8 , DISTANCE = 9 }
	Image modality of the data. More...

Static Public Member Functions inherited from Stream
static std::string	stateToString (State state)

Static Public Member Functions inherited from Data
static std::string	modalityString (Data::Modality m)
	Return the name of an image modality.

static Data::Modality	stringToModality (const std::string &s)
	Returns the modality corresponding to a modality string or NA if nothing matches.

Public Attributes inherited from ImageStream
Signal< Data::Kind >	signalKindChanged
	Is emitted when the stream changes between IMAGESTREAM and VOLUMESTREAM, before the next ImageStreamData is emitted.

Public Attributes inherited from Stream
ProtectedSignal< StateChange >	signalStateChanged
	Emitted after a state change has been completed with the old and new state.

ProtectedSignal	signalEnded
	Indicates that the stream reached the end of its data, e.g. when a video stream has played to the end.

ProtectedSignal< std::shared_ptr< const StreamData > >	signalStreamData
	Signal that is emitted by the stream when a new StreamData is available.

DeprecatedSignal< ProtectedSignal< std::shared_ptr< const StreamData > >, const StreamData & >	signalNewData
	Signal that is emitted by the stream when a new StreamData is available.

Public Attributes inherited from Data
Signal< const Data * >	signalDeleted
	Signal emitted when this instance is deleted.

Signal< const Data * >	signalMatrixChanged
	Signal emitted when the transformation of this Data has changed.

Signal< std::string >	signalNameChanged
	Signal emitted when the name changed.

Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Public Attributes inherited from Selectable
ProtectedSignal	signalSelectionChanged
	Signals that the selection or size might have changed.

Protected Member Functions inherited from VideoStreamBackendOpenCV
bool	readImage (TypedImage< unsigned char > *out, double &deviceTime, std::chrono::system_clock::time_point &arrivalTime)
	Reads a single frame, returns false if the reading fails.

std::optional< WorkContinuation >	doWork () override
	Create one StreamData and publish it (this function will be called at the desired frame rate) If this is not desired, you can do the following: return std::nullopt;.

Protected Member Functions inherited from ImageStream
void	setKind (Kind k)
	Sets the kind (typically IMAGESTREAM or VOLUMESTREAM) and emits signalKindChanged.

bool	workerThreadRequiresOpenGl () const override
	Ensure the thread has an GL context before the main loop starts.

Protected Member Functions inherited from Stream
virtual bool	worksWhilePaused () const
	Override if doWork() should be called also in the Paused state.

void	changeState (State newState)

std::shared_future< bool >	attemptStateChange (std::function< bool()> work, State stateWorking, State stateSuccess, State stateError)

Protected Member Functions inherited from Data
void	swapWith (Data &other)
	Swaps the data and emits a matrix and name changed signal for both.

Protected Member Functions inherited from NotCopyable
	NotCopyable (NotCopyable &&) noexcept=default

NotCopyable &	operator= (NotCopyable &&) noexcept=default

	NotCopyable (const NotCopyable &)=delete

NotCopyable &	operator= (const NotCopyable &)=delete

Protected Attributes inherited from VideoStreamBackendOpenCV
std::thread *	m_captureThread
	CPU thread for reading frames.

cv::VideoCapture *	m_capture
	OpenCV object which does the actual reading.

std::recursive_mutex	m_stoppingMutex

Protected Attributes inherited from Data
mat4	m_matrix
	Transformation matrix.

std::recursive_mutex *	m_matrixMutex
	Used to internally synchronize access to the matrix of data.

DataComponentList	m_dataComponentList
	The list of DataComponents for this data.

Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Protected Attributes inherited from Selectable
std::mutex	m_selectionMutex
	Mutex protecting the selection.

Selection	m_sel

Member Function Documentation

◆ openImpl()

bool openImpl ( )

overridevirtual

Open stream.

Returns whether the operation was successful. This method is responsible for allocating necessary resources, initializing device handles, and establishing connections to devices. Implementers should ensure that all one-time setup tasks are completed here.

Implements Stream.

◆ reset()

bool reset ( )

overridevirtual

Reverts stream to first frame, if possible. Returns whether the operation was successful.

Reimplemented from Stream.

◆ startImpl()

bool startImpl ( )

overridevirtual

Start stream.

Returns whether the operation was successful. This method is intended to initiate the actual data readout process or to connect a callback function for data handling. Implementers should ensure that the stream is ready and producing data after this call.

Implements Stream.

◆ uuid()

std::string uuid ( )

overridevirtual

Unique identifier for stream.

Implements Stream.

◆ describe()

std::string describe ( ) const

overridevirtual

Short description of the stream including latest state and update rate information.

Reimplemented from ImageStream.

◆ supportsPausing()

bool supportsPausing ( ) const

inlineoverridevirtual

Override and return true if this stream implements the pausing and resume operations.

Overridden method must be constexpr-essible and thread-safe.

Reimplemented from Stream.

◆ pauseImpl()

bool pauseImpl ( )

overridevirtual

Pause stream (not required to be supported).

Returns whether the operation was successful. This method is intended to temporarily pause data acquisition.

Reimplemented from Stream.

◆ resumeImpl()

bool resumeImpl ( )

overridevirtual

Resume stream from pause (only required to be supported when pauseImpl() is supported).

Returns whether the operation was successful. This method should resume data acquisition after a pause.

Reimplemented from Stream.

◆ threadingMode()

Stream::ThreadingMode threadingMode ( ) const

overridevirtual

Configures threading mode of stream.

Returns ThreadingMode::BaseClassRunsWorkerThread by default. Override and return DerivedClassHandlesThreading if stream should not run a worker thread by its own. Overridden method must be constexpr-essible and thread-safe.

Reimplemented from Stream.

◆ extractFrames() [1/2]

void extractFrames	(	const Selection &	sel,
		const std::function< void(std::shared_ptr< const ImageStreamData >)> &	callback,
		Progress *	p = nullptr )

Extracts selected frames from the video and feeds them into the callback.

Callback does NOT get ownership of the video frame!

Parameters

sel	Selection describing which frames to extract
progress	Optional Progress object for progress reporting

◆ extractFrames() [2/2]

std::unique_ptr< SharedImageSet > extractFrames	(	const Selection &	sel,
		Progress *	progress = nullptr )

Extract selected frames from the video stream into a SharedImageSet.

Parameters

sel	Selection describing which frames to extract
progress	Optional Progress object for progress reporting

◆ setPlaySelected()

void setPlaySelected ( bool isSet )

Makes the stream play on the selected only.

Parameters

isSet If true, stream plays on the selected only.

◆ setFocus()

void setFocus ( int index )

overridevirtual

Set focus of the selection.

Checks and clamps the index to be within the range defined by size(). Emits signalSelectionChanged if index is different from the underlying selection's focus.

Reimplemented from Selectable.

◆ size()

int size ( ) const

overridevirtual

Returns the number of images of the image stream per emission.

Reimplemented from ImageStream.

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

ImFusion/Stream/VideoFileStream.h

Detailed Description

Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ openImpl()

◆ reset()

◆ startImpl()

◆ uuid()

◆ describe()

◆ supportsPausing()

◆ pauseImpl()

◆ resumeImpl()

◆ threadingMode()

◆ extractFrames() [1/2]

◆ extractFrames() [2/2]

◆ setPlaySelected()

◆ setFocus()

◆ size()