Dirac - A Video Codec

Created by the British Broadcasting Corporation.


picture_byteio.h
Go to the documentation of this file.
1 /* ***** BEGIN LICENSE BLOCK *****
2 *
3 * $Id: picture_byteio.h,v 1.1 2008/01/31 11:25:15 tjdwave Exp $ $Name: Dirac_1_0_2 $
4 *
5 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6 *
7 * The contents of this file are subject to the Mozilla Public License
8 * Version 1.1 (the "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 * http://www.mozilla.org/MPL/
11 *
12 * Software distributed under the License is distributed on an "AS IS" basis,
13 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
14 * the specific language governing rights and limitations under the License.
15 *
16 * The Original Code is BBC Research and Development code.
17 *
18 * The Initial Developer of the Original Code is the British Broadcasting
19 * Corporation.
20 * Portions created by the Initial Developer are Copyright (C) 2004.
21 * All Rights Reserved.
22 *
23 * Contributor(s): Andrew Kennedy (Original Author)
24 * Anuradha Suraparaju
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
28 * Public License Version 2.1 (the "LGPL"), in which case the provisions of
29 * the GPL or the LGPL are applicable instead of those above. If you wish to
30 * allow use of your version of this file only under the terms of the either
31 * the GPL or LGPL and not to allow others to use your version of this file
32 * under the MPL, indicate your decision by deleting the provisions above
33 * and replace them with the notice and other provisions required by the GPL
34 * or LGPL. If you do not delete the provisions above, a recipient may use
35 * your version of this file under the terms of any one of the MPL, the GPL
36 * or the LGPL.
37 * ***** END LICENSE BLOCK ***** */
38 
42 #ifndef picture_byteio_h
43 #define picture_byteio_h
44 
45 
46 //LOCAL INCLUDES
47 #include <libdirac_byteio/parseunit_byteio.h> // Parent class
48 #include <libdirac_byteio/mvdata_byteio.h> // Contains mvdata streams
49 #include <libdirac_byteio/transform_byteio.h> // Transform header
50 
51 // DIRAC includes
52 #include <libdirac_common/common.h> // PictureType etc
53 
54 
55 namespace dirac
56 {
61  {
62  public:
63 
69  PictureByteIO(PictureParams& frame_params,
70  int frame_num);
71 
72 
78  PictureByteIO(PictureParams& frame_params,
79  const ParseUnitByteIO& parseunit_byteio);
80 
84  virtual ~PictureByteIO();
85 
90  void CollateByteStats(DiracByteStats& dirac_byte_stats);
91 
95  bool Input();
96 
100  void Output();
101 
102 
103 
104  const std::string GetBytes();
105 
106  int GetSize() const;
107 
111  ParseUnitType GetType() const { return PU_PICTURE;}
112 
116  int IsRef() const { return (GetParseCode()&0x0C)==0x0C;}
117 
121  int IsNonRef() const { return (GetParseCode()&0x0C)==0x08;}
122 
126  int NumRefs() const { return (GetParseCode()&0x03);}
127 
131  bool IsIntra() const { return IsPicture() && (NumRefs()==0) ; }
132 
136  bool IsInter() const { return IsPicture() && (NumRefs()>0) ; }
137 
138  /***
139  * Sets the MVDataIO
140  */
141  void SetMvData(MvDataByteIO *mv_data) {m_mv_data = mv_data; }
142 
143  /***
144  * Sets the TransformByteIo
145  */
146  void SetTransformData(TransformByteIO *transform_data) {m_transform_data = transform_data; }
147 
148  protected:
149 
150 
151  private:
152 
157  unsigned char CalcParseCode() const;
158 
162  void InputReferencePictures();
163 
167  void InputRetiredPicture();
168 
172  void SetPictureType();
173 
177  void SetReferenceType();
178 
182  void SetEntropyCodingFlag();
183 
188 
193 
198 
203 
204  };
205 
206 } // namespace dirac
207 
208 #endif
transform_byteio.h
dirac::PictureByteIO::GetBytes
const std::string GetBytes()
Gets string containing coded bytes.
dirac::TransformByteIO
Represents compressed sequence-parameter data used in an AccessUnit.
Definition: transform_byteio.h:59
dirac::PictureByteIO::NumRefs
int NumRefs() const
Gets parse-unit type.
Definition: picture_byteio.h:126
dirac::PictureByteIO::m_frame_num
int m_frame_num
Picture number.
Definition: picture_byteio.h:192
dirac::ParseUnitByteIO
Represents a collection of data in a Dirac bytestream that can be parsed as a self-contained unit.
Definition: parseunit_byteio.h:72
dirac::ParseUnitByteIO::IsPicture
bool IsPicture() const
Returns true is parse unit is Picture data.
Definition: parseunit_byteio.h:179
dirac::PictureByteIO::SetReferenceType
void SetReferenceType()
Calculates reference-type of picture.
dirac::ParseUnitType
ParseUnitType
Definition: parseunit_byteio.h:57
dirac
Definition of class SequenceHeaderByteIO.
Definition: accessunit_byteio.h:51
dirac::PictureParams
Parameters for initialising picture class objects.
Definition: common.h:532
dirac::PictureByteIO::m_mv_data
MvDataByteIO * m_mv_data
MV data.
Definition: picture_byteio.h:197
dirac::PictureByteIO::SetEntropyCodingFlag
void SetEntropyCodingFlag()
Sets the entropy coding flag in the picture parameters.
dirac::PictureByteIO::IsIntra
bool IsIntra() const
Returns true is picture is Intra picture.
Definition: picture_byteio.h:131
dirac::PictureByteIO::GetSize
int GetSize() const
Gets size (in bytes)
dirac::PU_PICTURE
@ PU_PICTURE
Definition: parseunit_byteio.h:59
dirac::DiracByteStats
Class DiracByteStats - for collecting statistics on aspects of the Dirac byte-stream.
Definition: dirac_byte_stats.h:70
dirac::PictureByteIO::Input
bool Input()
Inputs data from Dirac stream-format.
dirac::PictureByteIO::IsNonRef
int IsNonRef() const
Returns true is picture in Non-Reference picture.
Definition: picture_byteio.h:121
dirac::PictureByteIO::PictureByteIO
PictureByteIO(PictureParams &frame_params, int frame_num)
Constructor.
mvdata_byteio.h
dirac::PictureByteIO::InputRetiredPicture
void InputRetiredPicture()
Reads retired picture number.
dirac::PictureByteIO::IsInter
bool IsInter() const
Returns true is picture is Inter picture.
Definition: picture_byteio.h:136
dirac::PictureByteIO::SetTransformData
void SetTransformData(TransformByteIO *transform_data)
Definition: picture_byteio.h:146
dirac::PictureByteIO::CollateByteStats
void CollateByteStats(DiracByteStats &dirac_byte_stats)
Gathers byte stats on the picture data.
parseunit_byteio.h
dirac::PictureByteIO::SetMvData
void SetMvData(MvDataByteIO *mv_data)
Definition: picture_byteio.h:141
dirac::MvDataByteIO
Represents compressed sequence-parameter data used in an AccessUnit.
Definition: mvdata_byteio.h:59
dirac::PictureByteIO::InputReferencePictures
void InputReferencePictures()
Reads reference-picture data.
dirac::PictureByteIO::GetType
ParseUnitType GetType() const
Gets parse-unit type.
Definition: picture_byteio.h:111
dirac::PictureByteIO::~PictureByteIO
virtual ~PictureByteIO()
Destructor.
dirac::PictureByteIO::CalcParseCode
unsigned char CalcParseCode() const
Calculates parse-code based on picture parameters.
dirac::PictureByteIO::SetPictureType
void SetPictureType()
Calculates picture-type (eg INTRA/INTER) of picture.
dirac::ParseUnitByteIO::GetParseCode
unsigned char GetParseCode() const
Get parse code.
Definition: parseunit_byteio.h:223
dirac::PictureByteIO::Output
void Output()
Outputs picture values to Dirac stream-format.
common.h
dirac::PictureByteIO::IsRef
int IsRef() const
Returns true is picture in Reference picture.
Definition: picture_byteio.h:116
dirac::PictureByteIO
A compressed picture in Dirac bytestream format.
Definition: picture_byteio.h:60
dirac::PictureByteIO::m_frame_params
PictureParams & m_frame_params
Picture parameters.
Definition: picture_byteio.h:187
dirac::PictureByteIO::m_transform_data
TransformByteIO * m_transform_data
Transform data.
Definition: picture_byteio.h:202

© 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.