Equalizer  1.4.1
Public Member Functions | Protected Member Functions | Protected Attributes | Protected Types
co::Compressor Class Reference
+ Inheritance diagram for co::Compressor:
+ Collaboration diagram for co::Compressor:

List of all members.

Public Member Functions

CO_API Compressor ()
 Construct a new compressor.
virtual CO_API ~Compressor ()
 Destruct the compressor.
CO_API bool initCompressor (uint32_t name)
 Initialize the specified compressor or downloader.
CO_API bool initDecompressor (uint32_t name)
 Initialize the specified decompressor or uploader.
PlugingetPlugin ()
uint32_t getName () const
virtual CO_API bool isValid (uint32_t name) const
CO_API void reset ()
 Remove all information about the current compressor.
CO_API float getQuality () const
const CompressorInfogetInfo () const

Protected Member Functions

Plugin_findPlugin (uint32_t name)
 Find the plugin where located the compressor.
 LB_TS_VAR (_thread)

Protected Attributes

uint32_t _name
 The name of the (de)compressor.
Plugin_plugin
 Plugin handling the allocation.
void * _instance
 The instance of the (de)compressor, can be 0 for decompressor.
const CompressorInfo_info
 Info about the current compressor instance.
enum co::Compressor::State _state

Protected Types

enum  State { STATE_FREE, STATE_COMPRESSOR, STATE_DECOMPRESSOR }
 Instance allocation state.

Detailed Description

Definition at line 29 of file compressor.h.


Constructor & Destructor Documentation

Construct a new compressor.

virtual CO_API co::Compressor::~Compressor ( ) [virtual]

Destruct the compressor.


Member Function Documentation

Plugin* co::Compressor::_findPlugin ( uint32_t  name) [protected]

Find the plugin where located the compressor.

Parameters:
namethe name of the compressor
const CompressorInfo& co::Compressor::getInfo ( ) const [inline]
Returns:
the information about the current compressor instance.

Definition at line 72 of file compressor.h.

References _info.

uint32_t co::Compressor::getName ( ) const [inline]
Returns:
the name of the compressor.

Definition at line 59 of file compressor.h.

References _name.

Returns:
the plugin for the current compressor.

Definition at line 56 of file compressor.h.

References _plugin.

CO_API float co::Compressor::getQuality ( ) const
Returns:
the quality produced by the current compressor instance.
CO_API bool co::Compressor::initCompressor ( uint32_t  name)

Initialize the specified compressor or downloader.

Parameters:
namethe name of the compressor
Returns:
true on success, false otherwise.
CO_API bool co::Compressor::initDecompressor ( uint32_t  name)

Initialize the specified decompressor or uploader.

Parameters:
namethe name of the compressor
Returns:
true on success, false otherwise.
virtual CO_API bool co::Compressor::isValid ( uint32_t  name) const [virtual]
Returns:
true if the compressor is ready for the current compressor name.
CO_API void co::Compressor::reset ( )

Remove all information about the current compressor.


The documentation for this class was generated from the following file:
Generated on Mon Nov 26 2012 14:41:50 for Equalizer 1.4.1 by  doxygen 1.7.6.1