libpromeki main
PROfessional MEdia toolKIt
 
Loading...
Searching...
No Matches
Codec Class Reference

Abstract base class for image codecs. More...

#include <codec.h>

Classes

class  Instance
 Represents an active codec instance used for performing conversions. More...
 

Public Member Functions

 Codec ()
 Default constructor.
 
virtual ~Codec ()
 Destructor.
 
bool canConvert (const ImageDesc &inDesc, PixelFormat::ID outID, const Metadata &outMeta) const
 Returns whether this codec can convert the given input to the specified output format.
 
InstancecreateInstance ()
 Creates and returns a new codec instance.
 

Detailed Description

Abstract base class for image codecs.

Provides an interface for querying conversion capabilities and creating codec instances that perform image format conversions. Subclasses implement specific encoding/decoding algorithms.

Member Function Documentation

◆ canConvert()

bool Codec::canConvert ( const ImageDesc inDesc,
PixelFormat::ID  outID,
const Metadata outMeta 
) const
inline

Returns whether this codec can convert the given input to the specified output format.

Parameters
inDescThe input image description.
outIDThe desired output pixel format ID.
outMetaThe desired output metadata.
Returns
true if the codec supports the requested conversion.

◆ createInstance()

Instance * Codec::createInstance ( )
inline

Creates and returns a new codec instance.

Returns
A pointer to a new Instance, or nullptr if creation fails.

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