Move Opus support to a separate module

Author: freya022

README.md

@@ -54,6 +54,10 @@ This library is available on maven central. The latest version is always shown i
 
 The minimum java version supported by JDA is **Java SE 8**. JDA also uses JSR 305 to support solid interoperability with Kotlin out of the box.
 
+> [!NOTE]
+> If you wish to support sending raw audio (and not Opus directly), 
+> you will also have to add the [`JDA-opus-jna`](opus-jna) dependency.
+
 ### Gradle
 
 ```gradle
@@ -63,12 +67,10 @@ repositories {
 
 dependencies {
     implementation("net.dv8tion:JDA:$version") { // replace $version with the latest version
-      // Optionally disable audio natives to reduce jar size by excluding `opus-java` and `tink`
+      // Optionally disable audio natives to reduce jar size by excluding `tink`
       // Gradle DSL:
-      // exclude module: 'opus-java' // required for encoding audio into opus, not needed if audio is already provided in opus encoding
       // exclude module: 'tink' // required for encrypting and decrypting audio
       // Kotlin DSL:
-      // exclude(module="opus-java") // required for encoding audio into opus, not needed if audio is already provided in opus encoding
       // exclude(module="tink") // required for encrypting and decrypting audio
     }
 }
@@ -81,13 +83,8 @@ dependencies {
     <groupId>net.dv8tion</groupId>
     <artifactId>JDA</artifactId>
     <version>$version</version> <!-- replace $version with the latest version -->
-    <!-- Optionally disable audio natives to reduce jar size by excluding `opus-java` and `tink` -->
+    <!-- Optionally disable audio natives to reduce jar size by excluding `tink` -->
     <exclusions>
-        <!-- required for encoding audio into opus, not needed if audio is already provided in opus encoding
-        <exclusion>
-            <groupId>club.minnced</groupId>
-            <artifactId>opus-java</artifactId>
-        </exclusion> -->
         <!-- required for encrypting and decrypting audio
         <exclusion>
             <groupId>com.google.crypto.tink</groupId>

build.gradle.kts

@@ -19,7 +19,6 @@ import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
 import de.undercouch.gradle.tasks.download.Download
 import net.dv8tion.jda.tasks.Version
 import net.dv8tion.jda.tasks.applyAudioExclusions
-import net.dv8tion.jda.tasks.applyOpusExclusions
 import net.dv8tion.jda.tasks.nullableReplacement
 import nl.littlerobots.vcu.plugin.resolver.VersionSelectors
 import org.apache.tools.ant.filters.ReplaceTokens
@@ -51,7 +50,6 @@ projectEnvironment {
 }
 
 artifactFilters {
-    opusExclusions.addAll("natives/**", "com/sun/jna/**", "club/minnced/opus/util/*", "tomp2p/opuswrapper/*")
     additionalAudioExclusions.addAll("com/google/crypto/tink/**", "com/google/gson/**", "com/google/protobuf/**", "google/protobuf/**")
 }
 
@@ -110,17 +108,9 @@ dependencies {
     api(libs.websocket.client)
     api(libs.okhttp)
 
-    //Opus library support
-    api(libs.opus)
-
     //Collections Utility
     api(libs.commons.collections)
 
-    //we use this only together with opus-java
-    // if that dependency is excluded it also doesn't need jna anymore
-    // since jna is a transitive runtime dependency of opus-java we don't include it explicitly as dependency
-    compileOnly(libs.jna)
-
     /* Internal dependencies */
 
     //General Utility
@@ -135,6 +125,8 @@ dependencies {
         addAll(configurations["api"].allDependencies)
         addAll(configurations["implementation"].allDependencies)
         addAll(configurations["compileOnly"].allDependencies)
+
+        add(project(":opus-jna"))
     }
 
     testImplementation(libs.bundles.junit)
@@ -235,16 +227,6 @@ val generateJavaSources by tasks.registering(SourceTask::class) {
     dependsOn(sourcesForRelease)
 }
 
-val noOpusJar by tasks.registering(ShadowJar::class) {
-    dependsOn(shadowJar)
-    archiveClassifier.set(shadowJar.archiveClassifier.get() + "-no-opus")
-
-    configurations = shadowJar.configurations
-    from(sourceSets["main"].output)
-    applyOpusExclusions(artifactFilters)
-    manifest.inheritFrom(jar.manifest)
-}
-
 val minimalJar by tasks.registering(ShadowJar::class) {
     dependsOn(shadowJar)
     minimize()
@@ -337,7 +319,6 @@ tasks.build.configure {
     dependsOn(javadocJar)
     dependsOn(sourcesJar)
     dependsOn(shadowJar)
-    dependsOn(noOpusJar)
     dependsOn(minimalJar)
 
     jar.mustRunAfter(tasks.clean)
@@ -493,4 +474,3 @@ jreleaser {
 tasks.withType<AbstractJReleaserTask>().configureEach {
     mustRunAfter(tasks.named("publish"))
 }
-

buildSrc/src/main/kotlin/net/dv8tion/jda/tasks/exclusions.kt

@@ -20,20 +20,11 @@ import org.gradle.api.provider.SetProperty
 import org.gradle.api.tasks.AbstractCopyTask
 
 interface ArtifactFilters {
-    val opusExclusions: SetProperty<String>
     val additionalAudioExclusions: SetProperty<String>
 }
 
-fun AbstractCopyTask.applyOpusExclusions(filters: ArtifactFilters) {
-    for (exclusion in filters.opusExclusions.get()) {
-        exclude(exclusion)
-    }
-}
-
 fun AbstractCopyTask.applyAudioExclusions(filters: ArtifactFilters) {
-    applyOpusExclusions(filters)
-
-    for (exclusion in filters.opusExclusions.get()) {
+    for (exclusion in filters.additionalAudioExclusions.get()) {
         exclude(exclusion)
     }
 }

opus-jna/.gitignore

@@ -0,0 +1,2 @@
+# gradle
+/build/

opus-jna/README.md

@@ -0,0 +1,52 @@
+[maven-central]: https://img.shields.io/maven-central/v/net.dv8tion/JDA-opus-jna?filter=!*-preview*&logo=apachemaven&color=blue
+[jitpack]: https://img.shields.io/badge/Snapshots-JitPack?logo=jitpack
+[installation]: #-installation
+[license]: https://github.com/discord-jda/JDA/tree/master/LICENSE
+[license-shield]: https://img.shields.io/badge/License-Apache%202.0-white.svg
+
+<img align="right" src="https://github.com/discord-jda/JDA/blob/assets/assets/readme/logo.png?raw=true" height="150" width="150">
+
+[![maven-central][]][installation]
+[![jitpack][]](https://jitpack.io/#discord-jda/JDA)
+[![license-shield][]][license]
+
+# JDA Opus Support
+
+This module enables JDA to encode and decode Opus audio. It is not necessary if your bot can handle Opus audio by itself.
+
+## 🔬 Installation
+
+[![maven-central][]](https://central.sonatype.com/artifact/net.dv8tion/JDA-opus-jna)
+[![jitpack][]](https://jitpack.io/#discord-jda/JDA)
+
+This module is available on maven central. The latest version is always shown in the [GitHub Release](https://github.com/discord-jda/JDA/releases/latest).
+
+The minimum java version supported by this module is **Java SE 8**.
+
+> [!NOTE]
+> The Jitpack artifact must be retrieved using the `io.github.discord-jda.JDA` group ID and `opus-jna` as the artifact ID.
+
+### Gradle
+
+```gradle
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+    // There is no API to use, it is detected at runtime
+    runtimeOnly("net.dv8tion:JDA-opus-jna:$version")
+}
+```
+
+### Maven
+
+```xml
+<dependency>
+    <groupId>net.dv8tion</groupId>
+    <artifactId>JDA-opus-jna</artifactId>
+    <version>$version</version> <!-- replace $version with the latest version -->
+    <!-- There is no API to use, it is detected at runtime -->
+    <scope>runtime</scope>
+</dependency>
+```

opus-jna/build.gradle.kts

@@ -0,0 +1,94 @@
+/*
+ * Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
+ *
+ * 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.
+ */
+
+plugins {
+    `java-library`
+}
+
+////////////////////////////////////
+//                                //
+//      Module Configuration      //
+//                                //
+////////////////////////////////////
+
+base {
+    archivesName.set("JDA-opus-jna")
+}
+
+java {
+    sourceCompatibility = JavaVersion.VERSION_1_8
+    targetCompatibility = JavaVersion.VERSION_1_8
+}
+
+
+////////////////////////////////////
+//                                //
+//    Dependency Configuration    //
+//                                //
+////////////////////////////////////
+
+repositories {
+    mavenCentral()
+}
+
+dependencies {
+
+    /* Internal dependencies */
+
+    // JDA
+    implementation(rootProject)
+
+    //Logger
+    implementation(libs.slf4j)
+
+    //Opus library support
+    implementation(libs.opus)
+
+    //we use this only together with opus-java
+    // if that dependency is excluded it also doesn't need jna anymore
+    // since jna is a transitive runtime dependency of opus-java we don't include it explicitly as dependency
+    implementation(libs.jna)
+
+    /* Annotations */
+
+    //Code safety
+    compileOnly(libs.findbugs)
+}
+
+////////////////////////////////////
+//                                //
+//    Build Task Configuration    //
+//                                //
+////////////////////////////////////
+
+val jar by tasks.getting(Jar::class) {
+    archiveBaseName.set(project.name + "-opus-jna")
+    manifest.attributes("Implementation-Version" to project.version, "Automatic-Module-Name" to "net.dv8tion.jda")
+}
+
+tasks.withType<JavaCompile> {
+    options.encoding = "UTF-8"
+    options.isIncremental = true
+
+    val args = mutableListOf("-Xlint:deprecation", "-Xlint:unchecked")
+
+    if (JavaVersion.current().isJava9Compatible) {
+        args.add("--release")
+        args.add("8")
+    }
+
+    options.compilerArgs.addAll(args)
+}

src/main/java/net/dv8tion/jda/internal/audio/OpusJnaCodecFactory.java renamed to opus-jna/src/main/java/net/dv8tion/jda/internal/audio/OpusJnaCodecFactory.java

@@ -0,0 +1 @@
+net.dv8tion.jda.internal.audio.OpusJnaCodecFactory