henkelmax / opus4j

A Java wrapper for the Opus Codec.

Opus4J

A Java wrapper for the Opus Codec written in Rust using JNI.

Usage

Maven

<dependency>
  <groupId>de.maxhenkel.opus4j</groupId>
  <artifactId>opus4j</artifactId>
  <version>2.0.2</version>
</dependency>

<repositories>
  <repository>
    <id>henkelmax.public</id>
    <url>https://maven.maxhenkel.de/repository/public</url>
  </repository>
</repositories>

Gradle

dependencies {
  implementation 'de.maxhenkel.opus4j:opus4j:2.0.2'
}

repositories {
  maven {
    name = "henkelmax.public"
    url = 'https://maven.maxhenkel.de/repository/public'
  }
}

Example Code

Encoding

short[] rawAudio = ...;

// Creates a new encoder instance with 48kHz mono VOIP
OpusEncoder encoder = new OpusEncoder(48000, 1, OpusEncoder.Application.VOIP);

// Sets the max payload size to 1500 bytes
encoder.setMaxPayloadSize(1500);

// Encodes the raw audio
byte[] encoded = encoder.encode(rawAudio);

// Resets the encoder state
encoder.resetState();

...

// Closes the encoder - Not calling this will cause a memory leak!
encoder.close(); 

Decoding

byte[] encodedAudio = ...;

// Creates a new decoder instance with 48kHz mono
OpusDecoder decoder = new OpusDecoder(48000, 1);

// Sets the frame size to 960 samples
// If this is not set properly, decoded FEC frames will have the wrong size
decoder.setFrameSize(960);

// Decodes the encoded audio
short[] decoded = decoder.decode(encodedAudio);

// Decode a missing packet with FEC (Forward Error Correction)
decoded = decoder.decodeFec();

// Resets the decoder state
decoder.resetState();

...

// Closes the decoder - Not calling this will cause a memory leak!
decoder.close();

Credits

• Opus
• opus-rs
• jni-rs

opus4j's Issues

Doesn't work on Android (ARM64 architecture in general)

Library version: 2.0.2
StackTrace:

...

Caused by: de.maxhenkel.opus4j.UnknownPlatformException: Could not find opus4j natives for platform linux-aarch64
                                                                                                    	at de.maxhenkel.opus4j.LibraryLoader.load(LibraryLoader.java:113)
                                                                                                    	at de.maxhenkel.opus4j.Opus.load(Opus.java:32)
                                                                                                    	at de.maxhenkel.opus4j.OpusEncoder.<init>(OpusEncoder.java:19)
                                                                                                    	at com.example.speakerpoc.MainActivity.encodeAudioUsingLibrary(MainActivity.kt:141)
                                                                                                    	at com.example.speakerpoc.MainActivity.encodeFileUsingOpus(MainActivity.kt:125)
                                                                                                    	at com.example.speakerpoc.MainActivity.setupButtons$lambda$3$lambda$1(MainActivity.kt:49)
                                                                                                    	at com.example.speakerpoc.MainActivity.$r8$lambda$-TsL4DalP-5eJBwDry_a-WqqtNo(Unknown Source:0)
                                                                                                    	at com.example.speakerpoc.MainActivity$$ExternalSyntheticLambda1.onClick(Unknown Source:2)
                                                                                                    	at android.view.View.performClick(View.java:7506)
                                                                                                    	at com.google.android.material.button.MaterialButton.performClick(MaterialButton.java:1211)
                                                                                                    	at android.view.View.performClickInternal(View.java:7483)
                                                                                                    	at android.view.View.-$$Nest$mperformClickInternal(Unknown Source:0)
                                                                                                    	at android.view.View$PerformClick.run(View.java:29335)
                                                                                                    	at android.os.Handler.handleCallback(Handler.java:942)
                                                                                                    	at android.os.Handler.dispatchMessage(Handler.java:99)
                                                                                                    	at android.os.Looper.loopOnce(Looper.java:201)
                                                                                                    	at android.os.Looper.loop(Looper.java:288)
                                                                                                    	at android.app.ActivityThread.main(ActivityThread.java:7898)
                                                                                                    	at java.lang.reflect.Method.invoke(Native Method) 
                                                                                                    	at com.android.internal.os.RuntimeInit$MethodAndArgsCaller.run(RuntimeInit.java:548) 
                                                                                                    	at com.android.internal.os.ZygoteInit.main(ZygoteInit.java:936) 

License

It would be really great if this project have an open source license

Plans to support encoder API?

Hi! Thank you for open sourcing this, it works great

The encoder API supports a bunch of useful stuff like VBR, sample rate, inband FEC, and so on

Do you plan to expand on the rust bindings for the rest of https://docs.rs/opus/latest/opus/struct.Encoder.html ?