mirror of
https://github.com/Lime3DS/Lime3DS
synced 2024-11-16 04:03:43 +00:00
0cb52ee74a
Corrects a few issues with regards to Doxygen documentation, for example: - Incorrect parameter referencing. - Missing @param tags. - Typos in @param tags. and a few minor other issues.
45 lines
1.3 KiB
C++
45 lines
1.3 KiB
C++
// Copyright 2016 Citra Emulator Project
|
|
// Licensed under GPLv2 or any later version
|
|
// Refer to the license.txt file included.
|
|
|
|
#pragma once
|
|
|
|
#include <vector>
|
|
#include "common/common_types.h"
|
|
|
|
namespace AudioCore {
|
|
|
|
/**
|
|
* This class is an interface for an audio sink. An audio sink accepts samples in stereo signed
|
|
* PCM16 format to be output. Sinks *do not* handle resampling and expect the correct sample rate.
|
|
* They are dumb outputs.
|
|
*/
|
|
class Sink {
|
|
public:
|
|
virtual ~Sink() = default;
|
|
|
|
/// The native rate of this sink. The sink expects to be fed samples that respect this. (Units:
|
|
/// samples/sec)
|
|
virtual unsigned int GetNativeSampleRate() const = 0;
|
|
|
|
/**
|
|
* Feed stereo samples to sink.
|
|
* @param samples Samples in interleaved stereo PCM16 format.
|
|
* @param sample_count Number of samples.
|
|
*/
|
|
virtual void EnqueueSamples(const s16* samples, size_t sample_count) = 0;
|
|
|
|
/// Samples enqueued that have not been played yet.
|
|
virtual std::size_t SamplesInQueue() const = 0;
|
|
|
|
/**
|
|
* Sets the desired output device.
|
|
* @param device_id ID of the desired device.
|
|
*/
|
|
virtual void SetDevice(int device_id) = 0;
|
|
|
|
/// Returns the list of available devices.
|
|
virtual std::vector<std::string> GetDeviceList() const = 0;
|
|
};
|
|
|
|
} // namespace
|