tracklist.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2023 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __AUDIO_TRACKLIST_H__
#define __AUDIO_TRACKLIST_H__
 
#include "dsp/engine.h"
#include "dsp/track.h"
#include "gui/widgets/track.h"
 
typedef struct Track                  Track;
typedef struct _TracklistWidget       TracklistWidget;
typedef struct _PinnedTracklistWidget PinnedTracklistWidget;
typedef struct Track                  ChordTrack;
typedef struct SupportedFile          SupportedFile;
TYPEDEF_STRUCT_UNDERSCORED (FileImportInfo);
 
#define TRACKLIST_SCHEMA_VERSION 2
 
#define TRACKLIST (PROJECT->tracklist)
#define MAX_TRACKS 3000
 
#define tracklist_is_in_active_project(self) \
  (self->project == PROJECT \
   || \
   (self->sample_processor \
    && \
    sample_processor_is_in_active_project ( \
      self->sample_processor)))
 
#define tracklist_is_auditioner(self) \
  (self->sample_processor \
   && tracklist_is_in_active_project (self))
 
typedef enum TracklistPinOption
{
  TRACKLIST_PIN_OPTION_PINNED_ONLY,
  TRACKLIST_PIN_OPTION_UNPINNED_ONLY,
  TRACKLIST_PIN_OPTION_BOTH,
} TracklistPinOption;
 
typedef struct Tracklist
{
  int schema_version;
 
  Track * tracks[MAX_TRACKS];
 
  int num_tracks;
 
  Track * chord_track;
 
  Track * marker_track;
 
  Track * tempo_track;
 
  Track * modulator_track;
 
  Track * master_track;
 
  TracklistWidget * widget;
 
  PinnedTracklistWidget * pinned_widget;
 
  int pinned_tracks_cutoff;
 
  bool swapping_tracks;
 
  SampleProcessor * sample_processor;
 
  Project * project;
} Tracklist;
 
static const cyaml_schema_field_t tracklist_fields_schema[] = {
  YAML_FIELD_INT (Tracklist, schema_version),
  YAML_FIELD_FIXED_SIZE_PTR_ARRAY_VAR_COUNT (
    Tracklist,
    tracks,
    track_schema),
  YAML_FIELD_INT (Tracklist, pinned_tracks_cutoff),
 
  CYAML_FIELD_END
};
 
static const cyaml_schema_value_t tracklist_schema = {
  YAML_VALUE_PTR (Tracklist, tracklist_fields_schema),
};
 
COLD NONNULL_ARGS (1) void tracklist_init_loaded (
  Tracklist *       self,
  Project *         project,
  SampleProcessor * sample_processor);
 
COLD Tracklist *
tracklist_new (
  Project *         project,
  SampleProcessor * sample_processor);
 
NONNULL void
tracklist_select_all (
  Tracklist * self,
  bool        select,
  bool        fire_events);
 
void
tracklist_get_visible_tracks (
  Tracklist * self,
  Track **    visible_tracks,
  int *       num_visible);
 
Track *
tracklist_find_track_by_name (
  Tracklist *  self,
  const char * name);
 
NONNULL OPTIMIZE_O3 Track *
tracklist_find_track_by_name_hash (
  Tracklist *  self,
  unsigned int hash);
 
NONNULL int
tracklist_contains_master_track (Tracklist * self);
 
NONNULL int
tracklist_contains_chord_track (Tracklist * self);
 
NONNULL void
tracklist_print_tracks (Tracklist * self);
 
NONNULL void
tracklist_insert_track (
  Tracklist * self,
  Track *     track,
  int         pos,
  int         publish_events,
  int         recalc_graph);
 
NONNULL void
tracklist_remove_track (
  Tracklist * self,
  Track *     track,
  bool        rm_pl,
  bool        free_track,
  bool        publish_events,
  bool        recalc_graph);
 
void
tracklist_move_track (
  Tracklist * self,
  Track *     track,
  int         pos,
  bool        always_before_pos,
  bool        publish_events,
  bool        recalc_graph);
 
void
tracklist_append_track (
  Tracklist * self,
  Track *     track,
  int         publish_events,
  int         recalc_graph);
 
void
tracklist_set_track_pinned (
  Tracklist * self,
  Track *     track,
  const int   pinned,
  int         publish_events,
  int         recalc_graph);
 
NONNULL bool
tracklist_validate (Tracklist * self);
 
NONNULL HOT Track *
tracklist_get_track (Tracklist * self, int idx);
 
int
tracklist_get_track_pos (Tracklist * self, Track * track);
 
Track *
tracklist_get_track_by_type (Tracklist * self, TrackType type);
 
ChordTrack *
tracklist_get_chord_track (const Tracklist * self);
 
Track *
tracklist_get_first_visible_track (
  Tracklist * self,
  const int   pinned);
 
Track *
tracklist_get_prev_visible_track (
  Tracklist * self,
  Track *     track);
 
int
tracklist_get_last_pos (
  Tracklist *              self,
  const TracklistPinOption pin_opt,
  const bool               visible_only);
 
Track *
tracklist_get_last_track (
  Tracklist *              self,
  const TracklistPinOption pin_opt,
  const int                visible_only);
 
Track *
tracklist_get_next_visible_track (
  Tracklist * self,
  Track *     track);
 
Track *
tracklist_get_visible_track_after_delta (
  Tracklist * self,
  Track *     track,
  int         delta);
 
int
tracklist_get_visible_track_diff (
  Tracklist *   self,
  const Track * src,
  const Track * dest);
 
bool
tracklist_multiply_track_heights (
  Tracklist * self,
  double      multiplier,
  bool        visible_only,
  bool        check_only,
  bool        fire_events);
 
bool
tracklist_import_regions (
  GPtrArray *            region_arrays,
  const FileImportInfo * import_info,
  TracksReadyCallback    ready_cb,
  GError **              error);
 
bool
tracklist_import_files (
  Tracklist *           self,
  char **               uri_list,
  const SupportedFile * orig_file,
  Track *               track,
  TrackLane *           lane,
  int                   index,
  const Position *      pos,
  TracksReadyCallback   ready_cb,
  GError **             error);
 
void
tracklist_handle_move_or_copy (
  Tracklist *          self,
  Track *              this_track,
  TrackWidgetHighlight location,
  GdkDragAction        action);
 
bool
tracklist_track_name_is_unique (
  Tracklist *  self,
  const char * name,
  Track *      track_to_skip);
 
NONNULL bool
tracklist_has_soloed (const Tracklist * self);
 
NONNULL bool
tracklist_has_listened (const Tracklist * self);
 
NONNULL int
tracklist_get_num_muted_tracks (const Tracklist * self);
 
NONNULL int
tracklist_get_num_soloed_tracks (const Tracklist * self);
 
NONNULL int
tracklist_get_num_listened_tracks (const Tracklist * self);
 
int
tracklist_get_num_visible_tracks (
  Tracklist * self,
  int         visible);
 
int
tracklist_get_plugins (
  const Tracklist * const self,
  GPtrArray *             arr);
 
void
tracklist_activate_all_plugins (
  Tracklist * self,
  bool        activate);
 
void
tracklist_expose_ports_to_backend (Tracklist * self);
 
void
tracklist_mark_all_tracks_for_bounce (
  Tracklist * self,
  bool        bounce);
 
void
tracklist_get_total_bars (Tracklist * self, int * total_bars);
 
NONNULL void
tracklist_set_caches (Tracklist * self, CacheTypes types);
 
Tracklist *
tracklist_clone (Tracklist * src);
 
void
tracklist_free (Tracklist * self);
 
void
guile_tracklist_define_module (void);
 
#endif