frostwire-jlibtorrent

A swig Java interface for libtorrent by the makers of FrostWire.

Develop libtorrent based apps with the joy of coding in Java.

Using

All platforms will need you to use at least 2 .jar files.

The .jar with the java classes -> jlibtorrent-w.x.y.z.jar and a secondary .jars containing the JNI binary library for the particular OS and CPU architecture.

In the case of desktop operating systems, you might want to extract the shared library inside the jar (.dll, .so, .dylib) and place it in a folder specified by the java.library.path

The secondary jars are:

Windows: jlibtorrent-windows-w.x.y.z.jar (x86 and x86_64 .dlls)
Mac: jlibtorrent-macosx-w.x.y.z.jar (x86_64 .dylib)
Linux: jlibtorrent-linux-w.x.y.z.jar (x86 and x86_64 .so)

In the case of Android, make sure to put the following 3 jars in your project's libs folder (see FrostWire for Android's as an example):

jlibtorrent-w.x.y.z.jar
jlibtorrent-android-arm-w.x.y.z.jar
jlibtorrent-android-x86-w.x.y.z.jar

If you use ProGuard to obfuscate/minify make sure to add the following statement

-keep class com.frostwire.jlibtorrent.swig.libtorrent_jni {*;}

Note that there are multiple version of jlibtorrent for different platforms: jlibtorrent, jlibtorrent-windows, jlibtorrent-linux, jlibtorrent-macosx and jlibtorrent-android-<arch>. These are all different artifacts.

For examples look at https://github.com/frostwire/frostwire-jlibtorrent/tree/master/src/test/java/com/frostwire/jlibtorrent/demo

Architectures supported:

Android (armeabi-v7a, arm64-v8a, x86, x86_64)
Linux (x86, x86_64)
Windows (x86, x86_64)
Mac OS X (x86_64)

Building with Travis

You need:

Setup a travis account at http://travis-ci.org and get familiar with the service if necessary.
Open an account with Amazon Web Services (AWS) and get familiar with S3 (for storage) and IAM (for users).
Some familiarity with git commands.

The process is:

Create a user in amazon IAM, let's suppose it is user1. Download credentials for the keys.
Create a bucket in amazon S3, let's suppose it is jlibtorrent1.
Set the permission of the bucket according to your workflow, but at least the user1 should have permission to put/upload to the bucket. See for example this bucket policy:

{
	"Statement": [
		{
			"Effect": "Allow",
			"Principal": {"AWS":"arn:aws:iam::<user1's ARN here>:user/user1"},
			"Action": "s3:PutObject",
			"Resource": "arn:aws:s3:::jlibtorrent1/*"
		},
		{
			"Effect": "Allow",
			"Principal": "*",
			"Action": "s3:GetObject",
			"Resource": "arn:aws:s3:::jlibtorrent1/*"
		}
	]
}

Fork the project in github.
Go to travis and enable the repository.
Go to 'More options' > 'Settings' > 'Environment Variables' and set the S3_ACCESS_KEY, S3_SECRET_KEY, S3_BUCKET variables using the values in the credentials file for the user you created and the bucket name you created.
Clone locally your repo, let's assume to the jlibtorrent folder and checkout the stable branch:

$ git clone <your fork repo url> jlibtorrent
$ cd jlibtorrent
$ git checkout master

Verify in your travis online if the build already started. The build could take about 40 minutes, be patient.
When finished, check your s3 bucket for the binaries.
To trigger a new build, just make a change or merge new changes from the stable branch, commit and push.

Building Locally (Mac and Linux)

Building on Travis is something recommended only once you know you're done with your work as builds can take above 30 minutes to finish for all platforms and architectures.

When you're developing and debugging you need faster builds, and these can be performed locally with the help of build scripts in the swig/ folder.

Thre's a build script for each operating system, for example if you're on macos you can use the build-macos.sh, running it without setting things up should tell you about certain environment variables you'll need to set up. To understand the build process we recommend you read your corresponding build script and build-utils.shinc

The hacking and building process might require you to run the run-swig.sh script, we usually need to run this script if there are C++ api changes in libtorrent that require adjustments in libtorrent.i or libtorrent.h, this script will create automatic JNI wrappers in the outer source java folders. You should not run this script unless you know what you're doing.

Then you run the build script for your OS, get to the parent folder and invoke gradle build

The gradle build will look in the swig folder for the JNI shared libraries and it will automatically package the native holding .jar files, the final jars will be in the build/libs folder.

The windows build script is not finished, for now the windows build is done with travis builds.

Projects using jLibtorrent

FrostWire (both desktop and android editions)
TorrentStream-Android
Simple-Torrent-Android
TorrentTunes-Client
LibreTorrent

License