ringbuffer.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2004-2026 Savoir-faire Linux Inc.
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
#pragma once
 
#include "audio_format.h"
#include "noncopyable.h"
#include "audio_frame_resizer.h"
#include "resampler.h"
 
#include <atomic>
#include <condition_variable>
#include <mutex>
#include <chrono>
#include <map>
#include <vector>
 
namespace jami {
 
class RingBuffer
{
public:
    using clock = std::chrono::steady_clock;
    using time_point = clock::time_point;
    using FrameCallback = std::function<void(const std::shared_ptr<AudioFrame>&)>;
 
    RingBuffer(const std::string& id, AudioFormat format = AudioFormat::MONO());
 
    ~RingBuffer();
 
    const std::string& getId() const { return id; }
 
    void flush(const std::string& ringbufferId);
 
    void flushAll();
 
    std::vector<std::string> getSubscribers();
 
    inline AudioFormat getFormat() const { return format_; }
 
    inline void setFormat(const AudioFormat& format)
    {
        std::lock_guard l(writeLock_);
        format_ = format;
        resizer_.setFormat(format, static_cast<int>(format.sample_rate) / 50);
    }
 
    void createReadOffset(const std::string& ringbufferId);
 
    void createReadOffset(const std::string& ringbufferId, FrameCallback cb);
 
    void removeReadOffset(const std::string& ringbufferId);
 
    size_t readOffsetCount() const { return readoffsets_.size(); }
 
    void put(std::shared_ptr<AudioFrame>&& data);
 
    size_t availableForGet(const std::string& ringbufferId) const;
 
    std::shared_ptr<AudioFrame> get(const std::string& ringbufferId);
 
    size_t discard(size_t toDiscard, const std::string& ringbufferId);
 
    size_t putLength() const;
 
    size_t getLength(const std::string& ringbufferId) const;
 
    inline bool isFull() const { return putLength() == buffer_.size(); }
 
    inline bool isEmpty() const { return putLength() == 0; }
 
    inline void setFrameSize(int nb_samples) { resizer_.setFrameSize(nb_samples); }
 
    size_t waitForDataAvailable(const std::string& ringbufferId, const time_point& deadline = time_point::max()) const;
 
    void debug();
 
    bool isAudioMeterActive() const { return rmsSignal_; }
    void setAudioMeterState(bool state) { rmsSignal_ = state; }
 
private:
    struct ReadOffset
    {
        size_t offset;
        FrameCallback callback;
    };
    using ReadOffsetMap = std::map<std::string, ReadOffset>;
    NON_COPYABLE(RingBuffer);
 
    void putToBuffer(std::shared_ptr<AudioFrame>&& data);
 
    bool hasNoReadOffsets() const;
 
    size_t getSmallestReadOffset() const;
 
    size_t getReadOffset(const std::string& ringbufferId) const;
 
    void storeReadOffset(size_t offset, const std::string& ringbufferId);
 
    bool hasThisReadOffset(const std::string& ringbufferId) const;
 
    size_t discard(size_t toDiscard);
 
    const std::string id;
 
    size_t endPos_;
 
    AudioFormat format_ {AudioFormat::DEFAULT()};
    std::vector<std::shared_ptr<AudioFrame>> buffer_ {16};
 
    mutable std::mutex lock_;
    mutable std::condition_variable not_empty_;
    std::mutex writeLock_;
 
    ReadOffsetMap readoffsets_;
 
    Resampler resampler_;
    AudioFrameResizer resizer_;
 
    std::atomic_bool rmsSignal_ {false};
    double rmsLevel_ {0};
    int rmsFrameCount_ {0};
};
 
} // namespace jami