Merge branch 'master' into vlcj-5.x-java8

caprica · Jun 4, 2024 · d6d4c4a · d6d4c4a
2 parents 7cb0b14 + 305e529
commit d6d4c4a
Show file tree

Hide file tree

Showing 337 changed files with 948 additions and 391 deletions.
diff --git a/README.md b/README.md
@@ -30,6 +30,10 @@ vlcj-4.7.x, which is still current, is the last version of vlcj that was built a
 vlcj-4.8.x, which is still current, is the first version of vlcj that was built against JDK 11, and is the first to
 use the Java Module System.
 
+There is an alternative artefact available in the short term to maintain compatibility with Java 1.8, switch to the
+[vlcj-5.x-java8 branch](https://github.com/caprica/vlcj/tree/vlcj-5.x-java8) branch, and use the `vlcj-java8` artefact
+name instead of `vlcj`.
+
 *This version of vlcj requires VLC 4.0.0 as a minimum, no earlier version is supported.*
 
 This is the open source vlcj project page, see also the 'official'
@@ -46,6 +50,12 @@ Build Status
 Recent News
 ===========
 
+__January 2024__ Project status update:
+
+>This project is still actively maintained and supported, but activity has been less recently because the main driver
+>for the next release and the blocker for releasing something new is the ongoing development of VLC 4.x which is still
+>seemingly not close to being completed.
+
 __May 2022__ Supporting the project:
 
 >If you would like to help support the continued development of vlcj and our other Open Source efforts, you might like
@@ -122,7 +132,7 @@ Major New Features
 Headline changes:
 
  - requires LibVLC 4.0.0+
- - requires Java 8+
+ - requires Java 11+
  - full support for LibVLC native "video engine" rendering, specifically via OpenGL
    * example using LWJGL at [vlcj-lwjgl-demo](https://github.com/caprica/vlcj-lwjgl-demo)
  - fast vs precise native seeking when setting media position/time

diff --git a/doc/README.LICENSE b/doc/README.LICENSE
@@ -11,6 +11,6 @@ GNU General Public License for more details.
 You should have received a copy of the GNU General Public License
 along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
 
-Copyright 2009-2022 Caprica Software Limited.
+Copyright 2009-2024 Caprica Software Limited.
 
 VLCJ makes use of JNA (https://jna.dev.java.net/). JNA is licensed under LGPL.
diff --git a/src/main/java/uk/co/caprica/vlcj/factory/ApplicationApi.java b/src/main/java/uk/co/caprica/vlcj/factory/ApplicationApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;
@@ -26,6 +26,7 @@
 import java.util.ArrayList;
 import java.util.List;
 
+import static uk.co.caprica.vlcj.binding.lib.LibVlc.libvlc_abi_version;
 import static uk.co.caprica.vlcj.binding.lib.LibVlc.libvlc_audio_filter_list_get;
 import static uk.co.caprica.vlcj.binding.lib.LibVlc.libvlc_clock;
 import static uk.co.caprica.vlcj.binding.lib.LibVlc.libvlc_get_changeset;
@@ -76,6 +77,15 @@ public String changeset() {
         return libvlc_get_changeset();
     }
 
+    /**
+     * Get the native ABI version for libvlc.
+     *
+     * @return ABI version number
+     */
+    public int abiVersion() {
+        return libvlc_abi_version();
+    }
+
     /**
      * Set the application name.
      *
@@ -172,7 +182,7 @@ private List<ModuleDescription> getModuleDescriptions(libvlc_module_description_
         List<ModuleDescription> result = new ArrayList<ModuleDescription>();
         libvlc_module_description_t moduleDescription = moduleDescriptions;
         while(moduleDescription != null) {
-            result.add(new ModuleDescription(moduleDescription.psz_name, moduleDescription.psz_shortname, moduleDescription.psz_longname, moduleDescription.psz_help));
+            result.add(new ModuleDescription(moduleDescription.psz_name, moduleDescription.psz_shortname, moduleDescription.psz_longname, moduleDescription.psz_help, moduleDescription.psz_help_html));
             moduleDescription = moduleDescription.p_next;
         }
         return result;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/AudioApi.java b/src/main/java/uk/co/caprica/vlcj/factory/AudioApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/AudioOutput.java b/src/main/java/uk/co/caprica/vlcj/factory/AudioOutput.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/BaseApi.java b/src/main/java/uk/co/caprica/vlcj/factory/BaseApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/DialogHandler.java b/src/main/java/uk/co/caprica/vlcj/factory/DialogHandler.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/DialogHandlerAdapter.java b/src/main/java/uk/co/caprica/vlcj/factory/DialogHandlerAdapter.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/DialogId.java b/src/main/java/uk/co/caprica/vlcj/factory/DialogId.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/DialogQuestionType.java b/src/main/java/uk/co/caprica/vlcj/factory/DialogQuestionType.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2017 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/DialogType.java b/src/main/java/uk/co/caprica/vlcj/factory/DialogType.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2017 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/Dialogs.java b/src/main/java/uk/co/caprica/vlcj/factory/Dialogs.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/DialogsApi.java b/src/main/java/uk/co/caprica/vlcj/factory/DialogsApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/EqualizerApi.java b/src/main/java/uk/co/caprica/vlcj/factory/EqualizerApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/MediaApi.java b/src/main/java/uk/co/caprica/vlcj/factory/MediaApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/MediaDiscovererApi.java b/src/main/java/uk/co/caprica/vlcj/factory/MediaDiscovererApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/MediaPlayerApi.java b/src/main/java/uk/co/caprica/vlcj/factory/MediaPlayerApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/MediaPlayerFactory.java b/src/main/java/uk/co/caprica/vlcj/factory/MediaPlayerFactory.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/ModuleDescription.java b/src/main/java/uk/co/caprica/vlcj/factory/ModuleDescription.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;
@@ -44,19 +44,26 @@ public final class ModuleDescription {
      */
     private final String help;
 
+    /**
+     * HTML help text.
+     */
+    private final String helpHtml;
+
     /**
      * Create a new module description
      *
      * @param name name
      * @param shortName short name
      * @param longName long name
      * @param help help text
+     * @param helpHtml HTML help text
      */
-    public ModuleDescription(String name, String shortName, String longName, String help) {
+    public ModuleDescription(String name, String shortName, String longName, String help, String helpHtml) {
         this.name = name;
         this.shortName = shortName;
         this.longName = longName;
         this.help = help;
+        this.helpHtml = helpHtml;
     }
 
     /**
@@ -95,14 +102,24 @@ public String help() {
         return help;
     }
 
+    /**
+     * Get the module HTML help text.
+     *
+     * @return HTML help text
+     */
+    public String helpHtml() {
+        return helpHtml;
+    }
+
     @Override
     public String toString() {
         StringBuilder sb = new StringBuilder(200);
         sb.append(getClass().getSimpleName()).append('[');
         sb.append("name=").append(name).append(',');
         sb.append("shortName=").append(shortName).append(',');
         sb.append("longName=").append(longName).append(',');
-        sb.append("help=").append(help).append(']');
+        sb.append("help=").append(help).append(',');
+        sb.append("helpHtml=").append(help).append(']');
         return sb.toString();
     }
 }
diff --git a/src/main/java/uk/co/caprica/vlcj/factory/NativeLibraryMappingException.java b/src/main/java/uk/co/caprica/vlcj/factory/NativeLibraryMappingException.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/NativeLibraryPath.java b/src/main/java/uk/co/caprica/vlcj/factory/NativeLibraryPath.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/RendererApi.java b/src/main/java/uk/co/caprica/vlcj/factory/RendererApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/VideoSurfaceApi.java b/src/main/java/uk/co/caprica/vlcj/factory/VideoSurfaceApi.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory;

diff --git a/.../co/caprica/vlcj/factory/discovery/provider/BaseConfigFileDiscoveryDirectoryProvider.java b/.../co/caprica/vlcj/factory/discovery/provider/BaseConfigFileDiscoveryDirectoryProvider.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;

diff --git a/...aprica/vlcj/factory/discovery/provider/ConfigDirConfigFileDiscoveryDirectoryProvider.java b/...aprica/vlcj/factory/discovery/provider/ConfigDirConfigFileDiscoveryDirectoryProvider.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;

diff --git a/...ava/uk/co/caprica/vlcj/factory/discovery/provider/DirectoryProviderDiscoveryStrategy.java b/...ava/uk/co/caprica/vlcj/factory/discovery/provider/DirectoryProviderDiscoveryStrategy.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/discovery/provider/DiscoveryDirectoryProvider.java b/src/main/java/uk/co/caprica/vlcj/factory/discovery/provider/DiscoveryDirectoryProvider.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/discovery/provider/DiscoveryProviderPriority.java b/src/main/java/uk/co/caprica/vlcj/factory/discovery/provider/DiscoveryProviderPriority.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;

diff --git a/...n/java/uk/co/caprica/vlcj/factory/discovery/provider/JnaLibraryPathDirectoryProvider.java b/...n/java/uk/co/caprica/vlcj/factory/discovery/provider/JnaLibraryPathDirectoryProvider.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;

diff --git a/...n/java/uk/co/caprica/vlcj/factory/discovery/provider/LinuxWellKnownDirectoryProvider.java b/...n/java/uk/co/caprica/vlcj/factory/discovery/provider/LinuxWellKnownDirectoryProvider.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;

diff --git a/...n/java/uk/co/caprica/vlcj/factory/discovery/provider/MacOsWellKnownDirectoryProvider.java b/...n/java/uk/co/caprica/vlcj/factory/discovery/provider/MacOsWellKnownDirectoryProvider.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;

diff --git a/src/main/java/uk/co/caprica/vlcj/factory/discovery/provider/SystemPathDirectoryProvider.java b/src/main/java/uk/co/caprica/vlcj/factory/discovery/provider/SystemPathDirectoryProvider.java
@@ -14,7 +14,7 @@
  * You should have received a copy of the GNU General Public License
  * along with VLCJ.  If not, see <http://www.gnu.org/licenses/>.
  *
- * Copyright 2009-2022 Caprica Software Limited.
+ * Copyright 2009-2024 Caprica Software Limited.
  */
 
 package uk.co.caprica.vlcj.factory.discovery.provider;