SymbolDecoder.h

//
// Copyright 2018, Jeremy Cooper
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
// FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
// COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
// BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
// CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
// ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//

#ifndef SYMBOL_DECODER_H
#define SYMBOL_DECODER_H

class SymbolDecoder
{
protected:
  SymbolDecoder() {};
  ~SymbolDecoder() {};

public:
  //
  // Reset the decoder state.
  //
  virtual void Reset() = 0;
  
  //
  // Called by lower-level to indicate that a clock lock has
  // been achieved, or lost.
  //
  virtual void ClockDetected(bool detected) = 0;
  
  //
  // Called by a lower-level bit slicer when it decodes a bit.
  //
  virtual void ReceiveBit(bool bit) = 0;
  
  //
  // Is there sufficient reason to believe that a pre-amble sequence
  // is being received right now?
  //
  virtual bool PreambleDetected() const = 0;
  
  //
  // Called by lower-level to indicate that an R-DAT track has
  // definitely begun or has ended.
  //
  virtual void TrackDetected(bool started) = 0;

  //
  // Called by the lower-level to indicate that there is no more
  // input.
  //
  virtual void Stop() = 0;
};

#endif