- Main Page
- Namespaces
- Classes
- Files
- Directories

- File List
- File Members

# common.h File Reference

`#include <libdirac_common/bit_manager.h>`
`#include <libdirac_common/arrays.h>`
`#include <libdirac_common/common_types.h>`
`#include <vector>`
`#include <cmath>`

Go to the source code of this file.

## Namespaces
namespace | dirac
## Classes
class | dirac::PicArray
| A class for picture component data. More...
class | dirac::CostType
| A structure for recording costs, particularly in quantisation. More...
class | dirac::EntropyCorrector
| A class used for correcting estimates of entropy. More...
class | dirac::OLBParams
| Parameters for overlapped block motion compensation. More...
class | dirac::SeqParams
| Parameters relating to the video sequence being encoded/decoded. More...
class | dirac::FrameParams
| Parameters for initialising frame class objects. More...
class | dirac::CodecParams
| Parameters common to coder and decoder operation. More...
class | dirac::EncoderParams
| Parameters for the encoding process. More...
class | dirac::DecoderParams
| Parameters for the decoding process. More...
## Enumerations
enum | dirac::PredMode
| Prediction modes for blocks.
enum | dirac::CompSort
| Types of picture component.
enum | dirac::AddOrSub
| Addition or subtraction.
enum | dirac::Direction
| Forward or backward.
enum | dirac::WltFilter
| Currently only Daubechies (DAUB) implemented.
enum | dirac::CtxAliases
| Contexts used for coefficient coding.
enum | dirac::MvCtxAliases
| Contexts used for MV data coding.
## Functions
ValueType | dirac::BChk (const ValueType &num, const ValueType &max)
| A simple bounds checking function, very useful in a number of places.

## Detailed Description

This file contains common classes used throughout the encoder and decoder. The main classes are the encoder and decoder parameters for controlling the encode and decode processes. These are passed throughout the codec. There are also parameter classes for sequences and frames.

Definition in file common.h.