arranger_selections.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2019-2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __UNDO_ARRANGER_SELECTIONS_ACTION_H__
#define __UNDO_ARRANGER_SELECTIONS_ACTION_H__
 
#include <stdbool.h>
#include <stdint.h>
 
#include "actions/undoable_action.h"
#include "dsp/audio_function.h"
#include "dsp/automation_function.h"
#include "dsp/midi_function.h"
#include "dsp/port_identifier.h"
#include "dsp/position.h"
#include "dsp/quantize_options.h"
#include "gui/backend/audio_selections.h"
#include "gui/backend/automation_selections.h"
#include "gui/backend/chord_selections.h"
#include "gui/backend/midi_arranger_selections.h"
#include "gui/backend/timeline_selections.h"
 
typedef struct ArrangerSelections ArrangerSelections;
typedef struct ArrangerObject     ArrangerObject;
typedef struct Position           Position;
typedef struct QuantizeOptions    QuantizeOptions;
 
typedef enum ArrangerSelectionsActionType
{
  AS_ACTION_AUTOMATION_FILL,
  AS_ACTION_CREATE,
  AS_ACTION_DELETE,
  AS_ACTION_DUPLICATE,
  AS_ACTION_EDIT,
  AS_ACTION_LINK,
  AS_ACTION_MERGE,
  AS_ACTION_MOVE,
  AS_ACTION_QUANTIZE,
  AS_ACTION_RECORD,
  AS_ACTION_RESIZE,
  AS_ACTION_SPLIT,
} ArrangerSelectionsActionType;
 
static const cyaml_strval_t arranger_selections_action_type_strings[] = {
  {"Automation fill", AS_ACTION_AUTOMATION_FILL},
  { "Create",         AS_ACTION_CREATE         },
  { "Delete",         AS_ACTION_DELETE         },
  { "Duplicate",      AS_ACTION_DUPLICATE      },
  { "Edit",           AS_ACTION_EDIT           },
  { "Link",           AS_ACTION_LINK           },
  { "Merge",          AS_ACTION_MERGE          },
  { "Move",           AS_ACTION_MOVE           },
  { "Quantize",       AS_ACTION_QUANTIZE       },
  { "Record",         AS_ACTION_RECORD         },
  { "Resize",         AS_ACTION_RESIZE         },
  { "Split",          AS_ACTION_SPLIT          },
};
 
typedef enum ArrangerSelectionsActionResizeType
{
  ARRANGER_SELECTIONS_ACTION_RESIZE_L,
  ARRANGER_SELECTIONS_ACTION_RESIZE_R,
  ARRANGER_SELECTIONS_ACTION_RESIZE_L_LOOP,
  ARRANGER_SELECTIONS_ACTION_RESIZE_R_LOOP,
  ARRANGER_SELECTIONS_ACTION_RESIZE_L_FADE,
  ARRANGER_SELECTIONS_ACTION_RESIZE_R_FADE,
  ARRANGER_SELECTIONS_ACTION_STRETCH_L,
  ARRANGER_SELECTIONS_ACTION_STRETCH_R,
} ArrangerSelectionsActionResizeType;
 
static const cyaml_strval_t arranger_selections_action_resize_type_strings[] = {
  {"Resize L",         ARRANGER_SELECTIONS_ACTION_RESIZE_L     },
  { "Resize R",        ARRANGER_SELECTIONS_ACTION_RESIZE_R     },
  { "Resize L (loop)", ARRANGER_SELECTIONS_ACTION_RESIZE_L_LOOP},
  { "Resize R (loop)", ARRANGER_SELECTIONS_ACTION_RESIZE_R_LOOP},
  { "Resize L (fade)", ARRANGER_SELECTIONS_ACTION_RESIZE_L_FADE},
  { "Resize R (fade)", ARRANGER_SELECTIONS_ACTION_RESIZE_R_FADE},
  { "Stretch L",       ARRANGER_SELECTIONS_ACTION_STRETCH_L    },
  { "Stretch R",       ARRANGER_SELECTIONS_ACTION_STRETCH_R    },
};
 
