blofeld_knobs.c

/****************************************************************************
 * xtor - GTK based editor for MIDI synthesizers
 *
 * blofeld_knobs.c - Map Blofeld UI parameters to controller knobs.
 *
 * For the Blofeld, most UI frames consist of a row of sliders above and
 * a row of comboboxes ("buttons" in this file) below. So we assume the
 * controller has two rows too. So far focus is on the Nocturn which has
 * one row of knobs and one (double) row of buttons.
 *
 * Copyright (C) 2014  Ricard Wanderlof <ricard2013@butoba.net>
 *
 * Portions of this file derived from the GTK toolkit:
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/. 
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 ****************************************************************************/

#include <stdio.h>
#include <glib.h>
#include <gtk/gtk.h>
#include "midi.h"
#include "knob_mapper.h"

#include "debug.h"

struct knoblist {
  GList *build;
  GList *active;
};

/* We keep this structure local, as its contents depends on what we as a
 * specific knob mapper implementation require.
 * Use void * for communicating it externally. */
struct knobmap {
  GtkContainer *container;
  struct knoblist pots;
  struct knoblist buttons;
  gboolean sorted;
};

/* Structure build time variables */
static GtkContainer *current_container = NULL;

/* Callback for notifying gui when knob value has changed. */
static knob_notify_cb notify_ui = NULL;
static void *notify_ref;

/* Callback management */
static void
register_notify_cb(knob_notify_cb cb, void *ref)
{
  notify_ui = cb;
  notify_ref = ref;
}

#ifdef DEBUG
static void
print_knob(gpointer data, gpointer user_data)
{
  struct knob_descriptor *knob_description = data;
  GtkWidget *widget = knob_description->widget;
  GtkAllocation allocation;
  gtk_widget_get_allocation(widget, &allocation);
  printf("Widget %s:%s (%d,%d): %s\n",
         gtk_widget_get_name(widget), gtk_buildable_get_name(GTK_BUILDABLE(widget)),
         allocation.x, allocation.y,
         gtk_widget_get_visible(widget) ? "visible" : "hidden");
}

static void
print_knobmap(struct knobmap *knobmap)
{
  if (debug) {
    printf("Frame %s: Knobs:\n",
           gtk_buildable_get_name(GTK_BUILDABLE(knobmap->container)));
    g_list_foreach(knobmap->pots.active, print_knob, NULL);
    printf("Buttons:\n");
    g_list_foreach(knobmap->buttons.active, print_knob, NULL);
  }
}
#endif

/* Add knob_descriptor data to list pointed to by user_data, but 
 * only if the corresponding widget is VISIBLE */
static void
add_if_active(gpointer data, gpointer user_data)
{
  struct knob_descriptor *knob_descriptor = data;
  GList **active_list = user_data;

  if (gtk_widget_get_visible(knob_descriptor->widget))
    *active_list = g_list_prepend(*active_list, knob_descriptor);
}

/* Copy knob_descriptors with visible widgets to new list */
static GList *
copy_active(GList *knoblist)
{
  GList *active_list = NULL;
  g_list_foreach(knoblist, add_if_active, &active_list);

  return active_list;
}


/* Knob map build time functions */

/* Create a new map for container */
static void *
blofeld_knobs_container_new(GtkContainer *container)
{
  struct knobmap *knobmap = g_new0(struct knobmap, 1);

  if (current_container)
    eprintf("WARNING: %s called with container set\n", __func__);
  /* Save the container as the current one */
  current_container = container;

  /* Initialize knobmap structure */
  knobmap->container = container;
  /* knobnap->pots and knobmap->buttons = NULL; done by g_new0() */

  return knobmap;
}

/* Finish creating map for container */
static void *
blofeld_knobs_container_done(void *knobmap_in)
{
  struct knobmap *knobmap = knobmap_in;

  if (!current_container) {
    eprintf("WARNING: %s called with no container set\n", __func__);
    return NULL;
  }

  current_container = NULL;
  return knobmap;
}

