ara.hpp

Go to the documentation of this file.

#pragma once
 
// ARA (Audio Random Access) — minimal document controller stub.
// Full ARA 2.0 support is a large undertaking; this provides the interface
// structure so plugins can declare ARA capability without a full implementation.
//
// ARA allows DAWs to provide the plugin with direct access to audio content,
// enabling features like spectral editing, chord detection, and time-stretching
// without real-time playback.
 
#include <string>
#include <string_view>
#include <cstdint>
#include <vector>
#include <functional>
 
namespace pulp::format {

enum class AraRole {
    None = 0,
    PlaybackRenderer = 1,
    EditorRenderer = 2,
    EditorView = 4
};

class AraDocumentController {
public:
    virtual ~AraDocumentController() = default;

    virtual void begin_editing() {}

    virtual void end_editing() {}

    virtual void notify_audio_source_content_changed(int64_t audio_source_id) {
        (void)audio_source_id;
    }

    virtual int supported_roles() const { return 0; }

    virtual bool is_ara_supported() const { return false; }

    virtual std::string ara_factory_name() const { return ""; }
};

bool host_supports_ara();

bool ara_sdk_compiled_in();

int ara_sdk_generation();

constexpr const char* kClapAraFactoryExtension = "com.celemony.ara/clap-factory-v1";

constexpr const char* kVst3AraFactoryContextKey = "com.celemony.ara/vst3-host-factory-v1";

constexpr const char* kAuAraFactoryPropertyKey = "audioUnitARAFactory";

const void* ara_companion_factory_for(class AraDocumentController* controller);
 
}  // namespace pulp::format