arranger.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: © 2018-2022 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __GUI_WIDGETS_ARRANGER_H__
#define __GUI_WIDGETS_ARRANGER_H__
 
#include "dsp/position.h"
#include "dsp/transport.h"
#include "gui/widgets/main_window.h"
#include "utils/ui.h"
 
#include <gtk/gtk.h>
 
#define ARRANGER_WIDGET_TYPE (arranger_widget_get_type ())
G_DECLARE_FINAL_TYPE (ArrangerWidget, arranger_widget, Z, ARRANGER_WIDGET, GtkWidget)
 
typedef struct _ArrangerBgWidget ArrangerBgWidget;
typedef struct MidiNote          MidiNote;
typedef struct SnapGrid          SnapGrid;
typedef struct AutomationPoint   AutomationPoint;
 
typedef struct _GtkEventControllerMotion GtkEventControllerMotion;
typedef struct ArrangerObject            ArrangerObject;
typedef struct ArrangerSelections        ArrangerSelections;
typedef struct EditorSettings            EditorSettings;
typedef struct ObjectPool                ObjectPool;
typedef struct _RulerWidget              RulerWidget;
typedef enum ArrangerObjectType          ArrangerObjectType;
typedef enum TransportDisplay            TransportDisplay;
 
#define ARRANGER_WIDGET_GET_ACTION(arr, actn) \
  (arr->action == UI_OVERLAY_ACTION_##actn)
 
typedef enum ArrangerCursor
{
  ARRANGER_CURSOR_NONE,
  ARRANGER_CURSOR_SELECT,
  ARRANGER_CURSOR_SELECT_STRETCH,
  ARRANGER_CURSOR_EDIT,
  ARRANGER_CURSOR_AUTOFILL,
  ARRANGER_CURSOR_CUT,
  ARRANGER_CURSOR_ERASER,
  ARRANGER_CURSOR_AUDITION,
  ARRANGER_CURSOR_RAMP,
  ARRANGER_CURSOR_GRAB,
  ARRANGER_CURSOR_GRABBING,
  ARRANGER_CURSOR_RESIZING_L,
  ARRANGER_CURSOR_RESIZING_L_FADE,
  ARRANGER_CURSOR_STRETCHING_L,
  ARRANGER_CURSOR_RESIZING_L_LOOP,
  ARRANGER_CURSOR_RESIZING_R,
  ARRANGER_CURSOR_RESIZING_R_FADE,
  ARRANGER_CURSOR_STRETCHING_R,
  ARRANGER_CURSOR_RESIZING_R_LOOP,
  ARRANGER_CURSOR_RESIZING_UP,
  ARRANGER_CURSOR_RESIZING_UP_FADE_IN,
  ARRANGER_CURSOR_RESIZING_UP_FADE_OUT,
  ARRANGER_CURSOR_GRABBING_COPY,
  ARRANGER_CURSOR_GRABBING_LINK,
  ARRANGER_CURSOR_RANGE,
  ARRANGER_CURSOR_FADE_IN,
  ARRANGER_CURSOR_FADE_OUT,
  ARRANGER_CURSOR_RENAME,
  ARRANGER_CURSOR_PANNING,
} ArrangerCursor;
 
typedef enum ArrangerWidgetType
{
  ARRANGER_WIDGET_TYPE_TIMELINE,
  ARRANGER_WIDGET_TYPE_MIDI,
  ARRANGER_WIDGET_TYPE_MIDI_MODIFIER,
  ARRANGER_WIDGET_TYPE_AUDIO,
  ARRANGER_WIDGET_TYPE_CHORD,
  ARRANGER_WIDGET_TYPE_AUTOMATION,
} ArrangerWidgetType;
 
#if 0
typedef enum ArrangerWidgetHoverType
{
  ARRANGER_WIDGET_HOVER_TYPE_NONE,
  ARRANGER_WIDGET_HOVER_TYPE_TRACK,
  ARRANGER_WIDGET_HOVER_TYPE_TRACK_LANE,
  ARRANGER_WIDGET_HOVER_TYPE_AUTOMATION_TRACK,
} ArrangerWidgetHoverType;
#endif
 
typedef struct _ArrangerWidget
{
  GtkWidget parent_instance;
 
  ArrangerWidgetType type;
 
  GtkGestureDrag *           drag;
  GtkGestureClick *          click;
  GtkGestureClick *          right_click;
  GtkEventControllerMotion * motion_controller;
 
  double last_offset_x;
  double last_offset_y;
 
  double offset_x_from_scroll;
  double offset_y_from_scroll;
 
  UiOverlayAction action;
 
  double start_x;
 
  double start_y;
 
  double start_pos_px;
 
  bool drag_update_started;
 
  bool earliest_obj_exists;
 
  Position earliest_obj_start_pos;
 
  Position fade_pos_at_start;
 
  ArrangerObject * start_object;
 
  ArrangerObject * hovered_object;
 
  int start_object_was_selected;
 
  ArrangerSelections * sel_at_start;
 
  ZRegion * region_at_start;
 
  ArrangerSelections * sel_to_delete;
 
  // Position             earliest_obj_pos;
 
  Position start_pos;
 
  bool was_paused;
 
  Position playhead_pos_at_start;
 
  double curr_ticks_diff_from_start;
 
  double adj_ticks_diff;
 
  double last_adj_ticks_diff;
 
  Position curr_pos;
 
  Position end_pos; 
  gboolean key_is_pressed;
 
  double hover_x;
  double hover_y;
 
  bool hovered;
 
  int n_press;
 
  SnapGrid * snap_grid;
 
  int shift_held;
 
  int ctrl_held;
 
  int alt_held;
 
  gint64 last_frame_time;
 
  /* ----- TIMELINE ------ */
 
  int visible_track_diff;
 
  int lane_diff;
 
  int visible_at_diff;
 
  int is_pinned;
 
  int resizing_range;
 
  int resizing_range_start;
 
  AutomationTrack * hovered_at;
  TrackLane *       hovered_lane;
  Track *           hovered_track;
 
  /* textures used as region icons */
  GdkTexture * symbolic_link_texture;
  GdkTexture * music_note_16th_texture;
  GdkTexture * fork_awesome_snowflake_texture;
  GdkTexture * media_playlist_repeat_texture;
 
  int region_icon_texture_size;
 
  GskRenderNode * loop_line_node;
  GskRenderNode * clip_start_line_node;
  GskRenderNode * cut_line_node;
 
  /* ----- END TIMELINE ----- */
 
  /* ------ MIDI (PIANO ROLL) ---- */
 
  int hovered_note;
 
  /* ------ END MIDI (PIANO ROLL) ---- */
 
  /* ------ MIDI MODIFIER ---- */
 
  int start_vel_val;
 
  int vel_diff;
 
  /* ------ END MIDI MODIFIER ---- */
 
  /* ------- CHORD ------- */
 
  int hovered_chord_index;
 
  /* ------- END CHORD ------- */
 
  /* --- AUDIO --- */
 
  float fval_at_start;
 
  double dval_at_start;
 
  /* --- END AUDIO --- */
 
  int last_playhead_px;
 
  bool redraw;
 
  // cairo_t *      cached_cr;
 
  // cairo_surface_t * cached_surface;
 
  graphene_rect_t last_rect;
 
  bool can_link;
 
  bool is_highlighted;
 
  GdkRectangle highlight_rect;
  // GdkRectangle   prev_highlight_rect;
  //
 
  GdkRectangle last_selection_rect;
 
  guint drag_start_btn;
 
  bool first_draw;
 
  double new_hadj_val;
 
  TransportDisplay ruler_display;
 
  PangoLayout * vel_layout;
 
  PangoLayout * ap_layout;
 
  PangoLayout * audio_layout;
 
  PangoLayout * debug_layout;
 
  int queued_playhead_px;
 
  GPtrArray * hit_objs_to_draw;
 
  GtkPopoverMenu * popover_menu;
} ArrangerWidget;
 
PURE const char *
arranger_widget_get_type_str (ArrangerWidgetType type);
 
bool
arranger_widget_can_scroll_vertically (ArrangerWidget * self);
 
void
arranger_widget_setup (
  ArrangerWidget *   self,
  ArrangerWidgetType type,
  SnapGrid *         snap_grid);
 
void
arranger_widget_set_cursor (ArrangerWidget * self, ArrangerCursor cursor);
 
int
arranger_widget_pos_to_px (ArrangerWidget * self, Position * pos, int use_padding);
 
ArrangerCursor
arranger_widget_get_cursor (ArrangerWidget * self);
 
void
arranger_widget_refresh_cursor (ArrangerWidget * self);
 
void
arranger_widget_get_all_objects (ArrangerWidget * self, GPtrArray * objs_arr);
 
void
arranger_widget_px_to_pos (
  ArrangerWidget * self,
  double           px,
  Position *       pos,
  bool             has_padding);
 
void
arranger_widget_get_visible_rect (ArrangerWidget * self, GdkRectangle * rect);
 
void
arranger_widget_get_hit_objects_at_point (
  ArrangerWidget *   self,
  ArrangerObjectType type,
  double             x,
  double             y,
  GPtrArray *        arr);
 
void
arranger_widget_get_hit_objects_in_rect (
  ArrangerWidget *   self,
  ArrangerObjectType type,
  GdkRectangle *     rect,
  GPtrArray *        arr);
 
ArrangerObject *
arranger_widget_get_hit_arranger_object (
  ArrangerWidget *   self,
  ArrangerObjectType type,
  const double       x,
  const double       y);
 
void
arranger_widget_select_all (ArrangerWidget * self, bool select, bool fire_events);
 
NONNULL PURE bool
arranger_widget_is_in_moving_operation (ArrangerWidget * self);
 
RETURNS_NONNULL
ArrangerSelections *
arranger_widget_get_selections (ArrangerWidget * self);
 
void
arranger_widget_redraw_playhead (ArrangerWidget * self);
 
SnapGrid *
arranger_widget_get_snap_grid (ArrangerWidget * self);
 
gboolean
arranger_widget_on_key_press (
  GtkEventControllerKey * key_controller,
  guint                   keyval,
  guint                   keycode,
  GdkModifierType         state,
  ArrangerWidget *        self);
 
void
arranger_widget_on_key_release (
  GtkEventControllerKey * key_controller,
  guint                   keyval,
  guint                   keycode,
  GdkModifierType         state,
  ArrangerWidget *        self);
 
NONNULL void
arranger_widget_scroll_until_obj (
  ArrangerWidget * self,
  ArrangerObject * obj,
  int              horizontal,
  int              up,
  int              left,
  int              padding);
 
void
arranger_widget_toggle_selections_muted (
  ArrangerWidget * self,
  ArrangerObject * clicked_object);
 
void
arranger_widget_get_min_possible_position (ArrangerWidget * self, Position * pos);
 
void
arranger_widget_set_highlight_rect (ArrangerWidget * self, GdkRectangle * rect);
 
EditorSettings *
arranger_widget_get_editor_settings (ArrangerWidget * self);
 
EditorSettings
arranger_widget_get_editor_setting_values (ArrangerWidget * self);
 
bool
arranger_widget_is_playhead_visible (ArrangerWidget * self);
 
NONNULL void
arranger_widget_handle_playhead_auto_scroll (ArrangerWidget * self, bool force);
 
typedef void (*ArrangerWidgetForeachFunc) (ArrangerWidget * arranger);
 
NONNULL void
arranger_widget_foreach (ArrangerWidgetForeachFunc func);
 
NONNULL PURE RulerWidget *
arranger_widget_get_ruler (ArrangerWidget * self);
 
bool
arranger_widget_any_doing_action (void);
 
int
arranger_widget_get_playhead_px (ArrangerWidget * self);
 
#define arranger_widget_print_action(self) \
  g_debug ("action: %s", ui_overlay_strings[self->action])
 
bool
arranger_widget_get_drum_mode_enabled (ArrangerWidget * self);
 
NONNULL void
arranger_widget_create_item (
  ArrangerWidget * self,
  double           start_x,
  double           start_y,
  bool             autofilling);
 
NONNULL bool
arranger_widget_finish_creating_item_from_action (
  ArrangerWidget * self,
  double           x,
  double           y);
 
int
arranger_widget_get_total_height (ArrangerWidget * self);
 
#endif