sfizz-ui/plugins/vst/SfizzVstUpdates.h

// SPDX-License-Identifier: BSD-2-Clause

// This code is part of the sfizz library and is licensed under a BSD 2-clause
// license. You should have receive a LICENSE.md file along with the code.
// If not, contact the sfizz maintainers at https://github.com/sfztools/sfizz

#pragma once
#include "SfizzVstState.h"
#include <public.sdk/source/vst/vstcomponentbase.h>
#include <pluginterfaces/vst/ivstmessage.h>
#include <base/source/fobject.h>
#include <vector>
#include <map>
#include <string>
#include <memory>
#include <mutex>
#include <cstring>
#include <cstdint>

/**
 * @brief Update which is convertible with Vst::IMessage back and forth.
 */
template <class T> class IConvertibleToMessage {
public:
    virtual ~IConvertibleToMessage() {}

    IPtr<Vst::IMessage> convertToMessage(Vst::ComponentBase* sender) const;
    bool convertFromMessage(Vst::IMessage& message);
    static IPtr<T> createFromMessage(Vst::IMessage& message);

protected:
    virtual bool saveToAttributes(Vst::IAttributeList* attrs) const = 0;
    virtual bool loadFromAttributes(Vst::IAttributeList* attrs) = 0;
};

/**
 * @brief Update which notifies a FIFO queue of one-time updates
 */
class QueuedUpdates : public Steinberg::FObject {
public:
    using List = std::vector<IPtr<FObject>>;

    void enqueue(IPtr<FObject> update);
    List getUpdates(IDependent* dep);

    void addDependent(IDependent* dep) override;
    void removeDependent(IDependent* dep) override;

    OBJ_METHODS(QueuedUpdates, FObject)

private:
    std::mutex mutex_;
    std::map<IDependent*, List> updates_;
};

/**
 * @brief Update which notifies a single OSC message
 */
class OSCUpdate : public Steinberg::FObject,
                  public IConvertibleToMessage<OSCUpdate> {
public:
    OSCUpdate() = default;
    OSCUpdate(const uint8* data, uint32 size) : data_(data, data + size) {}
    const uint8* data() const noexcept { return data_.data(); }
    uint32_t size() const noexcept { return static_cast<uint32_t>(data_.size()); }

    bool saveToAttributes(Vst::IAttributeList* attrs) const override;
    bool loadFromAttributes(Vst::IAttributeList* attrs) override;

    OBJ_METHODS(OSCUpdate, FObject)

private:
    std::vector<uint8> data_;
};

/**
 * @brief Update which notifies one or more note on/off events
 */
class NoteUpdate : public Steinberg::FObject,
                   public IConvertibleToMessage<NoteUpdate> {
public:
    using Item = std::pair<uint32, float>;

    NoteUpdate() = default;
    NoteUpdate(const Item* items, uint32 count) : events_(items, items + count) {}
    const Item* events() const noexcept { return events_.data(); }
    const uint32 count() const noexcept { return static_cast<uint32>(events_.size()); }

    bool saveToAttributes(Vst::IAttributeList* attrs) const override;
    bool loadFromAttributes(Vst::IAttributeList* attrs) override;

    OBJ_METHODS(NoteUpdate, FObject)

private:
    std::vector<Item> events_;
};

/**
 * @brief Abstract update which notifies change of a certain file path.
 */
class FilePathUpdate : public Steinberg::FObject {
protected:
    FilePathUpdate() = default;

public:
    void setPath(std::string newPath)
    {
        std::lock_guard<std::mutex> lock(mutex_);
        path_ = std::move(newPath);
    }

    std::string getPath() const
    {
        std::lock_guard<std::mutex> lock(mutex_);
        return path_;
    }

    OBJ_METHODS(FilePathUpdate, FObject)

protected:
    bool saveFilePathAttributes_(Vst::IAttributeList* attrs) const;
    bool loadFilePathAttributes_(Vst::IAttributeList* attrs);

private:
    std::string path_;
    mutable std::mutex mutex_;
};

/**
 * @brief Update which notifies a change of SFZ file.
 */
class SfzUpdate : public FilePathUpdate,
                  public IConvertibleToMessage<SfzUpdate> {
public:
    OBJ_METHODS(SfzUpdate, FilePathUpdate)

    bool saveToAttributes(Vst::IAttributeList* attrs) const override;
    bool loadFromAttributes(Vst::IAttributeList* attrs) override;
};

/**
 * @brief Update which notifies a change of scala file.
 */
class ScalaUpdate : public FilePathUpdate,
                    public IConvertibleToMessage<ScalaUpdate> {
public:
    OBJ_METHODS(ScalaUpdate, FilePathUpdate)

    bool saveToAttributes(Vst::IAttributeList* attrs) const override;
    bool loadFromAttributes(Vst::IAttributeList* attrs) override;
};

/**
 * @brief Update which notifies a change of SFZ description.
 */
class SfzDescriptionUpdate : public Steinberg::FObject,
                             public IConvertibleToMessage<SfzDescriptionUpdate> {
public:
    void setDescription(std::string newDescription)
    {
        std::lock_guard<std::mutex> lock(mutex_);
        description_ = std::move(newDescription);
    }

    std::string getDescription() const
    {
        std::lock_guard<std::mutex> lock(mutex_);
        return description_;
    }

    bool saveToAttributes(Vst::IAttributeList* attrs) const override;
    bool loadFromAttributes(Vst::IAttributeList* attrs) override;

    OBJ_METHODS(SfzDescriptionUpdate, FObject)

private:
    std::string description_;
    mutable std::mutex mutex_;
};

/**
 * @brief Update which indicates the playing SFZ status.
 */
class PlayStateUpdate : public Steinberg::FObject,
                        public IConvertibleToMessage<PlayStateUpdate> {
public:
    void setState(SfizzPlayState newState)
    {
        std::lock_guard<std::mutex> lock(mutex_);
        state_ = std::move(newState);
    }

    SfizzPlayState getState() const
    {
        std::lock_guard<std::mutex> lock(mutex_);
        return state_;
    }

    bool saveToAttributes(Vst::IAttributeList* attrs) const override;
    virtual bool loadFromAttributes(Vst::IAttributeList* attrs) override;

    OBJ_METHODS(PlayStateUpdate, FObject)

private:
    SfizzPlayState state_ {};
    mutable std::mutex mutex_;
};

/**
 * @brief Update which automates a pack of parameters
 */
class AutomationUpdate : public Steinberg::FObject,
                         public IConvertibleToMessage<AutomationUpdate> {
public:
    using Item = std::pair<Vst::ParamID, float>;

    AutomationUpdate() = default;

    void setItems(std::vector<Item> newItems)
    {
        std::lock_guard<std::mutex> lock(mutex_);
        items_ = std::move(newItems);
    }

    std::vector<Item> getItems() const
    {
        std::lock_guard<std::mutex> lock(mutex_);
        return items_;
    }

    bool saveToAttributes(Vst::IAttributeList* attrs) const override;
    bool loadFromAttributes(Vst::IAttributeList* attrs) override;

    OBJ_METHODS(AutomationUpdate, FObject)

private:
    std::vector<Item> items_;
    mutable std::mutex mutex_;
};

#include "SfizzVstUpdates.hpp"