typedef enum ArrangerSelectionsActionEditType
{
  ARRANGER_SELECTIONS_ACTION_EDIT_NAME,
 
  ARRANGER_SELECTIONS_ACTION_EDIT_POS,
 
  ARRANGER_SELECTIONS_ACTION_EDIT_PRIMITIVE,
 
  ARRANGER_SELECTIONS_ACTION_EDIT_SCALE,
 
  ARRANGER_SELECTIONS_ACTION_EDIT_FADES,
 
  ARRANGER_SELECTIONS_ACTION_EDIT_MUTE,
 
  // ARRANGER_SELECTIONS_ACTION_EDIT_RAMP,
 
  ARRANGER_SELECTIONS_ACTION_EDIT_EDITOR_FUNCTION,
} ArrangerSelectionsActionEditType;
 
static const cyaml_strval_t arranger_selections_action_edit_type_strings[] = {
  {"Name",             ARRANGER_SELECTIONS_ACTION_EDIT_NAME           },
  { "Pos",             ARRANGER_SELECTIONS_ACTION_EDIT_POS            },
  { "Primitive",       ARRANGER_SELECTIONS_ACTION_EDIT_PRIMITIVE      },
  { "Scale",           ARRANGER_SELECTIONS_ACTION_EDIT_SCALE          },
  { "Fades",           ARRANGER_SELECTIONS_ACTION_EDIT_FADES          },
  { "Mute",            ARRANGER_SELECTIONS_ACTION_EDIT_MUTE           },
  { "Editor function", ARRANGER_SELECTIONS_ACTION_EDIT_EDITOR_FUNCTION},
};
 
typedef struct ArrangerSelectionsAction
{
  UndoableAction parent_instance;
 
  ArrangerSelectionsActionType type;
 
  ArrangerSelections * sel;
 
  ArrangerSelections * sel_after;
 
  ArrangerSelectionsActionEditType edit_type;
 
  ArrangerSelectionsActionResizeType resize_type;
 
  double ticks;
  int delta_tracks;
  int delta_lanes;
  int delta_chords;
  int delta_pitch;
  int delta_vel;
  double delta_normalized_amount;
 
  PortIdentifier * target_port;
 
  char * str;
 
  Position pos;
 
  ArrangerObject * r1[800];
  ArrangerObject * r2[800];
 
  int num_split_objs;
 
  bool first_run;
 
  QuantizeOptions * opts;
 
  /* --- below for serialization only --- */
  ChordSelections *        chord_sel;
  ChordSelections *        chord_sel_after;
  TimelineSelections *     tl_sel;
  TimelineSelections *     tl_sel_after;
  MidiArrangerSelections * ma_sel;
  MidiArrangerSelections * ma_sel_after;
  AutomationSelections *   automation_sel;
  AutomationSelections *   automation_sel_after;
  AudioSelections *        audio_sel;
  AudioSelections *        audio_sel_after;
 
  /* arranger objects that can be split */
  ZRegion *  region_r1[800];
  ZRegion *  region_r2[800];
  MidiNote * mn_r1[800];
  MidiNote * mn_r2[800];
 
  ZRegion * region_before;
  ZRegion * region_after;
 
} ArrangerSelectionsAction;
 
void
arranger_selections_action_init_loaded (ArrangerSelectionsAction * self);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_create_or_delete (
  ArrangerSelections * sel,
  const bool           create,
  GError **            error);
 
#define arranger_selections_action_new_create(sel, error) \
  arranger_selections_action_new_create_or_delete ( \
    (ArrangerSelections *) sel, true, error)
 
