output-slot.hpp

Go to the documentation of this file.

/*
  OUTPUT-SLOT.hpp  -  capability to transfer data to a physical output

  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_OUTPUT_SLOT_H
#define STEAM_PLAY_OUTPUT_SLOT_H


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

#include <memory>


namespace steam {
namespace play {
  
  using steam::engine::BuffHandle;
  using steam::engine::BufferProvider;
  using lib::time::FrameCnt;
  using lib::time::TimeValue;
  using lib::time::Time;
  
  using std::unique_ptr;
  
  
  
  class DataSink;
  
  typedef FrameCnt FrameID;
  
  
  
  /****************************************************************************/
  class OutputSlot
    : util::NonCopyable
    {
      
    protected:
      
      class ConnectionState;
      
      unique_ptr<ConnectionState> state_;
      
      virtual ConnectionState* buildState() =0;
      
      
    public:
      virtual ~OutputSlot();
      
      typedef lib::IterSource<DataSink>::iterator OpenedSinks;
      
      class Allocation
        {
        public:
          virtual OpenedSinks getOpenedSinks()   =0;
          virtual bool isActive()  const         =0;
          
          virtual Timings getTimingConstraints() =0;
          
        protected:
         ~Allocation(); 
        };
      
      class Connection;
      
      
      bool isFree()  const;
      
      Allocation& allocate();
      
      void disconnect();
    };
  
  
  
  class DataSink
    : public lib::Handle<OutputSlot::Connection>
    {
      
    public:
      BuffHandle lockBufferFor(FrameID);
      void emit(FrameID, BuffHandle const&, TimeValue currentTime = Time::ANYTIME);
      
      
      friend bool operator== (DataSink const& sink1, DataSink const& sink2)
      {
        return not (sink1 and sink2)
            or (sink1 and sink2
                and & sink1.impl() == & sink2.impl());
      }
      friend bool operator!= (DataSink const& sink1, DataSink const& sink2)
      {
        return not (sink1 == sink2);
      }
    };
  
  
  
  
  
}} // namespace steam::play
#endif