jack-keyboard/src/pianokeyboard.c
Johannes Maibaum 2f5b69c021 [WIP] Allow building with GTK+ 3.16+.
Set CMake option `ENABLE_GTK3` to `ON` to build with GTK+ 3.0.

In GTK3 mode:

- Use `GtkGrid` instead of `GtkTable`
- Don't use `GtkMisc` to set `GtkLabel`'s alignments
- `PianoKeyboard`'s draw() code still needs to be refactored (doesn't
  show key presses).
- Grab keyboard functionality still needs to be ported (doesn't work
  yet).
2016-09-18 16:33:36 +02:00

773 lines
18 KiB
C

/*-
* Copyright (c) 2007, 2008 Edward Tomasz Napierała <trasz@FreeBSD.org>
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/*
* This is piano_keyboard, piano keyboard-like GTK+ widget. It contains
* no MIDI-specific code.
*
* For questions and comments, contact Edward Tomasz Napierala <trasz@FreeBSD.org>.
*/
#include <assert.h>
#include <string.h>
#include <gtk/gtk.h>
#include <gdk/gdkkeysyms.h>
#include "pianokeyboard.h"
#define PIANO_KEYBOARD_DEFAULT_WIDTH 730
#define PIANO_KEYBOARD_DEFAULT_HEIGHT 70
enum {
NOTE_ON_SIGNAL,
NOTE_OFF_SIGNAL,
LAST_SIGNAL
};
static guint piano_keyboard_signals[LAST_SIGNAL] = { 0 };
static void
draw_keyboard_cue(PianoKeyboard *pk)
{
int w, h, first_note_in_lower_row, last_note_in_lower_row,
first_note_in_higher_row, last_note_in_higher_row;
w = pk->notes[0].w;
h = pk->notes[0].h;
first_note_in_lower_row = (pk->octave + 5) * 12;
last_note_in_lower_row = (pk->octave + 6) * 12 - 1;
first_note_in_higher_row = (pk->octave + 6) * 12;
last_note_in_higher_row = (pk->octave + 7) * 12 + 4;
cairo_t *cr = gdk_cairo_create(gtk_widget_get_window(GTK_WIDGET(pk)));
cairo_move_to(cr, pk->notes[first_note_in_lower_row].x + 3, h - 6);
cairo_line_to(cr, pk->notes[last_note_in_lower_row].x + w - 3, h - 6);
cairo_move_to(cr, pk->notes[first_note_in_higher_row].x + 3, h - 9);
cairo_line_to(cr, pk->notes[last_note_in_higher_row].x + w - 3, h - 9);
cairo_destroy(cr);
}
static void
#if GTK_CHECK_VERSION(3,0,0)
draw_note(PianoKeyboard *pk, cairo_t *cr, int note)
#else
draw_note(PianoKeyboard *pk, int note)
#endif
{
if (note < pk->min_note)
return;
if (note > pk->max_note)
return;
int is_white, x, w, h;
#if GTK_CHECK_VERSION(3,0,0)
if (!cr)
cr = gdk_cairo_create(gtk_widget_get_window(GTK_WIDGET(pk)));
GdkRGBA black = { .red = 0.0, .green = 0.0, .blue = 0.0, .alpha = 1.0};
GdkRGBA white = { .red = 1.0, .green = 1.0, .blue = 1.0, .alpha = 1.0};
#else
cairo_t *cr = gdk_cairo_create(gtk_widget_get_window(GTK_WIDGET(pk)));
GdkColor black = {0, 0, 0, 0};
GdkColor white = {0, 65535, 65535, 65535};
GtkWidget *widget;
GtkAllocation allocation;
#endif
is_white = pk->notes[note].white;
x = pk->notes[note].x;
w = pk->notes[note].w;
h = pk->notes[note].h;
if (pk->notes[note].pressed || pk->notes[note].sustained)
is_white = !is_white;
if (is_white)
#if GTK_CHECK_VERSION(3,0,0)
gdk_cairo_set_source_rgba(cr, &white);
#else
gdk_cairo_set_source_color(cr, &white);
#endif
else
#if GTK_CHECK_VERSION(3,0,0)
gdk_cairo_set_source_rgba(cr, &black);
#else
gdk_cairo_set_source_color(cr, &black);
#endif
cairo_rectangle(cr, x, 0, w, h);
cairo_fill(cr);
#if GTK_CHECK_VERSION(3,0,0)
gdk_cairo_set_source_rgba(cr, &black);
#else
gdk_cairo_set_source_color(cr, &black);
#endif
cairo_rectangle(cr, x, 0, w, h);
cairo_stroke(cr);
#if !GTK_CHECK_VERSION(3,0,0)
cairo_destroy(cr);
#endif
if (pk->enable_keyboard_cue)
draw_keyboard_cue(pk);
/* We need to redraw black keys that partially obscure the white one. */
if (note < NNOTES - 2 && !pk->notes[note + 1].white)
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, cr, note + 1);
#else
draw_note(pk, note + 1);
#endif
if (note > 0 && !pk->notes[note - 1].white)
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, cr, note - 1);
#else
draw_note(pk, note - 1);
/*
* XXX: This doesn't really belong here. Originally I wanted to pack PianoKeyboard into GtkFrame
* packed into GtkAlignment. I failed to make it behave the way I want. GtkFrame would need
* to adapt to the "proper" size of PianoKeyboard, i.e. to the useful_width, not allocated width;
* that didn't work.
*/
widget = GTK_WIDGET(pk);
gtk_widget_get_allocation(widget, &allocation);
gtk_paint_shadow(gtk_widget_get_style(widget), gtk_widget_get_window(widget), GTK_STATE_NORMAL, GTK_SHADOW_IN, NULL,
widget, NULL, pk->widget_margin, 0, allocation.width - pk->widget_margin * 2 + 1,
allocation.height);
#endif
}
static int
press_key(PianoKeyboard *pk, int key)
{
assert(key >= 0);
assert(key < NNOTES);
pk->maybe_stop_sustained_notes = 0;
/* This is for keyboard autorepeat protection. */
if (pk->notes[key].pressed)
return (0);
if (pk->sustain_new_notes)
pk->notes[key].sustained = 1;
else
pk->notes[key].sustained = 0;
pk->notes[key].pressed = 1;
g_signal_emit_by_name(GTK_WIDGET(pk), "note-on", key);
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, NULL, key);
#else
draw_note(pk, key);
#endif
return (1);
}
static int
release_key(PianoKeyboard *pk, int key)
{
assert(key >= 0);
assert(key < NNOTES);
pk->maybe_stop_sustained_notes = 0;
if (!pk->notes[key].pressed)
return (0);
if (pk->sustain_new_notes)
pk->notes[key].sustained = 1;
pk->notes[key].pressed = 0;
if (pk->notes[key].sustained)
return (0);
g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", key);
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, NULL, key);
#else
draw_note(pk, key);
#endif
return (1);
}
static void
stop_unsustained_notes(PianoKeyboard *pk)
{
int i;
for (i = 0; i < NNOTES; i++) {
if (pk->notes[i].pressed && !pk->notes[i].sustained) {
pk->notes[i].pressed = 0;
g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", i);
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, NULL, i);
#else
draw_note(pk, i);
#endif
}
}
}
static void
stop_sustained_notes(PianoKeyboard *pk)
{
int i;
for (i = 0; i < NNOTES; i++) {
if (pk->notes[i].sustained) {
pk->notes[i].pressed = 0;
pk->notes[i].sustained = 0;
g_signal_emit_by_name(GTK_WIDGET(pk), "note-off", i);
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, NULL, i);
#else
draw_note(pk, i);
#endif
}
}
}
static int
key_binding(PianoKeyboard *pk, guint16 key)
{
assert(pk->key_bindings != NULL);
if (key >= pk->key_bindings->len)
return (0);
return (g_array_index(pk->key_bindings, int, key));
}
static void
bind_key(PianoKeyboard *pk, guint key, int note)
{
assert(pk->key_bindings != NULL);
if (key >= pk->key_bindings->len)
g_array_set_size(pk->key_bindings, key + 1);
g_array_index(pk->key_bindings, int, key) = note;
}
static void
clear_notes(PianoKeyboard *pk)
{
assert(pk->key_bindings != NULL);
g_array_set_size(pk->key_bindings, 0);
}
static void
bind_keys_qwerty(PianoKeyboard *pk)
{
clear_notes(pk);
/* Lower keyboard row - "zxcvbnm". 52 is z, 38 is a. */
bind_key(pk, 52, 12); /* C0 */
bind_key(pk, 39, 13);
bind_key(pk, 53, 14);
bind_key(pk, 40, 15);
bind_key(pk, 54, 16);
bind_key(pk, 55, 17);
bind_key(pk, 42, 18);
bind_key(pk, 56, 19);
bind_key(pk, 43, 20);
bind_key(pk, 57, 21);
bind_key(pk, 44, 22);
bind_key(pk, 58, 23);
/* Map the remaining keys. This overlaps with qwe. */
bind_key(pk, 59, 24);
bind_key(pk, 46, 25);
bind_key(pk, 60, 26);
bind_key(pk, 47, 27);
bind_key(pk, 61, 28);
/* Upper keyboard row, first octave - "qwertyu". 24 is q, 10 is 1. */
bind_key(pk, 24, 24);
bind_key(pk, 11, 25);
bind_key(pk, 25, 26);
bind_key(pk, 12, 27);
bind_key(pk, 26, 28);
bind_key(pk, 27, 29);
bind_key(pk, 14, 30);
bind_key(pk, 28, 31);
bind_key(pk, 15, 32);
bind_key(pk, 29, 33);
bind_key(pk, 16, 34);
bind_key(pk, 30, 35);
/* Upper keyboard row, the rest - "iop". */
bind_key(pk, 31, 36);
bind_key(pk, 18, 37);
bind_key(pk, 32, 38);
bind_key(pk, 19, 39);
bind_key(pk, 33, 40);
/* We might as well bind these too: "[=]\" */
bind_key(pk, 34, 41);
bind_key(pk, 21, 42);
bind_key(pk, 35, 43);
bind_key(pk, 51, 45); /* yes, really, at least here... */
}
static gint
keyboard_event_handler(GtkWidget *mk, GdkEventKey *event, gpointer notused)
{
int note;
PianoKeyboard *pk = PIANO_KEYBOARD(mk);
note = key_binding(pk, event->hardware_keycode);
if (note <= 0) {
/* Key was not bound. Maybe it's one of the keys handled in jack-keyboard.c. */
return (FALSE);
}
note += pk->octave * 12;
assert(note >= 0);
assert(note < NNOTES);
if (event->type == GDK_KEY_PRESS) {
press_key(pk, note);
} else if (event->type == GDK_KEY_RELEASE) {
release_key(pk, note);
}
return (TRUE);
}
static int
get_note_for_xy(PianoKeyboard *pk, int x, int y)
{
int height, note;
GtkAllocation allocation;
gtk_widget_get_allocation(GTK_WIDGET(pk), &allocation);
height = allocation.height;
if (y <= ((height * 2) / 3)) { /* might be a black key */
for (note = 0; note <= pk->max_note; ++note) {
if (pk->notes[note].white)
continue;
if (x >= pk->notes[note].x && x <= pk->notes[note].x + pk->notes[note].w)
return (note);
}
}
for (note = 0; note <= pk->max_note; ++note) {
if (!pk->notes[note].white)
continue;
if (x >= pk->notes[note].x && x <= pk->notes[note].x + pk->notes[note].w)
return (note);
}
return (-1);
}
static gboolean
mouse_button_event_handler(PianoKeyboard *pk, GdkEventButton *event, gpointer notused)
{
int x, y, note;
x = event->x;
y = event->y;
note = get_note_for_xy(pk, x, y);
if (event->button != 1)
return (TRUE);
if (event->type == GDK_BUTTON_PRESS) {
/* This is possible when you make the window a little wider and then click
on the grey area. */
if (note < 0) {
return (TRUE);
}
if (pk->note_being_pressed_using_mouse >= 0)
release_key(pk, pk->note_being_pressed_using_mouse);
press_key(pk, note);
pk->note_being_pressed_using_mouse = note;
} else if (event->type == GDK_BUTTON_RELEASE) {
if (note >= 0) {
release_key(pk, note);
} else {
if (pk->note_being_pressed_using_mouse >= 0)
release_key(pk, pk->note_being_pressed_using_mouse);
}
pk->note_being_pressed_using_mouse = -1;
}
return (TRUE);
}
static gboolean
mouse_motion_event_handler(PianoKeyboard *pk, GdkEventMotion *event, gpointer notused)
{
int note;
if ((event->state & GDK_BUTTON1_MASK) == 0)
return (TRUE);
note = get_note_for_xy(pk, event->x, event->y);
if (note != pk->note_being_pressed_using_mouse && note >= 0) {
if (pk->note_being_pressed_using_mouse >= 0)
release_key(pk, pk->note_being_pressed_using_mouse);
press_key(pk, note);
pk->note_being_pressed_using_mouse = note;
}
return (TRUE);
}
static gboolean
#if GTK_CHECK_VERSION(3,0,0)
piano_keyboard_draw(GtkWidget *widget, cairo_t *cr)
#else
piano_keyboard_expose(GtkWidget *widget, GdkEventExpose *event)
#endif
{
int i;
PianoKeyboard *pk = PIANO_KEYBOARD(widget);
for (i = 0; i < NNOTES; i++)
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, NULL, i);
#else
draw_note(pk, i);
#endif
return (TRUE);
}
#if GTK_CHECK_VERSION(3,0,0)
static void
piano_keyboard_get_preferred_width(GtkWidget *widget, gint *minimal_width, gint *natural_width)
{
*minimal_width = *natural_width = PIANO_KEYBOARD_DEFAULT_WIDTH;
}
static void
piano_keyboard_get_preferred_height(GtkWidget *widget, gint *minimal_height, gint *natural_height)
{
*minimal_height = *natural_height = PIANO_KEYBOARD_DEFAULT_HEIGHT;
}
#else
static void
piano_keyboard_size_request(GtkWidget *widget, GtkRequisition *requisition)
{
requisition->width = PIANO_KEYBOARD_DEFAULT_WIDTH;
requisition->height = PIANO_KEYBOARD_DEFAULT_HEIGHT;
}
#endif
static int is_black(int key)
{
int note_in_octave = key % 12;
if( note_in_octave == 1 || note_in_octave == 3 ||
note_in_octave == 6 || note_in_octave == 8 || note_in_octave == 10)
return 1;
return 0;
}
static double black_key_left_shift(int key)
{
int note_in_octave = key % 12;
switch (note_in_octave)
{
case 1:
return 2.0/3.0;
case 3:
return 1.0/3.0;
case 6:
return 2.0/3.0;
case 8:
return 0.5;
case 10:
return 1.0/3.0;
default:
return 0;
}
return 0;
}
static void
recompute_dimensions(PianoKeyboard *pk)
{
int number_of_white_keys = 0, skipped_white_keys = 0, key_width, black_key_width, useful_width, note,
white_key, width, height;
GtkAllocation allocation;
for (note = pk->min_note; note <= pk->max_note; ++note)
if (!is_black(note))
++number_of_white_keys;
for (note = 0; note < pk->min_note; ++note)
if (!is_black(note))
++skipped_white_keys;
gtk_widget_get_allocation(GTK_WIDGET(pk), &allocation);
width = allocation.width;
height = allocation.height;
key_width = width / number_of_white_keys;
black_key_width = key_width * 0.8;
useful_width = number_of_white_keys * key_width;
pk->widget_margin = (width - useful_width) / 2;
for (note = 0, white_key = -skipped_white_keys; note < NNOTES; note++) {
if (is_black(note)) {
/* This note is black key. */
pk->notes[note].x = pk->widget_margin +
(white_key * key_width) -
(black_key_width * black_key_left_shift(note));
pk->notes[note].w = black_key_width;
pk->notes[note].h = (height * 2) / 3;
pk->notes[note].white = 0;
continue;
}
/* This note is white key. */
pk->notes[note].x = pk->widget_margin + white_key * key_width;
pk->notes[note].w = key_width;
pk->notes[note].h = height;
pk->notes[note].white = 1;
white_key++;
}
}
static void
piano_keyboard_size_allocate(GtkWidget *widget, GtkAllocation *allocation)
{
/* XXX: Are these two needed? */
g_return_if_fail(widget != NULL);
g_return_if_fail(allocation != NULL);
gtk_widget_set_allocation(widget, allocation);
recompute_dimensions(PIANO_KEYBOARD(widget));
if (gtk_widget_get_realized(widget))
gdk_window_move_resize (gtk_widget_get_window(widget), allocation->x, allocation->y, allocation->width, allocation->height);
}
static void
piano_keyboard_class_init(PianoKeyboardClass *klass)
{
GtkWidgetClass *widget_klass;
/* Set up signals. */
piano_keyboard_signals[NOTE_ON_SIGNAL] = g_signal_new ("note-on",
G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
0, NULL, NULL, g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
piano_keyboard_signals[NOTE_OFF_SIGNAL] = g_signal_new ("note-off",
G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION,
0, NULL, NULL, g_cclosure_marshal_VOID__INT, G_TYPE_NONE, 1, G_TYPE_INT);
widget_klass = (GtkWidgetClass*)klass;
#if GTK_CHECK_VERSION(3,0,0)
widget_klass->draw = piano_keyboard_draw;
widget_klass->get_preferred_width = piano_keyboard_get_preferred_width;
widget_klass->get_preferred_height = piano_keyboard_get_preferred_height;
#else
widget_klass->expose_event = piano_keyboard_expose;
widget_klass->size_request = piano_keyboard_size_request;
#endif
widget_klass->size_allocate = piano_keyboard_size_allocate;
}
static void
piano_keyboard_init(GtkWidget *mk)
{
gtk_widget_add_events(mk, GDK_BUTTON_PRESS_MASK | GDK_BUTTON_RELEASE_MASK | GDK_POINTER_MOTION_MASK);
g_signal_connect(G_OBJECT(mk), "button-press-event", G_CALLBACK(mouse_button_event_handler), NULL);
g_signal_connect(G_OBJECT(mk), "button-release-event", G_CALLBACK(mouse_button_event_handler), NULL);
g_signal_connect(G_OBJECT(mk), "motion-notify-event", G_CALLBACK(mouse_motion_event_handler), NULL);
g_signal_connect(G_OBJECT(mk), "key-press-event", G_CALLBACK(keyboard_event_handler), NULL);
g_signal_connect(G_OBJECT(mk), "key-release-event", G_CALLBACK(keyboard_event_handler), NULL);
}
GType
piano_keyboard_get_type(void)
{
static GType mk_type = 0;
if (!mk_type) {
static const GTypeInfo mk_info = {
sizeof(PianoKeyboardClass),
NULL, /* base_init */
NULL, /* base_finalize */
(GClassInitFunc) piano_keyboard_class_init,
NULL, /* class_finalize */
NULL, /* class_data */
sizeof (PianoKeyboard),
0, /* n_preallocs */
(GInstanceInitFunc) piano_keyboard_init,
};
mk_type = g_type_register_static(GTK_TYPE_DRAWING_AREA, "PianoKeyboard", &mk_info, 0);
}
return (mk_type);
}
GtkWidget *
piano_keyboard_new(void)
{
GtkWidget *widget;
PianoKeyboard *pk;
widget = g_object_new(TYPE_PIANO_KEYBOARD, NULL);
pk = PIANO_KEYBOARD(widget);
pk->maybe_stop_sustained_notes = 0;
pk->sustain_new_notes = 0;
pk->enable_keyboard_cue = 0;
pk->octave = 4;
pk->note_being_pressed_using_mouse = -1;
memset((void *)pk->notes, 0, sizeof(struct Note) * NNOTES);
/* 255 here is a random value larger than the highest key we bind. */
pk->key_bindings = g_array_sized_new(FALSE, TRUE, sizeof(int), 255);
pk->min_note = PIANO_MIN_NOTE;
pk->max_note = PIANO_MAX_NOTE;
bind_keys_qwerty(pk);
return (widget);
}
void
piano_keyboard_set_keyboard_cue(PianoKeyboard *pk, int enabled)
{
pk->enable_keyboard_cue = enabled;
}
void
piano_keyboard_sustain_press(PianoKeyboard *pk)
{
if (!pk->sustain_new_notes) {
pk->sustain_new_notes = 1;
pk->maybe_stop_sustained_notes = 1;
}
}
void
piano_keyboard_sustain_release(PianoKeyboard *pk)
{
if (pk->maybe_stop_sustained_notes)
stop_sustained_notes(pk);
pk->sustain_new_notes = 0;
}
void
piano_keyboard_set_note_on(PianoKeyboard *pk, int note)
{
if (pk->notes[note].pressed == 0) {
pk->notes[note].pressed = 1;
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, NULL, note);
#else
draw_note(pk, note);
#endif
}
}
void
piano_keyboard_set_note_off(PianoKeyboard *pk, int note)
{
if (pk->notes[note].pressed || pk->notes[note].sustained) {
pk->notes[note].pressed = 0;
pk->notes[note].sustained = 0;
#if GTK_CHECK_VERSION(3,0,0)
draw_note(pk, NULL, note);
#else
draw_note(pk, note);
#endif
}
}
void
piano_keyboard_set_octave(PianoKeyboard *pk, int octave)
{
stop_unsustained_notes(pk);
pk->octave = octave;
gtk_widget_queue_draw(GTK_WIDGET(pk));
}
gboolean
piano_keyboard_set_keyboard_layout(PianoKeyboard *pk, const char *layout)
{
assert(layout);
if (!strcasecmp(layout, "QWERTY")) {
bind_keys_qwerty(pk);
} else {
/* Unknown layout name. */
return (TRUE);
}
return (FALSE);
}
void
piano_keyboard_enable_all_midi_notes(PianoKeyboard* pk)
{
pk->min_note = 0;
pk->max_note = NNOTES-1;
recompute_dimensions(pk);
}