src/decoder/SchroState.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 _SCHROSTATE_HPP_
  39 #define _SCHROSTATE_HPP_
  40
  41 #include <common/dirac.h>
  42 #include <common/util.hpp>
  43
  44 #include <decoder/IDecoder.hpp>
  45
  46 namespace dirac
  47 {
  48 namespace decoder
  49 {
  50   // forward declaration
  51   class Schrodec;
  52
  53   //! factory method used to generate objects of type IDecoderState
  54   //!
  55   //! \a schrodec the schro decoder associated with the schro state
  56   //! \a schro_state the state value returned by schro_decoder_wait
  57   IDecoderState*         makeSchroState           ( Schrodec&     schrodec
  58                                                   , int           schro_state );
  59
  60
  61   class SchroNeedInput : public IDecoderState
  62   {
  63     friend IDecoderState* makeSchroState(Schrodec&, int);
  64     //! private constructor
  65     SchroNeedInput ( Schrodec& schrodec );
  66
  67     virtual void        run ();
  68     virtual bool        endOfSequence() const;
  69
  70     Schrodec&           schrodec_;
  71   };
  72
  73   class SchroNeedFrame : public IDecoderState
  74   {
  75     friend IDecoderState* makeSchroState(Schrodec&, int);
  76     //! private constructor
  77     SchroNeedFrame ( Schrodec& schrodec );
  78
  79     virtual void        run ();
  80     virtual bool        endOfSequence() const;
  81
  82     Schrodec&           schrodec_;
  83   };
  84
  85   class SchroFrameReady : public IDecoderState
  86   {
  87     friend IDecoderState* makeSchroState(Schrodec&, int);
  88     //! private constructor
  89     SchroFrameReady ( Schrodec& schrodec );
  90
  91     virtual void        run ();
  92     virtual bool        endOfSequence() const;
  93
  94     Schrodec&           schrodec_;
  95   };
  96
  97   class SchroError : public IDecoderState
  98   {
  99     friend IDecoderState* makeSchroState(Schrodec&, int);
 100     //! private constructor
 101     SchroError();
 102
 103     virtual void        run();
 104     virtual bool        endOfSequence() const;
 105   };
 106
 107   class SchroEndOfSequence : public IDecoderState
 108   {
 109     friend IDecoderState* makeSchroState(Schrodec&, int);
 110     //! private constructor
 111     SchroEndOfSequence();
 112
 113     virtual void        run();
 114     virtual bool        endOfSequence() const;
 115   };
 116
 117   class SchroNull : public IDecoderState
 118   {
 119     friend IDecoderState* makeSchroState(Schrodec&, int);
 120     //! private constructor
 121     SchroNull();
 122
 123     virtual void        run();
 124     virtual bool        endOfSequence() const;
 125   };
 126
 127
 128
 129
 130
 131 } /* decoder */
 132
 133 } /* dirac */
 134
 135
 136 #endif /* _SCHROSTATE_HPP_ */