2 * Copyright (c) 2007, 2008 Edward Tomasz Napiera�ła <trasz@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * This is piano_keyboard, piano keyboard-like GTK+ widget. It contains
29 * no MIDI-specific code.
31 * For questions and comments, contact Edward Tomasz Napierala <trasz@FreeBSD.org>.
37 #include <cairo/cairo.h>
40 #include <gdk/gdkkeysyms.h>
42 #include "gtk_pianokeyboard.h"
44 #define PIANO_KEYBOARD_DEFAULT_WIDTH 730
45 #define PIANO_KEYBOARD_DEFAULT_HEIGHT 70
54 static guint piano_keyboard_signals[LAST_SIGNAL] = { 0 };
57 draw_keyboard_cue(PianoKeyboard *pk, cairo_t* cr)
59 int w = pk->notes[0].w;
60 int h = pk->notes[0].h;
62 int first_note_in_lower_row = (pk->octave + 5) * 12;
63 int last_note_in_lower_row = (pk->octave + 6) * 12 - 1;
64 int first_note_in_higher_row = (pk->octave + 6) * 12;
65 int last_note_in_higher_row = (pk->octave + 7) * 12 + 4;
67 cairo_set_source_rgb (cr, 1.0f, 0.0f, 0.0f);
68 cairo_move_to (cr, pk->notes[first_note_in_lower_row].x + 3, h - 6);
69 cairo_line_to (cr, pk->notes[last_note_in_lower_row].x + w - 3, h - 6);
72 cairo_set_source_rgb (cr, 0.0f, 0.0f, 1.0f);
73 cairo_move_to (cr, pk->notes[first_note_in_higher_row].x + 3, h - 9);
74 cairo_line_to (cr, pk->notes[last_note_in_higher_row].x + w - 3, h - 9);
79 queue_note_draw (PianoKeyboard* pk, int note)
81 GdkWindow* w = GTK_WIDGET(pk)->window;
86 r.x = pk->notes[note].x;
88 r.width = pk->notes[note].w;
89 r.height = pk->notes[note].h;
91 gdk_window_invalidate_rect (w, &r, TRUE);
96 draw_note(PianoKeyboard *pk, cairo_t* cr, int note)
98 int is_white = pk->notes[note].white;
100 int x = pk->notes[note].x;
101 int w = pk->notes[note].w;
102 int h = pk->notes[note].h;
104 if (pk->notes[note].pressed || pk->notes[note].sustained) {
106 cairo_set_source_rgb (cr, 0.60f, 0.60f, 0.60f);
108 cairo_set_source_rgb (cr, 0.50f, 0.50f, 0.50f);
112 cairo_set_source_rgb (cr, 1.0f, 1.0f, 1.0f);
114 cairo_set_source_rgb (cr, 0.0f, 0.0f, 0.0f);
118 cairo_set_line_width (cr, 1.0);
120 cairo_rectangle (cr, x, 0, w, h);
123 cairo_set_source_rgb(cr, 0.0f, 0.0f, 0.0f); /* black outline */
124 cairo_rectangle (cr, x, 0, w, h);
127 if (pk->enable_keyboard_cue) {
128 draw_keyboard_cue (pk, cr);
131 /* We need to redraw black keys that partially obscure the white one. */
132 if (note < NNOTES - 2 && !pk->notes[note + 1].white) {
133 draw_note(pk, cr, note + 1);
136 if (note > 0 && !pk->notes[note - 1].white) {
137 draw_note(pk, cr, note - 1);
142 press_key(PianoKeyboard *pk, int key)
145 assert(key < NNOTES);
147 pk->maybe_stop_sustained_notes = 0;
149 /* This is for keyboard autorepeat protection. */
150 if (pk->notes[key].pressed)
153 if (pk->sustain_new_notes)
154 pk->notes[key].sustained = 1;
156 pk->notes[key].sustained = 0;
158 pk->notes[key].pressed = 1;
160 g_signal_emit_by_name(GTK_WIDGET(pk), "note-on", key);
161 queue_note_draw(pk, key);
167 release_key(PianoKeyboard *pk, int key)
170 assert(key < NNOTES);
172 pk->maybe_stop_sustained_notes = 0;
174 if (!pk->notes[key].pressed)
177 if (pk->sustain_new_notes)
178 pk->notes[key].sustained = 1;
180 pk->notes[key].pressed = 0;
182 if (pk->notes[key].sustained)
185 g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", key);
186 queue_note_draw(pk, key);
192 rest (PianoKeyboard* pk)
194 g_signal_emit_by_name(GTK_WIDGET(pk), "rest");
198 stop_unsustained_notes(PianoKeyboard *pk)
202 for (i = 0; i < NNOTES; i++) {
203 if (pk->notes[i].pressed && !pk->notes[i].sustained) {
204 pk->notes[i].pressed = 0;
205 g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", i);
206 queue_note_draw(pk, i);
212 stop_sustained_notes(PianoKeyboard *pk)
216 for (i = 0; i < NNOTES; i++) {
217 if (pk->notes[i].sustained) {
218 pk->notes[i].pressed = 0;
219 pk->notes[i].sustained = 0;
220 g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", i);
221 queue_note_draw(pk, i);
227 key_binding(PianoKeyboard *pk, const char *key)
229 gpointer notused, note;
232 assert(pk->key_bindings != NULL);
234 found = g_hash_table_lookup_extended(pk->key_bindings, key, ¬used, ¬e);
239 return (intptr_t)note;
243 bind_key(PianoKeyboard *pk, const char *key, int note)
245 assert(pk->key_bindings != NULL);
247 g_hash_table_insert(pk->key_bindings, (const gpointer)key, (gpointer)((intptr_t)note));
251 clear_notes(PianoKeyboard *pk)
253 assert(pk->key_bindings != NULL);
255 g_hash_table_remove_all(pk->key_bindings);
259 bind_keys_qwerty(PianoKeyboard *pk)
263 bind_key(pk, "space", 128);
265 /* Lower keyboard row - "zxcvbnm". */
266 bind_key(pk, "z", 12); /* C0 */
267 bind_key(pk, "s", 13);
268 bind_key(pk, "x", 14);
269 bind_key(pk, "d", 15);
270 bind_key(pk, "c", 16);
271 bind_key(pk, "v", 17);
272 bind_key(pk, "g", 18);
273 bind_key(pk, "b", 19);
274 bind_key(pk, "h", 20);
275 bind_key(pk, "n", 21);
276 bind_key(pk, "j", 22);
277 bind_key(pk, "m", 23);
279 /* Upper keyboard row, first octave - "qwertyu". */
280 bind_key(pk, "q", 24);
281 bind_key(pk, "2", 25);
282 bind_key(pk, "w", 26);
283 bind_key(pk, "3", 27);
284 bind_key(pk, "e", 28);
285 bind_key(pk, "r", 29);
286 bind_key(pk, "5", 30);
287 bind_key(pk, "t", 31);
288 bind_key(pk, "6", 32);
289 bind_key(pk, "y", 33);
290 bind_key(pk, "7", 34);
291 bind_key(pk, "u", 35);
293 /* Upper keyboard row, the rest - "iop". */
294 bind_key(pk, "i", 36);
295 bind_key(pk, "9", 37);
296 bind_key(pk, "o", 38);
297 bind_key(pk, "0", 39);
298 bind_key(pk, "p", 40);
302 bind_keys_qwertz(PianoKeyboard *pk)
304 bind_keys_qwerty(pk);
306 /* The only difference between QWERTY and QWERTZ is that the "y" and "z" are swapped together. */
307 bind_key(pk, "y", 12);
308 bind_key(pk, "z", 33);
312 bind_keys_azerty(PianoKeyboard *pk)
316 bind_key(pk, "space", 128);
318 /* Lower keyboard row - "wxcvbn,". */
319 bind_key(pk, "w", 12); /* C0 */
320 bind_key(pk, "s", 13);
321 bind_key(pk, "x", 14);
322 bind_key(pk, "d", 15);
323 bind_key(pk, "c", 16);
324 bind_key(pk, "v", 17);
325 bind_key(pk, "g", 18);
326 bind_key(pk, "b", 19);
327 bind_key(pk, "h", 20);
328 bind_key(pk, "n", 21);
329 bind_key(pk, "j", 22);
330 bind_key(pk, "comma", 23);
332 /* Upper keyboard row, first octave - "azertyu". */
333 bind_key(pk, "a", 24);
334 bind_key(pk, "eacute", 25);
335 bind_key(pk, "z", 26);
336 bind_key(pk, "quotedbl", 27);
337 bind_key(pk, "e", 28);
338 bind_key(pk, "r", 29);
339 bind_key(pk, "parenleft", 30);
340 bind_key(pk, "t", 31);
341 bind_key(pk, "minus", 32);
342 bind_key(pk, "y", 33);
343 bind_key(pk, "egrave", 34);
344 bind_key(pk, "u", 35);
346 /* Upper keyboard row, the rest - "iop". */
347 bind_key(pk, "i", 36);
348 bind_key(pk, "ccedilla", 37);
349 bind_key(pk, "o", 38);
350 bind_key(pk, "agrave", 39);
351 bind_key(pk, "p", 40);
355 keyboard_event_handler(GtkWidget *mk, GdkEventKey *event, gpointer ignored)
361 PianoKeyboard *pk = PIANO_KEYBOARD(mk);
365 /* We're not using event->keyval, because we need keyval with level set to 0.
366 E.g. if user holds Shift and presses '7', we want to get a '7', not '&'. */
367 kk.keycode = event->hardware_keycode;
371 keyval = gdk_keymap_lookup_key(NULL, &kk);
373 key = gdk_keyval_name(gdk_keyval_to_lower(keyval));
376 g_message("gtk_keyval_name() returned NULL; please report this.");
380 note = key_binding(pk, key);
383 /* Key was not bound. Maybe it's one of the keys handled in jack-keyboard.c. */
388 if (event->type == GDK_KEY_RELEASE) {
395 note += pk->octave * 12;
398 assert(note < NNOTES);
400 if (event->type == GDK_KEY_PRESS) {
403 } else if (event->type == GDK_KEY_RELEASE) {
404 release_key(pk, note);
411 get_note_for_xy(PianoKeyboard *pk, int x, int y)
413 int height = GTK_WIDGET(pk)->allocation.height;
416 if (y <= height / 2) {
417 for (note = 0; note < NNOTES - 1; note++) {
418 if (pk->notes[note].white)
421 if (x >= pk->notes[note].x && x <= pk->notes[note].x + pk->notes[note].w)
426 for (note = 0; note < NNOTES - 1; note++) {
427 if (!pk->notes[note].white)
430 if (x >= pk->notes[note].x && x <= pk->notes[note].x + pk->notes[note].w)
438 mouse_button_event_handler(PianoKeyboard *pk, GdkEventButton *event, gpointer ignored)
443 int note = get_note_for_xy(pk, x, y);
447 if (event->button != 1)
450 if (event->type == GDK_BUTTON_PRESS) {
451 /* This is possible when you make the window a little wider and then click
457 if (pk->note_being_pressed_using_mouse >= 0)
458 release_key(pk, pk->note_being_pressed_using_mouse);
461 pk->note_being_pressed_using_mouse = note;
463 } else if (event->type == GDK_BUTTON_RELEASE) {
465 release_key(pk, note);
468 if (pk->note_being_pressed_using_mouse >= 0)
469 release_key(pk, pk->note_being_pressed_using_mouse);
472 pk->note_being_pressed_using_mouse = -1;
480 mouse_motion_event_handler(PianoKeyboard *pk, GdkEventMotion *event, gpointer ignored)
486 if ((event->state & GDK_BUTTON1_MASK) == 0)
489 note = get_note_for_xy(pk, event->x, event->y);
491 if (note != pk->note_being_pressed_using_mouse && note >= 0) {
493 if (pk->note_being_pressed_using_mouse >= 0)
494 release_key(pk, pk->note_being_pressed_using_mouse);
496 pk->note_being_pressed_using_mouse = note;
503 piano_keyboard_expose(GtkWidget *widget, GdkEventExpose *event)
506 PianoKeyboard *pk = PIANO_KEYBOARD(widget);
507 cairo_t* cr = gdk_cairo_create (GDK_DRAWABLE (GTK_WIDGET(pk)->window));
509 gdk_cairo_region (cr, event->region);
512 for (i = 0; i < NNOTES; i++) {
515 r.x = pk->notes[i].x;
517 r.width = pk->notes[i].w;
518 r.height = pk->notes[i].h;
520 switch (gdk_region_rect_in (event->region, &r)) {
521 case GDK_OVERLAP_RECTANGLE_PART:
522 case GDK_OVERLAP_RECTANGLE_IN:
523 draw_note (pk, cr, i);
536 piano_keyboard_size_request(GtkWidget* w, GtkRequisition *requisition)
540 requisition->width = PIANO_KEYBOARD_DEFAULT_WIDTH;
541 requisition->height = PIANO_KEYBOARD_DEFAULT_HEIGHT;
545 recompute_dimensions(PianoKeyboard *pk)
547 int number_of_white_keys = (NNOTES - 1) * (7.0 / 12.0);
557 int width = GTK_WIDGET(pk)->allocation.width;
558 int height = GTK_WIDGET(pk)->allocation.height;
560 key_width = width / number_of_white_keys;
561 black_key_width = key_width * 0.8;
562 useful_width = number_of_white_keys * key_width;
563 pk->widget_margin = (width - useful_width) / 2;
565 for (note = 0, white_key = 0; note < NNOTES - 2; note++) {
566 note_in_octave = note % 12;
568 if (note_in_octave == 1 || note_in_octave == 3 || note_in_octave == 6 ||
569 note_in_octave == 8 || note_in_octave == 10) {
571 /* This note is black key. */
572 pk->notes[note].x = pk->widget_margin + white_key * key_width - black_key_width / 2;
573 pk->notes[note].w = black_key_width;
574 pk->notes[note].h = height / 2;
575 pk->notes[note].white = 0;
580 /* This note is white key. */
581 pk->notes[note].x = pk->widget_margin + white_key * key_width;
582 pk->notes[note].w = key_width;
583 pk->notes[note].h = height;
584 pk->notes[note].white = 1;
591 piano_keyboard_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
593 /* XXX: Are these two needed? */
594 g_return_if_fail(widget != NULL);
595 g_return_if_fail(allocation != NULL);
597 widget->allocation = *allocation;
599 recompute_dimensions(PIANO_KEYBOARD(widget));
601 if (GTK_WIDGET_REALIZED(widget)) {
602 gdk_window_move_resize (widget->window, allocation->x, allocation->y, allocation->width, allocation->height);
607 piano_keyboard_class_init(PianoKeyboardClass *klass)
609 GtkWidgetClass *widget_klass;
611 /* Set up signals. */
612 piano_keyboard_signals[NOTE_ON_SIGNAL] = g_signal_new ("note-on",
613 G_TYPE_FROM_CLASS (klass), (GSignalFlags)(G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION),
614 0, NULL, NULL, g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
616 piano_keyboard_signals[NOTE_OFF_SIGNAL] = g_signal_new ("note-off",
617 G_TYPE_FROM_CLASS (klass), (GSignalFlags)(G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION),
618 0, NULL, NULL, g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
620 piano_keyboard_signals[REST_SIGNAL] = g_signal_new ("rest",
621 G_TYPE_FROM_CLASS (klass), (GSignalFlags)(G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION),
622 0, NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
624 widget_klass = (GtkWidgetClass*) klass;
626 widget_klass->expose_event = piano_keyboard_expose;
627 widget_klass->size_request = piano_keyboard_size_request;
628 widget_klass->size_allocate = piano_keyboard_size_allocate;
632 piano_keyboard_init(GtkWidget *mk)
634 gtk_widget_add_events(mk, GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK);
636 g_signal_connect(G_OBJECT(mk), "button-press-event", G_CALLBACK(mouse_button_event_handler), NULL);
637 g_signal_connect(G_OBJECT(mk), "button-release-event", G_CALLBACK(mouse_button_event_handler), NULL);
638 g_signal_connect(G_OBJECT(mk), "motion-notify-event", G_CALLBACK(mouse_motion_event_handler), NULL);
639 g_signal_connect(G_OBJECT(mk), "key-press-event", G_CALLBACK(keyboard_event_handler), NULL);
640 g_signal_connect(G_OBJECT(mk), "key-release-event", G_CALLBACK(keyboard_event_handler), NULL);
644 piano_keyboard_get_type(void)
646 static GType mk_type = 0;
649 static const GTypeInfo mk_info = {
650 sizeof(PianoKeyboardClass),
651 NULL, /* base_init */
652 NULL, /* base_finalize */
653 (GClassInitFunc) piano_keyboard_class_init,
654 NULL, /* class_finalize */
655 NULL, /* class_data */
656 sizeof (PianoKeyboard),
658 (GInstanceInitFunc) piano_keyboard_init,
662 mk_type = g_type_register_static(GTK_TYPE_DRAWING_AREA, "PianoKeyboard", &mk_info, (GTypeFlags)0);
669 piano_keyboard_new(void)
671 GtkWidget *widget = (GtkWidget*)gtk_type_new(piano_keyboard_get_type());
673 PianoKeyboard *pk = PIANO_KEYBOARD(widget);
675 pk->maybe_stop_sustained_notes = 0;
676 pk->sustain_new_notes = 0;
677 pk->enable_keyboard_cue = 0;
679 pk->note_being_pressed_using_mouse = -1;
680 memset((void *)pk->notes, 0, sizeof(struct Note) * NNOTES);
681 pk->key_bindings = g_hash_table_new(g_str_hash, g_str_equal);
682 bind_keys_qwerty(pk);
688 piano_keyboard_set_keyboard_cue(PianoKeyboard *pk, int enabled)
690 pk->enable_keyboard_cue = enabled;
694 piano_keyboard_sustain_press(PianoKeyboard *pk)
696 if (!pk->sustain_new_notes) {
697 pk->sustain_new_notes = 1;
698 pk->maybe_stop_sustained_notes = 1;
703 piano_keyboard_sustain_release(PianoKeyboard *pk)
705 if (pk->maybe_stop_sustained_notes)
706 stop_sustained_notes(pk);
708 pk->sustain_new_notes = 0;
712 piano_keyboard_set_note_on(PianoKeyboard *pk, int note)
714 if (pk->notes[note].pressed == 0) {
715 pk->notes[note].pressed = 1;
716 queue_note_draw (pk, note);
721 piano_keyboard_set_note_off(PianoKeyboard *pk, int note)
723 if (pk->notes[note].pressed || pk->notes[note].sustained) {
724 pk->notes[note].pressed = 0;
725 pk->notes[note].sustained = 0;
726 queue_note_draw (pk, note);
731 piano_keyboard_set_octave(PianoKeyboard *pk, int octave)
733 stop_unsustained_notes(pk);
735 gtk_widget_queue_draw(GTK_WIDGET(pk));
739 piano_keyboard_set_keyboard_layout(PianoKeyboard *pk, const char *layout)
743 if (!g_ascii_strcasecmp(layout, "QWERTY")) {
744 bind_keys_qwerty(pk);
746 } else if (!g_ascii_strcasecmp(layout, "QWERTZ")) {
747 bind_keys_qwertz(pk);
749 } else if (!g_ascii_strcasecmp(layout, "AZERTY")) {
750 bind_keys_azerty(pk);
753 /* Unknown layout name. */