2 Copyright (C) 2003 Paul Davis
4 This program is free software; you an 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.
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.
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.
21 #include "gtk2ardour-config.h"
32 #include <boost/algorithm/string.hpp>
34 #include <gtk/gtkpaned.h>
35 #include <gtkmm/combo.h>
36 #include <gtkmm/label.h>
37 #include <gtkmm/paned.h>
39 #include <gtkmm/stock.h>
40 #include <gtkmm/window.h>
42 #include "pbd/basename.h"
43 #include "pbd/file_utils.h"
44 #include "pbd/stacktrace.h"
46 #include "ardour/audioengine.h"
47 #include "ardour/filesystem_paths.h"
48 #include "ardour/search_paths.h"
50 #include "gtkmm2ext/colors.h"
51 #include "gtkmm2ext/utils.h"
53 #include "canvas/item.h"
57 #include "public_editor.h"
61 #include "rgb_macros.h"
62 #include "gui_thread.h"
63 #include "ui_config.h"
64 #include "ardour_dialog.h"
65 #include "ardour_ui.h"
71 using Gtkmm2ext::Keyboard;
73 namespace ARDOUR_UI_UTILS {
74 sigc::signal<void> DPIReset;
77 #ifdef PLATFORM_WINDOWS
78 #define random() rand()
82 /** Add an element to a menu, settings its sensitivity.
83 * @param m Menu to add to.
84 * @param e Element to add.
85 * @param s true to make sensitive, false to make insensitive
88 ARDOUR_UI_UTILS::add_item_with_sensitivity (Menu_Helpers::MenuList& m, Menu_Helpers::MenuElem e, bool s)
92 m.back().set_sensitive (false);
98 ARDOUR_UI_UTILS::just_hide_it (GdkEventAny */*ev*/, Gtk::Window *win)
105 idle_notify_engine_stopped ()
107 Glib::RefPtr<Action> act = ActionManager::get_action ("Window", "toggle-audio-midi-setup");
108 Glib::RefPtr<ToggleAction> tact = Glib::RefPtr<ToggleAction>::cast_dynamic(act);
111 _("The current operation is not possible because of an error communicating with the audio hardware."),
112 false, Gtk::MESSAGE_WARNING, Gtk::BUTTONS_NONE, true);
114 msg.add_button (_("Cancel"), Gtk::RESPONSE_CANCEL);
116 if (tact && !tact->get_active()) {
117 msg.add_button (_("Configure Hardware"), Gtk::RESPONSE_OK);
120 if (msg.run () == Gtk::RESPONSE_OK) {
123 return false; /* do not call again */
127 ARDOUR_UI_UTILS::engine_is_running ()
129 if (ARDOUR::AudioEngine::instance()->running ()) {
132 Glib::signal_idle().connect (sigc::ptr_fun (&idle_notify_engine_stopped));
137 /* xpm2rgb copied from nixieclock, which bore the legend:
139 nixieclock - a nixie desktop timepiece
140 Copyright (C) 2000 Greg Ercolano, erco@3dsite.com
142 and was released under the GPL.
146 ARDOUR_UI_UTILS::xpm2rgb (const char** xpm, uint32_t& w, uint32_t& h)
148 static long vals[256], val;
149 uint32_t t, x, y, colors, cpp;
151 unsigned char *savergb, *rgb;
155 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
156 error << string_compose (_("bad XPM header %1"), xpm[0])
161 savergb = rgb = (unsigned char*) malloc (h * w * 3);
163 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
164 for (t = 0; t < colors; ++t) {
165 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
169 // COLORMAP -> RGB CONVERSION
170 // Get low 3 bytes from vals[]
174 for (y = h-1; y > 0; --y) {
176 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 3) {
177 val = vals[(int)*p++];
178 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
179 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
180 *(rgb+0) = val & 0xff; // 0:R
188 ARDOUR_UI_UTILS::xpm2rgba (const char** xpm, uint32_t& w, uint32_t& h)
190 static long vals[256], val;
191 uint32_t t, x, y, colors, cpp;
193 unsigned char *savergb, *rgb;
198 if ( sscanf(xpm[0], "%u%u%u%u", &w, &h, &colors, &cpp) != 4 ) {
199 error << string_compose (_("bad XPM header %1"), xpm[0])
204 savergb = rgb = (unsigned char*) malloc (h * w * 4);
206 // LOAD XPM COLORMAP LONG ENOUGH TO DO CONVERSION
208 if (strstr (xpm[1], "None")) {
209 sscanf (xpm[1], "%c", &transparent);
216 for (; t < colors; ++t) {
217 sscanf (xpm[t+1], "%c c #%lx", &c, &val);
221 // COLORMAP -> RGB CONVERSION
222 // Get low 3 bytes from vals[]
226 for (y = h-1; y > 0; --y) {
230 for (p = xpm[1+colors+(h-y-1)], x = 0; x < w; x++, rgb += 4) {
232 if (transparent && (*p++ == transparent)) {
240 *(rgb+3) = alpha; // 3: alpha
241 *(rgb+2) = val & 0xff; val >>= 8; // 2:B
242 *(rgb+1) = val & 0xff; val >>= 8; // 1:G
243 *(rgb+0) = val & 0xff; // 0:R
250 /** Returns a Pango::FontDescription given a string describing the font.
252 * If the returned FontDescription does not specify a family, then
253 * the family is set to "Sans". This mirrors GTK's behaviour in
256 * Some environments will force Pango to specify the family
257 * even if it was not specified in the string describing the font.
258 * Such environments should be left unaffected by this function,
259 * since the font family will be left alone.
261 * There may be other similar font specification enforcement
262 * that we might add here later.
264 Pango::FontDescription
265 ARDOUR_UI_UTILS::sanitized_font (std::string const& name)
267 Pango::FontDescription fd (name);
269 if (fd.get_family().empty()) {
270 fd.set_family ("Sans");
276 Pango::FontDescription
277 ARDOUR_UI_UTILS::get_font_for_style (string widgetname)
279 Gtk::Window window (WINDOW_TOPLEVEL);
281 Glib::RefPtr<Gtk::Style> style;
284 foobar.set_name (widgetname);
285 foobar.ensure_style();
287 style = foobar.get_style ();
289 Glib::RefPtr<const Pango::Layout> layout = foobar.get_layout();
291 PangoFontDescription *pfd = const_cast<PangoFontDescription *> (pango_layout_get_font_description(const_cast<PangoLayout *>(layout->gobj())));
295 /* layout inherited its font description from a PangoContext */
297 PangoContext* ctxt = (PangoContext*) pango_layout_get_context (const_cast<PangoLayout*>(layout->gobj()));
298 pfd = pango_context_get_font_description (ctxt);
299 return Pango::FontDescription (pfd); /* make a copy */
302 return Pango::FontDescription (pfd); /* make a copy */
306 ARDOUR_UI_UTILS::gdk_color_from_rgb (uint32_t rgb)
309 set_color_from_rgb (c, rgb);
314 ARDOUR_UI_UTILS::gdk_color_from_rgba (uint32_t rgba)
317 set_color_from_rgb (c, rgba >> 8);
322 ARDOUR_UI_UTILS::set_color_from_rgb (Gdk::Color& c, uint32_t rgb)
324 /* Gdk::Color color ranges are 16 bit, so scale from 8 bit by
327 c.set_rgb ((rgb >> 16)*256, ((rgb & 0xff00) >> 8)*256, (rgb & 0xff)*256);
331 ARDOUR_UI_UTILS::set_color_from_rgba (Gdk::Color& c, uint32_t rgba)
333 /* Gdk::Color color ranges are 16 bit, so scale from 8 bit by
336 c.set_rgb ((rgba >> 24)*256, ((rgba & 0xff0000) >> 16)*256, ((rgba & 0xff00) >> 8)*256);
340 ARDOUR_UI_UTILS::gdk_color_to_rgba (Gdk::Color const& c)
342 /* since alpha value is not available from a Gdk::Color, it is
343 hardcoded as 0xff (aka 255 or 1.0)
346 const uint32_t r = c.get_red_p () * 255.0;
347 const uint32_t g = c.get_green_p () * 255.0;
348 const uint32_t b = c.get_blue_p () * 255.0;
349 const uint32_t a = 0xff;
351 return RGBA_TO_UINT (r,g,b,a);
355 ARDOUR_UI_UTILS::relay_key_press (GdkEventKey* ev, Gtk::Window* win)
357 return ARDOUR_UI::instance()->key_event_handler (ev, win);
361 ARDOUR_UI_UTILS::emulate_key_event (unsigned int keyval)
363 GdkDisplay *display = gtk_widget_get_display (GTK_WIDGET(ARDOUR_UI::instance()->main_window().gobj()));
364 GdkKeymap *keymap = gdk_keymap_get_for_display (display);
365 GdkKeymapKey *keymapkey = NULL;
368 if (!gdk_keymap_get_entries_for_keyval(keymap, keyval, &keymapkey, &n_keys)) return false;
369 if (n_keys !=1) { g_free(keymapkey); return false;}
371 Gtk::Window& main_window (ARDOUR_UI::instance()->main_window());
374 ev.type = GDK_KEY_PRESS;
375 ev.window = main_window.get_window()->gobj();
376 ev.send_event = FALSE;
381 ev.string = const_cast<gchar*> ("");
382 ev.hardware_keycode = keymapkey[0].keycode;
383 ev.group = keymapkey[0].group;
386 relay_key_press (&ev, &main_window);
387 ev.type = GDK_KEY_RELEASE;
388 return relay_key_press(&ev, &main_window);
391 Glib::RefPtr<Gdk::Pixbuf>
392 ARDOUR_UI_UTILS::get_xpm (std::string name)
394 if (!xpm_map[name]) {
396 Searchpath spath(ARDOUR::ardour_data_search_path());
398 spath.add_subdirectory_to_paths("pixmaps");
400 std::string data_file_path;
402 if(!find_file (spath, name, data_file_path)) {
403 fatal << string_compose (_("cannot find XPM file for %1"), name) << endmsg;
407 xpm_map[name] = Gdk::Pixbuf::create_from_file (data_file_path);
408 } catch(const Glib::Error& e) {
409 warning << "Caught Glib::Error: " << e.what() << endmsg;
413 return xpm_map[name];
417 ARDOUR_UI_UTILS::get_color_themes (map<std::string,std::string>& themes)
419 Searchpath spath(ARDOUR::theme_search_path());
421 for (vector<string>::iterator s = spath.begin(); s != spath.end(); ++s) {
423 vector<string> entries;
425 find_files_matching_pattern (entries, *s, string ("*") + UIConfiguration::color_file_suffix);
427 for (vector<string>::iterator e = entries.begin(); e != entries.end(); ++e) {
431 tree.read ((*e).c_str());
432 XMLNode* root = tree.root();
434 if (!root || root->name() != X_("Ardour")) {
438 XMLProperty const* prop = root->property (X_("theme-name"));
444 std::string color_name = basename_nosuffix(*e);
445 size_t sep = color_name.find_first_of("-");
446 if (sep != string::npos) {
447 color_name = color_name.substr (0, sep);
449 themes.insert (make_pair (prop->value(), color_name));
455 ARDOUR_UI_UTILS::get_icon_sets ()
457 Searchpath spath(ARDOUR::ardour_data_search_path());
458 spath.add_subdirectory_to_paths ("icons");
461 r.push_back (_("default"));
463 for (vector<string>::iterator s = spath.begin(); s != spath.end(); ++s) {
465 vector<string> entries;
467 get_paths (entries, *s, false, false);
469 for (vector<string>::iterator e = entries.begin(); e != entries.end(); ++e) {
470 if (Glib::file_test (*e, Glib::FILE_TEST_IS_DIR)) {
471 r.push_back (Glib::filename_to_utf8 (Glib::path_get_basename(*e)));
480 ARDOUR_UI_UTILS::get_icon_path (const char* cname, string icon_set, bool is_image)
482 std::string data_file_path;
489 Searchpath spath(ARDOUR::ardour_data_search_path());
491 if (!icon_set.empty() && icon_set != _("default")) {
493 /* add "icons/icon_set" but .. not allowed to add both of these at once */
494 spath.add_subdirectory_to_paths ("icons");
495 spath.add_subdirectory_to_paths (icon_set);
497 find_file (spath, name, data_file_path);
499 spath.add_subdirectory_to_paths ("icons");
500 find_file (spath, name, data_file_path);
503 if (data_file_path.empty()) {
504 Searchpath rc (ARDOUR::ardour_data_search_path());
505 rc.add_subdirectory_to_paths ("resources");
506 find_file (rc, name, data_file_path);
509 if (is_image && data_file_path.empty()) {
511 if (!icon_set.empty() && icon_set != _("default")) {
512 warning << string_compose (_("icon \"%1\" not found for icon set \"%2\", fallback to default"), cname, icon_set) << endmsg;
515 Searchpath def (ARDOUR::ardour_data_search_path());
516 def.add_subdirectory_to_paths ("icons");
518 if (!find_file (def, name, data_file_path)) {
519 fatal << string_compose (_("cannot find icon image for %1 using %2"), name, spath.to_string()) << endmsg;
520 abort(); /*NOTREACHED*/
524 return data_file_path;
527 Glib::RefPtr<Gdk::Pixbuf>
528 ARDOUR_UI_UTILS::get_icon (const char* cname, string icon_set)
530 Glib::RefPtr<Gdk::Pixbuf> img;
532 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname, icon_set));
533 } catch (const Gdk::PixbufError &e) {
534 cerr << "Caught PixbufError: " << e.what() << endl;
536 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
542 namespace ARDOUR_UI_UTILS {
543 Glib::RefPtr<Gdk::Pixbuf>
544 get_icon (const char* cname)
546 Glib::RefPtr<Gdk::Pixbuf> img;
548 img = Gdk::Pixbuf::create_from_file (get_icon_path (cname));
549 } catch (const Gdk::PixbufError &e) {
550 cerr << "Caught PixbufError: " << e.what() << endl;
552 error << string_compose (_("Caught exception while loading icon named %1"), cname) << endmsg;
560 ARDOUR_UI_UTILS::longest (vector<string>& strings)
562 if (strings.empty()) {
566 vector<string>::iterator longest = strings.begin();
567 string::size_type longest_length = (*longest).length();
569 vector<string>::iterator i = longest;
572 while (i != strings.end()) {
574 string::size_type len = (*i).length();
576 if (len > longest_length) {
578 longest_length = len;
588 ARDOUR_UI_UTILS::key_is_legal_for_numeric_entry (guint keyval)
590 /* we assume that this does not change over the life of the process
593 static int comma_decimal = -1;
598 if (comma_decimal < 0) {
599 std::lconv* lc = std::localeconv();
600 if (strchr (lc->decimal_point, ',') != 0) {
612 case GDK_decimalpoint:
613 case GDK_KP_Separator:
643 case GDK_KP_Subtract:
673 ARDOUR_UI_UTILS::resize_window_to_proportion_of_monitor (Gtk::Window* window, int max_width, int max_height)
675 Glib::RefPtr<Gdk::Screen> screen = window->get_screen ();
676 Gdk::Rectangle monitor_rect;
677 screen->get_monitor_geometry (0, monitor_rect);
679 int const w = std::min (int (monitor_rect.get_width() * 0.8), max_width);
680 int const h = std::min (int (monitor_rect.get_height() * 0.8), max_height);
682 window->resize (w, h);
686 /** Replace _ with __ in a string; for use with menu item text to make underscores displayed correctly */
688 ARDOUR_UI_UTILS::escape_underscores (string const & s)
691 string::size_type const N = s.length ();
693 for (string::size_type i = 0; i < N; ++i) {
705 ARDOUR_UI_UTILS::unique_random_color (list<Gdk::Color>& used_colors)
713 h = fmod (random(), 360.0);
714 s = (random() % 65535) / 65535.0;
715 v = (random() % 65535) / 65535.0;
717 s = min (0.5, s); /* not too saturated */
718 v = max (0.9, v); /* not too bright */
719 newcolor.set_hsv (h, s, v);
721 if (used_colors.size() == 0) {
722 used_colors.push_back (newcolor);
726 for (list<Gdk::Color>::iterator i = used_colors.begin(); i != used_colors.end(); ++i) {
728 float rdelta, bdelta, gdelta;
730 rdelta = newcolor.get_red() - c.get_red();
731 bdelta = newcolor.get_blue() - c.get_blue();
732 gdelta = newcolor.get_green() - c.get_green();
734 if (sqrt (rdelta*rdelta + bdelta*bdelta + gdelta*gdelta) > 25.0) {
735 /* different enough */
736 used_colors.push_back (newcolor);
741 /* XXX need throttle here to make sure we don't spin for ever */
746 ARDOUR_UI_UTILS::rate_as_string (float r)
749 if (fmod (r, 1000.0f)) {
750 snprintf (buf, sizeof (buf), "%.1f kHz", r/1000.0);
752 snprintf (buf, sizeof (buf), "%.0f kHz", r/1000.0);
758 ARDOUR_UI_UTILS::windows_overlap (Gtk::Window *a, Gtk::Window *b)
764 if (a->get_screen() == b->get_screen()) {
768 a->get_position (ex, ey);
769 a->get_size (ew, eh);
770 b->get_position (mx, my);
771 b->get_size (mw, mh);
787 if (gdk_rectangle_intersect (&e, &m, &r)) {
795 ARDOUR_UI_UTILS::overwrite_file_dialog (Gtk::Window& parent, string title, string text)
797 ArdourDialog dialog (parent, title, true);
800 dialog.get_vbox()->pack_start (label, true, true);
801 dialog.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
802 dialog.add_button (_("Overwrite"), Gtk::RESPONSE_ACCEPT);
805 switch (dialog.run()) {
806 case RESPONSE_ACCEPT:
808 case RESPONSE_CANCEL:
815 ARDOUR_UI_UTILS::running_from_source_tree ()
817 gchar const *x = g_getenv ("ARDOUR_THEMES_PATH");
818 return x && (string (x).find ("gtk2_ardour") != string::npos);