v3.0 android (#1096)

binding/android/Porcupine/porcupine/build.gradle

@@ -2,7 +2,7 @@ apply plugin: 'com.android.library'
 
 ext {
     PUBLISH_GROUP_ID = 'ai.picovoice'
-    PUBLISH_VERSION = '2.2.2'
+    PUBLISH_VERSION = '3.0.0'
     PUBLISH_ARTIFACT_ID = 'porcupine-android'
 }
 

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/Porcupine.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021-2022 Picovoice Inc.
+    Copyright 2021-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.
@@ -43,13 +43,18 @@ public class Porcupine {
 
     private static String DEFAULT_MODEL_PATH;
     private static boolean isExtracted;
+    private static String _sdk = "android";
 
     static {
         System.loadLibrary("pv_porcupine");
     }
 
     private long handle;
 
+    public static void setSdk(String sdk) {
+        Porcupine._sdk = sdk;
+    }
+
     /**
      * Constructor.
      *
@@ -66,6 +71,8 @@ private Porcupine(
             String modelPath,
             String[] keywordPaths,
             float[] sensitivities) throws PorcupineException {
+        PorcupineNative.setSdk(Porcupine._sdk);
+
         handle = PorcupineNative.init(
                 accessKey,
                 modelPath,

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/PorcupineNative.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,6 +20,8 @@ class PorcupineNative {
 
     static native int getSampleRate();
 
+    static native void setSdk(String sdk);
+
     static native long init(
             String accessKey,
             String modelPath,
@@ -31,5 +33,4 @@ static native long init(
     static native int process(
             long object,
             short[] pcm) throws PorcupineException;
-
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineActivationException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineActivationException(Throwable cause) {
     public PorcupineActivationException(String message) {
         super(message);
     }
+
+    public PorcupineActivationException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineActivationLimitException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineActivationLimitException(Throwable cause) {
     public PorcupineActivationLimitException(String message) {
         super(message);
     }
+
+    public PorcupineActivationLimitException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineActivationRefusedException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineActivationRefusedException(Throwable cause) {
     public PorcupineActivationRefusedException(String message) {
         super(message);
     }
+
+    public PorcupineActivationRefusedException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineActivationThrottledException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineActivationThrottledException(Throwable cause) {
     public PorcupineActivationThrottledException(String message) {
         super(message);
     }
+
+    public PorcupineActivationThrottledException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -10,12 +10,46 @@
 
 package ai.picovoice.porcupine;
 
+import android.annotation.SuppressLint;
+
 public class PorcupineException extends Exception {
+    private final String message;
+    private final String[] messageStack;
+
     public PorcupineException(Throwable cause) {
         super(cause);
+        this.message = cause.getMessage();
+        this.messageStack = null;
     }
 
     public PorcupineException(String message) {
         super(message);
+        this.message = message;
+        this.messageStack = null;
+    }
+
+    public PorcupineException(String message, String[] messageStack) {
+        super(message);
+        this.message = message;
+        this.messageStack = messageStack;
+    }
+
+    public String[] getMessageStack() {
+        return this.messageStack;
+    }
+
+    @SuppressLint("DefaultLocale")
+    @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/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineIOException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineIOException(Throwable cause) {
     public PorcupineIOException(String message) {
         super(message);
     }
+
+    public PorcupineIOException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineInvalidArgumentException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineInvalidArgumentException(Throwable cause) {
     public PorcupineInvalidArgumentException(String message) {
         super(message);
     }
+
+    public PorcupineInvalidArgumentException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineInvalidStateException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineInvalidStateException(Throwable cause) {
     public PorcupineInvalidStateException(String message) {
         super(message);
     }
+
+    public PorcupineInvalidStateException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineKeyException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineKeyException(Throwable cause) {
     public PorcupineKeyException(String message) {
         super(message);
     }
+
+    public PorcupineKeyException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineMemoryException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineMemoryException(Throwable cause) {
     public PorcupineMemoryException(String message) {
         super(message);
     }
+
+    public PorcupineMemoryException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineRuntimeException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineRuntimeException(Throwable cause) {
     public PorcupineRuntimeException(String message) {
         super(message);
     }
+
+    public PorcupineRuntimeException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/Porcupine/porcupine/src/main/java/ai/picovoice/porcupine/exception/PorcupineStopIterationException.java

@@ -1,5 +1,5 @@
 /*
-    Copyright 2021 Picovoice Inc.
+    Copyright 2021-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.
     Unless required by applicable law or agreed to in writing, software distributed under the
@@ -18,4 +18,8 @@ public PorcupineStopIterationException(Throwable cause) {
     public PorcupineStopIterationException(String message) {
         super(message);
     }
+
+    public PorcupineStopIterationException(String message, String[] messageStack) {
+        super(message, messageStack);
+    }
 }

binding/android/PorcupineTestApp/build.gradle

@@ -6,6 +6,9 @@ buildscript {
     repositories {
         google()
         mavenCentral()
+        maven {
+            url 'https://s01.oss.sonatype.org/content/repositories/aipicovoice-1266/'
+        }
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:7.2.2'
@@ -21,6 +24,9 @@ allprojects {
     repositories {
         google()
         mavenCentral()
+        maven {
+            url 'https://s01.oss.sonatype.org/content/repositories/aipicovoice-1266/'
+        }
     }
 }
 

binding/android/PorcupineTestApp/porcupine-test-app/build.gradle

@@ -136,7 +136,7 @@ dependencies {
     implementation 'androidx.appcompat:appcompat:1.3.1'
     implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
     implementation 'com.google.code.gson:gson:2.10'
-    implementation 'ai.picovoice:porcupine-android:2.2.2'
+    implementation 'ai.picovoice:porcupine-android:3.0.0'
 
     // Espresso UI Testing
     androidTestImplementation 'androidx.test.ext:junit:1.1.5'

binding/android/PorcupineTestApp/porcupine-test-app/src/androidTest/java/ai/picovoice/porcupine/testapp/PorcupineTest.java

@@ -318,6 +318,33 @@ public void testInitWithNonAsciiModelName() throws PorcupineException {
 
             p.delete();
         }
+
+        @Test
+        public void testErrorStack() {
+            String[] error = {};
+            try {
+                new Porcupine.Builder()
+                        .setAccessKey("invalid")
+                        .setKeyword(Porcupine.BuiltInKeyword.PORCUPINE)
+                        .build(appContext);
+            } catch (PorcupineException e) {
+                error = e.getMessageStack();
+            }
+
+            assertTrue(0 < error.length);
+            assertTrue(error.length <= 8);
+
+            try {
+                new Porcupine.Builder()
+                        .setAccessKey("invalid")
+                        .setKeyword(Porcupine.BuiltInKeyword.PORCUPINE)
+                        .build(appContext);
+            } catch (PorcupineException e) {
+                for (int i = 0; i < error.length; i++) {
+                    assertEquals(e.getMessageStack()[i], error[i]);
+                }
+            }
+        }
     }
 
     @RunWith(Parameterized.class)

demo/android/Activity/build.gradle

@@ -6,6 +6,9 @@ buildscript {
     repositories {
         google()
         mavenCentral()
+        maven {
+            url 'https://s01.oss.sonatype.org/content/repositories/aipicovoice-1266/'
+        }
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:7.2.2'
@@ -21,6 +24,9 @@ allprojects {
     repositories {
         google()
         mavenCentral()
+        maven {
+            url 'https://s01.oss.sonatype.org/content/repositories/aipicovoice-1266/'
+        }
     }
 }