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 #include "ardour_button.h"
  38
  39 namespace ARDOUR {
  40         class Session;
  41 }
  42
  43 class AudioClock : public CairoWidget, public ARDOUR::SessionHandlePtr
  44 {
  45         public:
  46         enum Mode {
  47                 Timecode,
  48                 BBT,
  49                 MinSec,
  50                 Frames
  51         };
  52
  53         AudioClock (const std::string& clock_name, bool is_transient, const std::string& widget_name,
  54                     bool editable, bool follows_playhead, bool duration = false, bool with_info = false,
  55                     bool accept_on_focus_out = false);
  56         ~AudioClock ();
  57
  58         Mode mode() const { return _mode; }
  59         void set_off (bool yn);
  60         bool off() const { return _off; }
  61         bool on() const { return !_off; }
  62         void set_widget_name (const std::string& name);
  63         void set_active_state (Gtkmm2ext::ActiveState s);
  64         void set_editable (bool yn);
  65         void set_corner_radius (double);
  66
  67         void focus ();
  68
  69         void set (framepos_t, bool force = false, ARDOUR::framecnt_t offset = 0);
  70         void set_from_playhead ();
  71         void locate ();
  72         void set_mode (Mode, bool noemit = false);
  73         void set_bbt_reference (framepos_t);
  74         void set_is_duration (bool);
  75
  76         void copy_text_to_clipboard () const;
  77
  78         std::string name() const { return _name; }
  79
  80         framepos_t current_time (framepos_t position = 0) const;
  81         framepos_t current_duration (framepos_t position = 0) const;
  82         void set_session (ARDOUR::Session *s);
  83         void set_negative_allowed (bool yn);
  84
  85         ArdourButton* left_btn () { return &_left_btn; }
  86         ArdourButton* right_btn () { return &_right_btn; }
  87
  88         /** Alter cairo scaling during rendering.
  89          *
  90          * Used by clocks that resize themselves
  91          * to fit any given space. Can lead
  92          * to font distortion.
  93          */
  94         void set_scale (double x, double y);
  95
  96         static void print_minsec (framepos_t, char* buf, size_t bufsize, float frame_rate);
  97
  98         sigc::signal<void> ValueChanged;
  99         sigc::signal<void> mode_changed;
 100         sigc::signal<void> ChangeAborted;
 101
 102         static sigc::signal<void> ModeChanged;
 103         static std::vector<AudioClock*> clocks;
 104
 105         protected:
 106         void render (Cairo::RefPtr<Cairo::Context> const&, cairo_rectangle_t*);
 107         bool get_is_duration () const { return is_duration; } ;
 108
 109         virtual void build_ops_menu ();
 110         Gtk::Menu  *ops_menu;
 111
 112         bool on_button_press_event (GdkEventButton *ev);
 113         bool on_button_release_event(GdkEventButton *ev);
 114
 115         ArdourButton _left_btn;
 116         ArdourButton _right_btn;
 117
 118         private:
 119         Mode             _mode;
 120         std::string      _name;
 121         bool              is_transient;
 122         bool              is_duration;
 123         bool              editable;
 124         /** true if this clock follows the playhead, meaning that certain operations are redundant */
 125         bool             _follows_playhead;
 126         bool             _accept_on_focus_out;
 127         bool             _off;
 128         int              em_width;
 129         bool             _edit_by_click_field;
 130         bool             _negative_allowed;
 131         bool             edit_is_negative;
 132
 133         Glib::RefPtr<Pango::Layout> _layout;
 134
 135         bool         _with_info;
 136
 137         Pango::AttrColor*    editing_attr;
 138         Pango::AttrColor*    foreground_attr;
 139
 140         Pango::AttrList normal_attributes;
 141         Pango::AttrList editing_attributes;
 142
 143         int first_height;
 144         int first_width;
 145         bool style_resets_first;
 146         int layout_height;
 147         int layout_width;
 148         double corner_radius;
 149         uint32_t font_size;
 150
 151         static const double info_font_scale_factor;
 152         static const double separator_height;
 153         static const double x_leading_padding;
 154
 155         enum Field {
 156                 Timecode_Hours = 1,
 157                 Timecode_Minutes,
 158                 Timecode_Seconds,
 159                 Timecode_Frames,
 160                 MS_Hours,
 161                 MS_Minutes,
 162                 MS_Seconds,
 163                 MS_Milliseconds,
 164                 Bars,
 165                 Beats,
 166                 Ticks,
 167                 AudioFrames,
 168         };
 169
 170         Field index_to_field (int index) const;
 171
 172         /* this maps the number of input characters/digits when editing
 173            to a cursor position. insert_map[N] = index of character/digit
 174            where the cursor should be after N chars/digits. it is
 175            mode specific and so it is filled during set_mode().
 176         */
 177
 178         std::vector<int> insert_map;
 179
 180         bool editing;
 181         std::string edit_string;
 182         std::string pre_edit_string;
 183         std::string input_string;
 184
 185         framepos_t bbt_reference_time;
 186         framepos_t last_when;
 187         bool last_pdelta;
 188         bool last_sdelta;
 189
 190         bool dragging;
 191         double drag_start_y;
 192         double drag_y;
 193         double drag_accum;
 194         Field  drag_field;
 195
 196         void on_realize ();
 197         bool on_key_press_event (GdkEventKey *);
 198         bool on_key_release_event (GdkEventKey *);
 199         bool on_scroll_event (GdkEventScroll *ev);
 200         void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
 201         void on_size_request (Gtk::Requisition* req);
 202         bool on_motion_notify_event (GdkEventMotion *ev);
 203         bool on_focus_out_event (GdkEventFocus*);
 204
 205         void set_slave_info ();
 206         void set_timecode (framepos_t, bool);
 207         void set_bbt (framepos_t, ARDOUR::framecnt_t, bool);
 208         void set_minsec (framepos_t, bool);
 209         void set_frames (framepos_t, bool);
 210
 211         void set_clock_dimensions (Gtk::Requisition&);
 212
 213         framepos_t get_frame_step (Field, framepos_t pos = 0, int dir = 1);
 214
 215         bool timecode_validate_edit (const std::string&);
 216         bool bbt_validate_edit (const std::string&);
 217         bool minsec_validate_edit (const std::string&);
 218
 219         framepos_t frames_from_timecode_string (const std::string&) const;
 220         framepos_t frames_from_bbt_string (framepos_t, const std::string&) const;
 221         framepos_t frame_duration_from_bbt_string (framepos_t, const std::string&) const;
 222         framepos_t frames_from_minsec_string (const std::string&) const;
 223         framepos_t frames_from_audioframes_string (const std::string&) const;
 224
 225         void session_configuration_changed (std::string);
 226         void session_property_changed (const PBD::PropertyChange&);
 227
 228         Field index_to_field () const;
 229
 230         void start_edit (Field f = Field (0));
 231         void end_edit (bool);
 232         void end_edit_relative (bool);
 233         void edit_next_field ();
 234         ARDOUR::framecnt_t parse_as_distance (const std::string&);
 235
 236         ARDOUR::framecnt_t parse_as_timecode_distance (const std::string&);
 237         ARDOUR::framecnt_t parse_as_minsec_distance (const std::string&);
 238         ARDOUR::framecnt_t parse_as_bbt_distance (const std::string&);
 239         ARDOUR::framecnt_t parse_as_frames_distance (const std::string&);
 240
 241         void set_font (Pango::FontDescription);
 242         void set_colors ();
 243         void show_edit_status (int length);
 244         int  merge_input_and_edit_string ();
 245         std::string get_field (Field);
 246
 247         void drop_focus ();
 248         void dpi_reset ();
 249
 250         double bg_r, bg_g, bg_b, bg_a;
 251         double cursor_r, cursor_g, cursor_b, cursor_a;
 252
 253         double xscale;
 254         double yscale;
 255 };
 256
 257 #endif /* __audio_clock_h__ */