AsyncAudioSource.h

Go to the documentation of this file.

 
#ifndef ASYNC_AUDIO_SOURCE_INCLUDED
#define ASYNC_AUDIO_SOURCE_INCLUDED
 
 
/****************************************************************************
 *
 * System Includes
 *
 ****************************************************************************/
 
#include <cassert>
 
 
/****************************************************************************
 *
 * Project Includes
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Local Includes
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Forward declarations
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Namespace
 *
 ****************************************************************************/
 
namespace Async
{
 
 
/****************************************************************************
 *
 * Forward declarations of classes inside of the declared namespace
 *
 ****************************************************************************/
 
class AudioSink;
  
 
/****************************************************************************
 *
 * Defines & typedefs
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Exported Global Variables
 *
 ****************************************************************************/
 
 
 
/****************************************************************************
 *
 * Class definitions
 *
 ****************************************************************************/
 
class AudioSource
{
  public:
    AudioSource(void)
      : m_sink(0), m_sink_managed(false), m_handler(0),
        m_auto_unreg_source(false), is_flushing(false)
    {
    }
  
    virtual ~AudioSource(void);
  
    bool registerSink(AudioSink *sink, bool managed=false);
 
    void unregisterSink(void);
  
    bool isRegistered(void) const { return m_sink != 0; }
 
    AudioSink *sink(void) const { return m_sink; }
    
    bool sinkManaged(void) const { return m_sink_managed; }
 
    void handleAllSamplesFlushed(void)
    {
      is_flushing = false;
      allSamplesFlushed();
    }
    
    virtual void resumeOutput(void)
    {
      assert(m_handler != 0);
      m_handler->resumeOutput();
    }
    
 
  protected:
    virtual void allSamplesFlushed(void)
    {
      assert(m_handler != 0);
      m_handler->handleAllSamplesFlushed();
    }
    
    /*
     * @brief   Write samples to the connected sink
     * @param   samples The buffer containing the samples to write
     * @param   len     The number of samples in the buffer
     * @return  Return the number of samples that was taken care of
     *
     * This function is used by the inheriting class to write samples to
     * the connected sink, if any. If there is no connected sink, the samples
     * will be thrown away. This function will return the number of samples
     * that was taken care of. Samples that was not taken care of should
     * normally be written again to the sink.
     */
    int sinkWriteSamples(const float *samples, int len);
    
    /*
     * @brief   Tell the sink to flush any buffered samples
     *
     * This function is used by the inheriting class to tell the connected
     * sink to flush its buffered samples. When the sink have flushed all its
     * samples it will call the allSamplesFlushed function in this class.
     * If there is no registered sink the allSamplesFlushed function will be
     * called right away.
     */
    void sinkFlushSamples(void);
    
    bool setHandler(AudioSource *handler);
    
    /*
     * @brief   Return the handler
     * @return  Returns the handler previously set with setHandler or 0
     *          if none have been set
     */
    AudioSource *handler(void) const { return m_handler; }
    
    void clearHandler(void);
    
    
  private:
    AudioSink   *m_sink;
    bool        m_sink_managed;
    AudioSource *m_handler;
    bool        m_auto_unreg_source;
    bool        is_flushing;
    
    bool registerSinkInternal(AudioSink *sink, bool managed, bool reg);
    void unregisterSinkInternal(bool is_being_destroyed);
 
};  /* class AudioSource */
 
 
} /* namespace */
 
#endif /* ASYNC_AUDIO_SOURCE_INCLUDED */
 
 
 
/*
 * This file has not been truncated
 */