AEStream.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 <stdint.h>

extern "C" {
#include <libavcodec/avcodec.h>
}

class IAudioCallback;

class IAEClockCallback
{
public:
  virtual ~IAEClockCallback() = default;
  virtual double GetClock() = 0;
  virtual double GetClockSpeed() { return 1.0; }
};

class CAESyncInfo
{
public:
  double delay;
  double error;
  double rr;
  unsigned int errortime;
  enum AESyncState
  {
    SYNC_OFF,
    SYNC_INSYNC,
    SYNC_START,
    SYNC_MUTE,
    SYNC_ADJUST
  };
  AESyncState state;
};

class IAEStream
{
protected:
  friend class IAE;
  IAEStream() = default;
  virtual ~IAEStream() = default;

public:
  struct ExtData
  {
    double pts = 0;
    bool hasDownmix = false;
    double centerMixLevel = 1;
  };

public:
  virtual unsigned int GetSpace() = 0;

  virtual unsigned int AddData(const uint8_t* const *data, unsigned int offset, unsigned int frames, ExtData *extData) = 0;

  virtual double GetDelay() = 0;

  virtual CAESyncInfo GetSyncInfo() = 0;

  virtual bool IsBuffering() = 0;

  virtual double GetCacheTime() = 0;

  virtual double GetCacheTotal() = 0;

  virtual double GetMaxDelay() = 0;

  virtual void Pause() = 0;

  virtual void Resume() = 0;

  virtual void Drain(bool wait) = 0;

  virtual bool IsDraining() = 0;

  virtual bool IsDrained() = 0;

  virtual void Flush() = 0;

  virtual float GetVolume() = 0;

  virtual void  SetVolume(float volume) = 0;

  virtual float GetReplayGain() = 0;

  virtual void SetReplayGain(float factor) = 0;

  virtual float GetAmplification() = 0;

  virtual void SetAmplification(float amplify) = 0;

  virtual void SetFFmpegInfo(int profile, enum AVMatrixEncoding matrix_encoding, enum AVAudioServiceType audio_service_type) = 0;

  virtual unsigned int GetFrameSize() const = 0;

  virtual unsigned int GetChannelCount() const = 0;

  virtual unsigned int GetSampleRate() const = 0;

  virtual enum AEDataFormat GetDataFormat() const = 0;

  virtual double GetResampleRatio() = 0;

  virtual void SetResampleRatio(double ratio) = 0;

  virtual void SetResampleMode(int mode) = 0;

  virtual void RegisterAudioCallback(IAudioCallback* pCallback) = 0;

  virtual void UnRegisterAudioCallback() = 0;

  virtual void FadeVolume(float from, float target, unsigned int time) {} /* FIXME: once all the engines have these new methods */

  virtual bool IsFading() { return false; }

  virtual void RegisterSlave(IAEStream *stream) = 0;
};