PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

mbed_src_STM32F7/api/CircularBuffer.h@0:aa3fc5ad02f7, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:aa3fc5ad02f7 1 /* mbed Microcontroller Library
phungductung 0:aa3fc5ad02f7 2 * Copyright (c) 2015 ARM Limited
phungductung 0:aa3fc5ad02f7 3 *
phungductung 0:aa3fc5ad02f7 4 * Licensed under the Apache License, Version 2.0 (the "License");
phungductung 0:aa3fc5ad02f7 5 * you may not use this file except in compliance with the License.
phungductung 0:aa3fc5ad02f7 6 * You may obtain a copy of the License at
phungductung 0:aa3fc5ad02f7 7 *
phungductung 0:aa3fc5ad02f7 8 * http://www.apache.org/licenses/LICENSE-2.0
phungductung 0:aa3fc5ad02f7 9 *
phungductung 0:aa3fc5ad02f7 10 * Unless required by applicable law or agreed to in writing, software
phungductung 0:aa3fc5ad02f7 11 * distributed under the License is distributed on an "AS IS" BASIS,
phungductung 0:aa3fc5ad02f7 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
phungductung 0:aa3fc5ad02f7 13 * See the License for the specific language governing permissions and
phungductung 0:aa3fc5ad02f7 14 * limitations under the License.
phungductung 0:aa3fc5ad02f7 15 */
phungductung 0:aa3fc5ad02f7 16 #ifndef MBED_CIRCULARBUFFER_H
phungductung 0:aa3fc5ad02f7 17 #define MBED_CIRCULARBUFFER_H
phungductung 0:aa3fc5ad02f7 18
phungductung 0:aa3fc5ad02f7 19 namespace mbed {
phungductung 0:aa3fc5ad02f7 20
phungductung 0:aa3fc5ad02f7 21 /** Templated Circular buffer class
phungductung 0:aa3fc5ad02f7 22 */
phungductung 0:aa3fc5ad02f7 23 template<typename T, uint32_t BufferSize, typename CounterType = uint32_t>
phungductung 0:aa3fc5ad02f7 24 class CircularBuffer {
phungductung 0:aa3fc5ad02f7 25 public:
phungductung 0:aa3fc5ad02f7 26 CircularBuffer() : _head(0), _tail(0), _full(false) {
phungductung 0:aa3fc5ad02f7 27 }
phungductung 0:aa3fc5ad02f7 28
phungductung 0:aa3fc5ad02f7 29 ~CircularBuffer() {
phungductung 0:aa3fc5ad02f7 30 }
phungductung 0:aa3fc5ad02f7 31
phungductung 0:aa3fc5ad02f7 32 /** Push the transaction to the buffer. This overwrites the buffer if it's
phungductung 0:aa3fc5ad02f7 33 * full
phungductung 0:aa3fc5ad02f7 34 *
phungductung 0:aa3fc5ad02f7 35 * @param data Data to be pushed to the buffer
phungductung 0:aa3fc5ad02f7 36 */
phungductung 0:aa3fc5ad02f7 37 void push(const T& data) {
phungductung 0:aa3fc5ad02f7 38 if (full()) {
phungductung 0:aa3fc5ad02f7 39 _tail++;
phungductung 0:aa3fc5ad02f7 40 _tail %= BufferSize;
phungductung 0:aa3fc5ad02f7 41 }
phungductung 0:aa3fc5ad02f7 42 _pool[_head++] = data;
phungductung 0:aa3fc5ad02f7 43 _head %= BufferSize;
phungductung 0:aa3fc5ad02f7 44 if (_head == _tail) {
phungductung 0:aa3fc5ad02f7 45 _full = true;
phungductung 0:aa3fc5ad02f7 46 }
phungductung 0:aa3fc5ad02f7 47 }
phungductung 0:aa3fc5ad02f7 48
phungductung 0:aa3fc5ad02f7 49 /** Pop the transaction from the buffer
phungductung 0:aa3fc5ad02f7 50 *
phungductung 0:aa3fc5ad02f7 51 * @param data Data to be pushed to the buffer
phungductung 0:aa3fc5ad02f7 52 * @return True if the buffer is not empty and data contains a transaction, false otherwise
phungductung 0:aa3fc5ad02f7 53 */
phungductung 0:aa3fc5ad02f7 54 bool pop(T& data) {
phungductung 0:aa3fc5ad02f7 55 if (!empty()) {
phungductung 0:aa3fc5ad02f7 56 data = _pool[_tail++];
phungductung 0:aa3fc5ad02f7 57 _tail %= BufferSize;
phungductung 0:aa3fc5ad02f7 58 _full = false;
phungductung 0:aa3fc5ad02f7 59 return true;
phungductung 0:aa3fc5ad02f7 60 }
phungductung 0:aa3fc5ad02f7 61 return false;
phungductung 0:aa3fc5ad02f7 62 }
phungductung 0:aa3fc5ad02f7 63
phungductung 0:aa3fc5ad02f7 64 /** Check if the buffer is empty
phungductung 0:aa3fc5ad02f7 65 *
phungductung 0:aa3fc5ad02f7 66 * @return True if the buffer is empty, false if not
phungductung 0:aa3fc5ad02f7 67 */
phungductung 0:aa3fc5ad02f7 68 bool empty() {
phungductung 0:aa3fc5ad02f7 69 return (_head == _tail) && !_full;
phungductung 0:aa3fc5ad02f7 70 }
phungductung 0:aa3fc5ad02f7 71
phungductung 0:aa3fc5ad02f7 72 /** Check if the buffer is full
phungductung 0:aa3fc5ad02f7 73 *
phungductung 0:aa3fc5ad02f7 74 * @return True if the buffer is full, false if not
phungductung 0:aa3fc5ad02f7 75 */
phungductung 0:aa3fc5ad02f7 76 bool full() {
phungductung 0:aa3fc5ad02f7 77 return _full;
phungductung 0:aa3fc5ad02f7 78 }
phungductung 0:aa3fc5ad02f7 79
phungductung 0:aa3fc5ad02f7 80 /** Reset the buffer
phungductung 0:aa3fc5ad02f7 81 *
phungductung 0:aa3fc5ad02f7 82 */
phungductung 0:aa3fc5ad02f7 83 void reset() {
phungductung 0:aa3fc5ad02f7 84 _head = 0;
phungductung 0:aa3fc5ad02f7 85 _tail = 0;
phungductung 0:aa3fc5ad02f7 86 _full = false;
phungductung 0:aa3fc5ad02f7 87 }
phungductung 0:aa3fc5ad02f7 88
phungductung 0:aa3fc5ad02f7 89 private:
phungductung 0:aa3fc5ad02f7 90 T _pool[BufferSize];
phungductung 0:aa3fc5ad02f7 91 volatile CounterType _head;
phungductung 0:aa3fc5ad02f7 92 volatile CounterType _tail;
phungductung 0:aa3fc5ad02f7 93 volatile bool _full;
phungductung 0:aa3fc5ad02f7 94 };
phungductung 0:aa3fc5ad02f7 95
phungductung 0:aa3fc5ad02f7 96 }
phungductung 0:aa3fc5ad02f7 97
phungductung 0:aa3fc5ad02f7 98 #endif