src/calf/gui.h

   1 /* Calf DSP Library
   2  * Universal GUI module
   3  * Copyright (C) 2007 Krzysztof Foltman
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (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 GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General
  16  * Public License along with this program; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20 #ifndef __CALF_GUI_H
  21 #define __CALF_GUI_H
  22
  23 #include <expat.h>
  24 #include <map>
  25 #include <set>
  26 #include <vector>
  27 #include <gtk/gtk.h>
  28 #include "custom_ctl.h"
  29
  30 struct CalfCurve;
  31 struct CalfKeyboard;
  32 struct CalfLed;
  33
  34 namespace calf_plugins {
  35
  36 class plugin_gui;
  37
  38 struct control_base
  39 {
  40     typedef std::map<std::string, std::string> xml_attribute_map;
  41     xml_attribute_map attribs;
  42     plugin_gui *gui;
  43     void require_attribute(const char *name);
  44     void require_int_attribute(const char *name);
  45     int get_int(const char *name, int def_value = 0);
  46     float get_float(const char *name, float def_value = 0.f);
  47 };
  48
  49 #define _GUARD_CHANGE_ if (in_change) return; guard_change __gc__(this);
  50
  51 struct param_control: public control_base
  52 {
  53     int param_no;
  54     std::string param_variable;
  55     GtkWidget *label, *widget;
  56     int in_change;
  57
  58     struct guard_change {
  59         param_control *pc;
  60         guard_change(param_control *_pc) : pc(_pc) { pc->in_change++; }
  61         ~guard_change() { pc->in_change--; }
  62     };
  63
  64     param_control() { gui = NULL; param_no = -1; label = NULL; in_change = 0;}
  65     inline parameter_properties &get_props();
  66
  67     virtual void init_xml(const char *element) {}
  68     virtual GtkWidget *create_label();
  69     virtual void update_label();
  70     /// called to create a widget for a control
  71     virtual GtkWidget *create(plugin_gui *_gui, int _param_no)=0;
  72     /// called to transfer the value from control to parameter(s)
  73     virtual void get()=0;
  74     /// called to transfer the value from parameter(s) to control
  75     virtual void set()=0;
  76     /// called on DSSI configure()
  77     virtual void configure(const char *key, const char *value) {}
  78     virtual void hook_params();
  79     virtual void on_idle() {}
  80     virtual ~param_control();
  81 };
  82
  83 /////////////////////////////////////////////////////////////////////////////////////////////
  84 // containers
  85
  86 struct control_container: public control_base
  87 {
  88     GtkContainer *container;
  89
  90     virtual GtkWidget *create(plugin_gui *_gui, const char *element, xml_attribute_map &attributes)=0;
  91     virtual void add(GtkWidget *w, control_base *base) { gtk_container_add(container, w); }
  92     virtual ~control_container() {}
  93 };
  94
  95 struct table_container: public control_container
  96 {
  97     virtual GtkWidget *create(plugin_gui *_gui, const char *element, xml_attribute_map &attributes);
  98     virtual void add(GtkWidget *w, control_base *base);
  99 };
 100
 101 struct alignment_container: public control_container
 102 {
 103     virtual GtkWidget *create(plugin_gui *_gui, const char *element, xml_attribute_map &attributes);
 104 };
 105
 106 struct frame_container: public control_container
 107 {
 108     virtual GtkWidget *create(plugin_gui *_gui, const char *element, xml_attribute_map &attributes);
 109 };
 110
 111 struct box_container: public control_container
 112 {
 113     virtual void add(GtkWidget *w, control_base *base);
 114 };
 115
 116 struct vbox_container: public box_container
 117 {
 118     virtual GtkWidget *create(plugin_gui *_gui, const char *element, xml_attribute_map &attributes);
 119 };
 120
 121 struct hbox_container: public box_container
 122 {
 123     virtual GtkWidget *create(plugin_gui *_gui, const char *element, xml_attribute_map &attributes);
 124 };
 125
 126 struct notebook_container: public control_container
 127 {
 128     virtual void add(GtkWidget *w, control_base *base);
 129     virtual GtkWidget *create(plugin_gui *_gui, const char *element, xml_attribute_map &attributes);
 130 };
 131
 132 struct scrolled_container: public control_container
 133 {
 134     virtual void add(GtkWidget *w, control_base *base);
 135     virtual GtkWidget *create(plugin_gui *_gui, const char *element, xml_attribute_map &attributes);
 136 };
 137
 138 ////////////////////////////////////////////////////////////////////////////////////////////////////
 139 // controls
 140
 141 /// Display-only control: static text
 142 struct label_param_control: public param_control
 143 {
 144     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 145     virtual void get() {}
 146     virtual void set() {}
 147 };
 148
 149 /// Display-only control: value text
 150 struct value_param_control: public param_control, public send_updates_iface
 151 {
 152     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 153     virtual void get() {}
 154     virtual void set();
 155     virtual void send_status(const char *key, const char *value);
 156 };
 157
 158 /// Display-only control: volume meter
 159 struct vumeter_param_control: public param_control
 160 {
 161     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 162     virtual void get() {}
 163     virtual void set();
 164 };
 165
 166 /// Display-only control: LED
 167 struct led_param_control: public param_control
 168 {
 169     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 170     virtual void get() {}
 171     virtual void set();
 172 };
 173
 174 /// Horizontal slider
 175 struct hscale_param_control: public param_control
 176 {
 177     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 178     virtual void get();
 179     virtual void set();
 180     virtual void init_xml(const char *element);
 181     static void hscale_value_changed(GtkHScale *widget, gpointer value);
 182     static gchar *hscale_format_value(GtkScale *widget, double arg1, gpointer value);
 183 };
 184
 185 /// Vertical slider
 186 struct vscale_param_control: public param_control
 187 {
 188     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 189     virtual void get();
 190     virtual void set();
 191     virtual void init_xml(const char *element);
 192     static void vscale_value_changed(GtkHScale *widget, gpointer value);
 193 };
 194
 195 /// Spin button
 196 struct spin_param_control: public param_control
 197 {
 198     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 199     virtual void get();
 200     virtual void set();
 201     static void value_changed(GtkSpinButton *widget, gpointer value);
 202 };
 203
 204 /// Check box
 205 struct toggle_param_control: public param_control
 206 {
 207     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 208     virtual void get();
 209     virtual void set();
 210     static void toggle_value_changed(GtkCheckButton *widget, gpointer value);
 211 };
 212
 213 /// Push button
 214 struct button_param_control: public param_control
 215 {
 216     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 217     virtual void get();
 218     virtual void set();
 219     static void button_clicked(GtkButton *widget, gpointer value);
 220 };
 221
 222 /// Combo list box
 223 struct combo_box_param_control: public param_control
 224 {
 225     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 226     virtual void get();
 227     virtual void set();
 228     static void combo_value_changed(GtkComboBox *widget, gpointer value);
 229 };
 230
 231 /// Line graph
 232 struct line_graph_param_control: public param_control
 233 {
 234     int last_generation;
 235
 236     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 237     virtual void get() {}
 238     virtual void set();
 239     virtual void on_idle();
 240     virtual ~line_graph_param_control();
 241 };
 242
 243 /// Knob
 244 struct knob_param_control: public param_control
 245 {
 246     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 247     virtual void get();
 248     virtual void set();
 249     static void knob_value_changed(GtkWidget *widget, gpointer value);
 250 };
 251
 252 /// Static keyboard image
 253 struct keyboard_param_control: public param_control
 254 {
 255     CalfKeyboard *kb;
 256
 257     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 258     virtual void get() {}
 259     virtual void set() {}
 260 };
 261
 262 /// Curve editor
 263 struct curve_param_control: public param_control, public send_configure_iface
 264 {
 265     CalfCurve *curve;
 266
 267     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 268     virtual void get() {}
 269     virtual void set() {}
 270     virtual void send_configure(const char *key, const char *value);
 271 };
 272
 273 /// Text entry
 274 struct entry_param_control: public param_control, public send_configure_iface
 275 {
 276     GtkEntry *entry;
 277
 278     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 279     virtual void get() {}
 280     virtual void set() {}
 281     virtual void send_configure(const char *key, const char *value);
 282     static void entry_value_changed(GtkWidget *widget, gpointer value);
 283 };
 284
 285 /// File chooser button
 286 struct filechooser_param_control: public param_control, public send_configure_iface
 287 {
 288     GtkFileChooserButton *filechooser;
 289
 290     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 291     virtual void get() {}
 292     virtual void set() {}
 293     virtual void send_configure(const char *key, const char *value);
 294     static void filechooser_value_changed(GtkWidget *widget, gpointer value);
 295 };
 296
 297 /// List view used for variable-length tabular data
 298 struct listview_param_control: public param_control, public send_configure_iface
 299 {
 300     GtkTreeView *tree;
 301     GtkListStore *lstore;
 302     calf_plugins::table_edit_iface *teif;
 303
 304     virtual GtkWidget *create(plugin_gui *_gui, int _param_no);
 305     virtual void get() {}
 306     virtual void set() {}
 307     virtual void send_configure(const char *key, const char *value);
 308     void update_store(const std::string &data);
 309 };
 310
 311 class plugin_gui_window;
 312
 313 class plugin_gui: public send_configure_iface, public send_updates_iface
 314 {
 315 protected:
 316     int param_count;
 317     std::multimap<int, param_control *> par2ctl;
 318     XML_Parser parser;
 319     param_control *current_control;
 320     std::vector<control_container *> container_stack;
 321     control_container *top_container;
 322     std::map<std::string, int> param_name_map;
 323     int ignore_stack;
 324     int last_status_serial_no;
 325 public:
 326     plugin_gui_window *window;
 327     GtkWidget *container;
 328     const char *effect_name;
 329     plugin_ctl_iface *plugin;
 330     std::vector<param_control *> params;
 331
 332     plugin_gui(plugin_gui_window *_window);
 333     GtkWidget *create_from_xml(plugin_ctl_iface *_plugin, const char *xml);
 334     param_control *create_control_from_xml(const char *element, const char *attributes[]);
 335     control_container *create_container_from_xml(const char *element, const char *attributes[]);
 336
 337     void add_param_ctl(int param, param_control *ctl) { par2ctl.insert(std::pair<int, param_control *>(param, ctl)); }
 338     void refresh();
 339     void refresh(int param_no, param_control *originator = NULL);
 340     void xml_element_start(const char *element, const char *attributes[]);
 341     void set_param_value(int param_no, float value, param_control *originator = NULL);
 342     /// Called on change of configure variable
 343     void send_configure(const char *key, const char *value);
 344     /// Called on change of status variable
 345     void send_status(const char *key, const char *value);
 346     void on_idle();
 347     ~plugin_gui();
 348     static void xml_element_start(void *data, const char *element, const char *attributes[]);
 349     static void xml_element_end(void *data, const char *element);
 350 };
 351
 352 class main_window_owner_iface;
 353
 354 class main_window_iface
 355 {
 356 public:
 357     virtual void set_owner(main_window_owner_iface *owner)=0;
 358
 359     virtual void add_plugin(plugin_ctl_iface *plugin)=0;
 360     virtual void del_plugin(plugin_ctl_iface *plugin)=0;
 361
 362     virtual void set_window(plugin_ctl_iface *plugin, plugin_gui_window *window)=0;
 363     virtual void refresh_all_presets(bool builtin_too)=0;
 364     virtual bool check_condition(const char *name)=0;
 365     virtual ~main_window_iface() {}
 366 };
 367
 368 class main_window_owner_iface
 369 {
 370 public:
 371     virtual void new_plugin(const char *name) = 0;
 372     virtual void remove_plugin(plugin_ctl_iface *plugin) = 0;
 373     virtual ~main_window_owner_iface() {}
 374 };
 375
 376 class plugin_gui_window
 377 {
 378 public:
 379     plugin_gui *gui;
 380     GtkWindow *toplevel;
 381     GtkUIManager *ui_mgr;
 382     GtkActionGroup *std_actions, *builtin_preset_actions, *user_preset_actions, *command_actions;
 383     main_window_iface *main;
 384     int source_id;
 385
 386     plugin_gui_window(main_window_iface *_main);
 387     std::string make_gui_preset_list(GtkActionGroup *grp, bool builtin, char &ch);
 388     std::string make_gui_command_list(GtkActionGroup *grp);
 389     void fill_gui_presets(bool builtin, char &ch);
 390     void create(plugin_ctl_iface *_plugin, const char *title, const char *effect);
 391     void close();
 392     static gboolean on_idle(void *data);
 393     ~plugin_gui_window();
 394 };
 395
 396
 397 inline parameter_properties &param_control::get_props()
 398 {
 399     return  *gui->plugin->get_param_props(param_no);
 400 }
 401
 402 class null_audio_module;
 403
 404 struct activate_command_params
 405 {
 406     typedef void (*CommandFunc)(null_audio_module *);
 407     plugin_gui *gui;
 408     int function_idx;
 409
 410     activate_command_params(plugin_gui *_gui, int _idx)
 411     : gui(_gui), function_idx(_idx)
 412     {
 413     }
 414 };
 415
 416 void activate_command(GtkAction *action, activate_command_params *params);
 417
 418 };
 419
 420 #endif