aboutsummaryrefslogtreecommitdiffstats
path: root/alc/ringbuffer.h
diff options
context:
space:
mode:
authorChris Robinson <[email protected]>2020-12-05 03:28:19 -0800
committerChris Robinson <[email protected]>2020-12-05 03:28:19 -0800
commit8a352d25f96faf570cf8c3a2ee1f11a30d9ae0fe (patch)
tree2ce45a5170beeb50cf947cf53e7f544a0c0739fd /alc/ringbuffer.h
parent2b919eac78cd6ebe07d6ca7cd01450e6f1aea75b (diff)
Move the ringbuffer to common
Diffstat (limited to 'alc/ringbuffer.h')
-rw-r--r--alc/ringbuffer.h111
1 files changed, 0 insertions, 111 deletions
diff --git a/alc/ringbuffer.h b/alc/ringbuffer.h
deleted file mode 100644
index 32fb951c..00000000
--- a/alc/ringbuffer.h
+++ /dev/null
@@ -1,111 +0,0 @@
-#ifndef RINGBUFFER_H
-#define RINGBUFFER_H
-
-#include <stddef.h>
-
-#include <atomic>
-#include <memory>
-#include <utility>
-
-#include "albyte.h"
-#include "almalloc.h"
-
-
-/* NOTE: This lockless ringbuffer implementation is copied from JACK, extended
- * to include an element size. Consequently, parameters and return values for a
- * size or count is in 'elements', not bytes. Additionally, it only supports
- * single-consumer/single-provider operation.
- */
-
-struct ll_ringbuffer_data {
- al::byte *buf;
- size_t len;
-};
-using ll_ringbuffer_data_pair = std::pair<ll_ringbuffer_data,ll_ringbuffer_data>;
-
-
-struct RingBuffer {
-private:
- std::atomic<size_t> mWritePtr{0u};
- std::atomic<size_t> mReadPtr{0u};
- size_t mWriteSize{0u};
- size_t mSizeMask{0u};
- size_t mElemSize{0u};
-
- al::FlexArray<al::byte, 16> mBuffer;
-
-public:
- RingBuffer(const size_t count) : mBuffer{count} { }
-
- /** Reset the read and write pointers to zero. This is not thread safe. */
- void reset() noexcept;
-
- /**
- * The non-copying data reader. Returns two ringbuffer data pointers that
- * hold the current readable data. If the readable data is in one segment
- * the second segment has zero length.
- */
- ll_ringbuffer_data_pair getReadVector() const noexcept;
- /**
- * The non-copying data writer. Returns two ringbuffer data pointers that
- * hold the current writeable data. If the writeable data is in one segment
- * the second segment has zero length.
- */
- ll_ringbuffer_data_pair getWriteVector() const noexcept;
-
- /**
- * Return the number of elements available for reading. This is the number
- * of elements in front of the read pointer and behind the write pointer.
- */
- size_t readSpace() const noexcept
- {
- const size_t w{mWritePtr.load(std::memory_order_acquire)};
- const size_t r{mReadPtr.load(std::memory_order_acquire)};
- return (w-r) & mSizeMask;
- }
-
- /**
- * The copying data reader. Copy at most `cnt' elements into `dest'.
- * Returns the actual number of elements copied.
- */
- size_t read(void *dest, size_t cnt) noexcept;
- /**
- * The copying data reader w/o read pointer advance. Copy at most `cnt'
- * elements into `dest'. Returns the actual number of elements copied.
- */
- size_t peek(void *dest, size_t cnt) const noexcept;
- /** Advance the read pointer `cnt' places. */
- void readAdvance(size_t cnt) noexcept;
-
- /**
- * Return the number of elements available for writing. This is the number
- * of elements in front of the write pointer and behind the read pointer.
- */
- size_t writeSpace() const noexcept
- {
- const size_t w{mWritePtr.load(std::memory_order_acquire)};
- const size_t r{mReadPtr.load(std::memory_order_acquire) + mWriteSize - mSizeMask};
- return (r-w-1) & mSizeMask;
- }
-
- /**
- * The copying data writer. Copy at most `cnt' elements from `src'. Returns
- * the actual number of elements copied.
- */
- size_t write(const void *src, size_t cnt) noexcept;
- /** Advance the write pointer `cnt' places. */
- void writeAdvance(size_t cnt) noexcept;
-
- /**
- * Create a new ringbuffer to hold at least `sz' elements of `elem_sz'
- * bytes. The number of elements is rounded up to the next power of two
- * (even if it is already a power of two, to ensure the requested amount
- * can be written).
- */
- static std::unique_ptr<RingBuffer> Create(size_t sz, size_t elem_sz, int limit_writes);
-
- DEF_FAM_NEWDEL(RingBuffer, mBuffer)
-};
-using RingBufferPtr = std::unique_ptr<RingBuffer>;
-
-#endif /* RINGBUFFER_H */