Merge lp:~gala-dev/gala/screenshot into lp:gala

[Rico Tzschichholz]

This implements part of the interface gnome-settings-daemon uses to take screenshots by using shortcuts (or the Print Screen key). It implements window screenshots and full screen screenshots.

[lp:~gala-dev/gala/screenshot]

552. By Rico Tzschichholz on 2017-01-05

maskcorners: Add missing license header

554. By Santiago on 2016-12-31

screenshotmanager: Implement Screenshot and ScreenshotArea

555. By Rico Tzschichholz on 2017-02-16

screenshotmanager: Add support for mutter 3.22+

556. By Rico Tzschichholz on 2017-02-16

dbus: Acquire "org.gnome.Shell.Screenshot" bus-name

=== modified file 'src/DBus.vala'
--- src/DBus.vala	2015-11-11 19:56:40 +0000
+++ src/DBus.vala	2017-02-16 18:34:50 +0000
@@ -39,6 +39,21 @@
 				},
 				() => {},
 				() => warning ("Could not acquire name\n") );
+
+			Bus.own_name (BusType.SESSION, "org.gnome.Shell", BusNameOwnerFlags.NONE,
+				(connection) => {
+					try {
+						connection.register_object ("/org/gnome/Shell", DBusAccelerator.init (wm));
+						connection.register_object ("/org/gnome/Shell/Screenshot", ScreenshotManager.init (wm));
+					} catch (Error e) { warning (e.message); }
+				},
+				() => {},
+				() => critical ("Could not acquire name") );
+
+			Bus.own_name (BusType.SESSION, "org.gnome.Shell.Screenshot", BusNameOwnerFlags.REPLACE,
+				() => {},
+				() => {},
+				() => critical ("Could not acquire name") );
 		}
 
 		private DBus ()

