prymula/com: DPF-Prymula-audioplugins/dpf/distrho/extra/RingBuffer.hpp annotate

annotate DPF-Prymula-audioplugins/dpf/distrho/extra/RingBuffer.hpp @ 4:0962f0296c8a

ColorsMemory-0.210503-1.1

author	prymula <prymula76@outlook.com>
date	Tue, 30 Jan 2024 16:43:10 +0100
parents	84e66ea83026
children

rev	line source
3 84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	1 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	2 * DISTRHO Plugin Framework (DPF)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	3 * Copyright (C) 2012-2021 Filipe Coelho <falktx@falktx.com>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	4 *
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	5 * Permission to use, copy, modify, and/or distribute this software for any purpose with
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	6 * or without fee is hereby granted, provided that the above copyright notice and this
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	7 * permission notice appear in all copies.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	8 *
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	9 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	10 * TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	11 * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	12 * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	13 * IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	14 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	15 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	16
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	17 #ifndef DISTRHO_RING_BUFFER_HPP_INCLUDED
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	18 #define DISTRHO_RING_BUFFER_HPP_INCLUDED
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	19
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	20 #include "../DistrhoUtils.hpp"
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	21
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	22 START_NAMESPACE_DISTRHO
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	23
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	24 // -----------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	25 // Buffer structs
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	26
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	27 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	28 Base structure for all RingBuffer containers.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	29 This struct details the data model used in DPF's RingBuffer class.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	30
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	31 DPF RingBuffer uses a struct just like this one to store positions, buffer data, size, etc.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	32 The RingBuffer itself takes ownership of this struct and uses it to store any needed data.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	33 This allows to dynamically change the way its ring buffer is allocated, simply by changing the template type.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	34 For example, `RingBufferControl<HeapBuffer>` will create a ring buffer with heap memory, which can be of any size.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	35 In the same vein, `RingBufferControl<SmallStackBuffer>` will create a ring buffer with stack memory,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	36 directly tied to the RingBufferControl it belongs to.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	37
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	38 The main idea behind this model is to allow RingBufferControl over memory created elsewhere,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	39 for example shared memory area.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	40 One can create/place the Buffer struct in shared memory, and point RingBufferControl to it,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	41 thus avoiding the pitfalls of sharing access to a non trivially-copyable/POD C++ class.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	42
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	43 Unlike other ring buffers, an extra variable is used to track pending writes.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	44 This is so we can write a few bytes at a time and later mark the whole operation as complete,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	45 thus avoiding the issue of reading data too early from the other side.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	46 For example, write the size of some data first, and then the actual data.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	47 The reading side will only see data available once size + data is completely written and "committed".
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	48 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	49 struct HeapBuffer {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	50 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	51 Size of the buffer, allocated in @a buf.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	52 If the size is fixed (stack buffer), this variable can be static.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	53 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	54 uint32_t size;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	55
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	56 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	57 Current writing position, headmost position of the buffer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	58 Increments when writing.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	59 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	60 uint32_t head;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	61
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	62 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	63 Current reading position, last used position of the buffer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	64 Increments when reading.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	65 head == tail means empty buffer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	66 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	67 uint32_t tail;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	68
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	69 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	70 Temporary position of head until a commitWrite() is called.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	71 If buffer writing fails, wrtn will be back to head position thus ignoring the last operation(s).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	72 If buffer writing succeeds, head will be set to this variable.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	73 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	74 uint32_t wrtn;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	75
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	76 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	77 Boolean used to check if a write operation failed.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	78 This ensures we don't get incomplete writes.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	79 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	80 bool invalidateCommit;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	81
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	82 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	83 Pointer to buffer data.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	84 This can be either stack or heap data, depending on the usecase.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	85 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	86 uint8_t* buf;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	87 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	88
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	89 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	90 RingBufferControl compatible struct with a relatively small stack size (4k bytes).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	91 @see HeapBuffer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	92 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	93 struct SmallStackBuffer {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	94 static const uint32_t size = 4096;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	95 uint32_t head, tail, wrtn;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	96 bool invalidateCommit;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	97 uint8_t buf[size];
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	98 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	99
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	100 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	101 RingBufferControl compatible struct with a relatively big stack size (16k bytes).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	102 @see HeapBuffer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	103 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	104 struct BigStackBuffer {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	105 static const uint32_t size = 16384;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	106 uint32_t head, tail, wrtn;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	107 bool invalidateCommit;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	108 uint8_t buf[size];
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	109 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	110
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	111 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	112 RingBufferControl compatible struct with a huge stack size (64k bytes).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	113 @see HeapBuffer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	114 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	115 struct HugeStackBuffer {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	116 static const uint32_t size = 65536;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	117 uint32_t head, tail, wrtn;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	118 bool invalidateCommit;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	119 uint8_t buf[size];
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	120 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	121
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	122 #ifdef DISTRHO_PROPER_CPP11_SUPPORT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	123 # define HeapBuffer_INIT {0, 0, 0, 0, false, nullptr}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	124 # define StackBuffer_INIT {0, 0, 0, false, {0}}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	125 #else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	126 # define HeapBuffer_INIT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	127 # define StackBuffer_INIT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	128 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	129
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	130 // -----------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	131 // RingBufferControl templated class
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	132
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	133 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	134 DPF built-in RingBuffer class.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	135 RingBufferControl takes one buffer struct to take control over, and operates over it.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	136
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	137 This is meant for single-writer, single-reader type of control.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	138 Writing and reading is wait and lock-free.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	139
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	140 Typically usage involves:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	141 ```
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	142 // definition
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	143 HeapRingBuffer myHeapBuffer; // or RingBufferControl<HeapBuffer> class for more control
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	144
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	145 // construction, only needed for heap buffers
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	146 myHeapBuffer.createBuffer(8192);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	147
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	148 // writing data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	149 myHeapBuffer.writeUInt(size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	150 myHeapBuffer.writeCustomData(someOtherData, size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	151 myHeapBuffer.commitWrite();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	152
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	153 // reading data
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	154 if (myHeapBuffer.isDataAvailableForReading())
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	155 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	156 uint32_t size;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	157 if (myHeapBuffer.readUInt(size) && readCustomData(&anotherData, size))
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	158 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	159 // do something with "anotherData"
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	160 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	161 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	162 ```
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	163
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	164 @see HeapBuffer
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	165 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	166 template <class BufferStruct>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	167 class RingBufferControl
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	168 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	169 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	170 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	171 * Constructor for uninitialised ring buffer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	172 * A call to setRingBuffer is required to tied this control to a ring buffer struct;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	173 *
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	174 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	175 RingBufferControl() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	176 : buffer(nullptr),
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	177 errorReading(false),
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	178 errorWriting(false) {}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	179
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	180 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	181 * Destructor.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	182 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	183 virtual ~RingBufferControl() noexcept {}
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	184
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	185 // -------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	186 // check operations
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	187
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	188 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	189 * Check if there is any data available for reading, regardless of size.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	190 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	191 bool isDataAvailableForReading() const noexcept;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	192
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	193 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	194 * Check if ring buffer is empty (that is, there is nothing to read).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	195 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	196 bool isEmpty() const noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	197 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	198 DISTRHO_SAFE_ASSERT_RETURN(buffer != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	199
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	200 return (buffer->buf == nullptr \|\| buffer->head == buffer->tail);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	201 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	202
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	203 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	204 * Get the size of the data available to read.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	205 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	206 uint32_t getReadableDataSize() const noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	207 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	208 DISTRHO_SAFE_ASSERT_RETURN(buffer != nullptr, 0);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	209
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	210 const uint32_t wrap = buffer->head > buffer->tail ? 0 : buffer->size;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	211
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	212 return wrap + buffer->head - buffer->tail;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	213 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	214
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	215 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	216 * Get the size of the data available to write.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	217 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	218 uint32_t getWritableDataSize() const noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	219 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	220 DISTRHO_SAFE_ASSERT_RETURN(buffer != nullptr, 0);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	221
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	222 const uint32_t wrap = (buffer->tail > buffer->wrtn) ? 0 : buffer->size;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	223
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	224 return wrap + buffer->tail - buffer->wrtn;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	225 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	226
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	227 // -------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	228 // clear/reset operations
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	229
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	230 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	231 * Clear the entire ring buffer data, marking the buffer as empty.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	232 * Requires a buffer struct tied to this class.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	233 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	234 void clearData() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	235 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	236 DISTRHO_SAFE_ASSERT_RETURN(buffer != nullptr,);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	237
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	238 buffer->head = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	239 buffer->tail = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	240 buffer->wrtn = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	241 buffer->invalidateCommit = false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	242
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	243 std::memset(buffer->buf, 0, buffer->size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	244 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	245
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	246 // -------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	247 // read operations
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	248
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	249 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	250 * Read a single boolean value.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	251 * Returns false if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	252 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	253 bool readBool() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	254 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	255 bool b = false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	256 return tryRead(&b, sizeof(bool)) ? b : false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	257 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	258
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	259 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	260 * Read a single 8-bit byte.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	261 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	262 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	263 uint8_t readByte() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	264 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	265 uint8_t B = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	266 return tryRead(&B, sizeof(uint8_t)) ? B : 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	267 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	268
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	269 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	270 * Read a short 16-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	271 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	272 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	273 int16_t readShort() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	274 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	275 int16_t s = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	276 return tryRead(&s, sizeof(int16_t)) ? s : 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	277 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	278
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	279 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	280 * Read a short unsigned 16-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	281 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	282 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	283 uint16_t readUShort() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	284 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	285 uint16_t us = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	286 return tryRead(&us, sizeof(uint16_t)) ? us : 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	287 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	288
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	289 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	290 * Read a regular 32-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	291 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	292 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	293 int32_t readInt() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	294 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	295 int32_t i = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	296 return tryRead(&i, sizeof(int32_t)) ? i : 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	297 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	298
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	299 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	300 * Read an unsigned 32-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	301 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	302 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	303 uint32_t readUInt() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	304 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	305 uint32_t ui = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	306 return tryRead(&ui, sizeof(int32_t)) ? ui : 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	307 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	308
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	309 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	310 * Read a long 64-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	311 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	312 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	313 int64_t readLong() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	314 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	315 int64_t l = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	316 return tryRead(&l, sizeof(int64_t)) ? l : 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	317 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	318
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	319 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	320 * Read a long unsigned 64-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	321 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	322 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	323 uint64_t readULong() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	324 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	325 uint64_t ul = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	326 return tryRead(&ul, sizeof(int64_t)) ? ul : 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	327 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	328
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	329 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	330 * Read a single-precision floating point number.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	331 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	332 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	333 float readFloat() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	334 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	335 float f = 0.0f;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	336 return tryRead(&f, sizeof(float)) ? f : 0.0f;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	337 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	338
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	339 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	340 * Read a double-precision floating point number.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	341 * Returns 0 if reading fails.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	342 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	343 double readDouble() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	344 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	345 double d = 0.0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	346 return tryRead(&d, sizeof(double)) ? d : 0.0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	347 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	348
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	349 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	350 * Read an arbitrary amount of data, specified by @a size.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	351 * data pointer must be non-null, and size > 0.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	352 *
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	353 * Returns true if reading succeeds.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	354 * In case of failure, @a data pointer is automatically cleared by @a size bytes.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	355 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	356 bool readCustomData(void* const data, const uint32_t size) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	357 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	358 DISTRHO_SAFE_ASSERT_RETURN(data != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	359 DISTRHO_SAFE_ASSERT_RETURN(size > 0, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	360
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	361 if (tryRead(data, size))
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	362 return true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	363
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	364 std::memset(data, 0, size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	365 return false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	366 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	367
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	368 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	369 * Read a custom data type specified by the template typename used,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	370 * with size being automatically deduced by the compiler (through the use of sizeof).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	371 *
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	372 * Returns true if reading succeeds.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	373 * In case of failure, @a type value is automatically cleared by its deduced size.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	374 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	375 template <typename T>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	376 bool readCustomType(T& type) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	377 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	378 if (tryRead(&type, sizeof(T)))
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	379 return true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	380
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	381 std::memset(&type, 0, sizeof(T));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	382 return false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	383 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	384
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	385 // -------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	386 // write operations
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	387
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	388 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	389 * Write a single boolean value.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	390 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	391 bool writeBool(const bool value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	392 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	393 return tryWrite(&value, sizeof(bool));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	394 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	395
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	396 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	397 * Write a single 8-bit byte.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	398 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	399 bool writeByte(const uint8_t value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	400 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	401 return tryWrite(&value, sizeof(uint8_t));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	402 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	403
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	404 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	405 * Write a short 16-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	406 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	407 bool writeShort(const int16_t value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	408 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	409 return tryWrite(&value, sizeof(int16_t));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	410 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	411
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	412 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	413 * Write a short unsigned 16-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	414 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	415 bool writeUShort(const uint16_t value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	416 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	417 return tryWrite(&value, sizeof(uint16_t));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	418 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	419
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	420 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	421 * Write a regular 32-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	422 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	423 bool writeInt(const int32_t value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	424 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	425 return tryWrite(&value, sizeof(int32_t));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	426 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	427
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	428 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	429 * Write an unsigned 32-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	430 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	431 bool writeUInt(const uint32_t value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	432 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	433 return tryWrite(&value, sizeof(uint32_t));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	434 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	435
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	436 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	437 * Write a long 64-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	438 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	439 bool writeLong(const int64_t value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	440 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	441 return tryWrite(&value, sizeof(int64_t));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	442 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	443
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	444 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	445 * Write a long unsigned 64-bit integer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	446 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	447 bool writeULong(const uint64_t value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	448 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	449 return tryWrite(&value, sizeof(uint64_t));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	450 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	451
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	452 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	453 * Write a single-precision floating point number.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	454 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	455 bool writeFloat(const float value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	456 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	457 return tryWrite(&value, sizeof(float));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	458 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	459
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	460 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	461 * Write a double-precision floating point number.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	462 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	463 bool writeDouble(const double value) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	464 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	465 return tryWrite(&value, sizeof(double));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	466 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	467
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	468 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	469 * Write an arbitrary amount of data, specified by @a size.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	470 * data pointer must be non-null, and size > 0.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	471 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	472 bool writeCustomData(const void* const data, const uint32_t size) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	473 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	474 DISTRHO_SAFE_ASSERT_RETURN(data != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	475 DISTRHO_SAFE_ASSERT_RETURN(size > 0, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	476
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	477 return tryWrite(data, size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	478 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	479
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	480 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	481 * Write a custom data type specified by the template typename used,
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	482 * with size being automatically deduced by the compiler (through the use of sizeof).
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	483 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	484 template <typename T>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	485 bool writeCustomType(const T& type) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	486 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	487 return tryWrite(&type, sizeof(T));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	488 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	489
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	490 // -------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	491
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	492 /*!
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	493 * Commit all previous write operations to the ringbuffer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	494 * If a write operation has previously failed, this will reset/invalidate the previous write attempts.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	495 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	496 bool commitWrite() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	497 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	498 DISTRHO_SAFE_ASSERT_RETURN(buffer != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	499
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	500 if (buffer->invalidateCommit)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	501 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	502 buffer->wrtn = buffer->head;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	503 buffer->invalidateCommit = false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	504 return false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	505 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	506
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	507 // nothing to commit?
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	508 DISTRHO_SAFE_ASSERT_RETURN(buffer->head != buffer->wrtn, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	509
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	510 // all ok
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	511 buffer->head = buffer->wrtn;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	512 errorWriting = false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	513 return true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	514 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	515
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	516 // -------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	517
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	518 /*
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	519 * Tie this ring buffer control to a ring buffer struct, optionally clearing its data.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	520 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	521 void setRingBuffer(BufferStruct* const ringBuf, const bool clearRingBufferData) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	522 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	523 DISTRHO_SAFE_ASSERT_RETURN(buffer != ringBuf,);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	524
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	525 buffer = ringBuf;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	526
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	527 if (clearRingBufferData && ringBuf != nullptr)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	528 clearData();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	529 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	530
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	531 // -------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	532
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	533 protected:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	534 /** @internal try reading from the buffer, can fail. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	535 bool tryRead(void* const buf, const uint32_t size) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	536 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	537 DISTRHO_SAFE_ASSERT_RETURN(buffer != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	538 #if defined(__clang__)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	539 # pragma clang diagnostic push
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	540 # pragma clang diagnostic ignored "-Wtautological-pointer-compare"
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	541 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	542 DISTRHO_SAFE_ASSERT_RETURN(buffer->buf != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	543 #if defined(__clang__)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	544 # pragma clang diagnostic pop
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	545 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	546 DISTRHO_SAFE_ASSERT_RETURN(buf != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	547 DISTRHO_SAFE_ASSERT_RETURN(size > 0, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	548 DISTRHO_SAFE_ASSERT_RETURN(size < buffer->size, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	549
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	550 // empty
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	551 if (buffer->head == buffer->tail)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	552 return false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	553
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	554 uint8_t* const bytebuf(static_cast<uint8_t*>(buf));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	555
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	556 const uint32_t head(buffer->head);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	557 const uint32_t tail(buffer->tail);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	558 const uint32_t wrap((head > tail) ? 0 : buffer->size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	559
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	560 if (size > wrap + head - tail)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	561 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	562 if (! errorReading)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	563 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	564 errorReading = true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	565 d_stderr2("RingBuffer::tryRead(%p, %lu): failed, not enough space", buf, (ulong)size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	566 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	567 return false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	568 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	569
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	570 uint32_t readto(tail + size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	571
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	572 if (readto > buffer->size)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	573 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	574 readto -= buffer->size;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	575
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	576 if (size == 1)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	577 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	578 std::memcpy(bytebuf, buffer->buf + tail, 1);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	579 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	580 else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	581 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	582 const uint32_t firstpart(buffer->size - tail);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	583 std::memcpy(bytebuf, buffer->buf + tail, firstpart);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	584 std::memcpy(bytebuf + firstpart, buffer->buf, readto);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	585 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	586 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	587 else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	588 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	589 std::memcpy(bytebuf, buffer->buf + tail, size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	590
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	591 if (readto == buffer->size)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	592 readto = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	593 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	594
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	595 buffer->tail = readto;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	596 errorReading = false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	597 return true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	598 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	599
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	600 /** @internal try writing to the buffer, can fail. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	601 bool tryWrite(const void* const buf, const uint32_t size) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	602 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	603 DISTRHO_SAFE_ASSERT_RETURN(buffer != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	604 DISTRHO_SAFE_ASSERT_RETURN(buf != nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	605 DISTRHO_SAFE_ASSERT_RETURN(size > 0, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	606 DISTRHO_SAFE_ASSERT_UINT2_RETURN(size < buffer->size, size, buffer->size, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	607
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	608 const uint8_t* const bytebuf(static_cast<const uint8_t*>(buf));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	609
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	610 const uint32_t tail(buffer->tail);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	611 const uint32_t wrtn(buffer->wrtn);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	612 const uint32_t wrap((tail > wrtn) ? 0 : buffer->size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	613
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	614 if (size >= wrap + tail - wrtn)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	615 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	616 if (! errorWriting)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	617 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	618 errorWriting = true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	619 d_stderr2("RingBuffer::tryWrite(%p, %lu): failed, not enough space", buf, (ulong)size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	620 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	621 buffer->invalidateCommit = true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	622 return false;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	623 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	624
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	625 uint32_t writeto(wrtn + size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	626
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	627 if (writeto > buffer->size)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	628 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	629 writeto -= buffer->size;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	630
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	631 if (size == 1)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	632 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	633 std::memcpy(buffer->buf, bytebuf, 1);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	634 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	635 else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	636 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	637 const uint32_t firstpart(buffer->size - wrtn);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	638 std::memcpy(buffer->buf + wrtn, bytebuf, firstpart);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	639 std::memcpy(buffer->buf, bytebuf + firstpart, writeto);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	640 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	641 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	642 else
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	643 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	644 std::memcpy(buffer->buf + wrtn, bytebuf, size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	645
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	646 if (writeto == buffer->size)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	647 writeto = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	648 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	649
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	650 buffer->wrtn = writeto;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	651 return true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	652 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	653
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	654 private:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	655 /** Buffer struct pointer. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	656 BufferStruct* buffer;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	657
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	658 /** Whether read errors have been printed to terminal. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	659 bool errorReading;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	660
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	661 /** Whether write errors have been printed to terminal. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	662 bool errorWriting;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	663
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	664 DISTRHO_PREVENT_VIRTUAL_HEAP_ALLOCATION
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	665 DISTRHO_DECLARE_NON_COPYABLE(RingBufferControl)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	666 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	667
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	668 template <class BufferStruct>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	669 inline bool RingBufferControl<BufferStruct>::isDataAvailableForReading() const noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	670 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	671 return (buffer != nullptr && buffer->head != buffer->tail);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	672 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	673
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	674 template <>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	675 inline bool RingBufferControl<HeapBuffer>::isDataAvailableForReading() const noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	676 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	677 return (buffer != nullptr && buffer->buf != nullptr && buffer->head != buffer->tail);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	678 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	679
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	680 // -----------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	681 // RingBuffer using heap space
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	682
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	683 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	684 RingBufferControl with a heap buffer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	685 This is a convenience class that provides a method for creating and destroying the heap data.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	686 Requires the use of createBuffer(uint32_t) to make the ring buffer usable.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	687 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	688 class HeapRingBuffer : public RingBufferControl<HeapBuffer>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	689 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	690 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	691 /** Constructor. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	692 HeapRingBuffer() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	693 : heapBuffer(HeapBuffer_INIT)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	694 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	695 #ifndef DISTRHO_PROPER_CPP11_SUPPORT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	696 std::memset(&heapBuffer, 0, sizeof(heapBuffer));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	697 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	698 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	699
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	700 /** Destructor. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	701 ~HeapRingBuffer() noexcept override
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	702 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	703 if (heapBuffer.buf == nullptr)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	704 return;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	705
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	706 delete[] heapBuffer.buf;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	707 heapBuffer.buf = nullptr;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	708 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	709
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	710 /** Create a buffer of the specified size. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	711 bool createBuffer(const uint32_t size) noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	712 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	713 DISTRHO_SAFE_ASSERT_RETURN(heapBuffer.buf == nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	714 DISTRHO_SAFE_ASSERT_RETURN(size > 0, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	715
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	716 const uint32_t p2size = d_nextPowerOf2(size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	717
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	718 try {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	719 heapBuffer.buf = new uint8_t[p2size];
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	720 } DISTRHO_SAFE_EXCEPTION_RETURN("HeapRingBuffer::createBuffer", false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	721
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	722 heapBuffer.size = p2size;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	723 setRingBuffer(&heapBuffer, true);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	724 return true;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	725 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	726
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	727 /** Delete the previously allocated buffer. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	728 void deleteBuffer() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	729 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	730 DISTRHO_SAFE_ASSERT_RETURN(heapBuffer.buf != nullptr,);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	731
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	732 setRingBuffer(nullptr, false);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	733
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	734 delete[] heapBuffer.buf;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	735 heapBuffer.buf = nullptr;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	736 heapBuffer.size = 0;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	737 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	738
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	739 void copyFromAndClearOther(HeapRingBuffer& other)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	740 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	741 DISTRHO_SAFE_ASSERT_RETURN(other.heapBuffer.size == heapBuffer.size,);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	742
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	743 std::memcpy(&heapBuffer, &other.heapBuffer, sizeof(HeapBuffer) - sizeof(uint8_t*));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	744 std::memcpy(heapBuffer.buf, other.heapBuffer.buf, sizeof(uint8_t) * heapBuffer.size);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	745 other.clearData();
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	746 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	747
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	748 private:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	749 /** The heap buffer used for this class. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	750 HeapBuffer heapBuffer;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	751
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	752 DISTRHO_PREVENT_VIRTUAL_HEAP_ALLOCATION
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	753 DISTRHO_DECLARE_NON_COPYABLE(HeapRingBuffer)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	754 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	755
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	756 // -----------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	757 // RingBuffer using small stack space
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	758
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	759 /**
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	760 RingBufferControl with an included small stack buffer.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	761 No setup is necessary, this class is usable as-is.
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	762 */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	763 class SmallStackRingBuffer : public RingBufferControl<SmallStackBuffer>
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	764 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	765 public:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	766 /** Constructor. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	767 SmallStackRingBuffer() noexcept
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	768 : stackBuffer(StackBuffer_INIT)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	769 {
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	770 #ifndef DISTRHO_PROPER_CPP11_SUPPORT
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	771 std::memset(&stackBuffer, 0, sizeof(stackBuffer));
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	772 #endif
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	773 setRingBuffer(&stackBuffer, true);
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	774 }
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	775
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	776 private:
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	777 /** The small stack buffer used for this class. */
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	778 SmallStackBuffer stackBuffer;
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	779
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	780 DISTRHO_PREVENT_VIRTUAL_HEAP_ALLOCATION
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	781 DISTRHO_DECLARE_NON_COPYABLE(SmallStackRingBuffer)
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	782 };
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	783
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	784 // -----------------------------------------------------------------------
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	785
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	786 END_NAMESPACE_DISTRHO
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	787
84e66ea83026 DPF-Prymula-audioplugins-0.231015-2 prymula <prymula76@outlook.com> parents: diff changeset	788 #endif // DISTRHO_RING_BUFFER_HPP_INCLUDED

Mercurial > hg > pub > prymula > com

annotate DPF-Prymula-audioplugins/dpf/distrho/extra/RingBuffer.hpp @ 4:0962f0296c8a