Merge pull request #235 from codelerity/bus-message-rewrite

Bus message handling rewrite

Author: neilcsmith-net

src/org/freedesktop/gstreamer/Bus.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2019 Neil C Smith
+ * Copyright (c) 2020 Neil C Smith
  *
  * This file is part of gstreamer-java.
  *
@@ -15,26 +15,57 @@
  * You should have received a copy of the GNU Lesser General Public License
  * version 3 along with this work.  If not, see <http://www.gnu.org/licenses/>.
  */
-
 package org.freedesktop.gstreamer.glib;
 
 /**
  * Interface for enums that wrap a native int-based enum.
+ *
  * @param <T> Java enum type
  */
 public interface NativeEnum<T extends Enum<T>> {
 
     public int intValue();
 
+    /**
+     * Convert a native int value to the specified NativeEnum type.
+     *
+     * @param <T> enum type
+     * @param type enum class
+     * @param intValue native int value
+     * @return enum value
+     * @throws IllegalArgumentException if no enum value matches the specified
+     * native int value
+     */
     public static <T extends Enum<T> & NativeEnum<T>> T fromInt(Class<T> type, int intValue) {
         for (T value : type.getEnumConstants()) {
             if (value.intValue() == intValue) {
                 return value;
             }
         }
 
-        throw new IllegalArgumentException("Value " + intValue + " is unacceptable for " +
-                type.getSimpleName() + " enum");
+        throw new IllegalArgumentException("Value " + intValue + " is unacceptable for "
+                + type.getSimpleName() + " enum");
+    }
+
+    /**
+     * Convert a native int value to the specified NativeEnum type, allowing for
+     * a default value (or null) to be returned instead of throwing an exception
+     * on invalid values.
+     *
+     * @param <T> enum type
+     * @param type enum class
+     * @param defValue default value to return if no match (may be null)
+     * @param intValue native int value
+     * @return enum value
+     */
+    public static <T extends Enum<T> & NativeEnum<T>> T fromInt(Class<T> type, T defValue, int intValue) {
+        for (T value : type.getEnumConstants()) {
+            if (value.intValue() == intValue) {
+                return value;
+            }
+        }
+
+        return defValue;
     }
 
 }

src/org/freedesktop/gstreamer/glib/NativeEnum.java

@@ -1,4 +1,5 @@
 /* 
+ * Copyright (c) 2020 Neil C Smith
  * Copyright (c) 2014 Tom Greenwood <[email protected]>
  * Copyright (c) 2009 Levente Farkas
  * Copyright (c) 2007, 2008 Wayne Meissner
@@ -54,10 +55,10 @@ public interface GstBusAPI extends com.sun.jna.Library {
 
     void gst_bus_set_flushing(Bus ptr, int flushing);
     interface BusCallback extends GstCallback {
-        boolean callback(Bus bus, Message msg, Pointer data);
+        boolean callback(GstBusPtr bus, GstMessagePtr msg, Pointer data);
     }
     public interface BusSyncHandler extends GstCallback {
-    	BusSyncReply callback(Bus bus, Message msg, Pointer userData);
+    	BusSyncReply callback(GstBusPtr bus, GstMessagePtr msg, Pointer userData);
     }
     NativeLong gst_bus_add_watch(Bus bus, BusCallback function, Pointer data);
     void gst_bus_set_sync_handler(Bus bus, BusSyncHandler function, Pointer data, GDestroyNotify destroyCallback);

src/org/freedesktop/gstreamer/lowlevel/GstBusAPI.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2020 Neil C Smith
+ * 
+ * This file is part of gstreamer-java.
+ *
+ * This code is free software: you can redistribute it and/or modify it under the terms of the GNU
+ * Lesser General Public License version 3 only, as published by the Free Software Foundation.
+ *
+ * This code 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
+ * Lesser General Public License version 3 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License version 3 along with
+ * this work. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.freedesktop.gstreamer.lowlevel;
+
+import com.sun.jna.Pointer;
+
+/**
+ * GstBus pointer.
+ */
+public class GstBusPtr extends GstObjectPtr {
+    
+    public GstBusPtr() {
+    }
+    
+    public GstBusPtr(Pointer ptr) {
+        super(ptr);
+    }
+    
+}

