zrythm.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __ZRYTHM_H__
#define __ZRYTHM_H__
 
#include "zrythm-config.h"
 
#include <stdbool.h>
 
#include <glib.h>
 
#include "zix/sem.h"
#include <gio/gio.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;
typedef struct Settings               Settings;
typedef struct Log                    Log;
typedef struct CairoCaches            CairoCaches;
typedef struct PCGRand                PCGRand;
 
#define ZRYTHM (zrythm)
 
#define ZRYTHM_PROJECTS_DIR "projects"
 
#define MAX_RECENT_PROJECTS 20
#define DEBUGGING (G_UNLIKELY (ZRYTHM && ZRYTHM->debug))
#define ZRYTHM_TESTING \
  (G_UNLIKELY (ZRYTHM && ZRYTHM->testing))
#define ZRYTHM_GENERATING_PROJECT (ZRYTHM->generating_project)
#define ZRYTHM_HAVE_UI (ZRYTHM && ZRYTHM->have_ui)
 
#ifdef HAVE_LSP_DSP
#  define ZRYTHM_USE_OPTIMIZED_DSP \
    (G_LIKELY (ZRYTHM->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 struct Zrythm
{
  const char * exe_path;
 
  PluginManager * plugin_manager;
 
  Settings * settings;
 
  Project * project;
 
  char * recent_projects[MAX_RECENT_PROJECTS + 1];
  int    num_recent_projects;
 
  char ** templates;
 
  char * demo_template;
 
  bool opening_template;
 
  bool creating_project;
 
  char * create_project_path;
 
  char * open_filename;
 
  EventManager * event_manager;
 
  RecordingManager * recording_manager;
 
  FileManager * file_manager;
 
  ChordPresetPackManager * chord_preset_pack_manager;
 
  Symap * symap;
 
  Symap * error_domain_symap;
 
  PCGRand * rand;
 
  bool debug;
 
  bool testing;
 
  bool generating_project;
 
  //Log *               log;
 
  double progress;
 
  bool have_ui;
 
  bool use_optimized_dsp;
 
  CairoCaches * cairo_caches;
 
  char * testing_dir;
 
  int undo_stack_len;
 
  char * version;
 
  bool open_newer_backup;
 
  bool use_pipewire_in_tests;
 
  GPid pipewire_pid;
} Zrythm;
 
extern Zrythm * zrythm;
 
void
zrythm_add_to_recent_projects (
  Zrythm *     self,
  const char * filepath);
 
void
zrythm_remove_recent_project (char * filepath);
 
MALLOC
char *
zrythm_get_version (bool with_v);
 
bool
zrythm_is_release (bool official);
 
char *
zrythm_fetch_latest_release_ver_finish (
  GAsyncResult * result,
  GError **      error);
 
void
zrythm_fetch_latest_release_ver_async (
  GAsyncReadyCallback callback,
  gpointer            callback_data);
 
bool
zrythm_is_latest_release (const char * remote_latest_release);
 
void
zrythm_get_version_with_capabilities (
  char * buf,
  bool   include_system_info);
 
char *
zrythm_get_system_info (void);
 
char *
zrythm_get_default_user_dir (void);
 
char *
zrythm_get_dir (ZrythmDirType type);
 
char *
zrythm_get_prefix (void);
 
char *
zrythm_get_user_dir (bool force_default);
 
NONNULL bool
zrythm_init_user_dirs_and_files (
  Zrythm *  self,
  GError ** error);
 
NONNULL void
zrythm_init_templates (Zrythm * self);
 
Zrythm *
zrythm_new (
  const char * exe_path,
  bool         have_ui,
  bool         testing,
  bool         optimized_dsp);
 
void
zrythm_free (Zrythm * self);
 
#endif /* __ZRYTHM_H__ */