#define arranger_selections_action_new_delete(sel, error) \
  arranger_selections_action_new_create_or_delete ( \
    (ArrangerSelections *) sel, false, error)
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_record (
  ArrangerSelections * sel_before,
  ArrangerSelections * sel_after,
  const bool           already_recorded,
  GError **            error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_move_or_duplicate (
  ArrangerSelections *   sel,
  const bool             move,
  const double           ticks,
  const int              delta_chords,
  const int              delta_pitch,
  const int              delta_tracks,
  const int              delta_lanes,
  const double           delta_normalized_amount,
  const PortIdentifier * tgt_port_id,
  const bool             already_moved,
  GError **              error);
 
#define arranger_selections_action_new_move( \
  sel, ticks, chords, pitch, tracks, lanes, norm_amt, port_id, already_moved, \
  error) \
  arranger_selections_action_new_move_or_duplicate ( \
    (ArrangerSelections *) sel, 1, ticks, chords, pitch, tracks, lanes, \
    norm_amt, port_id, already_moved, error)
#define arranger_selections_action_new_duplicate( \
  sel, ticks, chords, pitch, tracks, lanes, norm_amt, port_id, already_moved, \
  error) \
  arranger_selections_action_new_move_or_duplicate ( \
    (ArrangerSelections *) sel, 0, ticks, chords, pitch, tracks, lanes, \
    norm_amt, port_id, already_moved, error)
 
#define arranger_selections_action_new_move_timeline( \
  sel, ticks, delta_tracks, delta_lanes, port_id, already_moved, error) \
  arranger_selections_action_new_move ( \
    sel, ticks, 0, 0, delta_tracks, delta_lanes, 0, port_id, already_moved, \
    error)
#define arranger_selections_action_new_duplicate_timeline( \
  sel, ticks, delta_tracks, delta_lanes, port_id, already_moved, error) \
  arranger_selections_action_new_duplicate ( \
    sel, ticks, 0, 0, delta_tracks, delta_lanes, 0, port_id, already_moved, \
    error)
 
#define arranger_selections_action_new_move_midi( \
  sel, ticks, delta_pitch, already_moved, error) \
  arranger_selections_action_new_move ( \
    sel, ticks, 0, delta_pitch, 0, 0, 0, NULL, already_moved, error)
#define arranger_selections_action_new_duplicate_midi( \
  sel, ticks, delta_pitch, already_moved, error) \
  arranger_selections_action_new_duplicate ( \
    sel, ticks, 0, delta_pitch, 0, 0, 0, NULL, already_moved, error)
#define arranger_selections_action_new_move_chord( \
  sel, ticks, delta_chords, already_moved, error) \
  arranger_selections_action_new_move ( \
    sel, ticks, delta_chords, 0, 0, 0, 0, NULL, already_moved, error)
#define arranger_selections_action_new_duplicate_chord( \
  sel, ticks, delta_chords, already_moved, error) \
  arranger_selections_action_new_duplicate ( \
    sel, ticks, delta_chords, 0, 0, 0, 0, NULL, already_moved, error)
 
#define arranger_selections_action_new_move_automation( \
  sel, ticks, norm_amt, already_moved, error) \
  arranger_selections_action_new_move ( \
    sel, ticks, 0, 0, 0, 0, norm_amt, NULL, already_moved, error)
