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