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  * inheritance pattern, since various types of canvas items (Note (rect), Hit
  47  * (diamond), etc) need to share this functionality but can't share an
  48  * ancestor.
  49  *
  50  * Note: Because of this, derived classes need to manually bounce events to
  51  * on_event, it won't happen automatically.
  52  */
  53
  54 class NoteBase : public sigc::trackable
  55 {
  56   public:
  57         typedef Evoral::Note<ARDOUR::MidiModel::TimeType> 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 ArdourCanvas::Coord x0 () const = 0;
  94         virtual ArdourCanvas::Coord y0 () const = 0;
  95         virtual ArdourCanvas::Coord x1 () const = 0;
  96         virtual ArdourCanvas::Coord y1 () const = 0;
  97
  98         float mouse_x_fraction() const { return _mouse_x_fraction; }
  99         float mouse_y_fraction() const { return _mouse_y_fraction; }
 100
 101         const boost::shared_ptr<NoteType> note() const { return _note; }
 102         MidiRegionView& region_view() const { return _region; }
 103
 104         inline static uint32_t meter_style_fill_color(uint8_t vel, bool selected) {
 105                 if (selected) {
 106                         if (vel < 64) {
 107                                 return UINT_INTERPOLATE(
 108                                         ARDOUR_UI::config()->get_SelectedMidiNoteColorBase(),
 109                                         ARDOUR_UI::config()->get_SelectedMidiNoteColorMid(),
 110                                         (vel / (double)63.0));
 111                         } else {
 112                                 return UINT_INTERPOLATE(
 113                                         ARDOUR_UI::config()->get_SelectedMidiNoteColorMid(),
 114                                         ARDOUR_UI::config()->get_SelectedMidiNoteColorTop(),
 115                                         ((vel-64) / (double)63.0));
 116                         }
 117                 } else {
 118                         if (vel < 64) {
 119                                 return UINT_INTERPOLATE(
 120                                         ARDOUR_UI::config()->get_MidiNoteColorBase(),
 121                                         ARDOUR_UI::config()->get_MidiNoteColorMid(),
 122                                         (vel / (double)63.0));
 123                         } else {
 124                                 return UINT_INTERPOLATE(
 125                                         ARDOUR_UI::config()->get_MidiNoteColorMid(),
 126                                         ARDOUR_UI::config()->get_MidiNoteColorTop(),
 127                                         ((vel-64) / (double)63.0));
 128                         }
 129                 }
 130         }
 131
 132         /// calculate outline colors from fill colors of notes
 133         inline static uint32_t calculate_outline(uint32_t color) {
 134                 return UINT_INTERPOLATE(color, 0x000000ff, 0.5);
 135         }
 136
 137         /// hue circle divided into 16 equal-looking parts, courtesy Thorsten Wilms
 138         static const uint32_t midi_channel_colors[16];
 139
 140         bool mouse_near_ends () const;
 141         virtual bool big_enough_to_trim () const;
 142
 143 protected:
 144         enum State { None, Pressed, Dragging };
 145
 146         MidiRegionView&                   _region;
 147         ArdourCanvas::Item*               _item;
 148         ArdourCanvas::Text*               _text;
 149         State                             _state;
 150         const boost::shared_ptr<NoteType> _note;
 151         bool                              _with_events;
 152         bool                              _own_note;
 153         bool                              _selected;
 154         bool                              _valid;
 155         float                             _mouse_x_fraction;
 156         float                             _mouse_y_fraction;
 157
 158         void set_mouse_fractions (GdkEvent*);
 159
 160 private:
 161         bool event_handler (GdkEvent *);
 162 };
 163
 164 #endif /* __gtk_ardour_note_h__ */