project.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __PROJECT_H__
#define __PROJECT_H__
 
#include "actions/undo_manager.h"
#include "dsp/engine.h"
#include "dsp/midi_mapping.h"
#include "dsp/midi_note.h"
#include "dsp/port.h"
#include "dsp/port_connections_manager.h"
#include "dsp/quantize_options.h"
#include "dsp/region.h"
#include "dsp/region_link_group_manager.h"
#include "dsp/tracklist.h"
#include "gui/backend/audio_selections.h"
#include "gui/backend/automation_selections.h"
#include "gui/backend/chord_selections.h"
#include "gui/backend/clip_editor.h"
#include "gui/backend/midi_arranger_selections.h"
#include "gui/backend/mixer_selections.h"
#include "gui/backend/timeline.h"
#include "gui/backend/timeline_selections.h"
#include "gui/backend/tool.h"
#include "plugins/plugin.h"
#include "zrythm.h"
 
#include <gtk/gtk.h>
 
#include <zix/sem.h>
 
typedef struct Timeline            Timeline;
typedef struct Transport           Transport;
typedef struct Tracklist           Tracklist;
typedef struct TracklistSelections TracklistSelections;
 
#define PROJECT_SCHEMA_VERSION 5
 
#define PROJECT ZRYTHM->project
#define DEFAULT_PROJECT_NAME "Untitled Project"
#define PROJECT_FILE "project.zpj"
#define PROJECT_BACKUPS_DIR "backups"
#define PROJECT_PLUGINS_DIR "plugins"
#define PROJECT_PLUGIN_STATES_DIR "states"
#define PROJECT_PLUGIN_EXT_COPIES_DIR "ext_file_copies"
#define PROJECT_PLUGIN_EXT_LINKS_DIR "ext_file_links"
#define PROJECT_EXPORTS_DIR "exports"
#define PROJECT_STEMS_DIR "stems"
#define PROJECT_POOL_DIR "pool"
#define PROJECT_FINISHED_FILE "FINISHED"
 
typedef enum ProjectPath
{
  PROJECT_PATH_PROJECT_FILE,
  PROJECT_PATH_BACKUPS,
 
  PROJECT_PATH_PLUGINS,
 
  PROJECT_PATH_PLUGIN_STATES,
 
  PROJECT_PATH_PLUGIN_EXT_COPIES,
 
  PROJECT_PATH_PLUGIN_EXT_LINKS,
 
  PROJECT_PATH_EXPORTS,
 
  /* PROJECT_PATH_EXPORTS / "stems". */
  PROJECT_PATH_EXPORTS_STEMS,
 
  PROJECT_PATH_POOL,
 
  PROJECT_PATH_FINISHED_FILE,
} ProjectPath;
 
typedef enum SelectionType
{
  SELECTION_TYPE_TRACKLIST,
 
  SELECTION_TYPE_TIMELINE,
 
  SELECTION_TYPE_INSERT,
 
  SELECTION_TYPE_MIDI_FX,
 
  SELECTION_TYPE_INSTRUMENT,
 
  SELECTION_TYPE_MODULATOR,
 
  SELECTION_TYPE_EDITOR,
} SelectionType;
 
static const cyaml_strval_t selection_type_strings[] = {
  {"Tracklist",   SELECTION_TYPE_TRACKLIST },
  { "Timeline",   SELECTION_TYPE_TIMELINE  },
  { "Insert",     SELECTION_TYPE_INSERT    },
  { "MIDI FX",    SELECTION_TYPE_MIDI_FX   },
  { "Instrument", SELECTION_TYPE_INSTRUMENT},
  { "Modulator",  SELECTION_TYPE_MODULATOR },
  { "Editor",     SELECTION_TYPE_EDITOR    },
};
 
typedef enum ProjectCompressionFlag
{
  PROJECT_COMPRESS_FILE,
  PROJECT_COMPRESS_DATA,
} ProjectCompressionFlag;
 
#define PROJECT_DECOMPRESS_FILE PROJECT_COMPRESS_FILE
#define PROJECT_DECOMPRESS_DATA PROJECT_COMPRESS_DATA
 