#define arranger_selections_action_new_duplicate_automation( \
  sel, ticks, norm_amt, already_moved, error) \
  arranger_selections_action_new_duplicate ( \
    sel, ticks, 0, 0, 0, 0, norm_amt, NULL, already_moved, error)
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_link (
  ArrangerSelections * sel_before,
  ArrangerSelections * sel_after,
  const double         ticks,
  const int            delta_tracks,
  const int            delta_lanes,
  const bool           already_moved,
  GError **            error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_edit (
  ArrangerSelections *             sel_before,
  ArrangerSelections *             sel_after,
  ArrangerSelectionsActionEditType type,
  bool                             already_edited,
  GError **                        error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_edit_single_obj (
  const ArrangerObject *           obj_before,
  const ArrangerObject *           obj_after,
  ArrangerSelectionsActionEditType type,
  bool                             already_edited,
  GError **                        error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_edit_midi_function (
  ArrangerSelections * sel_before,
  MidiFunctionType     midi_func_type,
  MidiFunctionOpts     opts,
  GError **            error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_edit_automation_function (
  ArrangerSelections *   sel_before,
  AutomationFunctionType automation_func_type,
  GError **              error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_edit_audio_function (
  ArrangerSelections * sel_before,
  AudioFunctionType    audio_func_type,
  AudioFunctionOpts    opts,
  const char *         uri,
  GError **            error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_automation_fill (
  ZRegion * region_before,
  ZRegion * region_after,
  bool      already_changed,
  GError ** error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_split (
  ArrangerSelections * sel,
  const Position *     pos,
  GError **            error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_merge (ArrangerSelections * sel, GError ** error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_resize (
  ArrangerSelections *               sel_before,
  ArrangerSelections *               sel_after,
  ArrangerSelectionsActionResizeType type,
  const double                       ticks,
  GError **                          error);
 
WARN_UNUSED_RESULT UndoableAction *
arranger_selections_action_new_quantize (
  ArrangerSelections * sel,
  QuantizeOptions *    opts,
  GError **            error);
 
NONNULL ArrangerSelectionsAction *
arranger_selections_action_clone (const ArrangerSelectionsAction * src);
 
bool
arranger_selections_action_perform_create_or_delete (
  ArrangerSelections * sel,
  const bool           create,
  GError **            error);
 
#define arranger_selections_action_perform_create(sel, error) \
  arranger_selections_action_perform_create_or_delete ( \
    (ArrangerSelections *) sel, true, error)
 
#define arranger_selections_action_perform_delete(sel, error) \
  arranger_selections_action_perform_create_or_delete ( \
    (ArrangerSelections *) sel, false, error)
 
bool
arranger_selections_action_perform_record (
  ArrangerSelections * sel_before,
  ArrangerSelections * sel_after,
  const bool           already_recorded,
  GError **            error);
 
bool
arranger_selections_action_perform_move_or_duplicate (
  ArrangerSelections *   sel,
  const bool             move,
  const double           ticks,
  const int              delta_chords,
  const int              delta_pitch,
  const int              delta_tracks,
  const int              delta_lanes,
  const double           delta_normalized_amount,
  const PortIdentifier * port_id,
  const bool             already_moved,
  GError **              error);
 
#define arranger_selections_action_perform_move( \
  sel, ticks, chords, pitch, tracks, lanes, norm_amt, port_id, already_moved, \
  error) \
  arranger_selections_action_perform_move_or_duplicate ( \
    (ArrangerSelections *) sel, 1, ticks, chords, pitch, tracks, lanes, \
    norm_amt, port_id, already_moved, error)
#define arranger_selections_action_perform_duplicate( \
  sel, ticks, chords, pitch, tracks, lanes, norm_amt, port_id, already_moved, \
  error) \
  arranger_selections_action_perform_move_or_duplicate ( \
    (ArrangerSelections *) sel, 0, ticks, chords, pitch, tracks, lanes, \
    norm_amt, port_id, already_moved, error)
 
#define arranger_selections_action_perform_move_timeline( \
  sel, ticks, delta_tracks, delta_lanes, port_id, already_moved, error) \
  arranger_selections_action_perform_move ( \
    sel, ticks, 0, 0, delta_tracks, delta_lanes, 0, port_id, already_moved, \
    error)
#define arranger_selections_action_perform_duplicate_timeline( \
  sel, ticks, delta_tracks, delta_lanes, port_id, already_moved, error) \
  arranger_selections_action_perform_duplicate ( \
    sel, ticks, 0, 0, delta_tracks, delta_lanes, 0, port_id, already_moved, \
    error)
 
#define arranger_selections_action_perform_move_midi( \
  sel, ticks, delta_pitch, already_moved, error) \
  arranger_selections_action_perform_move ( \
    sel, ticks, 0, delta_pitch, 0, 0, 0, NULL, already_moved, error)
#define arranger_selections_action_perform_duplicate_midi( \
  sel, ticks, delta_pitch, already_moved, error) \
  arranger_selections_action_perform_duplicate ( \
    sel, ticks, 0, delta_pitch, 0, 0, 0, NULL, already_moved, error)
#define arranger_selections_action_perform_move_chord( \
  sel, ticks, delta_chords, already_moved, error) \
  arranger_selections_action_perform_move ( \
    sel, ticks, delta_chords, 0, 0, 0, 0, NULL, already_moved, error)
#define arranger_selections_action_perform_duplicate_chord( \
  sel, ticks, delta_chords, already_moved, error) \
  arranger_selections_action_perform_duplicate ( \
    sel, ticks, delta_chords, 0, 0, 0, 0, NULL, already_moved, error)
 
#define arranger_selections_action_perform_move_automation( \
  sel, ticks, norm_amt, already_moved, error) \
  arranger_selections_action_perform_move ( \
    sel, ticks, 0, 0, 0, 0, norm_amt, NULL, already_moved, error)
