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