CarlaUtils.h

Go to the documentation of this file.

/*
 * Carla Plugin Host
 * Copyright (C) 2011-2022 Filipe Coelho <falktx@falktx.com>
 *
 * 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 2 of
 * the License, or 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.
 *
 * For a full copy of the GNU General Public License see the doc/GPL.txt file.
 */
 
#ifndef CARLA_UTILS_H_INCLUDED
#define CARLA_UTILS_H_INCLUDED
 
#include "CarlaBackend.h"
 
#ifdef __cplusplus
using CARLA_BACKEND_NAMESPACE::PluginCategory;
using CARLA_BACKEND_NAMESPACE::PluginType;
#endif


typedef void* CarlaPipeClientHandle;

typedef void (*CarlaPipeCallbackFunc)(void* ptr, const char* msg);

typedef struct _CarlaCachedPluginInfo {
    bool valid;

    PluginCategory category;

    uint hints;

    uint32_t audioIns;

    uint32_t audioOuts;

    uint32_t cvIns;

    uint32_t cvOuts;

    uint32_t midiIns;

    uint32_t midiOuts;

    uint32_t parameterIns;

    uint32_t parameterOuts;

    const char* name;

    const char* label;

    const char* maker;

    const char* copyright;
 
#ifdef __cplusplus
    CARLA_API _CarlaCachedPluginInfo() noexcept;
    CARLA_DECLARE_NON_COPYABLE(_CarlaCachedPluginInfo)
#endif
 
} CarlaCachedPluginInfo;
 
/* --------------------------------------------------------------------------------------------------------------------
 * cached plugins */

CARLA_PLUGIN_EXPORT uint carla_get_cached_plugin_count(PluginType ptype, const char* pluginPath);

CARLA_PLUGIN_EXPORT const CarlaCachedPluginInfo* carla_get_cached_plugin_info(PluginType ptype, uint index);
 
#ifndef CARLA_HOST_H_INCLUDED
/* --------------------------------------------------------------------------------------------------------------------
 * information */

CARLA_PLUGIN_EXPORT const char* carla_get_complete_license_text(void);

CARLA_PLUGIN_EXPORT const char* carla_get_juce_version(void);

CARLA_PLUGIN_EXPORT const char* const* carla_get_supported_file_extensions(void);

CARLA_PLUGIN_EXPORT const char* const* carla_get_supported_features(void);

CARLA_PLUGIN_EXPORT const char* carla_get_library_filename(void);

CARLA_PLUGIN_EXPORT const char* carla_get_library_folder(void);
#endif
 
/* --------------------------------------------------------------------------------------------------------------------
 * JUCE */

CARLA_PLUGIN_EXPORT void carla_juce_init(void);

CARLA_PLUGIN_EXPORT void carla_juce_idle(void);

CARLA_PLUGIN_EXPORT void carla_juce_cleanup(void);
 
/* --------------------------------------------------------------------------------------------------------------------
 * pipes */

CARLA_PLUGIN_EXPORT CarlaPipeClientHandle carla_pipe_client_new(const char* argv[], CarlaPipeCallbackFunc callbackFunc, void* callbackPtr);

CARLA_PLUGIN_EXPORT void carla_pipe_client_idle(CarlaPipeClientHandle handle);

CARLA_PLUGIN_EXPORT bool carla_pipe_client_is_running(CarlaPipeClientHandle handle);

CARLA_PLUGIN_EXPORT void carla_pipe_client_lock(CarlaPipeClientHandle handle);

CARLA_PLUGIN_EXPORT void carla_pipe_client_unlock(CarlaPipeClientHandle handle);

CARLA_PLUGIN_EXPORT const char* carla_pipe_client_readlineblock(CarlaPipeClientHandle handle, uint timeout);

CARLA_PLUGIN_EXPORT bool carla_pipe_client_readlineblock_bool(CarlaPipeClientHandle handle, uint timeout);
CARLA_PLUGIN_EXPORT int carla_pipe_client_readlineblock_int(CarlaPipeClientHandle handle, uint timeout);
CARLA_PLUGIN_EXPORT double carla_pipe_client_readlineblock_float(CarlaPipeClientHandle handle, uint timeout);

CARLA_PLUGIN_EXPORT bool carla_pipe_client_write_msg(CarlaPipeClientHandle handle, const char* msg);

CARLA_PLUGIN_EXPORT bool carla_pipe_client_write_and_fix_msg(CarlaPipeClientHandle handle, const char* msg);

CARLA_PLUGIN_EXPORT bool carla_pipe_client_flush(CarlaPipeClientHandle handle);

CARLA_PLUGIN_EXPORT bool carla_pipe_client_flush_and_unlock(CarlaPipeClientHandle handle);

CARLA_PLUGIN_EXPORT void carla_pipe_client_destroy(CarlaPipeClientHandle handle);
 
/* --------------------------------------------------------------------------------------------------------------------
 * system stuff */

CARLA_PLUGIN_EXPORT void carla_fflush(bool err);

CARLA_PLUGIN_EXPORT void carla_fputs(bool err, const char* string);

CARLA_PLUGIN_EXPORT void carla_set_process_name(const char* name);
 
/* --------------------------------------------------------------------------------------------------------------------
 * window control */

CARLA_PLUGIN_EXPORT double carla_get_desktop_scale_factor(void);
 
CARLA_PLUGIN_EXPORT int carla_cocoa_get_window(void* nsViewPtr);
CARLA_PLUGIN_EXPORT void carla_cocoa_set_transient_window_for(void* nsViewChild, void* nsViewParent);
 
CARLA_PLUGIN_EXPORT void carla_x11_reparent_window(uintptr_t winId1, uintptr_t winId2);
 
CARLA_PLUGIN_EXPORT void carla_x11_move_window(uintptr_t winId, int x, int y);
 
CARLA_PLUGIN_EXPORT int* carla_x11_get_window_pos(uintptr_t winId);
 
/* ----------------------------------------------------------------------------------------------------------------- */

 
#endif /* CARLA_UTILS_H_INCLUDED */