不韋 呂 / F746_AcousticEffector_MIC

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   F746_GUI F746_SAI_IO

mbed_src_STM32F7/api/CircularBuffer.h@10:56f2f01df983, 2017-04-10 (annotated)

Committer:
MikamiUitOpen
Date:
Mon Apr 10 13:44:13 2017 +0000
Revision:
10:56f2f01df983
Parent:
6:38f7dce055d0 
11

Who changed what in which revision?

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