Externalize opus binaries

.editorconfig

@@ -2,13 +2,11 @@
 root = true
 
 [*]
+charset = utf-8
 end_of_line = crlf
 insert_final_newline = true
+indent_style = space
+indent_size = 4
 
 [gradlew]
 end_of_line = lf
-
-[*.{java, md, gradle, properties}]
-charset = utf-8
-indent_style = space
-indent_size = 4

.gitattributes

@@ -1,8 +1,7 @@
 # Preserve gradlew's line ending
-.gitattributes text eol=crlf
-
 gradlew binary
 
+.git* text eol=crlf
 *.java text eol=crlf
 *.gradle text eol=crlf
 *.bat text eol=crlf

README.md

@@ -172,6 +172,20 @@ Be sure to replace the **VERSION** key below with the one of the versions shown
 
 ```
 
+**Maven without Audio**
+```xml
+<dependency>
+    <groupId>net.dv8tion</groupId>
+    <artifactId>JDA</artifactId>
+    <version>VERSION</version>
+    <exclusions>
+        <exclusion>
+            <artifactId>opus-java</artifactId>
+        </exclusion>
+    </exclusions>
+</dependency>
+```
+
 **Gradle**
 ```gradle
 dependencies {
@@ -183,7 +197,17 @@ repositories {
 }
 ```
 
+**Gradle without Audio**
+```gradle
+dependencies {
+    compile ('net.dv8tion:JDA:VERSION') {
+        exclude module: 'opus-java'
+    }
+}
+```
+
 The builds are distributed using JCenter through Bintray [JDA JCenter Bintray](https://bintray.com/dv8fromtheworld/maven/JDA/)
+<br>If you are not interested in audio, we recommend excluding the `opus-java` transitive dependency to achieve a smaller artifact without audio support.
 
 ### Logging Framework - SLF4J
 JDA is using [SLF4J](https://www.slf4j.org/) to log its messages.
@@ -315,6 +339,10 @@ All dependencies are managed automatically by Gradle.
    * Version: **1.7.25**
    * [Website](https://www.slf4j.org/)
    * [JCenter Repository](https://bintray.com/bintray/jcenter/org.slf4j%3Aslf4j-api/view)
+ * opus-java
+   * Version: **1.0.0**
+   * [GitHub](https://github.com/discord-java/opus-java)
+   * [JCenter Repository](https://bintray.com/minndevelopment/maven/opus-java)
 
 ## Related Projects
 

build.gradle

@@ -61,6 +61,7 @@ dependencies {
     compile 'net.sf.trove4j:trove4j:3.0.3'
 
     //Native Library Support
+    compile 'club.minnced:opus-java:1.0.1'
     compile 'net.java.dev.jna:jna:4.4.0'
 
     //Web Connection Support
@@ -199,9 +200,7 @@ String getProjectProperty(String propertyName)
     return property
 }
 
-task wrapper(type: Wrapper) {
-    gradleVersion = '4.2.1'
-}
+wrapper.gradleVersion = '4.6'
 
 build {
     dependsOn clean

src/main/java/net/dv8tion/jda/core/audio/AudioConnection.java

@@ -83,6 +83,7 @@ public class AudioConnection
     private volatile int silenceCounter = 0;
     private boolean sentSilenceOnConnect = false;
     private final byte[] silenceBytes = new byte[] {(byte)0xF8, (byte)0xFF, (byte)0xFE};
+    private static boolean printedError = false;
 
     public AudioConnection(AudioWebSocket webSocket, VoiceChannel channel)
     {
@@ -219,7 +220,7 @@ protected void updateUserSSRC(int ssrc, long userId)
             ssrcMap.put(ssrc, userId);
 
             //Only create a decoder if we are actively handling received audio.
-            if (receiveThread != null)
+            if (receiveThread != null && AudioNatives.ensureOpus())
                 opusDecoders.put(ssrc, new Decoder(ssrc));
         }
     }
@@ -262,9 +263,6 @@ private synchronized void setupSendSystem()
     {
         if (udpSocket != null && !udpSocket.isClosed() && sendHandler != null && sendSystem == null)
         {
-            IntBuffer error = IntBuffer.allocate(4);
-            opusEncoder = Opus.INSTANCE.opus_encoder_create(OPUS_SAMPLE_RATE, OPUS_CHANNEL_COUNT, Opus.OPUS_APPLICATION_AUDIO, error);
-
             IAudioSendFactory factory = ((JDAImpl) channel.getJDA()).getAudioSendFactory();
             sendSystem = factory.createSendSystem(new PacketProvider());
             sendSystem.setContextMap(contextMap);
@@ -360,7 +358,15 @@ private synchronized void setupReceiveThread()
                             }
                             if (decoder == null)
                             {
-                                opusDecoders.put(ssrc, decoder = new Decoder(ssrc));
+                                if (AudioNatives.ensureOpus())
+                                {
+                                    opusDecoders.put(ssrc, decoder = new Decoder(ssrc));
+                                }
+                                else
+                                {
+                                    LOG.error("Unable to decode audio due to missing opus binaries!");
+                                    break;
+                                }
                             }
                             if (!decoder.isInOrder(decryptedPacket.getSequence()))
                             {
@@ -631,6 +637,18 @@ public DatagramPacket getNextPacket(boolean changeTalking)
                     {
                         if (!sendHandler.isOpus())
                         {
+                            if (opusEncoder == null)
+                            {
+                                if (!AudioNatives.ensureOpus())
+                                {
+                                    if (!printedError)
+                                        LOG.error("Unable to process PCM audio without opus binaries!");
+                                    printedError = true;
+                                    return null;
+                                }
+                                IntBuffer error = IntBuffer.allocate(4);
+                                opusEncoder = Opus.INSTANCE.opus_encoder_create(OPUS_SAMPLE_RATE, OPUS_CHANNEL_COUNT, Opus.OPUS_APPLICATION_AUDIO, error);
+                            }
                             rawAudio = encodeToOpus(rawAudio);
                         }
                         AudioPacket packet = new AudioPacket(seq, timestamp, webSocket.getSSRC(), rawAudio);

src/main/java/net/dv8tion/jda/core/audio/AudioNatives.java

@@ -0,0 +1,95 @@
+/*
+ * Copyright 2015-2018 Austin Keener & Michael Ritter & Florian Spieß
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.dv8tion.jda.core.audio;
+
+import club.minnced.opus.util.OpusLibrary;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+
+public final class AudioNatives
+{
+    private static final Logger LOG = LoggerFactory.getLogger(AudioNatives.class);
+    private static boolean initialized;
+    private static boolean audioSupported;
+
+    private AudioNatives() {}
+
+    public static synchronized boolean loadFrom(String absolutePath)
+    {
+        if (initialized)
+            return false;
+        initialized = true;
+        System.load(absolutePath);
+        System.setProperty("opus.lib", absolutePath);
+        return audioSupported = true;
+    }
+
+    public static synchronized boolean ensureOpus()
+    {
+        if (initialized)
+            return audioSupported;
+        initialized = true;
+        try
+        {
+            if (OpusLibrary.isInitialized())
+                return audioSupported = true;
+            audioSupported = OpusLibrary.loadFromJar();
+        }
+        catch (Throwable e)
+        {
+            handleException(e);
+        }
+        finally
+        {
+            if (audioSupported)
+                LOG.info("Audio System successfully setup!");
+            else
+                LOG.info("Audio System encountered problems while loading, thus, is disabled.");
+        }
+        return audioSupported;
+    }
+
+    private static void handleException(Throwable e)
+    {
+        if (e instanceof UnsupportedOperationException)
+        {
+            LOG.error("Sorry, JDA's audio system doesn't support this system.\n{}", e.getMessage());
+        }
+        else if (e instanceof NoClassDefFoundError)
+        {
+            LOG.error("Missing opus dependency, unable to initialize audio!");
+        }
+        else if (e instanceof IOException)
+        {
+            LOG.error("There was an IO Exception when setting up the temp files for audio.", e);
+        }
+        else if (e instanceof UnsatisfiedLinkError)
+        {
+            LOG.error("JDA encountered a problem when attempting to load the Native libraries. Contact a DEV.", e);
+        }
+        else if (e instanceof Error)
+        {
+            throw (Error) e;
+        }
+        else
+        {
+            LOG.error("An unknown exception occurred while attempting to setup JDA's audio system!", e);
+        }
+    }
+}

src/main/java/net/dv8tion/jda/core/managers/impl/AudioManagerImpl.java

@@ -15,7 +15,6 @@
  */
 package net.dv8tion.jda.core.managers.impl;
 
-import com.sun.jna.Platform;
 import net.dv8tion.jda.core.JDA;
 import net.dv8tion.jda.core.Permission;
 import net.dv8tion.jda.core.audio.AudioConnection;
@@ -34,20 +33,14 @@
 import net.dv8tion.jda.core.managers.AudioManager;
 import net.dv8tion.jda.core.utils.Checks;
 import net.dv8tion.jda.core.utils.MiscUtil;
-import net.dv8tion.jda.core.utils.NativeUtil;
 import net.dv8tion.jda.core.utils.PermissionUtil;
 
-import java.io.IOException;
 import java.util.EnumSet;
 import java.util.concurrent.locks.ReentrantLock;
 
 public class AudioManagerImpl implements AudioManager
 {
     public static final ThreadGroup AUDIO_THREADS = new ThreadGroup("jda-audio");
-    //These values are set at the bottom of this file.
-    public static boolean AUDIO_SUPPORTED;
-    public static String OPUS_LIB_NAME;
-    protected static boolean initialized = false;
 
     public final ReentrantLock CONNECTION_LOCK = new ReentrantLock();
 
@@ -71,7 +64,6 @@ public AudioManagerImpl(GuildImpl guild)
     {
         this.guild = guild;
         this.api = this.guild.getJDA();
-        init(); //Just to make sure that the audio libs have been initialized.
     }
 
     public AudioConnection getAudioConnection()
@@ -84,8 +76,8 @@ public void openAudioConnection(VoiceChannel channel)
     {
         Checks.notNull(channel, "Provided VoiceChannel");
 
-        if (!AUDIO_SUPPORTED)
-            throw new UnsupportedOperationException("Sorry! Audio is disabled due to an internal JDA error! Contact Dev!");
+//        if (!AUDIO_SUPPORTED)
+//            throw new UnsupportedOperationException("Sorry! Audio is disabled due to an internal JDA error! Contact Dev!");
         if (!guild.equals(channel.getGuild()))
             throw new IllegalArgumentException("The provided VoiceChannel is not a part of the Guild that this AudioManager handles." +
                     "Please provide a VoiceChannel from the proper Guild");
@@ -356,62 +348,4 @@ protected void updateVoiceState()
             api.getClient().queueAudioConnect(channel);
         }
     }
-
-    //Load the Opus library.
-    public static synchronized boolean init()
-    {
-        if(initialized)
-            return AUDIO_SUPPORTED;
-        initialized = true;
-        String nativesRoot  = null;
-        try
-        {
-            //The libraries that this is referencing are available in the src/main/resources/opus/ folder.
-            //Of course, when JDA is compiled that just becomes /opus/
-            nativesRoot = "/natives/" + Platform.RESOURCE_PREFIX + "/%s";
-            if (nativesRoot.contains("darwin")) //Mac
-                nativesRoot += ".dylib";
-            else if (nativesRoot.contains("win"))
-                nativesRoot += ".dll";
-            else if (nativesRoot.contains("linux"))
-                nativesRoot += ".so";
-            else
-                throw new UnsupportedOperationException();
-
-            NativeUtil.loadLibraryFromJar(String.format(nativesRoot, "libopus"));
-        }
-        catch (Throwable e)
-        {
-            if (e instanceof UnsupportedOperationException)
-                LOG.error("Sorry, JDA's audio system doesn't support this system.\n" +
-                        "Supported Systems: Windows(x86, x64), Mac(x86, x64) and Linux(x86, x64)\n" +
-                        "Operating system: " + Platform.RESOURCE_PREFIX);
-            else if (e instanceof  IOException)
-            {
-                LOG.error("There was an IO Exception when setting up the temp files for audio.", e);
-            }
-            else if (e instanceof UnsatisfiedLinkError)
-            {
-                LOG.error("JDA encountered a problem when attempting to load the Native libraries. Contact a DEV.", e);
-            }
-            else
-            {
-                LOG.error("An unknown error occurred while attempting to setup JDA's audio system!", e);
-            }
-
-            nativesRoot = null;
-        }
-        finally
-        {
-            OPUS_LIB_NAME = nativesRoot != null ? String.format(nativesRoot, "libopus") : null;
-            AUDIO_SUPPORTED = nativesRoot != null;
-
-            if (AUDIO_SUPPORTED)
-                LOG.info("Audio System successfully setup!");
-            else
-                LOG.info("Audio System encountered problems while loading, thus, is disabled.");
-            return AUDIO_SUPPORTED;
-        }
-
-    }
 }