AudioIfc.hxx

Go to the documentation of this file.

#pragma once
 
/*
  Copyright (c) 2012,2025, 2026 Matthew H. Reilly (kb1vc)
  All rights reserved.
 
  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are
  met:
 
  Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.
  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.
*/
 
#include "SoDaBase.hxx"
#include <memory>
 
namespace SoDa {
  class AudioIfc;
  typedef std::shared_ptr<AudioIfc> AudioIfcPtr;
  
  class AudioIfc {
  protected:
    /*
     * constructor
     * @param sample_rate in Hz -- 48000 is a good choice
     * @param _sample_count_hint -- the size of the buffers passed to
     *                              and from the audio device (in samples)
     */
    AudioIfc(unsigned int _sample_rate,
         unsigned int _sample_count_hint,
         const std::string & name = "AudioIfc") {
      sample_rate = _sample_rate;
      sample_count_hint = _sample_count_hint;
      datatype_size = sizeof(float);
    }
 
  public:    
    virtual int send(void * buf, unsigned int len, bool when_ready = false) = 0; 

    virtual bool sendBufferReady(unsigned int len) = 0; 
 

    virtual int recv(std::vector<float> & buf, bool when_ready = false) = 0;

    virtual bool recvBufferReady(unsigned int len) = 0; 
 

    virtual bool setOutGain(float gain) {
      out_gain = gain;
      return true; 
    }

    virtual bool setInGain(float gain) {
      in_gain = gain;
      return true; 
    }

    virtual float getOutGain() { return out_gain; }

    virtual float getInGain() { return in_gain; }

    virtual void sleepOut() = 0;
    virtual void wakeOut() = 0;
        
    virtual void sleepIn() = 0;
    virtual void wakeIn() = 0;
        
 
    virtual std::string currentPlaybackState() { return std::string("UNKNOWN"); }
    virtual std::string currentCaptureState() { return std::string("UNKNOWN"); }    
 
  protected:
    unsigned int sample_rate;
    unsigned int sample_count_hint; 
 
    float in_gain;
    float out_gain; 
 
    int datatype_size; 
  };
}