/* * 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/Interfaces/AE.h" // for typedef's used in derived classes #include "cores/AudioEngine/Utils/AEAudioFormat.h" #include "cores/AudioEngine/Utils/AEUtil.h" #include #include class IAESink { public: /* return the name of this sync for logging */ virtual const char *GetName() = 0; IAESink() = default; virtual ~IAESink() = default; /* The sink does NOT have to honour anything in the format struct or the device if however it does not honour what is requested, it MUST update device/format with what it does support. */ virtual bool Initialize (AEAudioFormat &format, std::string &device) = 0; /* Deinitialize the sink for destruction */ virtual void Deinitialize() = 0; /* This method returns the total time in seconds of the cache. */ virtual double GetCacheTotal() = 0; /* This method returns latency of hardware. */ virtual double GetLatency() { return 0.0; } /*! * @brief Adds packets to be sent out, this routine MUST block or sleep. * @param data array of pointers to planes holding audio data * @param frames number of audio frames in data * @param offset offset in frames where audio data starts * @return number of frames consumed by the sink */ virtual unsigned int AddPackets(uint8_t **data, unsigned int frames, unsigned int offset) = 0; /*! * @brief instruct the sink to add a pause * @param millis ms to pause */ virtual void AddPause(unsigned int millis) {} /*! * @brief Return a timestamped status structure with delay and sink info * @param status structure filled with sink status */ virtual void GetDelay(AEDelayStatus& status) = 0; /* Drain the sink */ virtual void Drain() {} /* Indicates if sink can handle volume control. */ virtual bool HasVolume() { return false; } /* This method sets the volume control, volume ranges from 0.0 to 1.0. */ virtual void SetVolume(float volume) {} };