Skip to content

TheJoCraftNET/MapEngine-MediaExtension

Repository files navigation

MapEngine Media Extension

logo

GitHub tag (latest by date) AGPLv3 License Status Beta

Description

MapEngine Media Extension is an extension library for MapEngine. It provides an additional API for playing video and streaming live content using MapEngine.

The Extension uses bytedeco/javacv's FFmpeg implementation for decode media. JavaCV, JavaCPP and FFmpeg will be downloaded on server startup and loaded into the classpath. This plugin downloads only the currently needed libraries for the current operating system and architecture.

Features

  • Runtime dependency downloader
  • FFmpeg based media decoding
Downloading native libraries

This is an example of native libraries being downloaded on server startup.

RuntimeDependencyLoading

Live streaming via RTMP

This is an example of a live stream on a 7x4 map in Minecraft. The stream source is 1920x1080@20fps streamed with OBS.

Watch it here

Usage

MapMediaExt has to be added as a dependency to the plugin.yml regardless of the build system used.

Maven
<repositories>
    <repository>
        <id>tjcserver</id>
        <url>https://repo.thejocraft.net/releases/</url>
    </repository>
</repositories>
<dependencies>
    <dependency>
        <groupId>de.pianoman911</groupId>
        <artifactId>mapengine-mediaext</artifactId>
        <version>1.1.3</version>
        <scope>provided</scope>
    </dependency>
</dependencies>
Gradle (groovy)
repositories {
    maven {
        url = 'https://repo.thejocraft.net/releases/'
        name = 'tjcserver'
    }
}

dependencies {
    compileOnly 'de.pianoman911:mapengine-mediaext:1.1.3'
}
Gradle (kotlin)
repositories {
    maven("https://repo.thejocraft.net/releases/") {
        name = "tjcserver"
    }
}

dependencies {
    compileOnly("de.pianoman911:mapengine-mediaext:1.1.3")
}

Example

public class Bar {

    public void foo(IMapDisplay display, URI streamUri) {
        // create a drawing space for the display
        IDrawingSpace space = plugin.mapEngine().pipeline().drawingSpace(display);
        
        // add all online players as receivers
        space.ctx().receivers().addAll(Bukkit.getOnlinePlayers());

        // create a new frame source with a 10 frame buffer and rescaling enabled
        FfmpegFrameSource source = new FfmpegFrameSource(streamUri, 10, space, true);
        
        // start the decoding process
        source.start(); 
    }
}

More detailed examples can be found in the TheJoCraftNET/MapEngineExamples repository.

Building

  1. Clone the project (git clone https://github.com/TheJoCraftNET/MapEngine-MediaExtension.git)
  2. Go to the cloned directory (cd MapEngine-MediaExtension)
  3. Build the Jar (./gradlew build on Linux/MacOS, gradlew build on Windows)

The plugin jar can be found in the buildlibs directory.