aboutsummaryrefslogtreecommitdiff
path: root/src/audio_core/sink.h
diff options
context:
space:
mode:
authorbunnei <bunneidev@gmail.com>2016-02-25 19:21:50 -0500
committerbunnei <bunneidev@gmail.com>2016-02-25 19:21:50 -0500
commitaf7282b5ea8ed3ebfb47f35f6ac8212cfcb4c4fd (patch)
tree1ae5c0281f70ff811ea2370610745b3957060fa5 /src/audio_core/sink.h
parentb63a4192a7f44e3ca59bbfe0a28fc9e04e9e1ab6 (diff)
parent8b00954ec79fad71691ad2d4c82d5c1c60e21b0c (diff)
Merge pull request #1386 from MerryMage/audio-core-skeleton
Audio Core: Skeleton
Diffstat (limited to 'src/audio_core/sink.h')
-rw-r--r--src/audio_core/sink.h34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/audio_core/sink.h b/src/audio_core/sink.h
new file mode 100644
index 0000000000..cad21a85e7
--- /dev/null
+++ b/src/audio_core/sink.h
@@ -0,0 +1,34 @@
+// 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 GetNativeSampleRate() const = 0;
+
+ /**
+ * Feed stereo samples to sink.
+ * @param samples Samples in interleaved stereo PCM16 format. Size of vector must be multiple of two.
+ */
+ virtual void EnqueueSamples(const std::vector<s16>& samples) = 0;
+
+ /// Samples enqueued that have not been played yet.
+ virtual std::size_t SamplesInQueue() const = 0;
+};
+
+} // namespace