mf
Media Framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | List of all members
mf::frame_importer< Dim, Elem > Class Template Referenceabstract

Frame importer, abstract base class. More...

#include <frame_importer.h>

Inheritance diagram for mf::frame_importer< Dim, Elem >:
mf::seekable_frame_importer< Dim, Elem >

Public Types

using frame_view_type = ndarray_view< Dim, Elem >
 
using elem_type = Elem
 

Public Member Functions

virtual ~frame_importer ()
 
const ndsize< Dim > & frame_shape ()
 
virtual void read_frame (const frame_view_type &)=0
 
virtual bool reached_end () const =0
 

Static Public Attributes

static constexpr std::size_t dimension = Dim
 
static constexpr bool is_seekable = false
 

Protected Member Functions

 frame_importer (const ndsize< Dim > &frame_shape)
 

Detailed Description

template<std::size_t Dim, typename Elem>
class mf::frame_importer< Dim, Elem >

Frame importer, abstract base class.

Each frame is an ndarray<Dim, Elem> with fixed shape. Frames are read sequentially with read_frame(), and reached_end() becomes true when after last frame was read.

Member Typedef Documentation

template<std::size_t Dim, typename Elem>
using mf::frame_importer< Dim, Elem >::elem_type = Elem
template<std::size_t Dim, typename Elem>
using mf::frame_importer< Dim, Elem >::frame_view_type = ndarray_view<Dim, Elem>

Constructor & Destructor Documentation

template<std::size_t Dim, typename Elem>
mf::frame_importer< Dim, Elem >::frame_importer ( const ndsize< Dim > &  frame_shape)
inlineprotected
template<std::size_t Dim, typename Elem>
virtual mf::frame_importer< Dim, Elem >::~frame_importer ( )
inlinevirtual

Member Function Documentation

template<std::size_t Dim, typename Elem>
const ndsize<Dim>& mf::frame_importer< Dim, Elem >::frame_shape ( )
inline
template<std::size_t Dim, typename Elem>
virtual bool mf::frame_importer< Dim, Elem >::reached_end ( ) const
pure virtual

Implemented in mf::yuv_importer.

template<std::size_t Dim, typename Elem>
virtual void mf::frame_importer< Dim, Elem >::read_frame ( const frame_view_type )
pure virtual

Member Data Documentation

template<std::size_t Dim, typename Elem>
constexpr std::size_t mf::frame_importer< Dim, Elem >::dimension = Dim
static
template<std::size_t Dim, typename Elem>
constexpr bool mf::frame_importer< Dim, Elem >::is_seekable = false
static

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