#define arranger_selections_action_perform_duplicate_automation( \
  sel, ticks, norm_amt, already_moved, error) \
  arranger_selections_action_perform_duplicate ( \
    sel, ticks, 0, 0, 0, 0, norm_amt, NULL, already_moved, error)
 
bool
arranger_selections_action_perform_link (
  ArrangerSelections * sel_before,
  ArrangerSelections * sel_after,
  const double         ticks,
  const int            delta_tracks,
  const int            delta_lanes,
  const bool           already_moved,
  GError **            error);
 
bool
arranger_selections_action_perform_edit (
  ArrangerSelections *             sel_before,
  ArrangerSelections *             sel_after,
  ArrangerSelectionsActionEditType type,
  bool                             already_edited,
  GError **                        error);
 
bool
arranger_selections_action_perform_edit_single_obj (
  const ArrangerObject *           obj_before,
  const ArrangerObject *           obj_after,
  ArrangerSelectionsActionEditType type,
  bool                             already_edited,
  GError **                        error);
 
bool
arranger_selections_action_perform_edit_midi_function (
  ArrangerSelections * sel_before,
  MidiFunctionType     midi_func_type,
  MidiFunctionOpts     opts,
  GError **            error);
 
bool
arranger_selections_action_perform_edit_automation_function (
  ArrangerSelections *   sel_before,
  AutomationFunctionType automation_func_type,
  GError **              error);
 
bool
arranger_selections_action_perform_edit_audio_function (
  ArrangerSelections * sel_before,
  AudioFunctionType    audio_func_type,
  AudioFunctionOpts    opts,
  const char *         uri,
  GError **            error);
 
bool
arranger_selections_action_perform_automation_fill (
  ZRegion * region_before,
  ZRegion * region_after,
  bool      already_changed,
  GError ** error);
 
bool
arranger_selections_action_perform_split (
  ArrangerSelections * sel,
  const Position *     pos,
  GError **            error);
 
bool
arranger_selections_action_perform_merge (
  ArrangerSelections * sel,
  GError **            error);
 
bool
arranger_selections_action_perform_resize (
  ArrangerSelections *               sel_before,
  ArrangerSelections *               sel_after,
  ArrangerSelectionsActionResizeType type,
  const double                       ticks,
  GError **                          error);
 
bool
arranger_selections_action_perform_quantize (
  ArrangerSelections * sel,
  QuantizeOptions *    opts,
  GError **            error);
 
int
arranger_selections_action_do (ArrangerSelectionsAction * self, GError ** error);
 
int
arranger_selections_action_undo (
  ArrangerSelectionsAction * self,
  GError **                  error);
 
char *
arranger_selections_action_stringize (ArrangerSelectionsAction * self);
 
bool
arranger_selections_action_contains_clip (
  ArrangerSelectionsAction * self,
  AudioClip *                clip);
 
void
arranger_selections_action_free (ArrangerSelectionsAction * self);
 
#endif