Dirac - A Video Codec
Created by the British Broadcasting Corporation.
dirac::FrameParams Class Reference
Parameters for initialising frame class objects.
#include <common.h>
List of all members.
Public Member Functions
- FrameParams ()
- Default constructor.
- FrameParams (const ChromaFormat &cf, int xlen, int ylen)
- Constructor.
- FrameParams (const ChromaFormat &cf, const FrameSort &fs)
- Constructor.
- FrameParams (const SeqParams &sparams)
- Constructor.
- FrameParams (const SeqParams &sparams, const FrameSort &fs)
- Constructor.
- const ChromaFormat & CFormat () const
- Returns the chroma format of the frame.
- int Xl () const
- Returns the width of the frame.
- int Yl () const
- Returns the height of the frame.
- const FrameSort & FSort () const
- Returns the type of the frame (I, L1 or L2).
- int FrameNum () const
- Returns the number of the frame (in time order).
- int ExpiryTime () const
- Returns the number of frames after the current frame number after which the frame can be discarded.
- bool Output () const
- Returns an indication of whether the frame has been output yet.
- const std::vector< int > & Refs () const
- Returns a const C++ reference to the set of reference frame numbers (will be empty if the frame is an I frame).
- std::vector< int > & Refs ()
- Returns non-const C++ referece to the vector of reference frames, to allow them to be set.
- void SetFSort (const FrameSort &fs)
- Sets the type of frame to I, L1 or L2.
- void SetFrameNum (const int fn)
- Sets the frame number.
- void SetExpiryTime (const int expt)
- Sets how long the frame will stay in the buffer.
- void SetAsOutput ()
- Sets a flag to indicate that the frame has been output.
Private Attributes
Constructor & Destructor Documentation
dirac::FrameParams::FrameParams |
( |
|
) |
|
|
dirac::FrameParams::FrameParams |
( |
const ChromaFormat & |
cf, |
|
|
int |
xlen, |
|
|
int |
ylen |
|
) |
|
|
|
Frame chroma format is set Frame sort defaults to I frame. |
|
Frame chroma format and frame sort are set. |
dirac::FrameParams::FrameParams |
( |
const SeqParams & |
sparams |
) |
|
|
Member Function Documentation
const ChromaFormat& dirac::FrameParams::CFormat |
( |
|
) |
const [inline] |
|
int dirac::FrameParams::ExpiryTime |
( |
|
) |
const [inline] |
|
int dirac::FrameParams::FrameNum |
( |
|
) |
const [inline] |
|
const FrameSort& dirac::FrameParams::FSort |
( |
|
) |
const [inline] |
|
bool dirac::FrameParams::Output |
( |
|
) |
const [inline] |
|
std::vector<int>& dirac::FrameParams::Refs |
( |
|
) |
[inline] |
|
const std::vector<int>& dirac::FrameParams::Refs |
( |
|
) |
const [inline] |
|
void dirac::FrameParams::SetAsOutput |
( |
|
) |
[inline] |
|
void dirac::FrameParams::SetExpiryTime |
( |
const int |
expt |
) |
[inline] |
|
void dirac::FrameParams::SetFrameNum |
( |
const int |
fn |
) |
[inline] |
|
void dirac::FrameParams::SetFSort |
( |
const FrameSort & |
fs |
) |
[inline] |
|
int dirac::FrameParams::Xl |
( |
|
) |
const [inline] |
|
int dirac::FrameParams::Yl |
( |
|
) |
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.