/* Add widget to map for container */
static void *
blofeld_knobs_container_add_widget(void *knobmap_in,
                                   struct knob_descriptor *knob_description)
{
  struct knobmap *knobmap = knobmap_in;

  if (!knob_description) return knobmap;

  if (GTK_IS_RANGE(knob_description->widget))
    knobmap->pots.build = g_list_prepend(knobmap->pots.build,
                                         knob_description);
  else if (GTK_IS_COMBO_BOX(knob_description->widget))
    knobmap->buttons.build = g_list_prepend(knobmap->buttons.build,
                                            knob_description);
  /* We don't map toggle buttons or check buttons as it messes up the
   * ordering in for example the oscillator frames. */

  return knobmap;
}

static void sort_knobs(struct knoblist *knobs)
{
  if (knobs->active)
     g_list_free(knobs->active);
  knobs->active = copy_active(knobs->build);
  knobs->active = g_list_sort(knobs->active, left_right_compare);
}

/* Return knob_descriptor for knob no knob_no in the knobmap_in knob map */
static struct knob_descriptor *
blofeld_knob(void *knobmap_in, int knob_no, int alt_knob_no, int row)
{
  static int prev_knob_no = -1;
  static int prev_row = -1;
  static struct knobmap *prev_knobmap = NULL;
  static struct knob_descriptor *knob_descriptor = NULL;

  struct knobmap *knobmap = knobmap_in;

  if (!knobmap) return NULL;

  /* Caching: if called with same inparams as last time, and the knobmap
   * is still sorted (i.e. has not been invalidated), return same
   * knob_descriptor as last time. */
  if (knob_no == prev_knob_no &&
      knobmap == prev_knobmap &&
      row == prev_row &&
      knobmap->sorted)
    return knob_descriptor;

  prev_knob_no = knob_no;
  prev_knobmap = knobmap;
  prev_row = row;

  if (!knobmap->sorted) {
    sort_knobs(&knobmap->pots);
    sort_knobs(&knobmap->buttons);
#ifdef DEBUG
    print_knobmap(knobmap);
#endif
    knobmap->sorted = TRUE;
  }

  /* If we have a controller with more than one row of knobs, and the current
   * map has knobs than one row's worth, map solely as pots.
   * This happens for the modulation matrix for instance.
   * Note that we expect alt_knob_no only to be >= 0 under these circumstances.
   */
  int pots = g_list_length(knobmap->pots.active);
  if (alt_knob_no >= 0 && pots > alt_knob_no) {
    row = 0;
    knob_no = alt_knob_no;
  } else if (pots == 0) { /* no pots => map all knobs as buttons */
    row = 1;
    if (alt_knob_no >= 0)
      knob_no = alt_knob_no;
  }
  return knob_descriptor = g_list_nth_data(row == 0 ? 
                                           knobmap->pots.active : 
                                           knobmap->buttons.active, knob_no);
}

/* Invalidate current active knobmap, forcing blofeld_knob to create new
 * lists next the time a knob within the frame is moved, the most important
 * consequence of is that the visibility of the widgets is considered. */
static void
blofeld_invalidate(void *knobmap_in)
{
  struct knobmap *knobmap = knobmap_in;

  if (!knobmap) return;

  knobmap->sorted = FALSE;
}

/* Initialize knob mapper. */
void
blofeld_knobs_init(struct knob_mapper *knob_mapper)
{
  /* Start-up-time configuraton */
  knob_mapper->register_notify_cb = register_notify_cb;
  knob_mapper->container_new = blofeld_knobs_container_new;
  knob_mapper->container_done = blofeld_knobs_container_done;
  knob_mapper->container_add_widget = blofeld_knobs_container_add_widget;
  /* Run-time mapping */
  knob_mapper->knob = blofeld_knob;
  knob_mapper->invalidate = blofeld_invalidate;
};

/********************** End of file blofeld_knobs.c **************************/