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 if (pk->monophonic && pk->last_key != key) {
159 pk->notes[pk->last_key].pressed = 0;
160 pk->notes[pk->last_key].sustained = 0;
161 queue_note_draw(pk, pk->last_key);
165 pk->notes[key].pressed = 1;
167 g_signal_emit_by_name(GTK_WIDGET(pk), "note-on", key);
168 queue_note_draw(pk, key);
174 release_key(PianoKeyboard *pk, int key)
177 assert(key < NNOTES);
179 pk->maybe_stop_sustained_notes = 0;
181 if (!pk->notes[key].pressed)
184 if (pk->sustain_new_notes)
185 pk->notes[key].sustained = 1;
187 pk->notes[key].pressed = 0;
189 if (pk->notes[key].sustained)
192 g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", key);
193 queue_note_draw(pk, key);
199 rest (PianoKeyboard* pk)
201 g_signal_emit_by_name(GTK_WIDGET(pk), "rest");
205 stop_unsustained_notes(PianoKeyboard *pk)
209 for (i = 0; i < NNOTES; i++) {
210 if (pk->notes[i].pressed && !pk->notes[i].sustained) {
211 pk->notes[i].pressed = 0;
212 g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", i);
213 queue_note_draw(pk, i);
219 stop_sustained_notes(PianoKeyboard *pk)
223 for (i = 0; i < NNOTES; i++) {
224 if (pk->notes[i].sustained) {
225 pk->notes[i].pressed = 0;
226 pk->notes[i].sustained = 0;
227 g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", i);
228 queue_note_draw(pk, i);
234 key_binding(PianoKeyboard *pk, const char *key)
236 gpointer notused, note;
239 assert(pk->key_bindings != NULL);
241 found = g_hash_table_lookup_extended(pk->key_bindings, key, ¬used, ¬e);
246 return (intptr_t)note;
250 bind_key(PianoKeyboard *pk, const char *key, int note)
252 assert(pk->key_bindings != NULL);
254 g_hash_table_insert(pk->key_bindings, (const gpointer)key, (gpointer)((intptr_t)note));
258 clear_notes(PianoKeyboard *pk)
260 assert(pk->key_bindings != NULL);
262 g_hash_table_remove_all(pk->key_bindings);
266 bind_keys_qwerty(PianoKeyboard *pk)
270 bind_key(pk, "space", 128);
272 /* Lower keyboard row - "zxcvbnm". */
273 bind_key(pk, "z", 12); /* C0 */
274 bind_key(pk, "s", 13);
275 bind_key(pk, "x", 14);
276 bind_key(pk, "d", 15);
277 bind_key(pk, "c", 16);
278 bind_key(pk, "v", 17);
279 bind_key(pk, "g", 18);
280 bind_key(pk, "b", 19);
281 bind_key(pk, "h", 20);
282 bind_key(pk, "n", 21);
283 bind_key(pk, "j", 22);
284 bind_key(pk, "m", 23);
286 /* Upper keyboard row, first octave - "qwertyu". */
287 bind_key(pk, "q", 24);
288 bind_key(pk, "2", 25);
289 bind_key(pk, "w", 26);
290 bind_key(pk, "3", 27);
291 bind_key(pk, "e", 28);
292 bind_key(pk, "r", 29);
293 bind_key(pk, "5", 30);
294 bind_key(pk, "t", 31);
295 bind_key(pk, "6", 32);
296 bind_key(pk, "y", 33);
297 bind_key(pk, "7", 34);
298 bind_key(pk, "u", 35);
300 /* Upper keyboard row, the rest - "iop". */
301 bind_key(pk, "i", 36);
302 bind_key(pk, "9", 37);
303 bind_key(pk, "o", 38);
304 bind_key(pk, "0", 39);
305 bind_key(pk, "p", 40);
309 bind_keys_qwertz(PianoKeyboard *pk)
311 bind_keys_qwerty(pk);
313 /* The only difference between QWERTY and QWERTZ is that the "y" and "z" are swapped together. */
314 bind_key(pk, "y", 12);
315 bind_key(pk, "z", 33);
319 bind_keys_azerty(PianoKeyboard *pk)
323 bind_key(pk, "space", 128);
325 /* Lower keyboard row - "wxcvbn,". */
326 bind_key(pk, "w", 12); /* C0 */
327 bind_key(pk, "s", 13);
328 bind_key(pk, "x", 14);
329 bind_key(pk, "d", 15);
330 bind_key(pk, "c", 16);
331 bind_key(pk, "v", 17);
332 bind_key(pk, "g", 18);
333 bind_key(pk, "b", 19);
334 bind_key(pk, "h", 20);
335 bind_key(pk, "n", 21);
336 bind_key(pk, "j", 22);
337 bind_key(pk, "comma", 23);
339 /* Upper keyboard row, first octave - "azertyu". */
340 bind_key(pk, "a", 24);
341 bind_key(pk, "eacute", 25);
342 bind_key(pk, "z", 26);
343 bind_key(pk, "quotedbl", 27);
344 bind_key(pk, "e", 28);
345 bind_key(pk, "r", 29);
346 bind_key(pk, "parenleft", 30);
347 bind_key(pk, "t", 31);
348 bind_key(pk, "minus", 32);
349 bind_key(pk, "y", 33);
350 bind_key(pk, "egrave", 34);
351 bind_key(pk, "u", 35);
353 /* Upper keyboard row, the rest - "iop". */
354 bind_key(pk, "i", 36);
355 bind_key(pk, "ccedilla", 37);
356 bind_key(pk, "o", 38);
357 bind_key(pk, "agrave", 39);
358 bind_key(pk, "p", 40);
362 keyboard_event_handler(GtkWidget *mk, GdkEventKey *event, gpointer ignored)
368 PianoKeyboard *pk = PIANO_KEYBOARD(mk);
372 /* We're not using event->keyval, because we need keyval with level set to 0.
373 E.g. if user holds Shift and presses '7', we want to get a '7', not '&'. */
374 kk.keycode = event->hardware_keycode;
378 keyval = gdk_keymap_lookup_key(NULL, &kk);
380 key = gdk_keyval_name(gdk_keyval_to_lower(keyval));
383 g_message("gtk_keyval_name() returned NULL; please report this.");
387 note = key_binding(pk, key);
390 /* Key was not bound. Maybe it's one of the keys handled in jack-keyboard.c. */
395 if (event->type == GDK_KEY_RELEASE) {
402 note += pk->octave * 12;
405 assert(note < NNOTES);
407 if (event->type == GDK_KEY_PRESS) {
410 } else if (event->type == GDK_KEY_RELEASE) {
411 release_key(pk, note);
418 get_note_for_xy(PianoKeyboard *pk, int x, int y)
420 int height = GTK_WIDGET(pk)->allocation.height;
423 if (y <= height / 2) {
424 for (note = 0; note < NNOTES - 1; note++) {
425 if (pk->notes[note].white)
428 if (x >= pk->notes[note].x && x <= pk->notes[note].x + pk->notes[note].w)
433 for (note = 0; note < NNOTES - 1; note++) {
434 if (!pk->notes[note].white)
437 if (x >= pk->notes[note].x && x <= pk->notes[note].x + pk->notes[note].w)
445 mouse_button_event_handler(PianoKeyboard *pk, GdkEventButton *event, gpointer ignored)
450 int note = get_note_for_xy(pk, x, y);
454 if (event->button != 1)
457 if (event->type == GDK_BUTTON_PRESS) {
458 /* This is possible when you make the window a little wider and then click
464 if (pk->note_being_pressed_using_mouse >= 0)
465 release_key(pk, pk->note_being_pressed_using_mouse);
468 pk->note_being_pressed_using_mouse = note;
470 } else if (event->type == GDK_BUTTON_RELEASE) {
472 release_key(pk, note);
475 if (pk->note_being_pressed_using_mouse >= 0)
476 release_key(pk, pk->note_being_pressed_using_mouse);
479 pk->note_being_pressed_using_mouse = -1;
487 mouse_motion_event_handler(PianoKeyboard *pk, GdkEventMotion *event, gpointer ignored)
493 if ((event->state & GDK_BUTTON1_MASK) == 0)
496 note = get_note_for_xy(pk, event->x, event->y);
498 if (note != pk->note_being_pressed_using_mouse && note >= 0) {
500 if (pk->note_being_pressed_using_mouse >= 0)
501 release_key(pk, pk->note_being_pressed_using_mouse);
503 pk->note_being_pressed_using_mouse = note;
510 piano_keyboard_expose(GtkWidget *widget, GdkEventExpose *event)
513 PianoKeyboard *pk = PIANO_KEYBOARD(widget);
514 cairo_t* cr = gdk_cairo_create (GDK_DRAWABLE (GTK_WIDGET(pk)->window));
516 gdk_cairo_region (cr, event->region);
519 for (i = 0; i < NNOTES; i++) {
522 r.x = pk->notes[i].x;
524 r.width = pk->notes[i].w;
525 r.height = pk->notes[i].h;
527 switch (gdk_region_rect_in (event->region, &r)) {
528 case GDK_OVERLAP_RECTANGLE_PART:
529 case GDK_OVERLAP_RECTANGLE_IN:
530 draw_note (pk, cr, i);
543 piano_keyboard_size_request(GtkWidget* w, GtkRequisition *requisition)
547 requisition->width = PIANO_KEYBOARD_DEFAULT_WIDTH;
548 requisition->height = PIANO_KEYBOARD_DEFAULT_HEIGHT;
552 recompute_dimensions(PianoKeyboard *pk)
554 int number_of_white_keys = (NNOTES - 1) * (7.0 / 12.0);
564 int width = GTK_WIDGET(pk)->allocation.width;
565 int height = GTK_WIDGET(pk)->allocation.height;
567 key_width = width / number_of_white_keys;
568 black_key_width = key_width * 0.8;
569 useful_width = number_of_white_keys * key_width;
570 pk->widget_margin = (width - useful_width) / 2;
572 for (note = 0, white_key = 0; note < NNOTES - 2; note++) {
573 note_in_octave = note % 12;
575 if (note_in_octave == 1 || note_in_octave == 3 || note_in_octave == 6 ||
576 note_in_octave == 8 || note_in_octave == 10) {
578 /* This note is black key. */
579 pk->notes[note].x = pk->widget_margin + white_key * key_width - black_key_width / 2;
580 pk->notes[note].w = black_key_width;
581 pk->notes[note].h = height / 2;
582 pk->notes[note].white = 0;
587 /* This note is white key. */
588 pk->notes[note].x = pk->widget_margin + white_key * key_width;
589 pk->notes[note].w = key_width;
590 pk->notes[note].h = height;
591 pk->notes[note].white = 1;
598 piano_keyboard_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
600 /* XXX: Are these two needed? */
601 g_return_if_fail(widget != NULL);
602 g_return_if_fail(allocation != NULL);
604 widget->allocation = *allocation;
606 recompute_dimensions(PIANO_KEYBOARD(widget));
608 if (GTK_WIDGET_REALIZED(widget)) {
609 gdk_window_move_resize (widget->window, allocation->x, allocation->y, allocation->width, allocation->height);
614 piano_keyboard_class_init(PianoKeyboardClass *klass)
616 GtkWidgetClass *widget_klass;
618 /* Set up signals. */
619 piano_keyboard_signals[NOTE_ON_SIGNAL] = g_signal_new ("note-on",
620 G_TYPE_FROM_CLASS (klass), (GSignalFlags)(G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION),
621 0, NULL, NULL, g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
623 piano_keyboard_signals[NOTE_OFF_SIGNAL] = g_signal_new ("note-off",
624 G_TYPE_FROM_CLASS (klass), (GSignalFlags)(G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION),
625 0, NULL, NULL, g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
627 piano_keyboard_signals[REST_SIGNAL] = g_signal_new ("rest",
628 G_TYPE_FROM_CLASS (klass), (GSignalFlags)(G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION),
629 0, NULL, NULL, g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
631 widget_klass = (GtkWidgetClass*) klass;
633 widget_klass->expose_event = piano_keyboard_expose;
634 widget_klass->size_request = piano_keyboard_size_request;
635 widget_klass->size_allocate = piano_keyboard_size_allocate;
639 piano_keyboard_init(GtkWidget *mk)
641 gtk_widget_add_events(mk, GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK);
643 g_signal_connect(G_OBJECT(mk), "button-press-event", G_CALLBACK(mouse_button_event_handler), NULL);
644 g_signal_connect(G_OBJECT(mk), "button-release-event", G_CALLBACK(mouse_button_event_handler), NULL);
645 g_signal_connect(G_OBJECT(mk), "motion-notify-event", G_CALLBACK(mouse_motion_event_handler), NULL);
646 g_signal_connect(G_OBJECT(mk), "key-press-event", G_CALLBACK(keyboard_event_handler), NULL);
647 g_signal_connect(G_OBJECT(mk), "key-release-event", G_CALLBACK(keyboard_event_handler), NULL);
651 piano_keyboard_get_type(void)
653 static GType mk_type = 0;
656 static const GTypeInfo mk_info = {
657 sizeof(PianoKeyboardClass),
658 NULL, /* base_init */
659 NULL, /* base_finalize */
660 (GClassInitFunc) piano_keyboard_class_init,
661 NULL, /* class_finalize */
662 NULL, /* class_data */
663 sizeof (PianoKeyboard),
665 (GInstanceInitFunc) piano_keyboard_init,
669 mk_type = g_type_register_static(GTK_TYPE_DRAWING_AREA, "PianoKeyboard", &mk_info, (GTypeFlags)0);
676 piano_keyboard_new(void)
678 GtkWidget *widget = (GtkWidget*)gtk_type_new(piano_keyboard_get_type());
680 PianoKeyboard *pk = PIANO_KEYBOARD(widget);
682 pk->maybe_stop_sustained_notes = 0;
683 pk->sustain_new_notes = 0;
684 pk->enable_keyboard_cue = 0;
686 pk->note_being_pressed_using_mouse = -1;
688 pk->monophonic = FALSE;
689 memset((void *)pk->notes, 0, sizeof(struct PKNote) * NNOTES);
690 pk->key_bindings = g_hash_table_new(g_str_hash, g_str_equal);
691 bind_keys_qwerty(pk);
697 piano_keyboard_set_keyboard_cue(PianoKeyboard *pk, int enabled)
699 pk->enable_keyboard_cue = enabled;
703 piano_keyboard_set_monophonic(PianoKeyboard *pk, gboolean monophonic)
705 pk->monophonic = monophonic;
709 piano_keyboard_sustain_press(PianoKeyboard *pk)
711 if (!pk->sustain_new_notes) {
712 pk->sustain_new_notes = 1;
713 pk->maybe_stop_sustained_notes = 1;
718 piano_keyboard_sustain_release(PianoKeyboard *pk)
720 if (pk->maybe_stop_sustained_notes)
721 stop_sustained_notes(pk);
723 pk->sustain_new_notes = 0;
727 piano_keyboard_set_note_on(PianoKeyboard *pk, int note)
729 if (pk->notes[note].pressed == 0) {
730 pk->notes[note].pressed = 1;
731 queue_note_draw (pk, note);
736 piano_keyboard_set_note_off(PianoKeyboard *pk, int note)
738 if (pk->notes[note].pressed || pk->notes[note].sustained) {
739 pk->notes[note].pressed = 0;
740 pk->notes[note].sustained = 0;
741 queue_note_draw (pk, note);
746 piano_keyboard_set_octave(PianoKeyboard *pk, int octave)
748 stop_unsustained_notes(pk);
750 gtk_widget_queue_draw(GTK_WIDGET(pk));
754 piano_keyboard_set_keyboard_layout(PianoKeyboard *pk, const char *layout)
758 if (!g_ascii_strcasecmp(layout, "QWERTY")) {
759 bind_keys_qwerty(pk);
761 } else if (!g_ascii_strcasecmp(layout, "QWERTZ")) {
762 bind_keys_qwertz(pk);
764 } else if (!g_ascii_strcasecmp(layout, "AZERTY")) {
765 bind_keys_azerty(pk);
768 /* Unknown layout name. */