codec.h File Reference

High-level codec interface. More...

#include "volksdata/codec/codec_nt.h"
#include "volksdata/codec/codec_ttl.h"
#include "volksdata/codec/codec_trig.h"

Include dependency graph for codec.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	VOLK_CodecIterator
	Codec iterator. More...

Macros
#define	CODEC_TBL
#define	ENTRY(a, b, c)
	Get a codec by its format string.
#define	ENTRY(a, b, c)
	Get a codec by its format string.

Enumerations
enum	VOLK_CodecFormat { CODEC_TBL }
	Codec formats available. More...

Detailed Description

High-level codec interface.

This module, similarly to the store module, provides a high-level API to the individual codec interfaces. It allows programmatic access to a specified codec and fails gracefully when a codec is missing a requested feature.

Users of this library normally need not access codecs any deeper than this level.

Implementers of new codecs should consult the codec_interface.h documentation for implementation details. New codecs MUST be registered in two places in codec.h: 1) an #include "volksdata/codec/codec_<new_format>.h" line, and 2) an additional entry to the CODEC_TBL X-macro, which takes care of generating all necessary helper functions.

Definition in file codec.h.

Macro Definition Documentation

CODEC_TBL

#define CODEC_TBL

Value:

/*          #enum suffix    #fmt    #codec if  */   \
    ENTRY(  NT,             nt,     nt_codec  )     \
    ENTRY(  TTL,            ttl,    ttl_codec )     \
    ENTRY(  TRIG,           trig,   trig_codec )    \

Definition at line 33 of file codec.h.