read_once()

bool MayaFlux::Buffers::AudioBuffer::read_once ( std::shared_ptr< AudioBuffer >  buffer, bool  force = false  )

virtual

Reads audio data into the buffer from the audio backend.

Parameters

buffer	Shared pointer to the AudioBuffer to read data into
force	Whether to force reading even if in processing state

Returns

True if data was successfully read, false otherwise

This method attempts to read audio data from the audio backend into the provided AudioBuffer. If force is true, it will attempt to read even if the current buffer or the copy buffer are in processing state

Definition at line 94 of file AudioBuffer.cpp.

{
    if (buffer && buffer->get_num_samples() == m_num_samples) {
        if (m_is_processing.load() || buffer->is_processing()) {
            MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
                "read_once: Attempting to read from an audio buffer while it is being processed.");
 
            if (!force) {
                MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
                    "read_once: Skipping read due to ongoing processing.");
                return false;
            }
            MF_WARN(Journal::Component::Buffers, Journal::Context::BufferProcessing,
                "read_once: Forcing read despite ongoing processing. This may lead to data corruption.");
        }
        m_data = buffer->get_data();
        m_has_data = true;
        return true;
    }
 
    MF_ERROR(Journal::Component::Buffers, Journal::Context::BufferProcessing,
        "read_once: Buffer read failed due to size mismatch or null buffer.");
 
    return false;
}

References MayaFlux::Journal::BufferProcessing, MayaFlux::Journal::Buffers, m_data, m_has_data, m_is_processing, m_num_samples, MF_ERROR, and MF_WARN.