firevision::FvRawReader Class Reference

FvRaw image reader implementation. More...

#include <>>

Inheritance diagram for firevision::FvRawReader:

Public Member Functions
	FvRawReader (const char *filename)
	Constructor. More...
virtual	~FvRawReader ()
	Destructor. More...
virtual void	set_buffer (unsigned char *yuv422planar_buffer)
	Set buffer that the read image should be written to. More...
virtual colorspace_t	colorspace ()
	Get colorspace from the just read image. More...
virtual unsigned int	pixel_width ()
	Get width of read image in pixels. More...
virtual unsigned int	pixel_height ()
	Get height of read image in pixels. More...
virtual void	read ()
	Read data from file. More...
Public Member Functions inherited from firevision::Reader
virtual	~Reader ()
	Virtual empty destructor. More...
virtual void	set_buffer (unsigned char *yuv422planar_buffer)=0
	Set buffer that the read image should be written to. More...
virtual colorspace_t	colorspace ()=0
	Get colorspace from the just read image. More...
virtual unsigned int	pixel_width ()=0
	Get width of read image in pixels. More...
virtual unsigned int	pixel_height ()=0
	Get height of read image in pixels. More...
virtual void	read ()=0
	Read data from file. More...

Static Public Member Functions
static bool	is_FvRaw (const char *filename)
	Check if given file contains FvRaw image. More...

Detailed Description

FvRaw image reader implementation.

Author

Tim Niemueller

Definition at line 34 of file fvraw.h.

Constructor & Destructor Documentation

FvRawReader()

firevision::FvRawReader::FvRawReader

(

const char *

filename

)

Constructor.

Parameters

filename

filename to read from.

Definition at line 44 of file fvraw.cpp.

References firevision::FvRawWriter::FILE_IDENTIFIER.

~FvRawReader()

firevision::FvRawReader::~FvRawReader ( )

virtual

Destructor.

Definition at line 68 of file fvraw.cpp.

Member Function Documentation

colorspace()

colorspace_t firevision::FvRawReader::colorspace ( )

virtual

Get colorspace from the just read image.

Returns

colorspace

Implements firevision::Reader.

Definition at line 81 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::colorspace.

is_FvRaw()

bool firevision::FvRawReader::is_FvRaw ( const char *  filename )

static

Check if given file contains FvRaw image.

Parameters

filename

file to check

Returns

true if file contains FvRaw image, false otherwise

Definition at line 130 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::file_id, and firevision::FvRawWriter::FILE_IDENTIFIER.

pixel_height()

unsigned int firevision::FvRawReader::pixel_height ( )

virtual

Get height of read image in pixels.

Returns

height of image

Implements firevision::Reader.

Definition at line 101 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::height.

pixel_width()

unsigned int firevision::FvRawReader::pixel_width ( )

virtual

Get width of read image in pixels.

Returns

width of image

Implements firevision::Reader.

Definition at line 91 of file fvraw.cpp.

References firevision::FvRawWriter::FvRawHeader::width.

read()

void firevision::FvRawReader::read ( )

virtual

Read data from file.

Implements firevision::Reader.

Definition at line 111 of file fvraw.cpp.

set_buffer()

void firevision::FvRawReader::set_buffer ( unsigned char *  yuv422planar_buffer )

virtual

Set buffer that the read image should be written to.

Parameters

yuv422planar_buffer

buffer to write image to. The reader must ensure that it does the proper conversion (if needed) to YUV 422 planar format.

Implements firevision::Reader.

Definition at line 75 of file fvraw.cpp.

---

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

• src/libs/fvutils/readers/fvraw.h
• src/libs/fvutils/readers/fvraw.cpp