undoable_action.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __UNDO_UNDOABLE_ACTION_H__
#define __UNDO_UNDOABLE_ACTION_H__
 
#include <stdbool.h>
 
#include "utils/types.h"
#include "utils/yaml.h"
 
typedef struct AudioClip              AudioClip;
typedef struct PortConnectionsManager PortConnectionsManager;
 
#define UNDOABLE_ACTION_SCHEMA_VERSION 2
 
typedef enum UndoableActionType
{
  /* ---- Track/Channel ---- */
  UA_TRACKLIST_SELECTIONS,
 
  UA_CHANNEL_SEND,
 
  /* ---- end ---- */
 
  UA_MIXER_SELECTIONS,
  UA_ARRANGER_SELECTIONS,
 
  /* ---- connections ---- */
 
  UA_MIDI_MAPPING,
  UA_PORT_CONNECTION,
  UA_PORT,
 
  /* ---- end ---- */
 
  /* ---- range ---- */
 
  UA_RANGE,
 
  /* ---- end ---- */
 
  UA_TRANSPORT,
 
  UA_CHORD,
 
} UndoableActionType;
 
static const cyaml_strval_t undoable_action_type_strings[] = {
  {"Tracklist selections", UA_TRACKLIST_SELECTIONS},
  { "Channel send",        UA_CHANNEL_SEND        },
  { "Mixer selections",    UA_MIXER_SELECTIONS    },
  { "Arranger selections", UA_ARRANGER_SELECTIONS },
  { "MIDI mapping",        UA_MIDI_MAPPING        },
  { "Port connection",     UA_PORT_CONNECTION     },
  { "Port",                UA_PORT                },
  { "Range",               UA_RANGE               },
  { "Transport",           UA_TRANSPORT           },
  { "Chord",               UA_CHORD               },
};
 
typedef struct UndoableAction
{
  int schema_version;
 
  UndoableActionType type;
 
  double frames_per_tick;
 
  sample_rate_t sample_rate;
 
  int stack_idx;
 
  int num_actions;
} UndoableAction;
 
static const cyaml_schema_field_t undoable_action_fields_schema[] = {
  YAML_FIELD_INT (UndoableAction, schema_version),
  YAML_FIELD_ENUM (
    UndoableAction,
    type,
    undoable_action_type_strings),
  YAML_FIELD_FLOAT (UndoableAction, frames_per_tick),
  YAML_FIELD_INT (UndoableAction, sample_rate),
  YAML_FIELD_INT (UndoableAction, stack_idx),
  YAML_FIELD_INT (UndoableAction, num_actions),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t undoable_action_schema = {
  CYAML_VALUE_MAPPING (
    CYAML_FLAG_POINTER,
    UndoableAction,
    undoable_action_fields_schema),
};
 
NONNULL void
undoable_action_init_loaded (UndoableAction * self);
 
NONNULL void
undoable_action_init (
  UndoableAction *   self,
  UndoableActionType type);
 
NONNULL bool
undoable_action_needs_pause (UndoableAction * self);
 
NONNULL bool
undoable_action_can_contain_clip (UndoableAction * self);
 
NONNULL bool
undoable_action_contains_clip (
  UndoableAction * self,
  AudioClip *      clip);
 
NONNULL void
undoable_action_get_plugins (
  UndoableAction * self,
  GPtrArray *      arr);
 
NONNULL void
undoable_action_set_num_actions (
  UndoableAction * self,
  int              num_actions);
 
NONNULL_ARGS (1)
void undoable_action_save_or_load_port_connections (
  UndoableAction *          self,
  bool                      _do,
  PortConnectionsManager ** before,
  PortConnectionsManager ** after);
 
NONNULL_ARGS (1)
int undoable_action_do (UndoableAction * self, GError ** error);
 
NONNULL_ARGS (1)
int undoable_action_undo (
  UndoableAction * self,
  GError **        error);
 
void
undoable_action_free (UndoableAction * self);
 
NONNULL char *
undoable_action_to_string (UndoableAction * ua);
 
#endif