audio_clock.h

Go to the documentation of this file.

/*
 * Copyright (C) 2005-2006 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2005-2018 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2007 Doug McLain <doug@nostar.net>
 * Copyright (C) 2008-2011 David Robillard <d@drobilla.net>
 * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2012-2017 Robin Gareus <robin@gareus.org>
 * Copyright (C) 2015 Colin Fletcher <colin.m.fletcher@googlemail.com>
 * Copyright (C) 2016-2017 Nick Mainsbridge <mainsbridge@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <map>
#include <vector>
 
#include <pangomm.h>
 
#include <gtkmm/alignment.h>
#include <gtkmm/box.h>
#include <gtkmm/menu.h>
#include <gtkmm/label.h>
 
#include "ardour/ardour.h"
#include "ardour/session_handle.h"
 
#include "gtkmm2ext/cairo_widget.h"
#include "widgets/ardour_button.h"
 
namespace ARDOUR {
        class Session;
}
 
class AudioClock : public CairoWidget, public ARDOUR::SessionHandlePtr
{
public:
        enum Mode {
                Timecode,
                BBT,
                MinSec,
                Seconds,
                Samples
        };
 
        AudioClock (const std::string& clock_name, bool is_transient, const std::string& widget_name,
                    bool editable, bool follows_playhead, bool duration = false, bool with_info = false,
                    bool accept_on_focus_out = false);
        ~AudioClock ();
 
        Mode mode() const { return _mode; }
        void set_off (bool yn);
        bool off() const { return _off; }
        bool on() const { return !_off; }
        void set_widget_name (const std::string& name);
        void set_active_state (Gtkmm2ext::ActiveState s);
        void set_editable (bool yn);
        void set_corner_radius (double);
 
        void focus ();
 
        /* overridden by MainClock */
        virtual void set (Temporal::timepos_t const &, bool force = false, bool round_to_beat = false);
        void set_duration (Temporal::timecnt_t const &, bool force = false);
 
        virtual void set_mode (Mode);
 
        void set_from_playhead ();
        void locate ();
 
        void copy_text_to_clipboard () const;
 
        std::string name() const { return _name; }
 
        Temporal::timepos_t last_when () const { return last_time.position(); }
        Temporal::timecnt_t current_duration (Temporal::timepos_t position = Temporal::timepos_t()) const;
        void set_session (ARDOUR::Session *s);
        void set_negative_allowed (bool yn);
 
        ArdourWidgets::ArdourButton* left_btn () { return &_left_btn; }
        ArdourWidgets::ArdourButton* right_btn () { return &_right_btn; }
 
        void set_scale (double x, double y);
 
        static void print_minsec (samplepos_t, char* buf, size_t bufsize, float sample_rate, int decimals = 3);
 
        sigc::signal<void> ValueChanged;
        sigc::signal<void> mode_changed;
 
        static std::vector<AudioClock*> clocks;
 
protected:
        void render (Cairo::RefPtr<Cairo::Context> const&, cairo_rectangle_t*);
        bool get_is_duration () const { return is_duration; }
 
        virtual void build_ops_menu ();
        Gtk::Menu  *ops_menu;
 
        bool on_button_press_event (GdkEventButton *ev);
        bool on_button_release_event(GdkEventButton *ev);
 
        ArdourWidgets::ArdourButton _left_btn;
        ArdourWidgets::ArdourButton _right_btn;
 
