ffmpeg_writer: Uses ffmpeg to write images/sounds to movie files (AVI, MOV, ...). More...

#include <ffmpeg/FfmpegWriter.h>

Inheritance diagram for FfmpegWriter:

Public Member Functions
	FfmpegWriter ()

bool	open (yarp::os::Searchable &config) override
	Open the DeviceDriver.

bool	close () override
	Close the DeviceDriver.

bool	putImage (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image) override
	Write an image to the device.

virtual bool	putAudioVisual (yarp::sig::ImageOf< yarp::sig::PixelRgb > &image, yarp::sig::Sound &sound) override
	Write an image and sound.

bool	hasAudio () override

bool	hasVideo () override

Public Member Functions inherited from yarp::dev::IFrameWriterImage
virtual	~IFrameWriterImage ()
	Destructor.

Public Member Functions inherited from yarp::dev::IFrameWriterAudioVisual
virtual	~IFrameWriterAudioVisual ()
	Destructor.

Public Member Functions inherited from yarp::dev::DeviceDriver
	DeviceDriver ()

	DeviceDriver (const DeviceDriver &other)=delete

	DeviceDriver (DeviceDriver &&other) noexcept=delete

DeviceDriver &	operator= (const DeviceDriver &other)=delete

DeviceDriver &	operator= (DeviceDriver &&other) noexcept=delete

virtual	~DeviceDriver ()

virtual std::string	id () const
	Return the id assigned to the PolyDriver.

virtual void	setId (const std::string &id)
	Set the id for this device.

template<class T >
bool	view (T *&x)
	Get an interface to the device driver.

virtual DeviceDriver *	getImplementation ()
	Some drivers are bureaucrats, pointing at others.

Public Member Functions inherited from yarp::dev::IAudioVisualStream
virtual	~IAudioVisualStream ()
	Destructor.

virtual bool	hasRawVideo ()

Public Member Functions inherited from FfmpegWriter_ParamsParser
	FfmpegWriter_ParamsParser ()

	~FfmpegWriter_ParamsParser () override=default

bool	parseParams (const yarp::os::Searchable &config) override
	Parse the DeviceDriver parameters.

std::string	getDeviceClassName () const override
	Get the name of the DeviceDriver class.

std::string	getDeviceName () const override
	Get the name of the device (i.e.

std::string	getDocumentationOfDeviceParams () const override
	Get the documentation of the DeviceDriver's parameters.

std::vector< std::string >	getListOfParams () const override
	Return a list of all params used by the device.

Public Member Functions inherited from yarp::dev::IDeviceDriverParams
virtual	~IDeviceDriverParams ()

Additional Inherited Members
Public Attributes inherited from FfmpegWriter_ParamsParser
const std::string	m_device_classname = {"FfmpegWriter"}

const std::string	m_device_name = {"ffmpeg_writer"}

bool	m_parser_is_strict = false

const parser_version_type	m_parser_version = {}

const std::string	m_width_defaultValue = {"0"}

const std::string	m_height_defaultValue = {"0"}

const std::string	m_framerate_defaultValue = {"30"}

const std::string	m_audio_defaultValue = {"false"}

const std::string	m_channels_defaultValue = {"1"}

const std::string	m_sample_rate_defaultValue = {"44100"}

const std::string	m_out_defaultValue = {"movie.avi"}

int	m_width = {0}

int	m_height = {0}

int	m_framerate = {30}

bool	m_audio = {false}

int	m_channels = {1}

int	m_sample_rate = {44100}

std::string	m_out = {"movie.avi"}

Detailed Description

ffmpeg_writer: Uses ffmpeg to write images/sounds to movie files (AVI, MOV, ...).

Parameters required by this device are shown in class: FfmpegWriter_ParamsParser

Definition at line 33 of file FfmpegWriter.h.

Constructor & Destructor Documentation

◆ FfmpegWriter()

FfmpegWriter::FfmpegWriter ( )

inline

Definition at line 42 of file FfmpegWriter.h.

Member Function Documentation

◆ close()

bool FfmpegWriter::close ( )

overridevirtual

Close the DeviceDriver.

Returns: true/false on success/failure.

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 654 of file FfmpegWriter.cpp.

◆ hasAudio()

bool FfmpegWriter::hasAudio ( )

inlineoverridevirtual

Implements yarp::dev::IAudioVisualStream.

Definition at line 70 of file FfmpegWriter.h.

◆ hasVideo()

bool FfmpegWriter::hasVideo ( )

inlineoverridevirtual

Implements yarp::dev::IAudioVisualStream.

Definition at line 72 of file FfmpegWriter.h.

◆ open()

bool FfmpegWriter::open ( yarp::os::Searchable & config )

overridevirtual

Open the DeviceDriver.

Parameters

config is a list of parameters for the device. Which parameters are effective for your device can vary. See device invocation examples. If there is no example for your device, you can run the "yarpdev" program with the verbose flag set to probe what parameters the device is checking. If that fails too, you'll need to read the source code (please nag one of the yarp developers to add documentation for your device).

Returns: true/false upon success/failure

Reimplemented from yarp::dev::DeviceDriver.

Definition at line 555 of file FfmpegWriter.cpp.

◆ putAudioVisual()

bool FfmpegWriter::putAudioVisual	(	yarp::sig::ImageOf< yarp::sig::PixelRgb > &	image,
		yarp::sig::Sound &	sound
	)

overridevirtual

Write an image and sound.

Parameters

image	the image to be written
sound	the sound to be written

Returns: true/false upon success/failure

Implements yarp::dev::IFrameWriterAudioVisual.

Definition at line 723 of file FfmpegWriter.cpp.

◆ putImage()

bool FfmpegWriter::putImage ( yarp::sig::ImageOf< yarp::sig::PixelRgb > & image )

overridevirtual

Write an image to the device.

Parameters

image the image to write

Returns: true/false upon success/failure

Implements yarp::dev::IFrameWriterImage.

Definition at line 687 of file FfmpegWriter.cpp.

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

src/devices/ffmpeg/FfmpegWriter.h
src/devices/ffmpeg/FfmpegWriter.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FfmpegWriter()

Member Function Documentation

◆ close()

◆ hasAudio()

◆ hasVideo()

◆ open()

◆ putAudioVisual()

◆ putImage()