Remove old XOverlay interface and API, and tidy up replacement VideoOverlay interface and API.

Author: neilcsmith-net

src/org/freedesktop/gstreamer/interfaces/VideoOverlay.java

@@ -1,4 +1,5 @@
 /* 
+ * Copyright (C) 2019 Neil C Smith
  * Copyright (C) 2009 Levente Farkas <[email protected]>
  * Copyright (C) 2009 Tamas Korodi <[email protected]>
  * Copyright (C) 2008 Wayne Meissner
@@ -24,16 +25,15 @@
 
 import static org.freedesktop.gstreamer.lowlevel.GstVideoOverlayAPI.GSTVIDEOOVERLAY_API;
 
+import com.sun.jna.Pointer;
 import org.freedesktop.gstreamer.BusSyncReply;
 import org.freedesktop.gstreamer.Element;
 import org.freedesktop.gstreamer.Message;
 
-import com.sun.jna.Native;
-import com.sun.jna.NativeLong;
-import com.sun.jna.Platform;
 
 /**
- * Interface for elements providing tuner operations
+ * Interface for setting/getting a window system resource on elements
+ * supporting it to configure a window into which to render a video.
  */
 public class VideoOverlay extends GstInterface {
     /**
@@ -48,21 +48,21 @@ public static VideoOverlay wrap(Element element) {
 
     /**
      * Convenience function to check if the given message is a "prepare-window-handle".
-     * This usefull for setup native window handles with {@link BusSyncReply}.
+     * This useful for setup native window handles with {@link BusSyncReply}.
      * 
      * @param message
      * @return
      */
-    public static boolean isVideoOverlayPrepareWindowHandleMessage(Message message) {
+    public static boolean isPrepareWindowHandleMessage(Message message) {
         return GSTVIDEOOVERLAY_API.gst_is_video_overlay_prepare_window_handle_message(message);
     }
 
     /**
-     * Creates a new <tt>XOverlay</tt> instance
+     * Creates a new <tt>VideoOverlay</tt> instance
      * 
-     * @param element the element that implements the tuner interface
+     * @param element the element that implements the overlay interface
      */
-    protected VideoOverlay(Element element) {
+    private VideoOverlay(Element element) {
         super(element, GSTVIDEOOVERLAY_API.gst_video_overlay_get_type());
     }
 
@@ -72,25 +72,7 @@ protected VideoOverlay(Element element) {
      * @param handle A native handle to use to display video.
      */
     public void setWindowHandle(long handle) {
-      GSTVIDEOOVERLAY_API.gst_video_overlay_set_window_handle(this, new NativeLong(handle));
-    }
-    /**
-     * Sets the native window for the {@link Element} to use to display video.
-     *
-     * @param window A native window to use to display video, or <tt>null</tt> to
-     * stop using the previously set window.
-     */
-    public void setWindowHandle(java.awt.Component window) {
-        if (window == null) {
-            setWindowHandle(0);
-            return;
-        }
-        if (window.isLightweight())
-            throw new IllegalArgumentException("Component must be a native window");
-        if (Platform.isWindows())
-            GSTVIDEOOVERLAY_API.gst_video_overlay_set_window_handle(this, Native.getComponentPointer(window));
-        else
-            setWindowHandle(Native.getComponentID(window));
+      GSTVIDEOOVERLAY_API.gst_video_overlay_set_window_handle(this, new Pointer(handle));
     }
 
     /**
@@ -116,7 +98,7 @@ public void handleEvent(boolean handle_events) {
      * Configure a subregion as a video target within the window set by 
      * {@link #setWindowHandle(long)}. If this is not used or not supported 
      * the video will fill the area of the window set as the overlay to 100%. 
-     * By specifying the rectangle, the video can be overlayed to a specific 
+     * By specifying the rectangle, the video can be overlaid to a specific 
      * region of that window only. After setting the new rectangle one should 
      * call {@link #expose()} to force a redraw. To unset the region pass -1 
      * for the width and height parameters.
@@ -132,28 +114,5 @@ public void handleEvent(boolean handle_events) {
     public boolean setRenderRectangle(int x, int y, int width, int height) {
     	return GSTVIDEOOVERLAY_API.gst_video_overlay_set_render_rectangle(this, x, y, width, height);
     }
-    
-    /**
-     * Configure a subregion as a video target within the window set by 
-     * {@link #setWindowHandle(long)}. If this is not used or not supported 
-     * the video will fill the area of the window set as the overlay to 100%. 
-     * By specifying the rectangle, the video can be overlayed to a specific 
-     * region of that window only. After setting the new rectangle one should 
-     * call {@link #expose()} to force a redraw. To unset the region pass -1 
-     * for the width and height parameters.
-     * 
-     * This method is needed for non fullscreen video overlay in UI toolkits 
-     * that do not support subwindows.
-     * 
-     * @param overlay
-     * @param x
-     * @param y
-     * @param width
-     * @param height
-     */
-    @Deprecated
-    public boolean setRenderRectangle(VideoOverlay overlay, int x, int y, int width, int height) {
-    	return GSTVIDEOOVERLAY_API.gst_video_overlay_set_render_rectangle(this, x, y, width, height);
-    }
 
 }

src/org/freedesktop/gstreamer/interfaces/XOverlay.java

@@ -1,4 +1,5 @@
 /* 
+ * Copyright (c) 2019 Neil C Smith
  * Copyright (c) 2009 Levente Farkas
  * Copyright (c) 2009 Tamas Korodi <[email protected]>
  * 
@@ -31,9 +32,6 @@ public interface GstVideoOverlayAPI extends Library {
 
 	GType gst_video_overlay_get_type();
 
-	/* virtual class function wrappers */
-	void gst_video_overlay_set_window_handle(VideoOverlay overlay, NativeLong xwindow_id);
-
 	void gst_video_overlay_set_window_handle(VideoOverlay overlay, Pointer xwindow_id);
 
 	void gst_video_overlay_got_window_handle(VideoOverlay overlay, NativeLong xwindow_id);