gtk2_ardour/color_theme_manager.cc

   1 /*
   2     Copyright (C) 2000-2016 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #include <cmath>
  21 #include <errno.h>
  22
  23 #include "fix_carbon.h"
  24
  25 #include "pbd/gstdio_compat.h"
  26
  27 #include "gtkmm2ext/cell_renderer_color_selector.h"
  28 #include "gtkmm2ext/utils.h"
  29
  30 #include "pbd/compose.h"
  31 #include "pbd/file_utils.h"
  32 #include "pbd/replace_all.h"
  33
  34 #include "ardour/filesystem_paths.h"
  35 #include "ardour/profile.h"
  36
  37 #include "canvas/container.h"
  38 #include "canvas/rectangle.h"
  39 #include "canvas/scroll_group.h"
  40 #include "canvas/wave_view.h"
  41
  42 #include "ardour_button.h"
  43 #include "ardour_dialog.h"
  44 #include "color_theme_manager.h"
  45 #include "rgb_macros.h"
  46 #include "ui_config.h"
  47 #include "utils.h"
  48
  49 #include "pbd/i18n.h"
  50
  51 using namespace std;
  52 using namespace Gtk;
  53 using namespace PBD;
  54 using namespace ARDOUR;
  55 using namespace ARDOUR_UI_UTILS;
  56
  57 ColorThemeManager::ColorThemeManager ()
  58         : reset_button (_("Restore Defaults"))
  59         , palette_viewport (*palette_scroller.get_hadjustment(), *palette_scroller.get_vadjustment())
  60         , palette_group (0)
  61         , palette_window (0)
  62         , color_theme_label (_("Color Theme"))
  63 {
  64         set_spacing (12);
  65
  66         std::map<string,string> color_themes;
  67
  68         get_color_themes (color_themes);
  69
  70         if (color_themes.size() > 1) {
  71                 theme_list = TreeStore::create (color_theme_columns);
  72
  73                 TreeModel::iterator selected_iter = theme_list->children().end();
  74                 const bool running_from_source = running_from_source_tree();
  75
  76                 for (std::map<string,string>::iterator c = color_themes.begin(); c != color_themes.end(); ++c) {
  77                         TreeModel::Row row;
  78
  79                         row = *(theme_list->append());
  80                         row[color_theme_columns.name] = c->first;
  81
  82                         string color_file_name = c->second;
  83
  84                         if (running_from_source) {
  85                                 /* color themes from within the source tree are
  86                                    suffixed by "-PROGRAM-NAME" (lowercased)
  87                                 */
  88                                 replace_all (color_file_name, string_compose ("-%1", downcase (PROGRAM_NAME)), "");
  89                         }
  90
  91                         row[color_theme_columns.path] = color_file_name;
  92
  93                         /* match second (path; really basename) since that is
  94                            what we store/restore.
  95                         */
  96
  97                         if (UIConfiguration::instance().get_color_file() == color_file_name) {
  98                                 selected_iter = row;
  99                         }
 100                 }
 101
 102                 color_theme_dropdown.set_model (theme_list);
 103                 color_theme_dropdown.pack_start (color_theme_columns.name);
 104
 105                 if (selected_iter != theme_list->children().end()) {
 106                         color_theme_dropdown.set_active (selected_iter);
 107                 }
 108
 109                 Gtk::HBox* hbox = Gtk::manage (new Gtk::HBox());
 110                 Gtk::Alignment* align = Gtk::manage (new Gtk::Alignment);
 111                 align->set (0, 0.5);
 112                 align->add (color_theme_dropdown);
 113                 hbox->set_spacing (6);
 114                 hbox->pack_start (color_theme_label, false, false);
 115                 hbox->pack_start (*align, true, true);
 116                 pack_start (*hbox, PACK_SHRINK);
 117                 hbox->show_all ();
 118         }
 119
 120         reset_button.signal_clicked().connect (sigc::mem_fun (*this, &ColorThemeManager::reset_canvas_colors));
 121
 122         /* Now the alias list */
 123
 124         alias_list = TreeStore::create (alias_columns);
 125         alias_display.set_model (alias_list);
 126         alias_display.append_column (_("Object"), alias_columns.name);
 127
 128         Gtkmm2ext::CellRendererColorSelector* color_renderer = manage (new Gtkmm2ext::CellRendererColorSelector);
 129         TreeViewColumn* color_column = manage (new TreeViewColumn (_("Color"), *color_renderer));
 130         color_column->add_attribute (color_renderer->property_color(), alias_columns.color);
 131         alias_display.append_column (*color_column);
 132
 133         alias_display.get_column (0)->set_data (X_("colnum"), GUINT_TO_POINTER(0));
 134         alias_display.get_column (0)->set_expand (true);
 135         alias_display.get_column (1)->set_data (X_("colnum"), GUINT_TO_POINTER(1));
 136         alias_display.get_column (1)->set_expand (false);
 137         alias_display.set_reorderable (false);
 138         alias_display.set_headers_visible (true);
 139
 140         alias_display.signal_button_press_event().connect (sigc::mem_fun (*this, &ColorThemeManager::alias_button_press_event), false);
 141
 142         alias_scroller.add (alias_display);
 143
 144         palette_group = initialize_palette_canvas (*palette_viewport.canvas());
 145         palette_viewport.signal_size_allocate().connect (sigc::bind (sigc::mem_fun (*this, &ColorThemeManager::palette_canvas_allocated), palette_group, palette_viewport.canvas(),
 146                                                                      sigc::mem_fun (*this, &ColorThemeManager::palette_event)));
 147         palette_scroller.add (palette_viewport);
 148
 149         modifier_scroller.add (modifier_vbox);
 150
 151         notebook.append_page (alias_scroller, _("Items"));
 152         notebook.append_page (palette_scroller, _("Palette"));
 153         notebook.append_page (modifier_scroller, _("Transparency"));
 154
 155         notebook.set_size_request (400, 400);
 156
 157         pack_start (notebook, true, true);
 158         pack_start (reset_button, false, false);
 159
 160         color_dialog.get_colorsel()->set_has_opacity_control (true);
 161         color_dialog.get_colorsel()->set_has_palette (true);
 162         color_dialog.get_ok_button()->signal_clicked().connect (sigc::bind (sigc::mem_fun (color_dialog, &Gtk::Dialog::response), RESPONSE_ACCEPT));
 163         color_dialog.get_cancel_button()->signal_clicked().connect (sigc::bind (sigc::mem_fun (color_dialog, &Gtk::Dialog::response), RESPONSE_CANCEL));
 164
 165         color_theme_dropdown.signal_changed().connect (sigc::mem_fun (*this, &ColorThemeManager::on_color_theme_changed));
 166
 167         /* no need to call setup_palette() here, it will be done when its size is allocated */
 168         setup_aliases ();
 169         setup_modifiers ();
 170
 171         UIConfiguration::instance().ColorsChanged.connect (sigc::mem_fun (*this, &ColorThemeManager::colors_changed));
 172
 173         show_all ();
 174 }
 175
 176 void
 177 ColorThemeManager::setup_modifiers ()
 178 {
 179         UIConfiguration* uic (&UIConfiguration::instance());
 180         UIConfiguration::Modifiers& modifiers (uic->modifiers);
 181         Gtk::HBox* mod_hbox;
 182         Gtk::Label* mod_label;
 183         Gtk::HScale* mod_scale;
 184
 185         Gtkmm2ext::container_clear (modifier_vbox);
 186
 187         for (UIConfiguration::Modifiers::const_iterator m = modifiers.begin(); m != modifiers.end(); ++m) {
 188                 mod_hbox = manage (new HBox);
 189
 190                 mod_scale = manage (new HScale (0.0, 1.0, 0.01));
 191                 mod_scale->set_draw_value (false);
 192                 mod_scale->set_value (m->second.a());
 193                 mod_scale->set_update_policy (Gtk::UPDATE_DISCONTINUOUS);
 194                 mod_scale->signal_value_changed().connect (sigc::bind (sigc::mem_fun (*this, &ColorThemeManager::modifier_edited), mod_scale, m->first));
 195
 196                 mod_label = manage (new Label (m->first));
 197                 mod_label->set_alignment (1.0, 0.5);
 198                 mod_label->set_size_request (150, -1); /* 150 pixels should be enough for anyone */
 199
 200                 mod_hbox->pack_start (*mod_label, false, true, 12);
 201                 mod_hbox->pack_start (*mod_scale, true, true);
 202
 203                 modifier_vbox.pack_start (*mod_hbox, false, false);
 204         }
 205
 206         modifier_vbox.show_all ();
 207
 208 }
 209
 210 void
 211 ColorThemeManager::modifier_edited (Gtk::Range* range, string name)
 212 {
 213         using namespace ArdourCanvas;
 214
 215         double alpha = range->get_value();
 216         SVAModifier svam (SVAModifier::Assign, -1.0, -1.0, alpha);
 217         UIConfiguration::instance().set_modifier (name, svam);
 218 }
 219
 220 void
 221 ColorThemeManager::colors_changed ()
 222 {
 223         setup_palette ();
 224         setup_aliases ();
 225         setup_modifiers ();
 226 }
 227
 228 void
 229 ColorThemeManager::reset_canvas_colors()
 230 {
 231         string cfile;
 232         string basename;
 233
 234         /* look for a versioned user-owned color file, and try to rename it */
 235
 236         basename = UIConfiguration::instance().color_file_name (true, false, true);
 237
 238         if (find_file (ardour_config_search_path(), basename, cfile)) {
 239                 string backup = cfile + string (X_(".old"));
 240                 g_rename (cfile.c_str(), backup.c_str());
 241                 /* don't really care if it fails */
 242         }
 243
 244         UIConfiguration::instance().load_color_theme (false);
 245         UIConfiguration::instance().save_state ();
 246 }
 247
 248 ArdourCanvas::Container*
 249 ColorThemeManager::initialize_palette_canvas (ArdourCanvas::Canvas& canvas)
 250 {
 251         using namespace ArdourCanvas;
 252
 253         /* hide background */
 254         canvas.set_background_color (rgba_to_color (0.0, 0.0, 1.0, 0.0));
 255
 256         /* bi-directional scroll group */
 257
 258         ScrollGroup* scroll_group = new ScrollGroup (canvas.root(), ScrollGroup::ScrollSensitivity (ScrollGroup::ScrollsVertically|ScrollGroup::ScrollsHorizontally));
 259         canvas.add_scroller (*scroll_group);
 260
 261         /* new container to hold everything */
 262
 263         return new ArdourCanvas::Container (scroll_group);
 264 }
 265
 266 void
 267 ColorThemeManager::palette_canvas_allocated (Gtk::Allocation& alloc, ArdourCanvas::Container* group, ArdourCanvas::Canvas* canvas, sigc::slot<bool,GdkEvent*,std::string> event_handler)
 268 {
 269         build_palette_canvas (*canvas, *group, event_handler);
 270 }
 271
 272 struct NamedColor {
 273         string name;
 274         ArdourCanvas::HSV    color;
 275         NamedColor (string s, ArdourCanvas::HSV c) : name (s), color (c) {}
 276 };
 277
 278 struct SortByHue {
 279         bool operator() (NamedColor const & a, NamedColor const & b) {
 280                 using namespace ArdourCanvas;
 281                 const HSV black (0, 0, 0);
 282                 if (a.color.is_gray() || b.color.is_gray()) {
 283                         return black.distance (a.color) < black.distance (b.color);
 284                 } else {
 285                         return a.color.h < b.color.h;
 286                         // const HSV red (rgba_to_color (1.0, 0.0, 0.0, 1.0));
 287                         // return red.distance (a.color) < red.distance (b.color);
 288                 }
 289         }
 290 };
 291
 292
 293 void
 294 ColorThemeManager::build_palette_canvas (ArdourCanvas::Canvas& canvas, ArdourCanvas::Container& group, sigc::slot<bool,GdkEvent*,std::string> event_handler)
 295 {
 296         using namespace ArdourCanvas;
 297
 298         /* we want the colors sorted by hue, with their name */
 299
 300         UIConfiguration::Colors& colors (UIConfiguration::instance().colors);
 301         vector<NamedColor> nc;
 302         for (UIConfiguration::Colors::const_iterator x = colors.begin(); x != colors.end(); ++x) {
 303                 nc.push_back (NamedColor (x->first, HSV (x->second)));
 304         }
 305         SortByHue sorter;
 306         sort (nc.begin(), nc.end(), sorter);
 307
 308         const uint32_t color_limit = nc.size();
 309         const double box_size = 20.0;
 310         const double width = canvas.width();
 311         const double height = canvas.height();
 312
 313         uint32_t color_num = 0;
 314
 315         /* clear existing rects and delete them */
 316
 317         group.clear (true);
 318
 319         for (uint32_t y = 0; y < height - box_size && color_num < color_limit; y += box_size) {
 320                 for (uint32_t x = 0; x < width - box_size && color_num < color_limit; x += box_size) {
 321                         ArdourCanvas::Rectangle* r = new ArdourCanvas::Rectangle (&group, ArdourCanvas::Rect (x, y, x + box_size, y + box_size));
 322
 323                         string name = nc[color_num++].name;
 324
 325                         UIConfiguration::Colors::iterator c = colors.find (name);
 326
 327                         if (c != colors.end()) {
 328                                 Color color = c->second;
 329                                 r->set_fill_color (color);
 330                                 r->set_outline_color (rgba_to_color (0.0, 0.0, 0.0, 1.0));
 331                                 r->set_tooltip (name);
 332                                 r->Event.connect (sigc::bind (event_handler, name));
 333                         }
 334                 }
 335         }
 336 }
 337
 338 void
 339 ColorThemeManager::palette_size_request (Gtk::Requisition* req)
 340 {
 341         uint32_t ncolors = UIConfiguration::instance().colors.size();
 342         const int box_size = 20;
 343
 344         double c = sqrt ((double)ncolors);
 345         req->width = (int) floor (c * box_size);
 346         req->height = (int) floor (c * box_size);
 347
 348         /* add overflow row if necessary */
 349
 350         if (fmod (ncolors, c) != 0.0) {
 351                 req->height += box_size;
 352         }
 353 }
 354
 355 void
 356 ColorThemeManager::setup_palette ()
 357 {
 358         build_palette_canvas (*palette_viewport.canvas(), *palette_group, sigc::mem_fun (*this, &ColorThemeManager::palette_event));
 359 }
 360
 361 bool
 362 ColorThemeManager::palette_event (GdkEvent* ev, string name)
 363 {
 364         switch (ev->type) {
 365         case GDK_BUTTON_RELEASE:
 366                 edit_palette_color (name);
 367                 return true;
 368         default:
 369                 break;
 370         }
 371         return true;
 372 }
 373
 374 void
 375 ColorThemeManager::edit_palette_color (std::string name)
 376 {
 377         using namespace ArdourCanvas;
 378         double r,g, b, a;
 379         UIConfiguration* uic (&UIConfiguration::instance());
 380         ArdourCanvas::Color c = uic->color (name);
 381         Gdk::Color gdkcolor;
 382
 383         color_to_rgba (c, r, g, b, a);
 384
 385         gdkcolor.set_rgb_p (r, g, b);
 386         color_dialog.get_colorsel()->set_previous_color (gdkcolor);
 387         color_dialog.get_colorsel()->set_current_color (gdkcolor);
 388         color_dialog.get_colorsel()->set_previous_alpha ((guint16) (a * 65535));
 389         color_dialog.get_colorsel()->set_current_alpha ((guint16) (a * 65535));
 390
 391         color_dialog_connection.disconnect ();
 392         color_dialog_connection = color_dialog.signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ColorThemeManager::palette_color_response), name));
 393         color_dialog.present();
 394 }
 395
 396 void
 397 ColorThemeManager::palette_color_response (int result, std::string name)
 398 {
 399         using namespace ArdourCanvas;
 400
 401         color_dialog_connection.disconnect ();
 402
 403         UIConfiguration* uic (&UIConfiguration::instance());
 404         Gdk::Color gdkcolor;
 405         double r,g, b, a;
 406
 407         switch (result) {
 408         case RESPONSE_ACCEPT:
 409         case RESPONSE_OK:
 410                 gdkcolor = color_dialog.get_colorsel()->get_current_color();
 411                 a = color_dialog.get_colorsel()->get_current_alpha() / 65535.0;
 412                 r = gdkcolor.get_red_p();
 413                 g = gdkcolor.get_green_p();
 414                 b = gdkcolor.get_blue_p();
 415
 416                 uic->set_color (name, rgba_to_color (r, g, b, a));
 417                 break;
 418
 419         default:
 420                 break;
 421         }
 422
 423         color_dialog.hide ();
 424 }
 425
 426 bool
 427 ColorThemeManager::alias_palette_event (GdkEvent* ev, string new_alias, string target_name)
 428 {
 429         switch (ev->type) {
 430         case GDK_BUTTON_RELEASE:
 431                 UIConfiguration::instance().set_alias (target_name, new_alias);
 432                 return true;
 433                 break;
 434         default:
 435                 break;
 436         }
 437         return false;
 438 }
 439
 440 void
 441 ColorThemeManager::alias_palette_response (int response, std::string target_name, std::string old_alias)
 442 {
 443         switch (response) {
 444         case GTK_RESPONSE_OK:
 445         case GTK_RESPONSE_ACCEPT:
 446                 /* rebuild alias list with new color: inefficient but simple */
 447                 setup_aliases ();
 448                 break;
 449
 450         case GTK_RESPONSE_REJECT:
 451                 /* revert choice */
 452                 UIConfiguration::instance().set_alias (target_name, old_alias);
 453                 break;
 454
 455         default:
 456                 /* do nothing */
 457                 break;
 458         }
 459
 460         palette_window->hide ();
 461 }
 462
 463 void
 464 ColorThemeManager::choose_color_from_palette (string const & name)
 465 {
 466         UIConfiguration* uic (&UIConfiguration::instance());
 467         UIConfiguration::ColorAliases::iterator i = uic->color_aliases.find (name);
 468
 469         if (i == uic->color_aliases.end()) {
 470                 return;
 471         }
 472
 473         delete palette_window;
 474
 475         palette_window = new ArdourDialog (_("Color Palette"));
 476         palette_window->add_button (Stock::CANCEL, RESPONSE_REJECT); /* using CANCEL causes confusion if dialog is closed via CloseAllDialogs */
 477         palette_window->add_button (Stock::OK, RESPONSE_OK);
 478
 479         ArdourCanvas::GtkCanvas* canvas = new ArdourCanvas::GtkCanvas ();
 480         ArdourCanvas::Container* group = initialize_palette_canvas (*canvas);
 481
 482         canvas->signal_size_request().connect (sigc::mem_fun (*this, &ColorThemeManager::palette_size_request));
 483         canvas->signal_size_allocate().connect (sigc::bind (sigc::mem_fun (*this, &ColorThemeManager::palette_canvas_allocated), group, canvas,
 484                                                             sigc::bind (sigc::mem_fun (*this, &ColorThemeManager::alias_palette_event), name)));
 485
 486         palette_window->get_vbox()->pack_start (*canvas);
 487         palette_window->show_all ();
 488
 489         palette_response_connection = palette_window->signal_response().connect (sigc::bind (sigc::mem_fun (*this, &ColorThemeManager::alias_palette_response), name, i->second));
 490
 491         palette_window->set_position (WIN_POS_MOUSE);
 492         palette_window->present ();
 493 }
 494
 495 void
 496 ColorThemeManager::setup_aliases ()
 497 {
 498         using namespace ArdourCanvas;
 499
 500         UIConfiguration* uic (&UIConfiguration::instance());
 501         UIConfiguration::ColorAliases& aliases (uic->color_aliases);
 502
 503         alias_list->clear ();
 504
 505         for (UIConfiguration::ColorAliases::iterator i = aliases.begin(); i != aliases.end(); ++i) {
 506                 TreeModel::Children rows = alias_list->children();
 507                 TreeModel::Row row;
 508                 string::size_type colon;
 509
 510                 if ((colon = i->first.find (':')) != string::npos) {
 511
 512                         /* this is supposed to be a child node, so find the
 513                          * parent
 514                          */
 515
 516                         string parent = i->first.substr (0, colon);
 517                         TreeModel::iterator ri;
 518
 519                         for (ri = rows.begin(); ri != rows.end(); ++ri) {
 520                                 string s = (*ri)[alias_columns.name];
 521                                 if (s == parent) {
 522                                         break;
 523                                 }
 524                         }
 525
 526                         if (ri == rows.end()) {
 527                                 /* not found, add the parent as new top level row */
 528                                 row = *(alias_list->append());
 529                                 row[alias_columns.name] = parent;
 530                                 row[alias_columns.alias] = "";
 531
 532                                 /* now add the child as a child of this one */
 533
 534                                 row = *(alias_list->insert (row->children().end()));
 535                                 row[alias_columns.name] = i->first.substr (colon+1);
 536                         } else {
 537                                 row = *(alias_list->insert ((*ri)->children().end()));
 538                                 row[alias_columns.name] = i->first.substr (colon+1);
 539                         }
 540
 541                 } else {
 542                         /* add as a child */
 543                         row = *(alias_list->append());
 544                         row[alias_columns.name] = i->first;
 545                         row[alias_columns.key] = i->first;
 546                 }
 547
 548                 row[alias_columns.key] = i->first;
 549                 row[alias_columns.alias] = i->second;
 550
 551                 Gdk::Color col;
 552                 double r, g, b, a;
 553                 Color c (uic->color (i->second));
 554                 color_to_rgba (c, r, g, b, a);
 555                 col.set_rgb_p (r, g, b);
 556
 557                 row[alias_columns.color] = col;
 558         }
 559 }
 560
 561 bool
 562 ColorThemeManager::alias_button_press_event (GdkEventButton* ev)
 563 {
 564         TreeIter iter;
 565         TreeModel::Path path;
 566         TreeViewColumn* column;
 567         int cellx;
 568         int celly;
 569
 570         if (!alias_display.get_path_at_pos ((int)ev->x, (int)ev->y, path, column, cellx, celly)) {
 571                 return false;
 572         }
 573
 574         guint32 colnum = GPOINTER_TO_UINT (column->get_data (X_("colnum")));
 575
 576         switch (colnum) {
 577         case 0:
 578                 /* allow normal processing to occur */
 579                 return false;
 580
 581         case 1: /* color */
 582                 if ((iter = alias_list->get_iter (path))) {
 583                         string target_color_alias = (*iter)[alias_columns.key];
 584                         if (!target_color_alias.empty()) {
 585                                 choose_color_from_palette (target_color_alias);
 586                         }
 587                 }
 588                 break;
 589         }
 590
 591         return true;
 592 }
 593
 594 void
 595 ColorThemeManager::parameter_changed (string const&)
 596 {
 597 }
 598
 599 void
 600 ColorThemeManager::set_state_from_config ()
 601 {
 602
 603 }
 604
 605 void
 606 ColorThemeManager::add_to_page (OptionEditorPage* page)
 607 {
 608         add_widget_to_page (page, this);
 609 }
 610
 611 Gtk::Widget&
 612 ColorThemeManager::tip_widget()
 613 {
 614         return reset_button; /* XXX need a better widget for this purpose */
 615 }
 616
 617 void
 618 ColorThemeManager::on_color_theme_changed ()
 619 {
 620         Gtk::TreeModel::iterator iter = color_theme_dropdown.get_active();
 621
 622         if (iter) {
 623                 Gtk::TreeModel::Row row = *iter;
 624
 625                 if (row) {
 626                         string new_theme = row[color_theme_columns.path];
 627                         UIConfiguration::instance().set_color_file (new_theme);
 628                 }
 629         }
 630 }