PcmSinkInterface.hpp

/*
 * Copyright (c) 2022-2023, Soliton Systems K.K. All rights reserved.
 * Use in source and binary forms, with or without modification, 
 * is permitted provided that the following a condition is met:
 *
 * Use is permitted only in accordance with the terms and 
 * conditions set forth in the Software License Agreement available 
 * at https://zao-sdk.org/license-agreement/.
 */
#ifndef ZEP_AUDIO_PCM_SINK_INTERFACE_HPP_
#define ZEP_AUDIO_PCM_SINK_INTERFACE_HPP_
 
#include <future>
#include <memory>
#include <string>
#include <vector>
#include <zep/audio/PcmBufferWriter.hpp>
 
#include "../SinkStreamInterface.hpp"
#include "../StreamInterface.hpp"
#include "PcmFormat.hpp"
 
namespace zep {
namespace audio {
 
class PcmSinkCallbackInterface;
 
class PcmSinkInterface : public StreamInterface, public SinkStreamInterface {
 public:
  virtual void SetAcceptableFormats(const std::vector<PcmFormat>& formats) = 0;
 
  virtual bool GetDecidedFormat(PcmFormat& format) const noexcept = 0;
 
  virtual std::shared_future<PcmFormat> GetFormatDecisionStatus()
      const noexcept = 0;
 
  virtual void RegisterCallback(
      const std::shared_ptr<PcmSinkCallbackInterface>& listener,
      bool use_weak_ptr = false) = 0;
 
  virtual void RegisterCallback(
      std::unique_ptr<PcmSinkCallbackInterface>&& listener) = 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) {}
 
  virtual std::weak_ptr<PcmBufferPoolWriterInterface>
  OnRequestPcmBufferPool() = 0;
 
  virtual ~PcmSinkCallbackInterface() noexcept = default;
};
 
}  // namespace audio
}  // namespace zep
 
#endif  // ZEP_AUDIO_PCM_SINK_INTERFACE_HPP_