#1955 WIP - final changes to SDRPlay api native library loading.

Author: Dennis Sheirer

src/main/java/io/github/dsheirer/gui/SDRTrunk.java

@@ -55,6 +55,7 @@
 import io.github.dsheirer.source.tuner.TunerEvent;
 import io.github.dsheirer.source.tuner.manager.DiscoveredTuner;
 import io.github.dsheirer.source.tuner.manager.TunerManager;
+import io.github.dsheirer.source.tuner.sdrplay.api.SDRPlayLibraryHelper;
 import io.github.dsheirer.source.tuner.ui.TunerSpectralDisplayManager;
 import io.github.dsheirer.spectrum.DisableSpectrumWaterfallMenuItem;
 import io.github.dsheirer.spectrum.ShowTunerMenuItem;
@@ -152,6 +153,14 @@ public SDRTrunk()
         mApplicationLog = new ApplicationLog(mUserPreferences);
         mApplicationLog.start();
 
+        //Note: invoke this early in the application lifecycle, before the TunerManager causes the sdrplay classes
+        //to be loaded since the jextract auto-generated code attempts to load the library by name and that can fail
+        //when the library was not installed into a normal/default location, particularly on windows OS systems.
+        if(SDRPlayLibraryHelper.LOADED)
+        {
+            mLog.info("SDRPlay API native library preemptively loaded");
+        }
+
         mResourceMonitor = new ResourceMonitor(mUserPreferences);
 
         String operatingSystem = System.getProperty("os.name", "generic").toLowerCase(Locale.ENGLISH);

src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/README

@@ -40,10 +40,24 @@ Version 3.15 - Adds support for RSP dx2
 
 As a final step, delete the original api version branches and rename each of the new api version branches to remove the _1 suffix.
 
+Code Modifications: for each version, modify the sdrplay_api_h.java class to wrap the SYMBOL_LOOKUP variable using the
+following changes, so that the code doesn't throw an error on systems that don't have the API installed:
+    //jextract auto-generated code modified to wrap with exception handler for systems that don't have the library
+    static SymbolLookup SYMBOL_LOOKUP;
+    static
+    {
+        try
+        {
+            SYMBOL_LOOKUP = SymbolLookup.libraryLookup(System.mapLibraryName("sdrplay_api"), LIBRARY_ARENA)
+                    .or(SymbolLookup.loaderLookup())
+                    .or(Linker.nativeLinker().defaultLookup());
+        }
+        catch(Exception e)
+        {
+            SYMBOL_LOOKUP = null;
+        }
+    }
+
 IntelliJ setup
 1. Run configuration
 2. JVM Option: --enable-native-access=ALL-UNNAMED
-3. Add library location to the java.library.path:
-   Linux: /usr/local/lib
-   Windows: ??
-   MacOS: ??

src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/SDRPlayLibraryHelper.java

@@ -61,7 +61,6 @@ public static boolean load()
         catch(Throwable t)
         {
             String libraryPath = getSDRplayLibraryPath();
-            mLog.info("Checking: " + libraryPath);
             Path path = Path.of(libraryPath);
             boolean exists = Files.exists(path);
 
@@ -74,13 +73,12 @@ public static boolean load()
                 }
                 catch(Throwable t2)
                 {
-                    String name = System.mapLibraryName(SDRPLAY_API_LIBRARY_NAME);
-                    mLog.warn("SDRPlay - unable to load API library: " + libraryPath);
+                    mLog.warn("Unable to load SDRPlay API native library: " + libraryPath);
                 }
             }
             else
             {
-                mLog.info("SDRPlay API library not found at: " + libraryPath);
+                mLog.info("SDRPlay API native library not found at: " + libraryPath);
             }
         }
 

src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/v3_07/sdrplay_api_h.java

@@ -83,9 +83,21 @@ static MemoryLayout align(MemoryLayout layout, long align) {
         };
     }
 
-    static final SymbolLookup SYMBOL_LOOKUP = SymbolLookup.libraryLookup(System.mapLibraryName("sdrplay_api"), LIBRARY_ARENA)
-            .or(SymbolLookup.loaderLookup())
-            .or(Linker.nativeLinker().defaultLookup());
+    //jextract auto-generated code modified to wrap with exception handler for systems that don't have the library
+    static SymbolLookup SYMBOL_LOOKUP;
+    static
+    {
+        try
+        {
+            SYMBOL_LOOKUP = SymbolLookup.libraryLookup(System.mapLibraryName("sdrplay_api"), LIBRARY_ARENA)
+                    .or(SymbolLookup.loaderLookup())
+                    .or(Linker.nativeLinker().defaultLookup());
+        }
+        catch(Exception e)
+        {
+            SYMBOL_LOOKUP = null;
+        }
+    }
 
     public static final ValueLayout.OfBoolean C_BOOL = ValueLayout.JAVA_BOOLEAN;
     public static final ValueLayout.OfByte C_CHAR = ValueLayout.JAVA_BYTE;

src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/v3_08/sdrplay_api_h.java

@@ -83,9 +83,21 @@ static MemoryLayout align(MemoryLayout layout, long align) {
         };
     }
 
-    static final SymbolLookup SYMBOL_LOOKUP = SymbolLookup.libraryLookup(System.mapLibraryName("sdrplay_api"), LIBRARY_ARENA)
-            .or(SymbolLookup.loaderLookup())
-            .or(Linker.nativeLinker().defaultLookup());
+    //jextract auto-generated code modified to wrap with exception handler for systems that don't have the library
+    static SymbolLookup SYMBOL_LOOKUP;
+    static
+    {
+        try
+        {
+            SYMBOL_LOOKUP = SymbolLookup.libraryLookup(System.mapLibraryName("sdrplay_api"), LIBRARY_ARENA)
+                    .or(SymbolLookup.loaderLookup())
+                    .or(Linker.nativeLinker().defaultLookup());
+        }
+        catch(Exception e)
+        {
+            SYMBOL_LOOKUP = null;
+        }
+    }
 
     public static final ValueLayout.OfBoolean C_BOOL = ValueLayout.JAVA_BOOLEAN;
     public static final ValueLayout.OfByte C_CHAR = ValueLayout.JAVA_BYTE;

src/main/java/io/github/dsheirer/source/tuner/sdrplay/api/v3_15/sdrplay_api_h.java

@@ -83,9 +83,21 @@ static MemoryLayout align(MemoryLayout layout, long align) {
         };
     }
 
-    static final SymbolLookup SYMBOL_LOOKUP = SymbolLookup.libraryLookup(System.mapLibraryName("sdrplay_api"), LIBRARY_ARENA)
-            .or(SymbolLookup.loaderLookup())
-            .or(Linker.nativeLinker().defaultLookup());
+    //jextract auto-generated code modified to wrap with exception handler for systems that don't have the library
+    static SymbolLookup SYMBOL_LOOKUP;
+    static
+    {
+        try
+        {
+            SYMBOL_LOOKUP = SymbolLookup.libraryLookup(System.mapLibraryName("sdrplay_api"), LIBRARY_ARENA)
+                    .or(SymbolLookup.loaderLookup())
+                    .or(Linker.nativeLinker().defaultLookup());
+        }
+        catch(Exception e)
+        {
+            SYMBOL_LOOKUP = null;
+        }
+    }
 
     public static final ValueLayout.OfBoolean C_BOOL = ValueLayout.JAVA_BOOLEAN;
     public static final ValueLayout.OfByte C_CHAR = ValueLayout.JAVA_BYTE;