typedef struct Project
{
  int schema_version;
 
  char * title;
 
  char * datetime_str;
 
  char * dir;
 
  char * backup_dir;
 
  UndoManager * undo_manager;
 
  Tracklist * tracklist;
 
  ClipEditor * clip_editor;
 
  Timeline * timeline;
 
  SnapGrid * snap_grid_timeline;
 
  SnapGrid * snap_grid_editor;
 
  QuantizeOptions * quantize_opts_timeline;
 
  QuantizeOptions * quantize_opts_editor;
 
  AutomationSelections * automation_selections;
 
  AudioSelections * audio_selections;
 
  ChordSelections * chord_selections;
 
  TimelineSelections * timeline_selections;
 
  MidiArrangerSelections * midi_arranger_selections;
 
  TracklistSelections * tracklist_selections;
 
  MixerSelections * mixer_selections;
 
  double timeline_zoom;
  double piano_roll_zoom;
 
  RegionLinkGroupManager * region_link_group_manager;
 
  PortConnectionsManager * port_connections_manager;
 
  AudioEngine * audio_engine;
 
  MidiMappings * midi_mappings;
 
  Tool tool;
 
  bool loading_from_backup;
 
  bool loaded;
 
  SelectionType last_selection;
 
  char * version;
 
  ZixSem save_sem;
 
  UndoableAction * last_saved_action;
 
  gint64 last_successful_autosave_time;
 
  UndoableAction * last_action_in_last_successful_autosave;
} Project;
 
static const cyaml_schema_field_t project_fields_schema[] = {
  YAML_FIELD_INT (Project, schema_version),
  YAML_FIELD_STRING_PTR (Project, title),
  YAML_FIELD_STRING_PTR (Project, datetime_str),
  YAML_FIELD_STRING_PTR (Project, version),
  YAML_FIELD_MAPPING_PTR (
    Project,
    tracklist,
    tracklist_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    clip_editor,
    clip_editor_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    timeline,
    timeline_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    snap_grid_timeline,
    snap_grid_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    snap_grid_editor,
    snap_grid_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    quantize_opts_timeline,
    quantize_options_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    quantize_opts_editor,
    quantize_options_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    audio_engine,
    engine_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (
    Project,
    mixer_selections,
    mixer_selections_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (
    Project,
    timeline_selections,
    timeline_selections_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (
    Project,
    midi_arranger_selections,
    midi_arranger_selections_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (
    Project,
    chord_selections,
    chord_selections_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (
    Project,
    automation_selections,
    automation_selections_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (
    Project,
    audio_selections,
    audio_selections_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    tracklist_selections,
    tracklist_selections_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    region_link_group_manager,
    region_link_group_manager_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    port_connections_manager,
    port_connections_manager_fields_schema),
  YAML_FIELD_MAPPING_PTR (
    Project,
    midi_mappings,
    midi_mappings_fields_schema),
  YAML_FIELD_MAPPING_PTR_OPTIONAL (
    Project,
    undo_manager,
    undo_manager_fields_schema),
  YAML_FIELD_ENUM (
    Project,
    last_selection,
    selection_type_strings),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t project_schema = {
  YAML_VALUE_PTR (Project, project_fields_schema),
};
 
typedef struct ProjectSaveData
{
  Project * project;
 
  char * project_file_path;
 
  bool is_backup;
 
  bool finished;
 
  bool show_notification;
 
  bool has_error;
 
  ProgressInfo * progress_info;
} ProjectSaveData;
 
ProjectSaveData *
project_save_data_new (void);
 
void
project_save_data_free (ProjectSaveData * self);
 
void
project_validate (Project * self);
 
bool
project_fix_audio_regions (Project * self);
 
ArrangerSelections *
project_get_arranger_selections_for_last_selection (
  Project * self);
 
COLD WARN_UNUSED_RESULT Project *
project_create_default (
  Project *    self,
  const char * prj_dir,
  bool         headless,
  bool         with_engine,
  GError **    error);
 
WARN_UNUSED_RESULT COLD bool
project_load (
  const char * filename,
  const bool   is_template,
  GError **    error);
 
WARN_UNUSED_RESULT bool
project_save (
  Project *    self,
  const char * _dir,
  const bool   is_backup,
  const bool   show_notification,
  const bool   async,
  GError **    error);
 
int
project_autosave_cb (void * data);
 
MALLOC
NONNULL char *
project_get_path (Project * self, ProjectPath path, bool backup);
 
COLD void
project_init_selections (Project * self);
 
bool
_project_compress (
  bool                   compress,
  char **                _dest,
  size_t *               _dest_size,
  ProjectCompressionFlag dest_type,
  const char *           _src,
  const size_t           _src_size,
  ProjectCompressionFlag src_type,
  GError **              error);
 
#define project_compress(a, b, c, d, e, f, error) \
  _project_compress (true, a, b, c, d, e, f, error)
 
#define project_decompress(a, b, c, d, e, f, error) \
  _project_compress (false, a, b, c, d, e, f, error)
 
char *
project_get_existing_yaml (
  Project * self,
  bool      backup,
  GError ** error);
 
NONNULL Project *
project_clone (
  const Project * src,
  bool            for_backup,
  GError **       error);
 
COLD Project *
project_new (Zrythm * zrythm);
 
void
project_free (Project * self);
 
#endif