src/decoder/DiracState.hpp

   1 /* ***** BEGIN LICENSE BLOCK *****
   2 *
   3 * $Id:  $
   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 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) 2007.
  21 * All Rights Reserved.
  22 *
  23 * Contributor(s): Andrea Gabriellini (Original Author)
  24 *
  25 * Alternatively, the contents of this file may be used under the terms of
  26 * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
  27 * Public License Version 2.1 (the "LGPL"), in which case the provisions of
  28 * the GPL or the LGPL are applicable instead of those above. If you wish to
  29 * allow use of your version of this file only under the terms of the either
  30 * the GPL or LGPL and not to allow others to use your version of this file
  31 * under the MPL, indicate your decision by deleting the provisions above
  32 * and replace them with the notice and other provisions required by the GPL
  33 * or LGPL. If you do not delete the provisions above, a recipient may use
  34 * your version of this file under the terms of any one of the MPL, the GPL
  35 * or the LGPL.
  36 * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef _DIRACSTATE_HPP_
  39 #define _DIRACSTATE_HPP_
  40
  41 #include <common/dirac.h>
  42
  43 #include <decoder/IDecoder.hpp>
  44
  45 namespace dirac
  46 {
  47 namespace decoder
  48 {
  49   class Diracdec;
  50
  51   //! factory method used to generate state objects
  52   //!
  53   //! \a diracdec the dirac decoder associated with the dirac state
  54   //! \a diracState the state value returned by dirac_parse
  55   //! \r the dirac state object created by the factory method
  56   IDecoderState*        makeDiracState ( Diracdec& diracdec, int diracState );
  57
  58   class DiracNeedInput : public IDecoderState
  59   {
  60     friend IDecoderState* makeDiracState ( Diracdec&, int );
  61
  62     DiracNeedInput ( Diracdec& diracdec );
  63
  64     virtual void        run();
  65     virtual bool        endOfSequence() const;
  66
  67     Diracdec&           diracdec_;
  68   };
  69
  70   class DiracFrameReady : public IDecoderState
  71   {
  72     friend IDecoderState* makeDiracState ( Diracdec&, int );
  73
  74     DiracFrameReady ( Diracdec& diracdec );
  75
  76     virtual void        run();
  77     virtual bool        endOfSequence() const;
  78
  79     Diracdec&           diracdec_;
  80   };
  81
  82   class DiracEndOfSequence : public IDecoderState
  83   {
  84     friend IDecoderState* makeDiracState ( Diracdec&, int );
  85
  86     DiracEndOfSequence();
  87
  88     virtual void        run();
  89     virtual bool        endOfSequence() const;
  90   };
  91
  92   class DiracError : public IDecoderState
  93   {
  94     friend IDecoderState* makeDiracState ( Diracdec&, int );
  95
  96     DiracError();
  97
  98     virtual void        run();
  99     virtual bool        endOfSequence() const;
 100   };
 101
 102   class DiracNull : public IDecoderState
 103   {
 104     friend IDecoderState* makeDiracState ( Diracdec&, int );
 105
 106     DiracNull();
 107
 108     virtual void        run();
 109     virtual bool        endOfSequence() const;
 110   };
 111
 112   class DiracDoNothing : public IDecoderState
 113   {
 114     friend IDecoderState* makeDiracState ( Diracdec&, int );
 115
 116     DiracDoNothing();
 117
 118     virtual void        run();
 119     virtual bool        endOfSequence() const;
 120   };
 121
 122 } /* decoder */
 123
 124 } /* dirac */
 125
 126
 127 #endif /* _DIRACSTATE_HPP_ */