oneVPL++
C++ API Prototype for oneVPL
oneapi::vpl::bitstream_file_reader Class Reference

File based source data reader. More...

#include <source_reader.hpp>

Inheritance diagram for oneapi::vpl::bitstream_file_reader:
[legend]
Collaboration diagram for oneapi::vpl::bitstream_file_reader:
[legend]

Public Member Functions

 bitstream_file_reader (std::ifstream &ifl)
 Constructs reader with given file handle. More...
 
bool get_data (bitstream_as_src *bits)
 Read and store portion of data into the bitstream object. More...
 
bool is_EOS () const
 Checks and retrieve end of stream status. More...
 
- Public Member Functions inherited from oneapi::vpl::bitstream_source_reader
 bitstream_source_reader ()
 Default ctor.
 
virtual ~bitstream_source_reader ()
 Default dtor.
 
- Public Member Functions inherited from oneapi::vpl::source_reader
 source_reader ()
 Default ctor.
 
virtual ~source_reader ()
 Default dtor.
 

Protected Attributes

std::ifstream & if_
 File handle.
 

Detailed Description

File based source data reader.

Constructor & Destructor Documentation

◆ bitstream_file_reader()

oneapi::vpl::bitstream_file_reader::bitstream_file_reader ( std::ifstream &  ifl)
inlineexplicit

Constructs reader with given file handle.

Parameters
[in]iflReference to the file handle

Member Function Documentation

◆ get_data()

bool oneapi::vpl::bitstream_file_reader::get_data ( bitstream_as_src bits)
inlinevirtual

Read and store portion of data into the bitstream object.

Parameters
[out]bitsdata storage
Returns
True if data was read

Implements oneapi::vpl::bitstream_source_reader.

Here is the call graph for this function:

◆ is_EOS()

bool oneapi::vpl::bitstream_file_reader::is_EOS ( ) const
inlinevirtual

Checks and retrieve end of stream status.

Returns
True if EOS reached

Implements oneapi::vpl::source_reader.


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