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 __GUI_BACKEND_ARRANGER_SELECTIONS_H__
#define __GUI_BACKEND_ARRANGER_SELECTIONS_H__
 
#include <stdbool.h>
 
#include "utils/yaml.h"
 
typedef struct ArrangerObject ArrangerObject;
typedef struct Position       Position;
typedef struct AudioClip      AudioClip;
typedef struct UndoableAction UndoableAction;
typedef enum ArrangerSelectionsActionEditType
                       ArrangerSelectionsActionEditType;
typedef struct ZRegion ZRegion;
 
#define ARRANGER_SELECTIONS_SCHEMA_VERSION 1
 
#define ARRANGER_SELECTIONS_MAGIC 35867752
#define IS_ARRANGER_SELECTIONS(x) \
  (((ArrangerSelections *) x)->magic \
   == ARRANGER_SELECTIONS_MAGIC)
#define IS_ARRANGER_SELECTIONS_AND_NONNULL(x) \
  (x && IS_ARRANGER_SELECTIONS (x))
#define ARRANGER_SELECTIONS(x) arranger_selections_cast (x)
 
#define ARRANGER_SELECTIONS_DEFAULT_NUDGE_TICKS 0.1
 
typedef enum ArrangerSelectionsType
{
  ARRANGER_SELECTIONS_TYPE_NONE,
  ARRANGER_SELECTIONS_TYPE_CHORD,
  ARRANGER_SELECTIONS_TYPE_TIMELINE,
  ARRANGER_SELECTIONS_TYPE_MIDI,
  ARRANGER_SELECTIONS_TYPE_AUTOMATION,
  ARRANGER_SELECTIONS_TYPE_AUDIO,
} ArrangerSelectionsType;
 
static const cyaml_strval_t arranger_selections_type_strings[] = {
  {"None",        ARRANGER_SELECTIONS_TYPE_NONE      },
  { "Chord",      ARRANGER_SELECTIONS_TYPE_CHORD     },
  { "Timeline",   ARRANGER_SELECTIONS_TYPE_TIMELINE  },
  { "MIDI",       ARRANGER_SELECTIONS_TYPE_MIDI      },
  { "Automation", ARRANGER_SELECTIONS_TYPE_AUTOMATION},
  { "Audio",      ARRANGER_SELECTIONS_TYPE_AUDIO     },
};
 
typedef struct ArrangerSelections
{
  int schema_version;
 
  ArrangerSelectionsType type;
 
  int magic;
} ArrangerSelections;
 
static const cyaml_schema_field_t
  arranger_selections_fields_schema[] = {
    YAML_FIELD_INT (ArrangerSelections, schema_version),
    YAML_FIELD_ENUM (
      ArrangerSelections,
      type,
      arranger_selections_type_strings),
 
    CYAML_FIELD_END
  };
 
static const cyaml_schema_value_t arranger_selections_schema = {
  YAML_VALUE_PTR (
    ArrangerSelections,
    arranger_selections_fields_schema),
};
 
typedef enum ArrangerSelectionsProperty
{
  ARRANGER_SELECTIONS_PROPERTY_HAS_LENGTH,
  ARRANGER_SELECTIONS_PROPERTY_CAN_LOOP,
  ARRANGER_SELECTIONS_PROPERTY_HAS_LOOPED,
  ARRANGER_SELECTIONS_PROPERTY_CAN_FADE,
} ArrangerSelectionsProperty;
 
static inline ArrangerSelections *
arranger_selections_cast (void * sel)
{
  if (!IS_ARRANGER_SELECTIONS ((ArrangerSelections *) sel))
    {
      g_warning ("%s", __func__);
    }
  return (ArrangerSelections *) sel;
}
 
NONNULL_ARGS (1)
void arranger_selections_init_loaded (
  ArrangerSelections * self,
  bool                 project,
  UndoableAction *     action);
 
NONNULL void
arranger_selections_init (
  ArrangerSelections *   self,
  ArrangerSelectionsType type);
 
ArrangerSelections *
arranger_selections_new (ArrangerSelectionsType type);
 
NONNULL bool
arranger_selections_verify (ArrangerSelections * self);
 
