gtk2_ardour/note_base.h

   1 /*
   2     Copyright (C) 2007 Paul Davis
   3     Author: David Robillard
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18 */
  19
  20 #ifndef __gtk_ardour_note_base_h__
  21 #define __gtk_ardour_note_base_h__
  22
  23 #include <boost/shared_ptr.hpp>
  24
  25 #include "canvas/types.h"
  26 #include "evoral/types.hpp"
  27
  28 #include "rgb_macros.h"
  29 #include "ardour_ui.h"
  30 #include "ui_config.h"
  31
  32 class Editor;
  33 class MidiRegionView;
  34
  35 namespace Evoral {
  36         template<typename T> class Note;
  37 }
  38
  39 namespace ArdourCanvas {
  40         class Item;
  41         class Text;
  42 }
  43
  44 /** Base class for canvas notes (sustained note rectangles and hit diamonds).
  45  *
  46  * This is not actually a canvas item itself to avoid the dreaded diamond
  47  * inheritance pattern, since various types of canvas items (Note (rect), Hit
  48  * (diamond), etc) need to share this functionality but can't share an
  49  * ancestor.
  50  *
  51  * Note: Because of this, derived classes need to manually bounce events to
  52  * on_event, it won't happen automatically.
  53  */
  54 class NoteBase : public sigc::trackable
  55 {
  56   public:
  57         typedef Evoral::Note<Evoral::Beats> NoteType;
  58
  59         NoteBase (MidiRegionView& region, bool, const boost::shared_ptr<NoteType> note = boost::shared_ptr<NoteType>());
  60         virtual ~NoteBase ();
  61
  62         void set_item (ArdourCanvas::Item *);
  63         ArdourCanvas::Item* item() const { return _item; }
  64
  65         static PBD::Signal1<void, NoteBase*> NoteBaseDeleted;
  66
  67         virtual void show() = 0;
  68         virtual void hide() = 0;
  69
  70         bool valid() const { return _valid; }
  71         void invalidate ();
  72         void validate ();
  73
  74         bool selected() const { return _selected; }
  75         void set_selected(bool yn);
  76
  77         virtual void move_event(double dx, double dy) = 0;
  78
  79         uint32_t base_color();
  80
  81         void show_velocity();
  82         void hide_velocity();
  83
  84         /** Channel changed for this specific event */
  85         void on_channel_change(uint8_t channel);
  86
  87         /** Channel selection changed */
  88         void on_channel_selection_change(uint16_t selection);
  89
  90         virtual void set_outline_color(uint32_t c) = 0;
  91         virtual void set_fill_color(uint32_t c) = 0;
  92
  93         virtual void set_ignore_events(bool ignore) = 0;
  94
  95         virtual ArdourCanvas::Coord x0 () const = 0;
  96         virtual ArdourCanvas::Coord y0 () const = 0;
  97         virtual ArdourCanvas::Coord x1 () const = 0;
  98         virtual ArdourCanvas::Coord y1 () const = 0;
  99
 100         float mouse_x_fraction() const { return _mouse_x_fraction; }
 101         float mouse_y_fraction() const { return _mouse_y_fraction; }
 102
 103         const boost::shared_ptr<NoteType> note() const { return _note; }
 104         MidiRegionView& region_view() const { return _region; }
 105
 106         inline static uint32_t meter_style_fill_color(uint8_t vel, bool selected) {
 107                 if (selected) {
 108                         return ARDOUR_UI::config()->color_mod ("midi note selected", "midi note");
 109                 } else if (vel < 64) {
 110                         return UINT_INTERPOLATE(
 111                                 ARDOUR_UI::config()->color_mod ("midi note min", "midi note"),
 112                                 ARDOUR_UI::config()->color_mod ("midi note mid", "midi note"),
 113                                 (vel / (double)63.0));
 114                 } else {
 115                         return UINT_INTERPOLATE(
 116                                 ARDOUR_UI::config()->color_mod ("midi note mid", "midi note"),
 117                                 ARDOUR_UI::config()->color_mod ("midi note max", "midi note"),
 118                                 ((vel-64) / (double)63.0));
 119                 }
 120         }
 121
 122         /// calculate outline colors from fill colors of notes
 123         inline static uint32_t calculate_outline(uint32_t color, bool selected=false) {
 124                 if (selected) {
 125                         return ARDOUR_UI::config()->color ("midi note selected outline");
 126                 } else {
 127                         return UINT_INTERPOLATE(color, 0x000000ff, 0.5);
 128                 }
 129         }
 130
 131         /// hue circle divided into 16 equal-looking parts, courtesy Thorsten Wilms
 132         static const uint32_t midi_channel_colors[16];
 133
 134         bool mouse_near_ends () const;
 135         virtual bool big_enough_to_trim () const;
 136
 137 protected:
 138         enum State { None, Pressed, Dragging };
 139
 140         MidiRegionView&                   _region;
 141         ArdourCanvas::Item*               _item;
 142         ArdourCanvas::Text*               _text;
 143         State                             _state;
 144         const boost::shared_ptr<NoteType> _note;
 145         bool                              _with_events;
 146         bool                              _own_note;
 147         bool                              _selected;
 148         bool                              _valid;
 149         float                             _mouse_x_fraction;
 150         float                             _mouse_y_fraction;
 151
 152         void set_mouse_fractions (GdkEvent*);
 153
 154 private:
 155         bool event_handler (GdkEvent *);
 156 };
 157
 158 #endif /* __gtk_ardour_note_h__ */