=== modified file 'src/DBusAccelerator.vala'
--- src/DBusAccelerator.vala	2016-08-03 11:14:55 +0000
+++ src/DBusAccelerator.vala	2017-02-16 18:34:50 +0000
@@ -27,24 +27,14 @@
 	public class DBusAccelerator
 	{
 		static DBusAccelerator? instance;
-		static WindowManager wm;
-
+		
 		[DBus (visible = false)]
-		public static void init (WindowManager _wm)
+		public static unowned DBusAccelerator init (WindowManager wm)
 		{
-			wm = _wm;
-
-			Bus.own_name (BusType.SESSION, "org.gnome.Shell", BusNameOwnerFlags.NONE,
-				(connection) => {
-					if (instance == null)
-						instance = new DBusAccelerator ();
-
-					try {
-						connection.register_object ("/org/gnome/Shell", instance);
-					} catch (Error e) { warning (e.message); }
-				},
-				() => {},
-				() => critical ("Could not acquire name") );
+			if (instance == null)
+				instance = new DBusAccelerator (wm);
+
+			return instance;
 		}
 
 #if HAS_GSD316
@@ -53,10 +43,12 @@
 		public signal void accelerator_activated (uint action, uint device_id, uint timestamp);
 #endif
 
+		WindowManager wm;
 		HashTable<string, uint?> grabbed_accelerators;
 
-		DBusAccelerator ()
+		DBusAccelerator (WindowManager _wm)
 		{
+			wm = _wm;
 			grabbed_accelerators = new HashTable<string, uint> (str_hash, str_equal);
 
 			wm.get_screen ().get_display ().accelerator_activated.connect (on_accelerator_activated);

=== modified file 'src/Makefile.am'
--- src/Makefile.am	2016-08-03 11:14:55 +0000
+++ src/Makefile.am	2017-02-16 18:34:50 +0000
@@ -8,6 +8,7 @@
 	--vapidir $(VAPIDIR) \
 	$(VAPIDIR)/config.vapi \
 	$(VAPIDIR)/cogl-fixes.vapi \
+	$(VAPIDIR)/compat.vapi \
 	$(NULL)
 
 galadir = $(bindir)
@@ -41,6 +42,7 @@
 	MediaFeedback.vala \
 	PluginManager.vala \
 	ScreenSaver.vala \
+	ScreenshotManager.vala \
 	Settings.vala \
 	ShadowEffect.vala \
 	TextShadowEffect.vala \

=== added file 'src/ScreenshotManager.vala'
--- src/ScreenshotManager.vala	1970-01-01 00:00:00 +0000
+++ src/ScreenshotManager.vala	2017-02-16 18:34:50 +0000
@@ -0,0 +1,167 @@
+//
+//  Copyright (C) 2016 Rico Tzschichholz, Santiago León O.
+//
+//  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 3 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, see <http://www.gnu.org/licenses/>.
+//
+
+namespace Gala
+{
+	[DBus (name="org.gnome.Shell.Screenshot")]
+	public class ScreenshotManager : Object
+	{
+		static ScreenshotManager? instance;
+
+		[DBus (visible = false)]
+		public static unowned ScreenshotManager init (WindowManager wm)
+		{
+			if (instance == null)
+				instance = new ScreenshotManager (wm);
+
+			return instance;
+		}
+
+		WindowManager wm;
+
+		ScreenshotManager (WindowManager _wm)
+		{
+			wm = _wm;
+		}
+
+		public void flash_area (int x, int y, int width, int height)
+		{
+			warning ("FlashArea not implemented");
+		}
+
+		public void screenshot (bool include_cursor, bool flash, string filename, out bool success, out string filename_used)
+		{
+			debug ("Taking screenshot");
+
+			int width, height;
+			wm.get_screen ().get_size (out width, out height);
+
+			var image = take_screenshot (0, 0, width, height);
+			success = save_image (image, filename, out filename_used);
+		}
+
+		public void screenshot_area (int x, int y, int width, int height, bool flash, string filename, out bool success, out string filename_used)
+		{
+			warning ("ScreenShotArea not implemented");
+			filename_used = "";
+			success = false;
+		}
+
+		public void screenshot_window (bool include_frame, bool include_cursor, bool flash, string filename, out bool success, out string filename_used)
+		{
+			debug ("Taking window screenshot");
+
+			var window = wm.get_screen ().get_display ().get_focus_window ();
+			var window_actor = (Meta.WindowActor) window.get_compositor_private ();
+			unowned Meta.ShapedTexture window_texture = (Meta.ShapedTexture) window_actor.get_texture ();
+
+			float actor_x, actor_y;
+			window_actor.get_position (out actor_x, out actor_y);
+
+			var rect = window.get_frame_rect ();
+			if (include_frame) {
+				rect = window.frame_rect_to_client_rect (rect);
+			}
+
+			Cairo.RectangleInt clip = { rect.x - (int) actor_x, rect.y - (int) actor_y, rect.width, rect.height };
+			var image = (Cairo.ImageSurface) window_texture.get_image (clip);
+			success = save_image (image, filename, out filename_used);
+		}
+
+		public void select_area (out int x, out int y, out int width, out int height)
+		{
+			warning ("SelectArea not implemented");
+			x = y = width = height = 0;
+		}
+
+		static bool save_image (Cairo.ImageSurface image, string filename, out string used_filename)
+		{
+			if (!Path.is_absolute (filename)) {
+				string path = Environment.get_user_special_dir (UserDirectory.PICTURES);
+				if (!FileUtils.test (path, FileTest.EXISTS)) {
+					path = Environment.get_home_dir ();
+				}
+
+				if (!filename.has_suffix (".png")) {
+					used_filename = Path.build_filename (path, filename.concat (".png"), null);
+				} else {
+					used_filename = Path.build_filename (path, filename, null);
+				}
+			} else {
+				used_filename = filename;
+			}
+
+			try {
+				var screenshot = Gdk.pixbuf_get_from_surface (image, 0, 0, image.get_width (), image.get_height ());
+				screenshot.save (used_filename, "png");
+				return true;
+			} catch (GLib.Error e) {
+				return false;
+			}
+		}
+
+		Cairo.ImageSurface take_screenshot (int x, int y, int width, int height)
+		{
+			Cairo.ImageSurface image;
+#if HAS_MUTTER322
+			Clutter.Capture[] captures;
+			wm.stage.capture (false, {x, y, width, height}, out captures);
+
+			if (captures.length == 0)
+				image = new Cairo.ImageSurface (Cairo.Format.ARGB32, width, height);
+			else if (captures.length == 1)
+				image = captures[0].image;
+			else
+				image = composite_capture_images (captures, x, y, width, height);
+#else
+			unowned Clutter.Backend backend = Clutter.get_default_backend ();
+			unowned Cogl.Context context = Clutter.backend_get_cogl_context (backend);
+
+			image = new Cairo.ImageSurface (Cairo.Format.ARGB32, width, height);
+			var bitmap = Cogl.bitmap_new_for_data (context, width, height, Cogl.PixelFormat.BGRA_8888_PRE, image.get_stride (), image.get_data ());
+			Cogl.framebuffer_read_pixels_into_bitmap (Cogl.get_draw_framebuffer (), x, y, Cogl.ReadPixelsFlags.BUFFER, bitmap);
+			image.mark_dirty ();
+#endif
+
+			return image;
+		}
+
+#if HAS_MUTTER322
+		Cairo.ImageSurface composite_capture_images (Clutter.Capture[] captures, int x, int y, int width, int height)
+		{
+			var image = new Cairo.ImageSurface (captures[0].image.get_format (), width, height);
+			var cr = new Cairo.Context (image);
+
+			foreach (unowned Clutter.Capture capture in captures) {
+				// Ignore capture regions with scale other than 1 for now; mutter can't
+				// produce them yet, so there is no way to test them.
+				double capture_scale = 1.0;
+				capture.image.get_device_scale (out capture_scale, null);
+				if (capture_scale != 1.0)
+					continue;
+
+				cr.save ();
+				cr.translate (capture.rect.x - x, capture.rect.y - y);
+				cr.set_source_surface (capture.image, 0, 0);
+				cr.restore ();
+			}
+
+			return image;
+		}
+#endif
+	}
+}

=== modified file 'vapi/Makefile.am'
--- vapi/Makefile.am	2016-11-14 14:38:40 +0000
+++ vapi/Makefile.am	2017-02-16 18:34:50 +0000
@@ -1,5 +1,6 @@
 VAPIS = \
 	cogl-fixes.vapi \
+	compat.vapi \
 	config.vapi \
 	libbamf3.vapi \
 	gdesktopenums-3.0.vapi \

=== added file 'vapi/compat.vapi'
--- vapi/compat.vapi	1970-01-01 00:00:00 +0000
+++ vapi/compat.vapi	2017-02-16 18:34:50 +0000
@@ -0,0 +1,21 @@
+namespace Cogl
+{
+	[CCode (cheader_filename = "cogl/cogl.h")]
+	public class Context : Cogl.Handle {
+	}
+
+	[CCode (cname = "cogl_bitmap_new_for_data")]
+	public static Cogl.Bitmap bitmap_new_for_data (Cogl.Context Context, int width, int height, Cogl.PixelFormat format, int rowstride, [CCode (array_length = false)] uchar[] data);
+
+	[CCode (cname = "cogl_get_draw_framebuffer")]
+	public static unowned Cogl.Framebuffer get_draw_framebuffer ();
+
+	[CCode (cname = "cogl_framebuffer_read_pixels_into_bitmap")]
+	public static Cogl.Bool framebuffer_read_pixels_into_bitmap (Cogl.Framebuffer framebuffer, int x, int y, Cogl.ReadPixelsFlags source, Cogl.Bitmap bitmap);
+}
+
+namespace Clutter
+{
+	[CCode (cname = "clutter_backend_get_cogl_context")]
+	public static unowned Cogl.Context backend_get_cogl_context (Clutter.Backend backend);
+}

=== modified file 'vapi/mutter-clutter-1.0.vapi'
--- vapi/mutter-clutter-1.0.vapi	2016-11-14 14:38:40 +0000
+++ vapi/mutter-clutter-1.0.vapi	2017-02-16 18:34:50 +0000
@@ -7330,7 +7330,7 @@
 		[CCode (has_construct_function = false, type = "ClutterActor*")]
 		[Version (since = "0.8")]
 		public Stage ();
-		public bool capture (bool paint, Cairo.RectangleInt rect, Clutter.Capture captures, int n_captures);
+		public bool capture (bool paint, Cairo.RectangleInt rect, out Clutter.Capture[] captures);
 		[CCode (cname = "clutter_stage_event")]
 		[Version (since = "0.4")]
 		public bool emit_event (Clutter.Event event);
@@ -8361,9 +8361,9 @@
 		public bool prev (out unowned Clutter.Actor child);
 		public void remove ();
 	}
-	[CCode (cheader_filename = "clutter/clutter.h", has_type_id = false)]
+	[CCode (cheader_filename = "clutter/clutter.h", has_destroy_function = false, has_type_id = false)]
 	public struct Capture {
-		public weak Cairo.Surface image;
+		public Cairo.ImageSurface image;
 		public Cairo.RectangleInt rect;
 	}
 	[CCode (cheader_filename = "clutter/clutter.h", type_id = "CLUTTER_TYPE_COLOR")]