track.h

// SPDX-FileCopyrightText: © 2018-2024 Alexandros Theodotou <alex@zrythm.org>
// SPDX-License-Identifier: LicenseRef-ZrythmLicense
 
#ifndef __GUI_WIDGETS_TRACK_H__
#define __GUI_WIDGETS_TRACK_H__
 
#include "common/utils/types.h"
#include "gui/backend/gtk_widgets/gtk_wrapper.h"
 
#define TRACK_WIDGET_TYPE (track_widget_get_type ())
G_DECLARE_FINAL_TYPE (TrackWidget, track_widget, Z, TRACK_WIDGET, GtkWidget)
 
class AutomationModeWidget;
class CustomButtonWidget;
class Track;
class AutomationTrack;
TYPEDEF_STRUCT_UNDERSCORED (ArrangerWidget);
TYPEDEF_STRUCT_UNDERSCORED (MeterWidget);
TYPEDEF_STRUCT_UNDERSCORED (TrackCanvasWidget);
TYPEDEF_STRUCT_UNDERSCORED (FaderButtonsWidget);


constexpr int TRACK_BUTTON_SIZE = 18;

constexpr int TRACK_BUTTON_PADDING = 6;

constexpr int TRACK_BUTTON_PADDING_FROM_EDGE = 3;
 
#define TRACK_BOT_BUTTONS_SHOULD_BE_VISIBLE(height) \
  (height \
   >= (TRACK_BUTTON_SIZE + TRACK_BUTTON_PADDING_FROM_EDGE) * 2 \
        + TRACK_BUTTON_PADDING)
 
constexpr int TRACK_COLOR_AREA_WIDTH = 18;
 
constexpr const char * TRACK_ICON_NAME_MONO_COMPAT = "mono";
constexpr const char * TRACK_ICON_NAME_SWAP_PHASE = "phase";
constexpr const char * TRACK_ICON_NAME_RECORD = "media-record";
constexpr const char * TRACK_ICON_NAME_SOLO = "solo";
constexpr const char * TRACK_ICON_NAME_MUTE = "mute";
constexpr const char * TRACK_ICON_NAME_LISTEN =
  "gnome-icon-library-headphones-symbolic";
constexpr const char * TRACK_ICON_NAME_SHOW_UI = "jam-icons-screen";
constexpr const char * TRACK_ICON_NAME_SHOW_AUTOMATION_LANES = "automation-4p";
constexpr const char * TRACK_ICON_NAME_SHOW_TRACK_LANES = "untitled-ui-rows-03";
constexpr const char * TRACK_ICON_NAME_LOCK =
  "gnome-icon-library-padlock2-symbolic";
constexpr const char * TRACK_ICON_NAME_UNLOCK =
  "gnome-icon-library-padlock2-open-symbolic";
constexpr const char * TRACK_ICON_NAME_FREEZE = "fork-awesome-snowflake-o";
constexpr const char * TRACK_ICON_NAME_PLUS = "add";
constexpr const char * TRACK_ICON_NAME_MINUS = "remove";
constexpr const char * TRACK_ICON_NAME_BUS = "effect";
constexpr const char * TRACK_ICON_NAME_CHORDS = "minuet-chords";
constexpr const char * TRACK_ICON_NAME_SHOW_MARKERS =
  "gnome-icon-library-flag-outline-thick-symbolic";
constexpr const char * TRACK_ICON_NAME_MIDI = "instrument";
constexpr const char * TRACK_ICON_NAME_TEMPO = "filename-bpm-amarok";
constexpr const char * TRACK_ICON_NAME_MODULATOR =
  "gnome-icon-library-encoder-knob-symbolic";
constexpr const char * TRACK_ICON_NAME_FOLD = "fluentui-folder-regular";
constexpr const char * TRACK_ICON_NAME_FOLD_OPEN =
  "fluentui-folder-open-regular";
constexpr const char * TRACK_ICON_NAME_MONITOR_AUDIO = "audition";
 
