AE.h

/*
 *  Copyright (C) 2010-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include "cores/AudioEngine/Utils/AEAudioFormat.h"

#include <cassert>
#include <list>
#include <map>
#include <memory>
#include <utility>
#include <vector>

extern "C" {
#include <libavutil/samplefmt.h>
}

typedef std::pair<std::string, std::string> AEDevice;
typedef std::vector<AEDevice> AEDeviceList;

/* forward declarations */
class IAEStream;
class IAEStreamDeleter;
class IAESound;
class IAESoundDeleter;
class IAEPacketizer;
class IAudioCallback;
class IAEClockCallback;
class CAEStreamInfo;

namespace ADDON
{
struct Interface_AudioEngine;
}

/* sound options */
#define AE_SOUND_OFF 0 
#define AE_SOUND_IDLE 1 
#define AE_SOUND_ALWAYS 2 
/* config options */
#define AE_CONFIG_FIXED 1
#define AE_CONFIG_AUTO  2
#define AE_CONFIG_MATCH 3

enum AEQuality
{
  AE_QUALITY_UNKNOWN = -1, 
  AE_QUALITY_DEFAULT = 0, 
  /* Basic quality levels */
  AE_QUALITY_LOW = 20, 
  AE_QUALITY_MID = 30, 
  AE_QUALITY_HIGH = 50, 
  /* Optional quality levels */
  AE_QUALITY_REALLYHIGH = 100, 
  AE_QUALITY_GPU = 101, 
};

struct SampleConfig
{
  AVSampleFormat fmt;
  uint64_t channel_layout;
  int channels;
  int sample_rate;
  int bits_per_sample;
  int dither_bits;
};

class IAE
{
protected:

  IAE() = default;
  virtual ~IAE() = default;

  virtual void Start() = 0;
public:
  using StreamPtr = std::unique_ptr<IAEStream, IAEStreamDeleter>;
  using SoundPtr = std::unique_ptr<IAESound, IAESoundDeleter>;

  virtual void Shutdown() { }

  virtual bool Suspend() = 0;

  virtual bool Resume() = 0;

  virtual bool IsSuspended() {return true;}

  virtual float GetVolume() = 0;

  virtual void SetVolume(const float volume) = 0;

  virtual void SetMute(const bool enabled) = 0;

  virtual bool IsMuted() = 0;

  virtual StreamPtr MakeStream(AEAudioFormat& audioFormat,
                               unsigned int options = 0,
                               IAEClockCallback* clock = NULL) = 0;

  virtual SoundPtr MakeSound(const std::string& file) = 0;

  virtual void EnumerateOutputDevices(AEDeviceList &devices, bool passthrough) = 0;

  virtual bool SupportsRaw(AEAudioFormat &format) { return false; }

  virtual bool SupportsSilenceTimeout() { return false; }

  virtual bool UsesDtsCoreFallback() { return false; }

  virtual bool HasStereoAudioChannelCount() { return false; }

  virtual bool HasHDAudioChannelCount() { return true; }

  virtual void RegisterAudioCallback(IAudioCallback* pCallback) {}

  virtual void UnregisterAudioCallback(IAudioCallback* pCallback) {}

  virtual bool SupportsQualityLevel(enum AEQuality level) { return false; }

  virtual bool IsSettingVisible(const std::string &settingId) {return false; }

  virtual void KeepConfiguration(unsigned int millis) {}

  virtual void DeviceChange() {}

  virtual void DeviceCountChange(const std::string& driver) {}

  virtual bool GetCurrentSinkFormat(AEAudioFormat &SinkFormat) { return false; }

private:
  friend class IAEStreamDeleter;
  friend class IAESoundDeleter;
  friend struct ADDON::Interface_AudioEngine;

  virtual bool FreeStream(IAEStream* stream, bool finish) = 0;

  virtual void FreeSound(IAESound* sound) = 0;
};

class IAEStreamDeleter
{
private:
  IAE* m_iae;
  bool m_finish;

public:
  IAEStreamDeleter() : m_iae(nullptr), m_finish(true) {}
  explicit IAEStreamDeleter(IAE& iae) : m_iae(&iae), m_finish{true} {}
  void setFinish(bool finish) { m_finish = finish; }
  void operator()(IAEStream* stream)
  {
    assert(m_iae);
    m_iae->FreeStream(stream, m_finish);
  }
};

class IAESoundDeleter
{
private:
  IAE* m_iae;

public:
  IAESoundDeleter() : m_iae(nullptr) {}
  explicit IAESoundDeleter(IAE& iae) : m_iae(&iae) {}
  void operator()(IAESound* sound)
  {
    assert(m_iae);
    m_iae->FreeSound(sound);
  }
};