cluster.h

/*
 * Copyright © 2017-2023 Synthstrom Audible Limited
 *
 * This file is part of The Synthstrom Audible Deluge Firmware.
 *
 * The Synthstrom Audible Deluge Firmware 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 "definitions.h"
#include "definitions_cxx.hpp"
#include "memory/general_memory_allocator.h"
#include "memory/stealable.h"
#include <array>
#include <cstdint>
 
class Sample;
class SampleCluster;
class SampleCache;

class Cluster final : public Stealable {
public:
    constexpr static size_t kSizeFAT16Max = 32768;
    enum class Type {
        EMPTY,
        SAMPLE,
        GENERAL_MEMORY,
        SAMPLE_CACHE,
        PERC_CACHE_FORWARDS,
        PERC_CACHE_REVERSED,
        OTHER,
    };
 
    static Cluster* create(Cluster::Type type = Cluster::Type::SAMPLE, bool shouldAddReasons = true,
                           void* dontStealFromThing = nullptr);
    void destroy();
 
    static size_t size;
    static size_t size_magnitude;
    static void setSize(size_t size);

    Cluster() = default;
    void convertDataIfNecessary();
    bool mayBeStolen(void* thingNotToStealFrom) override;
    void steal(char const* errorCode) override;
    [[nodiscard]] StealableQueue getAppropriateQueue() const override;
    void addReason();
 
    Cluster::Type type;
    uint32_t clusterIndex = 0;
 
    int32_t numReasonsToBeLoaded = 0;
    int8_t numReasonsHeldBySampleRecorder = 0;
 
    bool extraBytesAtStartConverted = false;
    bool extraBytesAtEndConverted = false;
 
    Sample* sample = nullptr;
    SampleCache* sampleCache = nullptr;
 
    char firstThreeBytesPreDataConversion[3];
    bool loaded = false;
 
    // MUST BE THE LAST TWO MEMBERS
    char dummy[CACHE_LINE_SIZE];
    char data[CACHE_LINE_SIZE];
};