Make gstreamer pipeline configurable

Author: phillipberndt

README.rst

@@ -165,8 +165,9 @@ Embedded video playback is not working.
 
 You likely have a ``gstreamer`` codec issue.  First, try to install
 ``gstreamer``'s 'bad' codecs (package ``libgstreamer-plugins-bad1.0-0`` on
-Debian/Ubuntu). By doing so, ``pdfpc`` will use ``gstreamer``'s OpenGL backend
-for rendering, which might solve your issue.
+Debian/Ubuntu) and add ``option gstreamer-pipeline glimagesink`` to your
+``pdfpcrc`` file.  By doing so, ``pdfpc`` will use ``gstreamer``'s OpenGL
+backend for rendering, which might solve your issue.
 
 If the problem persists, try loading the video file you want to play with the
 following command: ``gst-launch-1.0 filesrc location=<your video> ! decodebin !

man/pdfpcrc.in

@@ -60,6 +60,9 @@ Add an additional black slide at the end of the presentation (bool, Default fals
 .B current-height
 Percentage of the height of the presenter screen to be used for the current slide. (int, Default 80)
 .TP
+.B current-size
+Percentage of the presenter screen to be used for the current slide. (int, Default 60)
+.TP
 .BI disable-caching
 see
 .B pdfpcrc(5)
@@ -68,8 +71,9 @@ see
 see
 .B pdfpcrc(5)
 .TP
-.B current-size
-Percentage of the presenter screen to be used for the current slide. (int, Default 60)
+.B gstreamer-pipeline
+Video rendering methods. Valid values are \fIxvimagesink\fR and \fIglimagesink\fR. (Default
+xvimagesink)
 .TP
 .B next-height
 Percentage of the height of the presenter screen to be used for the next slide. (int, Default 70)

src/classes/action/movie.vala

@@ -298,16 +298,20 @@ namespace pdfpc {
                     break;
                 }
                 Gst.Element sink;
-                // if the gstreamer OpenGL sink is installed (in gstreamer-plugins-bad), use it
-                // as it fixes video issues (cf pdfpc/pdfpc#197). Otherwise, fallback on
-                // default xvimagesink.
-                Gst.ElementFactory glimagesinkFactory = Gst.ElementFactory.find("glimagesink");
-                if(glimagesinkFactory != null) {
-                    sink = glimagesinkFactory.create(@"sink$n");
-                } else {
-                    GLib.printerr("gstreamer's OpenGL plugin glimagesink not available. Using xvimagesink instead.\n");
-                    sink = Gst.ElementFactory.make("xvimagesink", @"sink$n");
+
+                switch(Options.gstreamer_pipeline) {
+                    case Options.GstreamerPipeline.XVIMAGESINK:
+                        sink = Gst.ElementFactory.make("xvimagesink", @"sink$n");
+                        break;
+                    case Options.GstreamerPipeline.GLIMAGESINK:
+                        sink = Gst.ElementFactory.make("glimagesink", @"sink$n");
+                        break;
+                    default:
+                        GLib.printerr("Invalid gstreamer-pipeline selected. Falling back to autovideosink.\n");
+                        sink = Gst.ElementFactory.make("autovideosink", @"sink$n");
+                        break;
                 }
+
                 Gst.Element queue = Gst.ElementFactory.make("queue", @"queue$n");
                 bin.add_many(queue,sink);
                 tee.link(queue);
@@ -316,7 +320,7 @@ namespace pdfpc {
                 sink.set("force_aspect_ratio", false);
                 Gst.Video.Overlay xoverlay = (Gst.Video.Overlay) sink;
 
-                if(glimagesinkFactory != null) {
+                if(Options.gstreamer_pipeline == Options.GstreamerPipeline.GLIMAGESINK) {
                     var overlay_widget = this.controller.overlay_widget(n, this.area);
                     if (overlay_widget.get_realized()) {
                         xoverlay.set_window_handle((uint*)((Gdk.X11.Window) overlay_widget.get_window()).get_xid());
@@ -327,7 +331,7 @@ namespace pdfpc {
                         });
                     }
                 }
-                else {
+                else if(Options.gstreamer_pipeline == Options.GstreamerPipeline.XVIMAGESINK) {
                     xoverlay.set_window_handle(xid);
                     xoverlay.set_render_rectangle(rect.x*gdk_scale, rect.y*gdk_scale,
                                                   rect.width*gdk_scale, rect.height*gdk_scale);

src/classes/config_file_reader.vala

@@ -253,6 +253,19 @@ namespace pdfpc {
                         Options.use_time_of_day = true;
                     }
                     break;
+                case "gstreamer-pipeline":
+                    switch(fields[2]) {
+                        case "xvimagesink":
+                            Options.gstreamer_pipeline = Options.GstreamerPipeline.XVIMAGESINK;
+                            break;
+                        case "glimagesink":
+                            Options.gstreamer_pipeline = Options.GstreamerPipeline.GLIMAGESINK;
+                            break;
+                        default:
+                            GLib.printerr("Invalid value for option gstreamer-pipeline, only xvimagesink and glimagesink are supported\n");
+                            break;
+                    }
+                    break;
                 default:
                     GLib.printerr("Unknown option %s in pdfpcrc\n", fields[1]);
                     break;

src/classes/options.vala

@@ -157,6 +157,16 @@ namespace pdfpc {
          */
         public static bool version = false;
 
+        public enum GstreamerPipeline {
+            XVIMAGESINK,
+            GLIMAGESINK,
+        }
+
+        /**
+         * Select the gstreamer pipeline to use for video output
+         */
+        public static GstreamerPipeline gstreamer_pipeline = GstreamerPipeline.XVIMAGESINK;
+
         public class BindTuple {
             public string type;
             public uint keyCode;