NONNULL void
arranger_selections_add_object (
  ArrangerSelections * self,
  ArrangerObject *     obj);
 
NONNULL void
arranger_selections_set_from_selections (
  ArrangerSelections * dest,
  ArrangerSelections * src);
 
NONNULL void
arranger_selections_sort_by_indices (
  ArrangerSelections * sel,
  int                  desc);
 
NONNULL void
arranger_selections_sort_by_positions (
  ArrangerSelections * self,
  int                  desc);
 
NONNULL ArrangerSelections *
arranger_selections_clone (const ArrangerSelections * self);
 
NONNULL bool
arranger_selections_has_any (ArrangerSelections * self);
 
NONNULL void
arranger_selections_get_start_pos (
  const ArrangerSelections * self,
  Position *                 pos,
  const bool                 global);
 
NONNULL void
arranger_selections_get_end_pos (
  ArrangerSelections * self,
  Position *           pos,
  int                  global);
 
NONNULL int
arranger_selections_get_num_objects (
  const ArrangerSelections * self);
 
NONNULL ArrangerObject *
arranger_selections_get_first_object (
  const ArrangerSelections * self);
 
NONNULL ArrangerObject *
arranger_selections_get_last_object (
  const ArrangerSelections * self,
  bool                       ends_last);
 
NONNULL void
arranger_selections_paste_to_pos (
  ArrangerSelections * self,
  Position *           pos,
  bool                 undoable);
 
NONNULL void
arranger_selections_get_all_objects (
  const ArrangerSelections * self,
  GPtrArray *                arr);
 
#if 0
NONNULL
void
arranger_selections_redraw (
  ArrangerSelections * self);
#endif
 
void
arranger_selections_add_to_region (
  ArrangerSelections * self,
  ZRegion *            region,
  bool                 clone);
 
NONNULL void
arranger_selections_add_ticks (
  ArrangerSelections * self,
  const double         ticks);
 
NONNULL bool
arranger_selections_all_on_same_lane (
  ArrangerSelections * self);
 
NONNULL void
arranger_selections_select_all (
  ArrangerSelections * self,
  bool                 fire_events);
 
NONNULL void
arranger_selections_clear (
  ArrangerSelections * self,
  bool                 free,
  bool                 fire_events);
 
NONNULL void
arranger_selections_post_deserialize (
  ArrangerSelections * self);
 
NONNULL bool
arranger_selections_validate (ArrangerSelections * self);
 
NONNULL void
arranger_selections_free_members (ArrangerSelections * self);
 
NONNULL void
arranger_selections_free (ArrangerSelections * self);
 
NONNULL void
arranger_selections_free_full (ArrangerSelections * self);
 
NONNULL int
arranger_selections_contains_object (
  ArrangerSelections * self,
  ArrangerObject *     obj);
 
NONNULL bool
arranger_selections_contains_undeletable_object (
  const ArrangerSelections * self);
 
NONNULL bool
arranger_selections_contains_unclonable_object (
  const ArrangerSelections * self);
 
NONNULL bool
arranger_selections_contains_unrenamable_object (
  const ArrangerSelections * self);
 
NONNULL bool
arranger_selections_contains_object_with_property (
  ArrangerSelections *       self,
  ArrangerSelectionsProperty property,
  bool                       value);
 
NONNULL void
arranger_selections_remove_object (
  ArrangerSelections * self,
  ArrangerObject *     obj);
 
NONNULL void
arranger_selections_merge (ArrangerSelections * self);
 
NONNULL bool
arranger_selections_can_be_pasted (ArrangerSelections * self);
 
NONNULL bool
arranger_selections_contains_looped (
  ArrangerSelections * self);
 
NONNULL bool
arranger_selections_can_be_merged (ArrangerSelections * self);
 
NONNULL double
arranger_selections_get_length_in_ticks (
  ArrangerSelections * self);
 
NONNULL bool
arranger_selections_contains_clip (
  ArrangerSelections * self,
  AudioClip *          clip);
 
NONNULL bool
arranger_selections_can_split_at_pos (
  const ArrangerSelections * self,
  const Position *           pos);
 
NONNULL ArrangerSelections *
arranger_selections_get_for_type (ArrangerSelectionsType type);
 
#endif