src/org/freedesktop/gstreamer/lowlevel/GstBusPtr.java

@@ -1,4 +1,5 @@
 /* 
+ * Copyright (c) 2020 Neil C Smith
  * Copyright (c) 2014 Tom Greenwood <[email protected]>
  * Copyright (c) 2009 Levente Farkas
  * Copyright (c) 2007, 2008 Wayne Meissner
@@ -35,21 +36,24 @@
 import org.freedesktop.gstreamer.lowlevel.annotations.Invalidate;
 
 import com.sun.jna.Pointer;
+import com.sun.jna.Structure.FieldOrder;
+import com.sun.jna.ptr.IntByReference;
+import com.sun.jna.ptr.LongByReference;
 import com.sun.jna.ptr.PointerByReference;
-import java.util.Arrays;
-import java.util.List;
 
 /*
  * GstMessage functions
  */
 public interface GstMessageAPI extends com.sun.jna.Library {
     GstMessageAPI GSTMESSAGE_API = GstNative.load(GstMessageAPI.class);
 
+    @FieldOrder({"mini_object", "type", "timestamp", "src",
+        "seqnum", "lock", "cond"})
     public static final class MessageStruct extends com.sun.jna.Structure {
     	public volatile MiniObjectStruct mini_object;
-        public volatile MessageType type;
+        public volatile int type;
         public volatile long timestamp;
-        public volatile GstObject src;
+        public volatile GstObjectPtr src;
         public volatile int seqnum;
 
         public volatile Pointer lock;
@@ -63,39 +67,48 @@ public MessageStruct() {
         public MessageStruct(Pointer ptr) {
             useMemory(ptr);
         }
-
-        @Override
-        protected List<String> getFieldOrder() {
-            return Arrays.asList(new String[]{
-                "mini_object", 
-                "type", "timestamp", "src",
-                "seqnum",
-                "lock", "cond"
-            });
+        
+        int typeOffset() {
+            return fieldOffset("type");
+        }
+        
+        int srcOffset() {
+            return fieldOffset("src");
         }
     }
 
     GType gst_message_get_type();
     String gst_message_type_get_name(MessageType type);
     void gst_message_parse_state_changed(Message msg, State[] old, State[] current, State[] pending);
+    void gst_message_parse_state_changed(GstMessagePtr msg, IntByReference old, IntByReference current, IntByReference pending);
     void gst_message_parse_tag(Message msg, PointerByReference tagList);
+    void gst_message_parse_tag(GstMessagePtr msg, PointerByReference tagList);
     void gst_message_parse_clock_provide(Message msg, PointerByReference clock, int[] reader);
     void gst_message_parse_new_clock(Message msg, PointerByReference clock);
     void gst_message_parse_error(Message msg, PointerByReference err, PointerByReference debug);
+    void gst_message_parse_error(GstMessagePtr msg, PointerByReference err, PointerByReference debug);
     void gst_message_parse_error(Message msg, GErrorStruct[] err, Pointer[] debug);
     void gst_message_parse_warning(Message msg, PointerByReference err, PointerByReference debug);
+    void gst_message_parse_warning(GstMessagePtr msg, PointerByReference err, PointerByReference debug);
     void gst_message_parse_warning(Message msg, GErrorStruct[] err, Pointer[] debug);
     void gst_message_parse_info(Message msg, PointerByReference err, PointerByReference debug);
+    void gst_message_parse_info(GstMessagePtr msg, PointerByReference err, PointerByReference debug);
     void gst_message_parse_info(Message msg, GErrorStruct[] err, Pointer[] debug);
     void gst_message_parse_buffering(Message msg, int[] percent);
+    void gst_message_parse_buffering(GstMessagePtr msg, IntByReference percent);
     void gst_message_parse_segment_start(Message message, Format[] format, long[] position); 
+    void gst_message_parse_segment_start(GstMessagePtr msg, IntByReference format, LongByReference position); 
     void gst_message_parse_segment_done(Message message, Format[] format, long[] position);
+    void gst_message_parse_segment_done(GstMessagePtr msg, IntByReference format, LongByReference position); 
     void gst_message_parse_duration(Message message, Format[] format, long[] position);
+    void gst_message_parse_duration(GstMessagePtr msg, IntByReference format, LongByReference position);
     void gst_message_parse_async_start(Message message, boolean[] new_base_time);
-    
     boolean gst_message_parse_context_type(Message message, String[] context_type);
+    boolean gst_message_parse_context_type(GstMessagePtr msg, PointerByReference /*String*/ context_type);
+    
     @CallerOwnsReturn Message gst_message_new_eos(GstObject src);
     Pointer ptr_gst_message_new_eos(GstObject src);
+    @CallerOwnsReturn GstMessagePtr gst_message_new_eos(GstObjectPtr src);
     @CallerOwnsReturn Message gst_message_new_error(GstObject src, GErrorStruct error, String debug);
     @CallerOwnsReturn Message gst_message_new_warning(GstObject src, GErrorStruct error, String debug);
     @CallerOwnsReturn Message gst_message_new_info(GstObject src, GErrorStruct error, String debug);

src/org/freedesktop/gstreamer/lowlevel/GstMessageAPI.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2020 Neil C Smith
+ * 
+ * This file is part of gstreamer-java.
+ *
+ * This code is free software: you can redistribute it and/or modify it under the terms of the GNU
+ * Lesser General Public License version 3 only, as published by the Free Software Foundation.
+ *
+ * This code 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
+ * Lesser General Public License version 3 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License version 3 along with
+ * this work. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.freedesktop.gstreamer.lowlevel;
+
+import com.sun.jna.Pointer;
+
+/**
+ * GstMessage pointer.
+ */
+public class GstMessagePtr extends GstMiniObjectPtr {
+
+    private static final int TYPE_OFFSET;
+    private static final int SRC_OFFSET;
+    
+    static {
+        GstMessageAPI.MessageStruct struct = new GstMessageAPI.MessageStruct();
+        TYPE_OFFSET = struct.typeOffset();
+        SRC_OFFSET = struct.srcOffset();
+    }
+    
+    
+    public GstMessagePtr() {
+    }
+
+    public GstMessagePtr(Pointer ptr) {
+        super(ptr);
+    }
+    
+    public int getMessageType() {
+        return getPointer().getInt(TYPE_OFFSET);
+    }
+
+    public GstObjectPtr getSource() {
+        Pointer raw = getPointer().getPointer(SRC_OFFSET);
+        return raw == null ? null : new GstObjectPtr(raw);
+    }
+    
+    
+}

src/org/freedesktop/gstreamer/lowlevel/GstMessagePtr.java

@@ -21,6 +21,7 @@
 
 package org.freedesktop.gstreamer.lowlevel;
 
+import com.sun.jna.Callback;
 import java.util.Arrays;
 import java.util.List;
 
@@ -41,6 +42,10 @@ public interface GstMiniObjectAPI extends com.sun.jna.Library {
     void gst_mini_object_ref(GstMiniObjectPtr ptr);
     void gst_mini_object_unref(GstMiniObjectPtr ptr);
     void gst_mini_object_unref(Pointer ptr);
+    void gst_mini_object_weak_ref(GstMiniObjectPtr ptr, GstMiniObjectNotify notify,
+            IntPtr data);
+    void gst_mini_object_weak_unref(GstMiniObjectPtr ptr, GstMiniObjectNotify notify,
+            IntPtr data);
 
     @CallerOwnsReturn MiniObject gst_mini_object_make_writable(@Invalidate MiniObject mini_object);
     @CallerOwnsReturn MiniObject gst_mini_object_copy(MiniObject mini_object);
@@ -50,6 +55,12 @@ public interface GstMiniObjectAPI extends com.sun.jna.Library {
     Pointer gst_mini_object_get_qdata(MiniObject mini_object, GQuark quark);
     Pointer gst_mini_object_steal_qdata(MiniObject mini_object, GQuark quark);
 
+    public static interface GstMiniObjectNotify extends Callback {
+
+        public void callback(IntPtr userData, Pointer obj);
+
+    }
+
     public static final class MiniObjectStruct extends com.sun.jna.Structure {
         public volatile GType type; 
         public volatile int refcount;