mf
Media Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | List of all members
mf::flow::sync_node Class Referencefinal

Synchronous node base class. More...

#include <sync_node.h>

Inheritance diagram for mf::flow::sync_node:
mf::flow::filter_node mf::flow::node

Public Member Functions

 sync_node (graph &gr)
 
void internal_setup () finaloverride
 Called by propagate_setup_. More...
 
void launch () finaloverride
 Called by graph for all nodes, before any frame is pulled from sink. More...
 
void stop () finaloverride
 Called by graph for all node, before destruction of any node. More...
 
bool process_next_frame () override
 
node_inputadd_input (time_unit past_window, time_unit future_window) override
 
sync_node_outputadd_output (const frame_format &format) override
 
- Public Member Functions inherited from mf::flow::filter_node
 filter_node (graph &gr)
 
 ~filter_node ()
 
template<typename Filter , typename... Args>
Filter & set_filter (Args &&...args)
 
filterthis_filter ()
 
const filterthis_filter () const
 
- Public Member Functions inherited from mf::flow::node
virtual ~node ()
 
graphthis_graph () noexcept
 
void define_source_stream_properties (bool seekable, time_unit stream_duration=-1)
 
void set_prefetch_duration (time_unit)
 
const auto & inputs () noexcept
 
const auto & outputs () noexcept
 
bool is_source () const noexcept
 
bool is_sink () const noexcept
 
time_unit end_time () const noexcept
 
bool reached_end () const noexcept
 
bool was_setup () const noexcept
 
time_unit prefetch_duration () const noexcept
 
time_unit offset () const noexcept
 
bool stream_duration_is_defined () const noexcept
 
time_unit stream_duration () const noexcept
 
bool is_seekable () const noexcept
 
bool is_bounded () const
 
bool is_active () const noexcept
 
void update_activation ()
 Called by output, propagates to preceding nodes. More...
 
time_unit current_time () const noexcept
 

Additional Inherited Members

- Public Attributes inherited from mf::flow::node
std::string name
 
- Protected Member Functions inherited from mf::flow::filter_node
void setup_filter ()
 
void pre_process_filter (node_job &)
 
void process_filter (node_job &)
 
- Protected Member Functions inherited from mf::flow::node
 node (graph &gr)
 
 node (const node &)=delete
 
nodeoperator= (const node &)=delete
 
void setup_sink ()
 Called by sink node, runs set up procedure for all node in graph. More...
 
void set_current_time (time_unit t) noexcept
 
void mark_end ()
 
node_job make_job ()
 
void cancel_job (node_job &)
 
template<typename Input >
Input & add_input_ (time_unit past_window, time_unit future_window)
 
template<typename Output >
Output & add_output_ (const frame_format &format)
 

Detailed Description

Synchronous node base class.

Processes frames synchronously when pulled from output. Can have multiple inputs, but only one output.

Constructor & Destructor Documentation

mf::flow::sync_node::sync_node ( graph gr)
inlineexplicit

Member Function Documentation

node_input& mf::flow::sync_node::add_input ( time_unit  past_window,
time_unit  future_window 
)
inlineoverridevirtual

Implements mf::flow::filter_node.

sync_node_output& mf::flow::sync_node::add_output ( const frame_format format)
inlineoverridevirtual

Implements mf::flow::filter_node.

void mf::flow::sync_node::internal_setup ( )
finaloverridevirtual

Called by propagate_setup_.

Implements mf::flow::node.

void mf::flow::sync_node::launch ( )
finaloverridevirtual

Called by graph for all nodes, before any frame is pulled from sink.

Implements mf::flow::node.

bool mf::flow::sync_node::process_next_frame ( )
overridevirtual

Implements mf::flow::node.

void mf::flow::sync_node::stop ( )
finaloverridevirtual

Called by graph for all node, before destruction of any node.

Implements mf::flow::node.


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