gtk2_ardour/color_theme_manager.cc

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