#define TRACK_ICON_IS(x, name) (x == std::string (TRACK_ICON_NAME_##name))
 
#define TRACK_CB_ICON_IS(name) TRACK_ICON_IS (cb->icon_name, name)

enum class TrackWidgetHighlight
{
  TRACK_WIDGET_HIGHLIGHT_NONE,
  TRACK_WIDGET_HIGHLIGHT_TOP,
  TRACK_WIDGET_HIGHLIGHT_BOTTOM,
  TRACK_WIDGET_HIGHLIGHT_INSIDE,
};

enum class TrackWidgetResizeTarget
{
  TRACK_WIDGET_RESIZE_TARGET_TRACK,
  TRACK_WIDGET_RESIZE_TARGET_AT,
  TRACK_WIDGET_RESIZE_TARGET_LANE,
};

using TrackWidget = struct _TrackWidget
{
  GtkWidget parent_instance;

  GtkBox * main_box;

  GtkBox * group_colors_box;
 
  GtkGestureDrag *  drag;
  GtkGestureClick * click;

  GtkGestureClick * right_click;

  int dragged;

  int n_press;

  bool bg_hovered;

  bool color_area_hovered;

  bool icon_hovered;

  int resize;

  int resizing;

  TrackWidgetResizeTarget resize_target_type;

  void * resize_target;

  Track * track;

  int ctrl_held_at_start;

  GtkBox * highlight_top_box;
  GtkBox * highlight_bot_box;

  TrackWidgetHighlight highlight_loc;

  int selected_in_dnd;

  double start_x;
  double start_y;
  double last_offset_y;

  double last_x;
  double last_y;

  CustomButtonWidget * last_hovered_btn;

  int button_pressed;

  CustomButtonWidget * clicked_button;

  AutomationModeWidget * clicked_am;
 
  TrackCanvasWidget * canvas;

  // gulong              record_toggle_handler_id;
  // gulong              solo_toggled_handler_id;
  // gulong              mute_toggled_handler_id;

  std::vector<std::unique_ptr<CustomButtonWidget>> top_buttons;
  std::vector<std::unique_ptr<CustomButtonWidget>> bot_buttons;
 
  MeterWidget * meter_l;
  MeterWidget * meter_r;

  char * tooltip_text;

  SteadyTimePoint last_midi_out_trigger_time;

  int redraw;

  bool was_armed;

  cairo_t *         cached_cr;
  cairo_surface_t * cached_surface;

  GtkPopoverMenu * popover_menu;

  GtkPopover *         track_name_popover;
  FaderButtonsWidget * fader_buttons_for_popover;
};
 
const char *
track_widget_highlight_to_str (TrackWidgetHighlight highlight);

TrackWidget *
track_widget_new (Track * track);

void
track_widget_set_name (TrackWidget * self, const char * name);

void
track_widget_on_show_automation_toggled (TrackWidget * self);

void
track_widget_on_show_lanes_toggled (TrackWidget * self);

void
track_widget_on_record_toggled (TrackWidget * self);

bool
track_widget_is_cursor_in_range_select_half (TrackWidget * self, double y);

void
track_widget_update_icons (TrackWidget * self);

void
track_widget_update_size (TrackWidget * self);

TrackWidgetHighlight
track_widget_get_highlight_location (TrackWidget * self, int y);

void
track_widget_do_highlight (
  TrackWidget * self,
  gint          x,
  gint          y,
  const int     highlight);

int
track_widget_get_local_y (
  TrackWidget *    self,
  ArrangerWidget * arranger,
  int              arranger_y);

void
track_widget_redraw_meters (TrackWidget * self);

void
track_widget_recreate_group_colors (TrackWidget * self);
 
CustomButtonWidget *
track_widget_get_hovered_button (TrackWidget * self, int x, int y);
 
AutomationModeWidget *
track_widget_get_hovered_am_widget (TrackWidget * self, int x, int y);
 
AutomationTrack *
track_widget_get_at_at_y (TrackWidget * self, double y);

 
#endif