ardour/libs/gtkmm2ext/cairo_widget.cc
Robin Gareus cba8fd090f Fix widget retina scaling (#9243)
For normal cairo-widgets ardour should not use image surfaces on macOS,
because that bypasses retina scaling. In theory explicit upsampling could
be performed (compere to openGL/cairo), but for the case at hand that is
overkill and inconvenient.

Performance critical widgets that render periodically can enable openGL
backing. Casual widgets (buttons with text, knobs, sliders etc) can be
rendered directly without any significant performance penalty.
2023-02-17 15:57:32 +01:00

470 lines
10 KiB
C++

/*
* Copyright (C) 2011-2016 Paul Davis <paul@linuxaudiosystems.com>
* Copyright (C) 2014-2018 Robin Gareus <robin@gareus.org>
* Copyright (C) 2014 Ben Loftis <ben@harrisonconsoles.com>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#include "gtkmm2ext/cairo_widget.h"
#include "gtkmm2ext/gui_thread.h"
#include "gtkmm2ext/rgb_macros.h"
#ifdef __APPLE__
#include <gdk/gdk.h>
#include "gtkmm2ext/nsglview.h"
#endif
#include "pbd/i18n.h"
static const char* has_cairo_widget_background_info = "has_cairo_widget_background_info";
sigc::slot<void,Gtk::Widget*> CairoWidget::focus_handler;
void CairoWidget::set_source_rgb_a( cairo_t* cr, Gdk::Color col, float a) //ToDo: this one and the Canvas version should be in a shared file (?)
{
float r = col.get_red_p ();
float g = col.get_green_p ();
float b = col.get_blue_p ();
cairo_set_source_rgba(cr, r, g, b, a);
}
void CairoWidget::set_source_rgb_a( cairo_t* cr, Gtkmm2ext::Color col, float a) //ToDo: this one and the Canvas version should be in a shared file (?)
{
int ir, ig, ib;
UINT_TO_RGB (col, &ir, &ig, &ib);
const float r = ir / 256.;
const float g = ig / 256.;
const float b = ib / 256.;
cairo_set_source_rgba(cr, r, g, b, a);
}
CairoWidget::CairoWidget ()
: _active_state (Gtkmm2ext::Off)
, _visual_state (Gtkmm2ext::NoVisualState)
, _need_bg (true)
, _grabbed (false)
, _name_proxy (this, X_("name"))
, _current_parent (0)
, _canvas_widget (false)
, _nsglview (0)
#ifdef __APPLE__
, _use_image_surface (false)
#elif defined USE_CAIRO_IMAGE_SURFACE
, _use_image_surface (true)
#else
, _use_image_surface (NULL != getenv("ARDOUR_IMAGE_SURFACE"))
#endif
, _widget_name ("")
{
_name_proxy.connect (sigc::mem_fun (*this, &CairoWidget::on_widget_name_changed));
}
CairoWidget::~CairoWidget ()
{
if (_canvas_widget) {
gtk_widget_set_realized (GTK_WIDGET(gobj()), false);
}
if (_parent_style_change) {
_parent_style_change.disconnect();
}
}
void
CairoWidget::set_canvas_widget ()
{
assert (!_nsglview);
assert (!_canvas_widget);
ensure_style ();
gtk_widget_set_realized (GTK_WIDGET(gobj()), true);
_canvas_widget = true;
_use_image_surface = false;
image_surface.clear ();
}
void
CairoWidget::use_nsglview (bool retina)
{
assert (!_nsglview);
assert (!_canvas_widget);
assert (!get_realized());
#ifdef ARDOUR_CANVAS_NSVIEW_TAG // patched gdkquartz.h
_nsglview = Gtkmm2ext::nsglview_create (this, retina);
#endif
}
void
CairoWidget::use_image_surface (bool yn)
{
if (_use_image_surface == yn) {
return;
}
image_surface.clear ();
_use_image_surface = yn;
}
int
CairoWidget::get_width () const
{
if (_canvas_widget && (_allocation.get_width() || _allocation.get_height())) {
return _allocation.get_width ();
}
return Gtk::EventBox::get_width ();
}
int
CairoWidget::get_height () const
{
if (_canvas_widget && (_allocation.get_width() || _allocation.get_height())) {
return _allocation.get_height ();
}
return Gtk::EventBox::get_height ();
}
void
CairoWidget::size_allocate (Gtk::Allocation& alloc)
{
if (_canvas_widget) {
memcpy (&_allocation, &alloc, sizeof(Gtk::Allocation));
return;
}
Gtk::EventBox::size_allocate (alloc);
}
bool
CairoWidget::on_button_press_event (GdkEventButton*)
{
focus_handler (this);
return false;
}
uint32_t
CairoWidget::background_color ()
{
if (_need_bg) {
Gdk::Color bg (get_parent_bg());
return RGBA_TO_UINT (bg.get_red() / 255, bg.get_green() / 255, bg.get_blue() / 255, 255);
} else {
return 0;
}
}
bool
CairoWidget::on_expose_event (GdkEventExpose *ev)
{
#ifdef __APPLE__
if (_nsglview) {
Gtkmm2ext::nsglview_queue_draw (_nsglview, ev->area.x, ev->area.y, ev->area.width, ev->area.height);
return true;
}
#endif
Cairo::RefPtr<Cairo::Context> cr;
if (_use_image_surface) {
if (!image_surface) {
image_surface = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, get_width(), get_height());
}
cr = Cairo::Context::create (image_surface);
} else {
cr = get_window()->create_cairo_context ();
}
cr->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height);
if (_need_bg) {
cr->clip_preserve ();
/* paint expose area the color of the parent window bg
*/
Gdk::Color bg (get_parent_bg());
cr->set_source_rgb (bg.get_red_p(), bg.get_green_p(), bg.get_blue_p());
cr->fill ();
} else {
cr->clip ();
}
cairo_rectangle_t expose_area;
expose_area.x = ev->area.x;
expose_area.y = ev->area.y;
expose_area.width = ev->area.width;
expose_area.height = ev->area.height;
render (cr, &expose_area);
if (_use_image_surface) {
image_surface->flush();
/* now blit our private surface back to the GDK one */
Cairo::RefPtr<Cairo::Context> window_context = get_window()->create_cairo_context ();
window_context->rectangle (ev->area.x, ev->area.y, ev->area.width, ev->area.height);
window_context->clip ();
window_context->set_source (image_surface, 0, 0);
window_context->set_operator (Cairo::OPERATOR_SOURCE);
window_context->paint ();
}
return true;
}
/** Marks the widget as dirty, so that render () will be called on
* the next GTK expose event.
*/
void
CairoWidget::set_dirty (cairo_rectangle_t *area)
{
ENSURE_GUI_THREAD (*this, &CairoWidget::set_dirty);
if (!area) {
queue_draw ();
} else {
// TODO emit QueueDrawArea -> ArdourCanvas::Widget
if (QueueDraw ()) {
return;
}
queue_draw_area (area->x, area->y, area->width, area->height);
}
}
void
CairoWidget::queue_draw ()
{
if (QueueDraw ()) {
return;
}
Gtk::EventBox::queue_draw ();
}
void
CairoWidget::queue_resize ()
{
if (QueueResize ()) {
return;
}
Gtk::EventBox::queue_resize ();
}
/** Handle a size allocation.
* @param alloc GTK allocation.
*/
void
CairoWidget::on_size_allocate (Gtk::Allocation& alloc)
{
if (!_canvas_widget) {
Gtk::EventBox::on_size_allocate (alloc);
} else {
memcpy (&_allocation, &alloc, sizeof(Gtk::Allocation));
}
if (_use_image_surface) {
image_surface.clear ();
image_surface = Cairo::ImageSurface::create (Cairo::FORMAT_ARGB32, alloc.get_width(), alloc.get_height());
}
if (_canvas_widget) {
return;
}
#ifdef __APPLE__
if (_nsglview) {
gint xx, yy;
gtk_widget_translate_coordinates(
GTK_WIDGET(gobj()),
GTK_WIDGET(get_toplevel()->gobj()),
0, 0, &xx, &yy);
Gtkmm2ext::nsglview_resize (_nsglview, xx, yy, alloc.get_width(), alloc.get_height());
}
#endif
set_dirty ();
}
Gdk::Color
CairoWidget::get_parent_bg ()
{
Widget* parent;
parent = get_parent ();
while (parent) {
void* p = g_object_get_data (G_OBJECT(parent->gobj()), has_cairo_widget_background_info);
if (p) {
Glib::RefPtr<Gtk::Style> style = parent->get_style();
if (_current_parent != parent) {
if (_parent_style_change) _parent_style_change.disconnect();
_current_parent = parent;
_parent_style_change = parent->signal_style_changed().connect (mem_fun (*this, &CairoWidget::on_style_changed));
}
return style->get_bg (Gtk::STATE_NORMAL);
}
if (!parent->get_has_window()) {
parent = parent->get_parent();
} else {
break;
}
}
if (parent && parent->get_has_window()) {
if (_current_parent != parent) {
if (_parent_style_change) _parent_style_change.disconnect();
_current_parent = parent;
_parent_style_change = parent->signal_style_changed().connect (mem_fun (*this, &CairoWidget::on_style_changed));
}
return parent->get_style ()->get_bg (Gtk::STATE_NORMAL);
}
return get_style ()->get_bg (get_state());
}
void
CairoWidget::set_active_state (Gtkmm2ext::ActiveState s)
{
if (_active_state != s) {
_active_state = s;
StateChanged ();
}
}
void
CairoWidget::set_visual_state (Gtkmm2ext::VisualState s)
{
if (_visual_state != s) {
_visual_state = s;
StateChanged ();
}
}
void
CairoWidget::set_active (bool yn)
{
/* this is an API simplification for buttons
that only use the Active and Normal states.
*/
if (yn) {
set_active_state (Gtkmm2ext::ExplicitActive);
} else {
unset_active_state ();
}
}
void
CairoWidget::on_style_changed (const Glib::RefPtr<Gtk::Style>&)
{
set_dirty ();
}
void
CairoWidget::on_realize ()
{
if (_canvas_widget) {
/* do not need a realized event box */
return;
}
Gtk::EventBox::on_realize();
#ifdef __APPLE__
if (_nsglview) {
Gtkmm2ext::nsglview_overlay (_nsglview, get_window()->gobj());
}
#endif
}
void
CairoWidget::on_map ()
{
Gtk::EventBox::on_map();
#ifdef __APPLE__
if (_nsglview) {
Gtkmm2ext::nsglview_set_visible (_nsglview, true);
Gtk::Allocation a = get_allocation();
gint xx, yy;
gtk_widget_translate_coordinates(
GTK_WIDGET(gobj()),
GTK_WIDGET(get_toplevel()->gobj()),
0, 0, &xx, &yy);
Gtkmm2ext::nsglview_resize (_nsglview, xx, yy, a.get_width(), a.get_height());
}
#endif
}
void
CairoWidget::on_unmap ()
{
Gtk::EventBox::on_unmap();
#ifdef __APPLE__
if (_nsglview) {
Gtkmm2ext::nsglview_set_visible (_nsglview, false);
}
#endif
}
void
CairoWidget::on_state_changed (Gtk::StateType)
{
/* this will catch GTK-level state changes from calls like
::set_sensitive()
*/
if (get_state() == Gtk::STATE_INSENSITIVE) {
set_visual_state (Gtkmm2ext::VisualState (visual_state() | Gtkmm2ext::Insensitive));
} else {
set_visual_state (Gtkmm2ext::VisualState (visual_state() & ~Gtkmm2ext::Insensitive));
}
set_dirty ();
}
void
CairoWidget::set_draw_background (bool yn)
{
_need_bg = yn;
}
void
CairoWidget::provide_background_for_cairo_widget (Gtk::Widget& w, const Gdk::Color& bg)
{
/* set up @w to be able to provide bg information to
any CairoWidgets that are packed inside it.
*/
w.modify_bg (Gtk::STATE_NORMAL, bg);
w.modify_bg (Gtk::STATE_INSENSITIVE, bg);
w.modify_bg (Gtk::STATE_ACTIVE, bg);
w.modify_bg (Gtk::STATE_SELECTED, bg);
g_object_set_data (G_OBJECT(w.gobj()), has_cairo_widget_background_info, (void*) 0xfeedface);
}
void
CairoWidget::set_focus_handler (sigc::slot<void,Gtk::Widget*> s)
{
focus_handler = s;
}
void
CairoWidget::on_widget_name_changed ()
{
Glib::ustring name = get_name();
if (_widget_name == name) {
return;
}
_widget_name = name;
on_name_changed ();
}