timings.hpp

Go to the documentation of this file.

/*
  TIMINGS.hpp  -  timing specifications for a frame quantised data stream

  Copyright (C)         Lumiera.org
    2011,               Hermann Vosseler <Ichthyostega@web.de>

  This program is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License as
  published by the Free Software Foundation; either version 2 of
  the License, or (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef STEAM_PLAY_TIMINGS_H
#define STEAM_PLAY_TIMINGS_H


#include "lib/error.hpp"
//#include "lib/handle.hpp"
#include "lib/time/timevalue.hpp"
//#include "steam/engine/buffer-provider.hpp"
//#include "lib/iter-source.hpp"
//#include "lib/sync.hpp"

//#include <string>
//#include <vector>
#include <boost/rational.hpp>
#include <memory>

namespace lib {
namespace time{
  class Quantiser;
  typedef std::shared_ptr<const Quantiser> PQuant;
}}

namespace steam {
namespace play {

  using lib::time::FrameCnt;
  using lib::time::FrameRate;
  using lib::time::TimeValue;
  using lib::time::Duration;
  using lib::time::Offset;
  using lib::time::Time;
//using std::string;

//using std::vector;
//using std::shared_ptr;
  
  enum PlaybackUrgency {
    ASAP,
    NICE,
    TIMEBOUND
  };
  
  
  
  /*************************************************************************/
  class Timings
    {
      lib::time::PQuant grid_;
      
    public:
      PlaybackUrgency playbackUrgency;
      boost::rational<FrameCnt> playbackSpeed;                     
      Time scheduledDelivery;                           
      Duration outputLatency;                                    
      Duration engineLatency;                           
      
      explicit
      Timings (FrameRate fps);
      
      Timings (FrameRate fps, Time realTimeAnchor);
      
      // default copy acceptable
      
      
      static Timings DISABLED;
      
      Time     getOrigin()  const;
      
      Time     getFrameStartAt    (FrameCnt frameNr)    const;
      Duration getFrameDurationAt (TimeValue refPoint)  const;
      Duration getFrameDurationAt (FrameCnt refFrameNr) const;
      
      FrameCnt getBreakPointAfter (TimeValue refPoint)  const;
      
      Duration constantFrameTimingsInterval (TimeValue startPoint)  const;
      
      Offset getRealOffset (FrameCnt frameOffset)  const;
      
      Time getTimeDue(FrameCnt frameOffset)  const;
      
      Duration getPlanningChunkDuration() const;
      
      FrameCnt establishNextPlanningChunkStart(FrameCnt anchorFrame)  const;
      
      
      bool isOriginalSpeed()  const;
      bool isTimebound()      const;
      
      
      bool isValid()  const;
      
      
      
      Timings constrainedBy (Timings additionalConditions);
      
    };
  
  
  
  
  
  inline bool
  Timings::isOriginalSpeed()  const
  {
    return 1 == playbackSpeed;
  }
  
  inline bool
  Timings::isTimebound()  const
  {
    return play::TIMEBOUND == playbackUrgency;
  }
  
  
  
}} // namespace steam::play
#endif