AsyncAudioSink.h

Go to the documentation of this file.

 
#ifndef ASYNC_AUDIO_SINK_INCLUDED
#define ASYNC_AUDIO_SINK_INCLUDED
 
 
/****************************************************************************
 *
 * System Includes
 *
 ****************************************************************************/
 
 
#include <cassert>
 
 
/****************************************************************************
 *
 * Project Includes
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Local Includes
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Forward declarations
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Namespace
 *
 ****************************************************************************/
 
namespace Async
{
 
 
/****************************************************************************
 *
 * Forward declarations of classes inside of the declared namespace
 *
 ****************************************************************************/
 
class AudioSource;
  
 
/****************************************************************************
 *
 * Defines & typedefs
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Exported Global Variables
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Class definitions
 *
 ****************************************************************************/
 
class AudioSink
{
  public:
    AudioSink(void) : m_source(0), m_handler(0), m_auto_unreg_sink(false) {}
  
    virtual ~AudioSink(void);
  
    bool registerSource(AudioSource *source);
  
    void unregisterSource(void);
  
    bool isRegistered(void) const { return m_source != 0; }
    
    AudioSource *source(void) const { return m_source; }
    
    virtual int writeSamples(const float *samples, int count)
    {
      assert(m_handler != 0);
      return m_handler->writeSamples(samples, count);
    }
    
    virtual void flushSamples(void)
    {
      assert(m_handler != 0);
      m_handler->flushSamples();    
    }
    
    
  protected:
    void sourceResumeOutput(void);
    
    void sourceAllSamplesFlushed(void);
    
    bool setHandler(AudioSink *handler);
    
    void clearHandler(void);
    
    /*
     * @brief   Return the handler
     * @return  Returns the handler previously set with setHandler or 0
     *          if none have been set
     */
    AudioSink *handler(void) const { return m_handler; }
    
    
  private:
    AudioSource *m_source;
    AudioSink   *m_handler;
    bool        m_auto_unreg_sink;
    
    bool registerSourceInternal(AudioSource *source, bool reg_sink);
    
};  /* class AudioSink */
 
 
} /* namespace */
 
#endif /* ASYNC_AUDIO_SINK_INCLUDED */
 
 
 
/*
 * This file has not been truncated
 */