Move Bus disposal into Pipeline.Handle so that it can be disposed and GC'd when pipeline gets disposed, and enable tests for this.

Author: neilcsmith-net

src/org/freedesktop/gstreamer/Bin.java

@@ -30,6 +30,7 @@
 import org.freedesktop.gstreamer.glib.NativeFlags;
 import org.freedesktop.gstreamer.glib.Natives;
 import org.freedesktop.gstreamer.lowlevel.GstAPI.GstCallback;
+import org.freedesktop.gstreamer.lowlevel.GstObjectPtr;
 
 /**
  * Base class and element that can contain other elements.
@@ -73,6 +74,10 @@ protected Bin(Initializer init) {
         super(init);
     }
 
+    Bin(Handle handle, boolean needRef) {
+        super(handle, needRef);
+    }
+    
     /**
      * Creates a new Bin with a unique name.
      */
@@ -530,5 +535,13 @@ public int intValue() {
         }
 
     }
+    
+    static class Handle extends Element.Handle {
+        
+        public Handle(GstObjectPtr ptr, boolean ownsHandle) {
+            super(ptr, ownsHandle);
+        }
+        
+    }
 
 }

src/org/freedesktop/gstreamer/Element.java

@@ -32,6 +32,7 @@
 
 import static org.freedesktop.gstreamer.lowlevel.GstElementAPI.GSTELEMENT_API;
 import static org.freedesktop.gstreamer.lowlevel.GObjectAPI.GOBJECT_API;
+import org.freedesktop.gstreamer.lowlevel.GstObjectPtr;
 
 /**
  * Abstract base class for all pipeline elements.
@@ -79,6 +80,10 @@ public class Element extends GstObject {
     protected Element(Initializer init) {
         super(init);
     }
+    
+    Element(Handle handle, boolean needRef) {
+        super(handle, needRef);
+    }
 
     /**
      * Creates an instance of the required element type, but does not wrap it in
@@ -723,5 +728,13 @@ public void setStartTime(long time) {
     public boolean query(Query query) {
         return GSTELEMENT_API.gst_element_query(this, query);
     }
+    
+    static class Handle extends GstObject.Handle {
+        
+        public Handle(GstObjectPtr ptr, boolean ownsHandle) {
+            super(ptr, ownsHandle);
+        }
+        
+    }
 
 }

src/org/freedesktop/gstreamer/Pipeline.java

@@ -27,6 +27,7 @@
 
 import com.sun.jna.Pointer;
 import java.util.EnumSet;
+import java.util.concurrent.atomic.AtomicReference;
 import java.util.logging.Logger;
 
 
@@ -35,6 +36,7 @@
 import static org.freedesktop.gstreamer.lowlevel.GstQueryAPI.GSTQUERY_API;
 import org.freedesktop.gstreamer.glib.NativeFlags;
 import org.freedesktop.gstreamer.glib.Natives;
+import org.freedesktop.gstreamer.lowlevel.GstObjectPtr;
 
 /**
  * A {@code Pipeline} is a special {@link Bin} used as the top level container
@@ -94,17 +96,24 @@ public class Pipeline extends Bin {
     public static final String GTYPE_NAME = "GstPipeline";
 
     private static Logger LOG = Logger.getLogger(Pipeline.class.getName());
+    
+    private final Handle handle;
 
     protected Pipeline(Initializer init) {
-        super(init);
+        this(new Handle(init.ptr.as(GstObjectPtr.class, GstObjectPtr::new), init.ownsHandle), init.needRef);
+    }
+    
+    Pipeline(Handle handle, boolean needRef) {
+        super(handle, needRef);
+        this.handle = handle;
+        handle.busRef.set(GSTPIPELINE_API.gst_pipeline_get_bus(this));
     }
 
     /**
      * Creates a new instance of Pipeline with a unique name.
      */
     public Pipeline() {
         this(Natives.initializer(GSTPIPELINE_API.ptr_gst_pipeline_new(null), false));
-        initBus();
     }
 
     /**
@@ -114,24 +123,13 @@ public Pipeline() {
      */
     public Pipeline(String name) {
         this(initializer(name));
-        initBus();
     }
 
     private static Initializer initializer(String name) {
         Pointer new_pipeline = GSTPIPELINE_API.ptr_gst_pipeline_new(name);
         return Natives.initializer(new_pipeline, false);
     }
 
-    private void initBus() {
-        Bus bus = getBus();
-        // TODO started to work around with add_signal_watch - when working can
-        // remove this comment!
-        // This is mostly a hack to get the Bus to install a sync message handler
-        //
-//        bus.setFlushing(true);
-//        bus.setFlushing(false);
-    }
-
     /**
      * Usually, when a pipeline goes from READY to NULL state, it automatically
      * flushes all pending messages on the bus, which is done for refcounting
@@ -214,7 +212,7 @@ public void useClock(Clock clock) {
      */
     @Override
     public Bus getBus() {
-        return GSTPIPELINE_API.gst_pipeline_get_bus(this);
+        return handle.busRef.get();
     }
 
     /**
@@ -357,4 +355,35 @@ public Segment querySegment(Format format) {
         GSTQUERY_API.gst_query_parse_segment(qry, rate, fmt, start_value, stop_value);
         return new Segment(rate[0], fmt[0], start_value[0], stop_value[0]);
     }
+    
+    static class Handle extends Bin.Handle {
+        
+        private final AtomicReference<Bus> busRef;
+        
+        public Handle(GstObjectPtr ptr, boolean ownsHandle) {
+            super(ptr, ownsHandle);
+            this.busRef = new AtomicReference<>();
+        }
+
+        @Override
+        public void invalidate() {
+            disposeBus();
+            super.invalidate();
+        }
+
+        @Override
+        public void dispose() {
+            disposeBus();
+            super.dispose();
+        }
+
+        private void disposeBus() {
+            Bus bus = busRef.getAndSet(null);
+            if (bus != null) {
+                bus.dispose();
+            }
+        }
+        
+    }
+    
 }

test/org/freedesktop/gstreamer/ElementFactoryTest.java

@@ -156,7 +156,6 @@ public void testCreatePlaybin() {
         assertTrue("Element not a subclass of PlayBin", e instanceof PlayBin);
     }
     @Test
-    @Ignore
     public void testGarbageCollection() throws Throwable {
         ElementFactory factory = ElementFactory.find("fakesrc");
         assertNotNull("Could not locate fakesrc factory", factory);

test/org/freedesktop/gstreamer/GarbageCollectionEDTTest.java

@@ -131,14 +131,9 @@ public void pipelineBus() {
 
     }
     @Test
-    @Ignore("See comment below.")
     public void busWithListeners() {
         Pipeline pipe = new Pipeline("test");
         Bus bus = pipe.getBus();
-        // Reasoning for @Igore:
-        //
-        // #connect increments the native reference count this in turn prevents 
-        // the native part of the BUS to get out of scope.
         bus.connect(new Bus.EOS() {
 
             public void endOfStream(GstObject source) {

test/org/freedesktop/gstreamer/GarbageCollectionTest.java

@@ -130,14 +130,9 @@ public void pipelineBus() {
 
     }
     @Test
-    @Ignore("See comment below.")
     public void busWithListeners() {
         Pipeline pipe = new Pipeline("test");
         Bus bus = pipe.getBus();
-        // Reasoning for @Igore:
-        //
-        // #connect increments the native reference count this in turn prevents 
-        // the native part of the BUS to get out of scope.
         bus.connect(new Bus.EOS() {
 
             public void endOfStream(GstObject source) {