v2.0 java (#260)

.github/workflows/java-demos.yml

@@ -26,14 +26,15 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
+        java-version: ['11', '17', '19']
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up JDK 11
+    - name: Set up JDK ${{ matrix.java-version }}
       uses: actions/setup-java@v3
       with:
-        java-version: '11'
+        java-version: ${{ matrix.java-version }}
         distribution: 'temurin'
 
     - name: Build

.github/workflows/java-perf.yml

@@ -31,14 +31,14 @@ jobs:
         os: [ubuntu-latest, macos-latest, windows-latest]
         include:
         - os: ubuntu-latest
-          init_performance_threshold_sec: 2.0
-          proc_performance_threshold_sec: 0.5
-        - os: windows-latest
-          init_performance_threshold_sec: 2.1
-          proc_performance_threshold_sec: 0.6
+          init_performance_threshold_sec: 4.5
+          proc_performance_threshold_sec: 1.0
         - os: macos-latest
-          init_performance_threshold_sec: 2.5
-          proc_performance_threshold_sec: 0.7
+          init_performance_threshold_sec: 5.5
+          proc_performance_threshold_sec: 3.0
+        - os: windows-latest
+          init_performance_threshold_sec: 4.5
+          proc_performance_threshold_sec: 1.0
 
     steps:
     - uses: actions/checkout@v3
@@ -64,20 +64,20 @@ jobs:
         machine: [rpi3-32, rpi3-64, rpi4-32, rpi4-64, jetson]
         include:
         - machine: rpi3-32
-          init_performance_threshold_sec: 7.5
-          proc_performance_threshold_sec: 3.3
+          init_performance_threshold_sec: 14.0
+          proc_performance_threshold_sec: 9.3
         - machine: rpi3-64
-          init_performance_threshold_sec: 8.8
-          proc_performance_threshold_sec: 3.3
+          init_performance_threshold_sec: 13.5
+          proc_performance_threshold_sec: 8.3
         - machine: rpi4-32
-          init_performance_threshold_sec: 5.6
-          proc_performance_threshold_sec: 2.0
+          init_performance_threshold_sec: 8.5
+          proc_performance_threshold_sec: 4.6
         - machine: rpi4-64
-          init_performance_threshold_sec: 5.1
-          proc_performance_threshold_sec: 1.9
+          init_performance_threshold_sec: 7.8
+          proc_performance_threshold_sec: 5.0
         - machine: jetson
-          init_performance_threshold_sec: 5.1
-          proc_performance_threshold_sec: 2.0
+          init_performance_threshold_sec: 7.8
+          proc_performance_threshold_sec: 5.5
 
     steps:
     - uses: actions/checkout@v3

.github/workflows/java.yml

@@ -30,14 +30,15 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
+        java-version: ['11', '17', '19']
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: Set up JDK 11
+    - name: Set up JDK ${{ matrix.java-version }}
       uses: actions/setup-java@v3
       with:
-        java-version: '11'
+        java-version: ${{ matrix.java-version }}
         distribution: 'temurin'
 
     - name: Build

binding/java/build.gradle

@@ -7,7 +7,7 @@ plugins {
 
 ext {
     PUBLISH_GROUP_ID = 'ai.picovoice'
-    PUBLISH_VERSION = '1.1.1'
+    PUBLISH_VERSION = '2.0.0'
     PUBLISH_ARTIFACT_ID = 'cheetah-java'
 }
 

binding/java/gradle/wrapper/gradle-wrapper.properties

@@ -1,5 +1,5 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-7.3.2-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-7.6.1-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

binding/java/src/ai/picovoice/cheetah/Cheetah.java

@@ -19,6 +19,8 @@
  */
 public class Cheetah {
 
+    private static String sdk = "java";
+
     public static final String LIBRARY_PATH;
     public static final String MODEL_PATH;
 
@@ -27,6 +29,10 @@ public class Cheetah {
         MODEL_PATH = Utils.getPackagedModelPath();
     }
 
+    public static void setSdk(String sdk) {
+        Cheetah.sdk = sdk;
+    }
+
     private long handle;
 
     /**
@@ -53,6 +59,8 @@ private Cheetah(
         } catch (Exception exception) {
             throw new CheetahException(exception);
         }
+        CheetahNative.setSdk(Cheetah.sdk);
+
         handle = CheetahNative.init(
                 accessKey,
                 modelPath,

binding/java/src/ai/picovoice/cheetah/CheetahNative.java

@@ -20,6 +20,8 @@ class CheetahNative {
 
     static native String getVersion();
 
+    static native void setSdk(String sdk);
+
     static native long init(
             String accessKey,
             String modelPath,

binding/java/src/ai/picovoice/cheetah/exception/CheetahActivationException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahActivationException(Throwable cause) {
     public CheetahActivationException(String message) {
         super(message);
     }
+
+    public CheetahActivationException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahActivationLimitException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahActivationLimitException(Throwable cause) {
     public CheetahActivationLimitException(String message) {
         super(message);
     }
+
+    public CheetahActivationLimitException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahActivationRefusedException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahActivationRefusedException(Throwable cause) {
     public CheetahActivationRefusedException(String message) {
         super(message);
     }
+
+    public CheetahActivationRefusedException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahActivationThrottledException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahActivationThrottledException(Throwable cause) {
     public CheetahActivationThrottledException(String message) {
         super(message);
     }
+
+    public CheetahActivationThrottledException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -13,11 +13,42 @@
 package ai.picovoice.cheetah;
 
 public class CheetahException extends Exception {
+    private final String message;
+    private final String[] messageStack;
+
     public CheetahException(Throwable cause) {
         super(cause);
+        this.message = cause.getMessage();
+        this.messageStack = null;
     }
 
     public CheetahException(String message) {
         super(message);
+        this.message = message;
+        this.messageStack = null;
+    }
+
+    public CheetahException(String message, String[] messageStack) {
+        super(message);
+        this.message = message;
+        this.messageStack = messageStack;
+    }
+
+    public String[] getMessageStack() {
+        return this.messageStack;
+    }
+
+    @Override
+    public String getMessage() {
+        StringBuilder sb = new StringBuilder(message);
+        if (messageStack != null) {
+            if (messageStack.length > 0) {
+                sb.append(":");
+                for (int i = 0; i < messageStack.length; i++) {
+                    sb.append(String.format("\n  [%d] %s", i, messageStack[i]));
+                }
+            }
+        }
+        return sb.toString();
     }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahIOException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahIOException(Throwable cause) {
     public CheetahIOException(String message) {
         super(message);
     }
+
+    public CheetahIOException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahInvalidArgumentException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahInvalidArgumentException(Throwable cause) {
     public CheetahInvalidArgumentException(String message) {
         super(message);
     }
+
+    public CheetahInvalidArgumentException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahInvalidStateException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahInvalidStateException(Throwable cause) {
     public CheetahInvalidStateException(String message) {
         super(message);
     }
+
+    public CheetahInvalidStateException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahKeyException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahKeyException(Throwable cause) {
     public CheetahKeyException(String message) {
         super(message);
     }
+
+    public CheetahKeyException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahMemoryException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahMemoryException(Throwable cause) {
     public CheetahMemoryException(String message) {
         super(message);
     }
+
+    public CheetahMemoryException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahRuntimeException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahRuntimeException(Throwable cause) {
     public CheetahRuntimeException(String message) {
         super(message);
     }
+
+    public CheetahRuntimeException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/src/ai/picovoice/cheetah/exception/CheetahStopIterationException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2022 Picovoice Inc.
+    Copyright 2022-2023 Picovoice Inc.
 
     You may not use this file except in compliance with the license. A copy of the license is
     located in the "LICENSE" file accompanying this source.
@@ -20,4 +20,8 @@ public CheetahStopIterationException(Throwable cause) {
     public CheetahStopIterationException(String message) {
         super(message);
     }
+
+    public CheetahStopIterationException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/java/test/ai/picovoice/cheetah/CheetahPerformanceTest.java

@@ -35,7 +35,6 @@ public class CheetahPerformanceTest {
 
     @Test
     void initPerformance() throws Exception {
-
         long[] perfResults = new long[numTestIterations];
         for (int i = 0; i < numTestIterations + 1; i++) {
             long before = System.nanoTime();