zrythm.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2024 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __ZRYTHM_H__
#define __ZRYTHM_H__
 
#include "zrythm-config.h"
 
#include <memory>
 
#include <gio/gio.h>
#include <glib.h>
 
#include "ext/juce/juce.h"
#include "zix/sem.h"
 
typedef struct Project                Project;
typedef struct Symap                  Symap;
typedef struct RecordingManager       RecordingManager;
typedef struct EventManager           EventManager;
typedef struct PluginManager          PluginManager;
typedef struct FileManager            FileManager;
typedef struct ChordPresetPackManager ChordPresetPackManager;
class Settings;
typedef struct Log         Log;
typedef struct CairoCaches CairoCaches;
typedef struct PCGRand     PCGRand;
class StringArray;
 
#define ZRYTHM_PROJECTS_DIR "projects"
 
#define MAX_RECENT_PROJECTS 20
#define DEBUGGING (G_UNLIKELY (gZrythm && gZrythm->debug))
#define ZRYTHM_TESTING (g_test_initialized ())
#define ZRYTHM_GENERATING_PROJECT (gZrythm->generating_project)
#define ZRYTHM_HAVE_UI (gZrythm && gZrythm->have_ui_)
 
#ifdef HAVE_LSP_DSP
#  define ZRYTHM_USE_OPTIMIZED_DSP (G_LIKELY (gZrythm->use_optimized_dsp))
#else
#  define ZRYTHM_USE_OPTIMIZED_DSP false
#endif
 
typedef enum ZrythmDirType
{
  /*
   * ----
   * System directories that ship with Zrythm
   * and must not be changed.
   * ----
   */
 
  ZRYTHM_DIR_SYSTEM_PREFIX,
 
  ZRYTHM_DIR_SYSTEM_BINDIR,
 
  ZRYTHM_DIR_SYSTEM_PARENT_DATADIR,
 
  ZRYTHM_DIR_SYSTEM_PARENT_LIBDIR,
 
  ZRYTHM_DIR_SYSTEM_ZRYTHM_LIBDIR,
 
  ZRYTHM_DIR_SYSTEM_BUNDLED_PLUGINSDIR,
 
  ZRYTHM_DIR_SYSTEM_LOCALEDIR,
 
  ZRYTHM_DIR_SYSTEM_SOURCEVIEW_LANGUAGE_SPECS_DIR,
 
  ZRYTHM_DIR_SYSTEM_BUNDLED_SOURCEVIEW_LANGUAGE_SPECS_DIR,
 
  ZRYTHM_DIR_SYSTEM_ZRYTHM_DATADIR,
 
  ZRYTHM_DIR_SYSTEM_SAMPLESDIR,
 
  ZRYTHM_DIR_SYSTEM_SCRIPTSDIR,
 
  ZRYTHM_DIR_SYSTEM_THEMESDIR,
 
  ZRYTHM_DIR_SYSTEM_THEMES_CSS_DIR,
 
  ZRYTHM_DIR_SYSTEM_THEMES_ICONS_DIR,
 
  ZRYTHM_DIR_SYSTEM_SPECIAL_LV2_PLUGINS_DIR,
 
  ZRYTHM_DIR_SYSTEM_FONTSDIR,
 
  ZRYTHM_DIR_SYSTEM_TEMPLATES,
 
  /* ************************************ */
 
  /*
   * ----
   * Zrythm user directories that contain
   * user-modifiable data.
   * ----
   */
 
  ZRYTHM_DIR_USER_TOP,
 
  ZRYTHM_DIR_USER_PROJECTS,
  ZRYTHM_DIR_USER_TEMPLATES,
  ZRYTHM_DIR_USER_THEMES,
 
  ZRYTHM_DIR_USER_THEMES_CSS,
 
  ZRYTHM_DIR_USER_THEMES_ICONS,
 
  ZRYTHM_DIR_USER_SCRIPTS,
 
  ZRYTHM_DIR_USER_LOG,
 
  ZRYTHM_DIR_USER_PROFILING,
 
  ZRYTHM_DIR_USER_GDB,
 
  ZRYTHM_DIR_USER_BACKTRACE,
 
} ZrythmDirType;
typedef enum ZrythmDirType {…};
 
class ZrythmDirectoryManager
{
public:
  char * get_user_dir (bool force_default);
 
  char * get_default_user_dir ();
 
  char * get_dir (ZrythmDirType type);
 
  char * testing_dir = nullptr;
};
class ZrythmDirectoryManager {…};
 
class Zrythm
{
public:
  explicit Zrythm (const char * exe_path, bool have_ui, bool optimized_dsp);
 
  ~Zrythm ();
 
  void init ();
 
  void add_to_recent_projects (const char * filepath);
 
  void remove_recent_project (char * filepath);
 
  static char * get_version (bool with_v);
 
  static bool is_release (bool official);
 
  static char *
  fetch_latest_release_ver_finish (GAsyncResult * result, GError ** error);
 
  static void fetch_latest_release_ver_async (
    GAsyncReadyCallback callback,
    gpointer            callback_data);
 
  static bool is_latest_release (const char * remote_latest_release);
 
  static void
  get_version_with_capabilities (char * buf, bool include_system_info);
 
  static char * get_system_info ();
 
  static char * get_prefix ();
 
  bool init_user_dirs_and_files (GError ** error);
 
  void init_templates ();
 
  const char * exe_path_ = nullptr;
 
  PluginManager * plugin_manager = nullptr;
 
  std::unique_ptr<Settings> settings;
 
  Project * project = nullptr;
 
  std::unique_ptr<StringArray> recent_projects_;
 
  char ** templates = nullptr;
 
  char * demo_template = nullptr;
 
  bool opening_template = false;
 
  bool creating_project = false;
 
  char * create_project_path = nullptr;
 
  char * open_filename = nullptr;
 
  EventManager * event_manager = nullptr;
 
  RecordingManager * recording_manager = nullptr;
 
  FileManager * file_manager = nullptr;
 
  ChordPresetPackManager * chord_preset_pack_manager = nullptr;
 
  std::unique_ptr<ZrythmDirectoryManager> dir_mgr;
 
  Symap * symap = nullptr;
 
  Symap * error_domain_symap = nullptr;
 
  PCGRand * rand = nullptr;
 
  bool debug = false;
 
  bool generating_project = false;
 
  bool have_ui_ = false;
 
  bool use_optimized_dsp = false;
 
  CairoCaches * cairo_caches = nullptr;
 
  int undo_stack_len = 0;
 
  char * version = nullptr;
 
  bool open_newer_backup = false;
 
  bool use_pipewire_in_tests = false;
 
  GPid pipewire_pid = 0;
 
  JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (Zrythm)
};
class Zrythm {…};
 
extern std::unique_ptr<Zrythm> gZrythm;
 
#endif /* __ZRYTHM_H__ */