DD::Image::CodecOp Class Referenceabstract

Inherits DD::Image::FileOp.

Inherited by DD::Image::Read.

Public Member Functions

 CodecOp ()
 
virtual CodecHandlercodec_handler () const =0
 
virtual void codec_options_knobs (Knob_Callback f)
 
void add_codec_knobs (const void *id, const char *fileExt)
 
int codec_knobs () const
 
- Public Member Functions inherited from DD::Image::FileOp
 FileOp ()
 
virtual ~FileOp ()
 
virtual Opop ()=0
 
void Reload_Button (Knob_Callback f)
 
int version () const
 
void setVersion (int newVersion)
 
void internalError (const char *fmt,...)
 
void internalErrorV (const char *fmt, va_list args)
 
int replaced_knobs () const
 
int extra_knobs () const
 
Knobplacemarker () const
 
KnobextraPlacemarker () const
 
virtual const char * getFilename () const =0
 
virtual const char * file_type () const =0
 
virtual FileHandler * handler () const =0
 
virtual void filehandler_knobs (Knob_Callback f)
 
virtual int filehandler_knob_changed (Knob *k)
 
virtual int filehandler_knob_change_finished (Knob *k, bool changeByUser)
 
virtual void filehandler_extra_knobs (Knob_Callback f)
 
virtual void replaceable_knobs (Knob_Callback f)
 
virtual void extra_knobs (Knob_Callback f)
 
void replace_knobs (const void *id, const char *fileExt)
 Change the set of knobs in response to the user changing the filename or the file type pulldown. More...
 
const void * replaced_knobs_id () const
 
void add_extra_knobs (const void *id, const char *fileExt)
 
const void * extra_knobs_id () const
 

Additional Inherited Members

- Static Public Member Functions inherited from DD::Image::FileOp
static const char * StripPrefix (const char *filename, std::string *prefix=nullptr)
 
static const char * StripSuffix (const char *filename, std::string *suffix=nullptr)
 
static bool GetFormatAndName (const char *fname, std::string &format, std::string &name)
 
static const char *const * file_types (const char *suffix, const char *altsuffix, const char **prefixBlacklist, const char **extras, const char **obsoleteIDs=nullptr)
 Return an array of names of file types known about. This is generated by searching the pluigin directories for any plugins called "*Writer.plugin_ext". The first location in the array is a blank string for 'unknown' and the array is NULL-terminated. More...
 
static void AddAlias (const char *from, const char *to)
 
static const char * LookupAlias (const char *from)
 
- Protected Attributes inherited from DD::Image::FileOp
bool _readerError
 whether or not the reader is in error (set by internalError)
 
std::string _readerErrorString
 the last reader error (set by internalError)
 

Detailed Description

This class extends the functionality of the FileOp class to allow codec-format-specific knobs to be substituted in to a particular place more easily. This is normally extended by the Read/Write nodes

Constructor & Destructor Documentation

CodecOp::CodecOp ( )

CodecOp Class

Member Function Documentation

virtual CodecHandler* DD::Image::CodecOp::codec_handler ( ) const
pure virtual

return the codec format handler for the current knob settings. this should return null if the handler does not support codecs.

void CodecOp::codec_options_knobs ( Knob_Callback  f)
virtual

insert in the codec specific knobs. subclasses should call this in their knobs() implementation

void CodecOp::add_codec_knobs ( const void *  id,
const char *  fileExt 
)

If the id is different, replace the knobs by calling the above. Subclasses should call this in e.g. knob_changed() after the handler has changed

int CodecOp::codec_knobs ( ) const

get the number of codec knobs



©2021 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.thefoundry.co.uk