The task context provides and requires services. It uses an ExecutionEngine to perform its functions. Essential interfaces are operations, data flow ports and properties. These interfaces have been defined using the oroGen specification. In order to modify the interfaces you should (re)use oroGen and rely on the associated workflow. More...

#include <VideoDecoder.hpp>

Inheritance diagram for video_streamer::VideoDecoder:

Public Member Functions
	VideoDecoder (std::string const &name="video_streamer::VideoDecoder", TaskCore::TaskState initial_state=Stopped)

	VideoDecoder (std::string const &name, RTT::ExecutionEngine *engine, TaskCore::TaskState initial_state=Stopped)

	~VideoDecoder ()

bool	configureHook ()
	The following lines are template definitions for the various state machine. More...

void	updateHook ()

void	stopHook ()

void	cleanupHook ()

Protected Member Functions
void	WriteFrame ()

Protected Attributes
AVCodec *	codec

AVCodecContext *	c

AVFrame *	rgb_picture

AVFrame *	yuv_picture

AVPacket	avpkt

SwsContext *	sws_context

base::samples::frame::Frame *	frame

RTT::extras::ReadOnlyPointer< base::samples::frame::Frame >	ro_ptr

Friends
class	VideoDecoderBase

Detailed Description

The task context provides and requires services. It uses an ExecutionEngine to perform its functions. Essential interfaces are operations, data flow ports and properties. These interfaces have been defined using the oroGen specification. In order to modify the interfaces you should (re)use oroGen and rely on the associated workflow.

The name of a TaskContext is primarily defined via:

deployment 'deployment_name'
    task('custom_task_name','video_streamer::VideoDecoder')
end

It can be dynamically adapted when the deployment is called with a prefix argument.

Constructor & Destructor Documentation

VideoDecoder::VideoDecoder	(	std::string const &	name = `"video_streamer::VideoDecoder"`,
		TaskCore::TaskState	initial_state = `Stopped`
	)

TaskContext constructor for VideoDecoder

Parameters

name	Name of the task. This name needs to be unique to make it identifiable via nameservices.
initial_state	The initial TaskState of the TaskContext. Default is Stopped state.

VideoDecoder::VideoDecoder	(	std::string const &	name,
		RTT::ExecutionEngine *	engine,
		TaskCore::TaskState	initial_state = `Stopped`
	)

TaskContext constructor for VideoDecoder

Parameters

name	Name of the task. This name needs to be unique to make it identifiable for nameservices.
engine	The RTT Execution engine to be used for this task, which serialises the execution of all commands, programs, state machines and incoming events for a task.
initial_state	The initial TaskState of the TaskContext. Default is Stopped state.

VideoDecoder::~VideoDecoder ( )

Default deconstructor of VideoDecoder

Member Function Documentation

void VideoDecoder::cleanupHook ( )

This hook is called by Orocos when the state machine transitions from Stopped to PreOperational, requiring the call to configureHook() before calling start() again.

bool VideoDecoder::configureHook ( )

The following lines are template definitions for the various state machine.

This hook is called by Orocos when the state machine transitions from PreOperational to Stopped. If it returns false, then the component will stay in PreOperational. Otherwise, it goes into Stopped.

It is meaningful only if the #needs_configuration has been specified in the task context definition with (for example):

task_context "TaskName" do
  needs_configuration
  ...
end

void VideoDecoder::stopHook ( )

This hook is called by Orocos when the component is in the RunTimeError state, at each activity step. See the discussion in updateHook() about triggering options.

Call recover() to go back in the Runtime state. This hook is called by Orocos when the state machine transitions from Running to Stopped after stop() has been called.

void VideoDecoder::updateHook ( )

This hook is called by Orocos when the state machine transitions from Stopped to Running. If it returns false, then the component will stay in Stopped. Otherwise, it goes into Running and updateHook() will be called. This hook is called by Orocos when the component is in the Running state, at each activity step. Here, the activity gives the "ticks" when the hook should be called.

The error(), exception() and fatal() calls, when called in this hook, allow to get into the associated RunTimeError, Exception and FatalError states.

In the first case, updateHook() is still called, and recover() allows you to go back into the Running state. In the second case, the errorHook() will be called instead of updateHook(). In Exception, the component is stopped and recover() needs to be called before starting it again. Finally, FatalError cannot be recovered.

void VideoDecoder::WriteFrame ( )

protected

Friends And Related Function Documentation

friend class VideoDecoderBase

friend

Member Data Documentation

AVPacket video_streamer::VideoDecoder::avpkt

protected

AVCodecContext* video_streamer::VideoDecoder::c

protected

AVCodec* video_streamer::VideoDecoder::codec

protected

base::samples::frame::Frame* video_streamer::VideoDecoder::frame

protected

AVFrame* video_streamer::VideoDecoder::rgb_picture

protected

RTT::extras::ReadOnlyPointer<base::samples::frame::Frame> video_streamer::VideoDecoder::ro_ptr

protected

SwsContext* video_streamer::VideoDecoder::sws_context

protected

AVFrame* video_streamer::VideoDecoder::yuv_picture

protected

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

/build/rock-master-18.09-perception-orogen-video-streamer-0.20150421/tasks/VideoDecoder.hpp
/build/rock-master-18.09-perception-orogen-video-streamer-0.20150421/tasks/VideoDecoder.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation