Dirac - A Video Codec
Created by the British Broadcasting Corporation.
dirac::EncoderParams Class Reference
Parameters for the encoding process.
More...
#include <common.h>
Inheritance diagram for dirac::EncoderParams:
List of all members.Public Member Functions
- EncoderParams (const VideoFormat &video_format, FrameType ftype=INTER_FRAME, unsigned int num_refs=2, bool set_defaults=true)
- Default constructor.
- bool Verbose () const
- Returns true if we're operating verbosely, false otherwise.
- bool LocalDecode () const
- Returns a flag indicating that we're doing local decoding.
- bool Lossless () const
- Get whether we're doing lossless coding.
- bool FullSearch () const
- Get whether we're doing full-search motion estimation.
- int XRangeME () const
- Get the horizontal search range for full-search motion estimation.
- int YRangeME () const
- Get the vertical search range for full-search motion estimation.
- float Qf () const
- Get the quality factor.
- int NumL1 () const
- Return the nominal number of L1 frames before the next I frame.
- int L1Sep () const
- Return the separation between L1 frames (and between L1 and I frames).
- float UFactor () const
- Return the amount we're weighting noise in the U component.
- float VFactor () const
- Return the amount we're weighting noise in the V component.
- float CPD () const
- Return the number of cycles per degree at the nominal viewing distance for the raster.
- bool Denoise () const
- Return whether input denoising is on or off.
- float ILambda () const
- Return the Lagrangian parameter to be used for I frames.
- float L1Lambda () const
- Return the Lagrangian parameter to be used for L1 frames.
- float L2Lambda () const
- Return the Lagrangian parameter to be used for L2 frames.
- float L1MELambda () const
- Return the Lagrangian ME parameter to be used for L1 frames.
- float L2MELambda () const
- Return the Lagrangian ME parameter to be used for L2 frames.
- int GOPLength () const
- Return the size of the GOP.
- char * OutputPath () const
- Return the output path to be used for storing diagnositic data.
- const EntropyCorrector & EntropyFactors () const
- Return a reference to the entropy factors.
- EntropyCorrector & EntropyFactors ()
- Return a reference to the entropy factors - we need to be able to change the values of the entropy factors in situ.
- WltFilter IntraTransformFilter ()
- Return the Wavelet filter to be used for intra frames.
- WltFilter InterTransformFilter ()
- Return the Wavelet filter to be used for Inter frames.
- int TargetRate ()
- Return the Target Bit Rate in kbps.
- bool UsingAC () const
- Return true if using Arithmetic coding.
- void SetVerbose (bool v)
- Sets verbosity on or off.
- void SetLocalDecode (const bool decode)
- Sets a flag indicating that we're producing a locally decoded o/p.
- void SetLossless (const bool l)
- Set whether we're doing lossless coding.
- void SetFullSearch (const bool fs)
- Set whether we're doing full-search motion estimation.
- void SetXRangeME (const int xr)
- Set the horizontal search range for full-search motion estimation.
- void SetYRangeME (const int yr)
- Set the vertical search range for full-search motion estimation.
- void SetQf (const float qfac)
- Set the quality factor.
- void SetNumL1 (const int nl)
- Set the nominal number of L1 frames between I frames.
- void SetL1Sep (const int lsep)
- Set the separation between L1 frames.
- void SetUFactor (const float uf)
- Set the amount to weight noise in the U component.
- void SetVFactor (const float vf)
- Set the amount to weight noise in the V component.
- void SetCPD (const float cpd)
- Set the number of cycles per degree at the nominal viewing distance.
- void SetDenoise (const bool denoise)
- Set denoising value - true or false.
- void SetOutputPath (const char *op)
- Set the output path to be used for diagnostic data.
- void SetEntropyFactors (EntropyCorrector *entcorrect)
- Sets the entropy factors - TBD: set this up in a constructor and pass encoder params around entirely by reference.
- void SetIntraTransformFilter (unsigned int wf_idx)
- Set the Wavelet filter to be used for intra frames.
- void SetInterTransformFilter (unsigned int wf_idx)
- Set the Wavelet filter to be used for inter frames.
- void SetIntraTransformFilter (WltFilter wf)
- Set the Wavelet filter to be used for intra frames.
- void SetUsualCodeBlocks (const FrameType &ftype)
- Set the number of code blocks for all levels.
- void SetInterTransformFilter (WltFilter wf)
- Set the Wavelet filter to be used for inter frames.
- void SetTargetRate (const int rate)
- Set the target bit rate.
- void SetUsingAC (bool using_ac)
- Set the arithmetic coding flag.
Private Member Functions
- void CalcLambdas (const float qf)
- Calculate the Lagrangian parameters from the quality factor.
Private Attributes
Detailed Description
Parameters for the encoding process, derived from CodecParams.
Constructor & Destructor Documentation
dirac::EncoderParams::EncoderParams |
( |
const VideoFormat & |
video_format, |
|
|
FrameType |
ftype = INTER_FRAME , |
|
|
unsigned int |
num_refs = 2 , |
|
|
bool |
set_defaults = true |
|
) |
|
|
Member Function Documentation
void dirac::EncoderParams::CalcLambdas |
( |
const float |
qf |
) |
[private] |
|
float dirac::EncoderParams::CPD |
( |
|
) |
const [inline] |
|
bool dirac::EncoderParams::Denoise |
( |
|
) |
const [inline] |
|
bool dirac::EncoderParams::FullSearch |
( |
|
) |
const [inline] |
|
int dirac::EncoderParams::GOPLength |
( |
|
) |
const |
|
float dirac::EncoderParams::ILambda |
( |
|
) |
const [inline] |
|
WltFilter dirac::EncoderParams::InterTransformFilter |
( |
|
) |
[inline] |
|
WltFilter dirac::EncoderParams::IntraTransformFilter |
( |
|
) |
[inline] |
|
float dirac::EncoderParams::L1Lambda |
( |
|
) |
const [inline] |
|
float dirac::EncoderParams::L1MELambda |
( |
|
) |
const [inline] |
|
int dirac::EncoderParams::L1Sep |
( |
|
) |
const [inline] |
|
float dirac::EncoderParams::L2Lambda |
( |
|
) |
const [inline] |
|
float dirac::EncoderParams::L2MELambda |
( |
|
) |
const [inline] |
|
bool dirac::EncoderParams::LocalDecode |
( |
|
) |
const [inline] |
|
bool dirac::EncoderParams::Lossless |
( |
|
) |
const [inline] |
|
int dirac::EncoderParams::NumL1 |
( |
|
) |
const [inline] |
|
|
Return the nominal number of L1 frames before the next I frame. Can be overridden by I-frame insertion |
char* dirac::EncoderParams::OutputPath |
( |
|
) |
const [inline] |
|
float dirac::EncoderParams::Qf |
( |
|
) |
const [inline] |
|
void dirac::EncoderParams::SetCPD |
( |
const float |
cpd |
) |
[inline] |
|
void dirac::EncoderParams::SetDenoise |
( |
const bool |
denoise |
) |
[inline] |
|
void dirac::EncoderParams::SetEntropyFactors |
( |
EntropyCorrector * |
entcorrect |
) |
[inline] |
|
void dirac::EncoderParams::SetFullSearch |
( |
const bool |
fs |
) |
[inline] |
|
void dirac::EncoderParams::SetInterTransformFilter |
( |
WltFilter |
wf |
) |
[inline] |
|
void dirac::EncoderParams::SetInterTransformFilter |
( |
unsigned int |
wf_idx |
) |
|
|
void dirac::EncoderParams::SetIntraTransformFilter |
( |
WltFilter |
wf |
) |
[inline] |
|
void dirac::EncoderParams::SetIntraTransformFilter |
( |
unsigned int |
wf_idx |
) |
|
|
void dirac::EncoderParams::SetL1Sep |
( |
const int |
lsep |
) |
[inline] |
|
void dirac::EncoderParams::SetLocalDecode |
( |
const bool |
decode |
) |
[inline] |
|
void dirac::EncoderParams::SetLossless |
( |
const bool |
l |
) |
[inline] |
|
void dirac::EncoderParams::SetNumL1 |
( |
const int |
nl |
) |
[inline] |
|
void dirac::EncoderParams::SetOutputPath |
( |
const char * |
op |
) |
[inline] |
|
void dirac::EncoderParams::SetQf |
( |
const float |
qfac |
) |
[inline] |
|
void dirac::EncoderParams::SetTargetRate |
( |
const int |
rate |
) |
[inline] |
|
void dirac::EncoderParams::SetUFactor |
( |
const float |
uf |
) |
[inline] |
|
void dirac::EncoderParams::SetUsingAC |
( |
bool |
using_ac |
) |
[inline] |
|
void dirac::EncoderParams::SetUsualCodeBlocks |
( |
const FrameType & |
ftype |
) |
|
|
void dirac::EncoderParams::SetVerbose |
( |
bool |
v |
) |
[inline] |
|
void dirac::EncoderParams::SetVFactor |
( |
const float |
vf |
) |
[inline] |
|
void dirac::EncoderParams::SetXRangeME |
( |
const int |
xr |
) |
[inline] |
|
void dirac::EncoderParams::SetYRangeME |
( |
const int |
yr |
) |
[inline] |
|
int dirac::EncoderParams::TargetRate |
( |
|
) |
[inline] |
|
float dirac::EncoderParams::UFactor |
( |
|
) |
const [inline] |
|
bool dirac::EncoderParams::UsingAC |
( |
|
) |
const [inline] |
|
bool dirac::EncoderParams::Verbose |
( |
|
) |
const [inline] |
|
float dirac::EncoderParams::VFactor |
( |
|
) |
const [inline] |
|
int dirac::EncoderParams::XRangeME |
( |
|
) |
const [inline] |
|
int dirac::EncoderParams::YRangeME |
( |
|
) |
const [inline] |
|
Member Data Documentation
The documentation for this class was generated from the following file:
© 2004 British Broadcasting Corporation.
Dirac code licensed under the Mozilla Public License (MPL) Version 1.1.
HTML documentation generated by Dimitri van Heesch's
excellent Doxygen tool.