gtk2_ardour/audio_clock.h

   1 /*
   2     Copyright (C) 1999 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __audio_clock_h__
  21 #define __audio_clock_h__
  22
  23 #include <map>
  24 #include <vector>
  25
  26 #include <pangomm.h>
  27
  28 #include <gtkmm/alignment.h>
  29 #include <gtkmm/box.h>
  30 #include <gtkmm/menu.h>
  31 #include <gtkmm/label.h>
  32
  33 #include "ardour/ardour.h"
  34 #include "ardour/session_handle.h"
  35
  36 #include "gtkmm2ext/cairo_widget.h"
  37
  38 namespace ARDOUR {
  39         class Session;
  40 }
  41
  42 class AudioClock : public CairoWidget, public ARDOUR::SessionHandlePtr
  43 {
  44   public:
  45         enum Mode {
  46                 Timecode,
  47                 BBT,
  48                 MinSec,
  49                 Frames
  50         };
  51
  52         AudioClock (const std::string& clock_name, bool is_transient, const std::string& widget_name,
  53                     bool editable, bool follows_playhead, bool duration = false, bool with_info = false);
  54         ~AudioClock ();
  55
  56         Mode mode() const { return _mode; }
  57         void set_off (bool yn);
  58         bool off() const { return _off; }
  59         void set_widget_name (const std::string& name);
  60         void set_active_state (Gtkmm2ext::ActiveState s);
  61         void set_editable (bool yn);
  62         void set_corner_radius (double);
  63         void set_fixed_width (bool);
  64
  65         void focus ();
  66
  67         void set (framepos_t, bool force = false, ARDOUR::framecnt_t offset = 0);
  68         void set_from_playhead ();
  69         void locate ();
  70         void set_mode (Mode);
  71         void set_bbt_reference (framepos_t);
  72         void set_is_duration (bool);
  73
  74         std::string name() const { return _name; }
  75
  76         framepos_t current_time (framepos_t position = 0) const;
  77         framepos_t current_duration (framepos_t position = 0) const;
  78         void set_session (ARDOUR::Session *s);
  79
  80         sigc::signal<void> ValueChanged;
  81         sigc::signal<void> mode_changed;
  82         sigc::signal<void> ChangeAborted;
  83
  84         static sigc::signal<void> ModeChanged;
  85         static std::vector<AudioClock*> clocks;
  86
  87   protected:
  88         void render (cairo_t*);
  89
  90         virtual void build_ops_menu ();
  91         Gtk::Menu  *ops_menu;
  92
  93   private:
  94         Mode             _mode;
  95         std::string      _name;
  96         bool              is_transient;
  97         bool              is_duration;
  98         bool              editable;
  99         /** true if this clock follows the playhead, meaning that certain operations are redundant */
 100         bool             _follows_playhead;
 101         bool             _off;
 102         bool             _fixed_width;
 103         int              layout_x_offset;
 104         int              em_width;
 105         bool             _edit_by_click_field;
 106
 107         Glib::RefPtr<Pango::Layout> _layout;
 108         Glib::RefPtr<Pango::Layout> _left_layout;
 109         Glib::RefPtr<Pango::Layout> _right_layout;
 110
 111         Pango::AttrColor*    editing_attr;
 112         Pango::AttrColor*    foreground_attr;
 113
 114         Pango::AttrList normal_attributes;
 115         Pango::AttrList editing_attributes;
 116         Pango::AttrList info_attributes;
 117
 118         int first_height;
 119         int first_width;
 120         int layout_height;
 121         int layout_width;
 122         int info_height;
 123         int upper_height;
 124         double mode_based_info_ratio;
 125         double corner_radius;
 126
 127         static const double info_font_scale_factor;
 128         static const double separator_height;
 129         static const double x_leading_padding;
 130
 131         enum Field {
 132                 Timecode_Hours = 1,
 133                 Timecode_Minutes,
 134                 Timecode_Seconds,
 135                 Timecode_Frames,
 136                 MS_Hours,
 137                 MS_Minutes,
 138                 MS_Seconds,
 139                 MS_Milliseconds,
 140                 Bars,
 141                 Beats,
 142                 Ticks,
 143                 AudioFrames,
 144         };
 145
 146         Field index_to_field (int index) const;
 147
 148         /* this maps the number of input characters/digits when editing
 149            to a cursor position. insert_map[N] = index of character/digit
 150            where the cursor should be after N chars/digits. it is
 151            mode specific and so it is filled during set_mode().
 152         */
 153
 154         std::vector<int> insert_map;
 155
 156         bool editing;
 157         std::string edit_string;
 158         std::string pre_edit_string;
 159         std::string input_string;
 160
 161         framepos_t bbt_reference_time;
 162         framepos_t last_when;
 163         bool last_pdelta;
 164         bool last_sdelta;
 165
 166         bool dragging;
 167         double drag_start_y;
 168         double drag_y;
 169         double drag_accum;
 170         Field  drag_field;
 171
 172         void on_realize ();
 173         bool on_key_press_event (GdkEventKey *);
 174         bool on_key_release_event (GdkEventKey *);
 175         bool on_scroll_event (GdkEventScroll *ev);
 176         bool on_button_press_event (GdkEventButton *ev);
 177         bool on_button_release_event(GdkEventButton *ev);
 178         void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
 179         void on_size_request (Gtk::Requisition* req);
 180         bool on_motion_notify_event (GdkEventMotion *ev);
 181         void on_size_allocate (Gtk::Allocation&);
 182         bool on_focus_out_event (GdkEventFocus*);
 183
 184         void set_timecode (framepos_t, bool);
 185         void set_bbt (framepos_t, bool);
 186         void set_minsec (framepos_t, bool);
 187         void set_frames (framepos_t, bool);
 188
 189         framepos_t get_frame_step (Field, framepos_t pos = 0, int dir = 1);
 190
 191         bool timecode_validate_edit (const std::string&);
 192         bool bbt_validate_edit (const std::string&);
 193         bool minsec_validate_edit (const std::string&);
 194
 195         framepos_t frames_from_timecode_string (const std::string&) const;
 196         framepos_t frames_from_bbt_string (framepos_t, const std::string&) const;
 197         framepos_t frame_duration_from_bbt_string (framepos_t, const std::string&) const;
 198         framepos_t frames_from_minsec_string (const std::string&) const;
 199         framepos_t frames_from_audioframes_string (const std::string&) const;
 200
 201         void session_configuration_changed (std::string);
 202
 203         Field index_to_field () const;
 204
 205         void start_edit (Field f = Field (0));
 206         void end_edit (bool);
 207         void end_edit_relative (bool);
 208         void edit_next_field ();
 209         ARDOUR::framecnt_t parse_as_distance (const std::string&);
 210
 211         ARDOUR::framecnt_t parse_as_timecode_distance (const std::string&);
 212         ARDOUR::framecnt_t parse_as_minsec_distance (const std::string&);
 213         ARDOUR::framecnt_t parse_as_bbt_distance (const std::string&);
 214         ARDOUR::framecnt_t parse_as_frames_distance (const std::string&);
 215
 216         void set_font ();
 217         void set_colors ();
 218         void show_edit_status (int length);
 219         int  merge_input_and_edit_string ();
 220         std::string get_field (Field);
 221
 222         void drop_focus ();
 223         void dpi_reset ();
 224
 225         double bg_r, bg_g, bg_b, bg_a;
 226         double cursor_r, cursor_g, cursor_b, cursor_a;
 227 };
 228
 229 #endif /* __audio_clock_h__ */