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 #include "canvas/types.h"
  25 #include "ardour/midi_model.h"
  26
  27 #include "rgb_macros.h"
  28 #include "ardour_ui.h"
  29 #include "ui_config.h"
  30
  31 class Editor;
  32 class MidiRegionView;
  33
  34 namespace Evoral {
  35         template<typename T> class Note;
  36 }
  37
  38 namespace ArdourCanvas {
  39         class Item;
  40         class Text;
  41 }
  42
  43 /** This manages all the event handling for any MIDI event on the canvas.
  44  *
  45  * This is not actually a canvas item itself to avoid the dreaded diamond,
  46  * since various types of canvas items (Note (rect), Hit (diamond), etc)
  47  * need to share this functionality but can't share an ancestor.
  48  *
  49  * Note: Because of this, derived classes need to manually bounce events to
  50  * on_event, it won't happen automatically.
  51  *
  52  * A newer, better canvas should remove the need for all the ugly here.
  53  */
  54 class NoteBase : public sigc::trackable
  55 {
  56 public:
  57         typedef Evoral::Note<ARDOUR::MidiModel::TimeType> NoteType;
  58
  59         NoteBase (
  60                 MidiRegionView&                   region,
  61                 bool,
  62                 const boost::shared_ptr<NoteType> note = boost::shared_ptr<NoteType>()
  63                 );
  64
  65         virtual ~NoteBase ();
  66
  67         void set_item (ArdourCanvas::Item *);
  68
  69         static PBD::Signal1<void, NoteBase*> NoteBaseDeleted;
  70
  71         virtual void show() = 0;
  72         virtual void hide() = 0;
  73
  74         bool valid() const { return _valid; }
  75         void invalidate ();
  76         void validate ();
  77
  78         bool selected() const { return _selected; }
  79         void set_selected(bool yn);
  80
  81         virtual void move_event(double dx, double dy) = 0;
  82
  83         uint32_t base_color();
  84
  85         void show_velocity();
  86         void hide_velocity();
  87
  88         /** Channel changed for this specific event */
  89         void on_channel_change(uint8_t channel);
  90
  91         /** Channel selection changed */
  92         void on_channel_selection_change(uint16_t selection);
  93
  94         virtual void set_outline_color(uint32_t c) = 0;
  95         virtual void set_fill_color(uint32_t c) = 0;
  96
  97         virtual ArdourCanvas::Coord x0 () const = 0;
  98         virtual ArdourCanvas::Coord y0 () const = 0;
  99         virtual ArdourCanvas::Coord x1 () const = 0;
 100         virtual ArdourCanvas::Coord y1 () const = 0;
 101
 102         float mouse_x_fraction() const { return _mouse_x_fraction; }
 103         float mouse_y_fraction() const { return _mouse_y_fraction; }
 104
 105         const boost::shared_ptr<NoteType> note() const { return _note; }
 106         MidiRegionView& region_view() const { return _region; }
 107
 108         inline static uint32_t meter_style_fill_color(uint8_t vel, bool selected) {
 109                 if (selected) {
 110                         if (vel < 64) {
 111                                 return UINT_INTERPOLATE(
 112                                         ARDOUR_UI::config()->get_canvasvar_SelectedMidiNoteColorBase(),
 113                                         ARDOUR_UI::config()->get_canvasvar_SelectedMidiNoteColorMid(),
 114                                         (vel / (double)63.0));
 115                         } else {
 116                                 return UINT_INTERPOLATE(
 117                                         ARDOUR_UI::config()->get_canvasvar_SelectedMidiNoteColorMid(),
 118                                         ARDOUR_UI::config()->get_canvasvar_SelectedMidiNoteColorTop(),
 119                                         ((vel-64) / (double)63.0));
 120                         }
 121                 } else {
 122                         if (vel < 64) {
 123                                 return UINT_INTERPOLATE(
 124                                         ARDOUR_UI::config()->get_canvasvar_MidiNoteColorBase(),
 125                                         ARDOUR_UI::config()->get_canvasvar_MidiNoteColorMid(),
 126                                         (vel / (double)63.0));
 127                         } else {
 128                                 return UINT_INTERPOLATE(
 129                                         ARDOUR_UI::config()->get_canvasvar_MidiNoteColorMid(),
 130                                         ARDOUR_UI::config()->get_canvasvar_MidiNoteColorTop(),
 131                                         ((vel-64) / (double)63.0));
 132                         }
 133                 }
 134         }
 135
 136         /// calculate outline colors from fill colors of notes
 137         inline static uint32_t calculate_outline(uint32_t color) {
 138                 return UINT_INTERPOLATE(color, 0x000000ff, 0.5);
 139         }
 140
 141         /// hue circle divided into 16 equal-looking parts, courtesy Thorsten Wilms
 142         static const uint32_t midi_channel_colors[16];
 143
 144         bool mouse_near_ends () const;
 145         bool big_enough_to_trim () const;
 146
 147 protected:
 148         enum State { None, Pressed, Dragging };
 149
 150         MidiRegionView&                   _region;
 151         ArdourCanvas::Item*               _item;
 152         ArdourCanvas::Text*               _text;
 153         State                             _state;
 154         const boost::shared_ptr<NoteType> _note;
 155         bool                              _with_events;
 156         bool                              _own_note;
 157         bool                              _selected;
 158         bool                              _valid;
 159         float                             _mouse_x_fraction;
 160         float                             _mouse_y_fraction;
 161
 162         void set_mouse_fractions (GdkEvent*);
 163
 164 private:
 165         bool event_handler (GdkEvent *);
 166 };
 167
 168 #endif /* __gtk_ardour_note_h__ */