Audaspace 1.5.0
A high level audio library.
Loading...
Searching...
No Matches
RingBuffer.h
Go to the documentation of this file.
1/*******************************************************************************
2 * Copyright 2009-2021 Jörg Müller
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 ******************************************************************************/
16
17#pragma once
18
25#include "Audaspace.h"
26#include "Buffer.h"
27
28#include <cstddef>
29
31
37{
38private:
40 Buffer m_buffer;
41
43 volatile size_t m_read;
44
46 volatile size_t m_write;
47
48 // delete copy constructor and operator=
49 RingBuffer(const RingBuffer&) = delete;
50 RingBuffer& operator=(const RingBuffer&) = delete;
51
52public:
57 RingBuffer(int size = 0);
58
63
67 int getSize() const;
68
69 size_t getReadSize() const;
70
71 size_t getWriteSize() const;
72
73 size_t read(data_t* target, size_t size);
74
75 size_t write(data_t* source, size_t size);
76
77 void clear();
78
82 void reset();
83
88 void resize(int size);
89
96 void assureSize(int size);
97};
98
The main header file of the library defining the namespace and basic data types.
#define AUD_NAMESPACE_END
Closes the audaspace namespace aud.
Definition Audaspace.h:119
float sample_t
Sample type.(float samples)
Definition Audaspace.h:126
#define AUD_NAMESPACE_BEGIN
Opens the audaspace namespace aud.
Definition Audaspace.h:116
#define AUD_API
Used for exporting symbols in the shared library.
Definition Audaspace.h:93
unsigned char data_t
Sample data type (format samples)
Definition Audaspace.h:129
The Buffer class.
This class is a simple buffer in RAM which is 32 Byte aligned and provides resize functionality.
Definition Buffer.h:34
This class is a simple ring buffer in RAM which is 32 Byte aligned and provides functionality for con...
Definition RingBuffer.h:37
RingBuffer(int size=0)
Creates a new ring buffer.
sample_t * getBuffer() const
Returns the pointer to the ring buffer in memory.
void reset()
Resets the ring buffer to a state where nothing has been written or read.
int getSize() const
Returns the size of the ring buffer in bytes.
void assureSize(int size)
Makes sure the ring buffer has a minimum size.
void resize(int size)
Resizes the ring buffer.