private:
        Mode             _mode;
        std::string      _name;
        bool              is_duration;
        bool              editable;
        bool             _follows_playhead;
        bool             _accept_on_focus_out;
        bool             _off;
        bool             _negative_allowed;
        bool             edit_is_negative;
 
        Temporal::timepos_t _limit_pos;
 
        Glib::RefPtr<Pango::Layout> _layout;
 
        bool         _with_info;
 
        Pango::AttrColor*    editing_attr;
        Pango::AttrColor*    foreground_attr;
 
        Pango::AttrList normal_attributes;
        Pango::AttrList editing_attributes;
 
        int first_height;
        int first_width;
        bool style_resets_first;
        int layout_height;
        int layout_width;
        double corner_radius;
        uint32_t font_size;
 
        enum Field {
                Timecode_Hours = 1,
                Timecode_Minutes,
                Timecode_Seconds,
                Timecode_frames,
                MS_Hours,
                MS_Minutes,
                MS_Seconds,
                MS_Milliseconds,
                Bars,
                Beats,
                Ticks,
                SS_Seconds,
                SS_Deciseconds,
                S_Samples,
        };
 
        Field index_to_field (int index) const;
 
        /* this maps the number of input characters/digits when editing
           to a cursor position. insert_map[N] = index of character/digit
           where the cursor should be after N chars/digits. it is
           mode specific and so it is filled during set_mode().
        */
 
        std::vector<int> insert_map;
 
        bool editing;
        std::string edit_string;
        std::string pre_edit_string;
        std::string input_string;
 
        Temporal::timecnt_t last_time;
 
        bool dragging;
        double drag_start_y;
        double drag_y;
        double drag_accum;
        Field  drag_field;
 
        void on_realize ();
        bool on_key_press_event (GdkEventKey *);
        bool on_key_release_event (GdkEventKey *);
        bool on_scroll_event (GdkEventScroll *ev);
        void on_style_changed (const Glib::RefPtr<Gtk::Style>&);
        void on_size_request (Gtk::Requisition* req);
        bool on_motion_notify_event (GdkEventMotion *ev);
        bool on_focus_out_event (GdkEventFocus*);
        bool on_enter_notify_event (GdkEventCrossing*);
        bool on_leave_notify_event (GdkEventCrossing*);
 
        void set_slave_info ();
        void set_timecode (Temporal::timepos_t const &);
        void set_bbt (Temporal::timecnt_t const &);
        void set_minsec (Temporal::timepos_t const &);
        void set_seconds (Temporal::timepos_t const &);
        void set_samples (Temporal::timepos_t const &);
        void set_out_of_bounds (bool negative);
        void finish_set (Temporal::timepos_t const &, bool);
 
        void set_clock_dimensions (Gtk::Requisition&);
 
        Temporal::timepos_t get_incremental_step (Field, Temporal::timepos_t const & pos = Temporal::timepos_t ());
 
        bool timecode_validate_edit (const std::string&);
        bool bbt_validate_edit (std::string&);
        bool minsec_validate_edit (const std::string&);
 
        samplepos_t samples_from_timecode_string (const std::string&) const;
        samplepos_t samples_from_bbt_string (Temporal::timepos_t const &, const std::string&) const;
        samplepos_t sample_duration_from_bbt_string (Temporal::timepos_t const &, const std::string&) const;
        samplepos_t samples_from_minsec_string (const std::string&) const;
        samplepos_t samples_from_seconds_string (const std::string&) const;
        samplepos_t samples_from_audiosamples_string (const std::string&) const;
 
        void session_configuration_changed (std::string);
        void tempo_map_changed ();
 
        Field index_to_field () const;
 
        void start_edit (Field f = Field (0));
        void end_edit (bool);
        void end_edit_relative (bool);
 
        Temporal::timecnt_t parse_as_distance (const std::string&);
        Temporal::timecnt_t parse_as_timecode_distance (const std::string&);
        Temporal::timecnt_t parse_as_minsec_distance (const std::string&);
        Temporal::timecnt_t parse_as_bbt_distance (const std::string&);
        Temporal::timecnt_t parse_as_seconds_distance (const std::string&);
        Temporal::timecnt_t parse_as_samples_distance (const std::string&);
 
        void set_colors ();
        void show_edit_status (int length);
        int  merge_input_and_edit_string ();
        std::string get_field (Field);
 
        void drop_focus ();
        void dpi_reset ();
 
        double bg_r, bg_g, bg_b, bg_a;
        double cursor_r, cursor_g, cursor_b, cursor_a;
 
        double xscale;
        double yscale;
 
        bool _hovering;
 
        PBD::ScopedConnection tempo_map_connection;
};