PcmSinkInterface.hpp

#ifndef ZAO_ENDPOINT_AUDIO_PCM_SINK_INTERFACE_HPP_
#define ZAO_ENDPOINT_AUDIO_PCM_SINK_INTERFACE_HPP_
 
#include <future>
#include <memory>
#include <string>
#include <vector>
 
#include "../EventSourceInterface.hpp"
#include "../SinkStreamInterface.hpp"
#include "../StreamInterface.hpp"
#include "PcmBufferWriter.hpp"
#include "PcmFormat.hpp"
#include "PcmSinkBufferDequeueResult.hpp"
#include "PcmSinkBufferEnqueueResult.hpp"
#include "PcmSinkBufferInterface.hpp"
 
namespace zao {
namespace endpoint {
namespace audio {
 
class PcmSinkCallbackInterface;
 
class PcmSinkInterface : public StreamInterface,
                         public SinkStreamInterface,
                         public EventSourceInterface<PcmSinkCallbackInterface> {
 public:
  [[deprecated("Please use SetSinkFormats function")]]
  void SetAcceptableFormats(const std::vector<PcmFormat>& formats) {
    return SetSinkFormats(formats);
  }
 
  virtual void SetSinkFormats(const std::vector<PcmFormat>& formats) = 0;
 
  [[deprecated("Please use GetDeterminedFormat function")]]
  bool GetDecidedFormat(PcmFormat& format) const {
    return GetDeterminedFormat(format);
  }
 
  virtual bool GetDeterminedFormat(PcmFormat& format) const = 0;
 
  [[deprecated("Please use GetDeterminedFormatAsync function")]]
  std::shared_future<PcmFormat> GetFormatDecisionStatus() const {
    return GetDeterminedFormatAsync();
  }
 
  virtual std::shared_future<PcmFormat> GetDeterminedFormatAsync() const = 0;
 
  virtual void ConfigureQueue(std::size_t samples_per_buffer,
                              std::size_t num_of_buffers) = 0;
 
  virtual PcmSinkBufferDequeueResult DequeueSinkBuffer() = 0;
 
  virtual PcmSinkBufferEnqueueResult EnqueueSinkBuffer(
      std::unique_ptr<PcmSinkBufferInterface> buffer) = 0;
 
  virtual void FlushQueue() = 0;
 
  virtual ~PcmSinkInterface() noexcept = default;
};
 
class PcmSinkCallbackInterface : public StreamCallbackInterface,
                                 public SinkStreamCallbackInterface {
 public:
  enum class EventType {
    kUnknown = 0,
 
    kDisconnected,
 
    kUnlinked,
 
    kDecodeError,
 
    kFailedFormatNegotiation,
  };
 
  virtual bool OnRequestSinkFormat(const PcmFormat& format) = 0;
 
  virtual void OnNotifySinkEvent(EventType type, const std::string& message) {}
 
#ifndef LIBZAO_ENDPOINT_INTERNAL
  [[deprecated("Never called when new pull-type API is selected.")]]
#endif
  virtual std::weak_ptr<PcmBufferPoolWriterInterface> OnRequestPcmBufferPool() {
    return {};
  }
 
  virtual ~PcmSinkCallbackInterface() noexcept = default;
};  // namespace audio
 
}  // namespace audio
}  // namespace endpoint
}  // namespace zao
 
#endif  // ZAO_ENDPOINT_AUDIO_PCM_SINK_INTERFACE_HPP_