Skip to content

mainLink0435/audiodecoder.openmpt

 
 

Repository files navigation

audiodecoder.openmpt addon for Kodi

This is a Kodi audio decoder addon for tracker module files.

This is a custom fork of the official OpenMPT Audio Decoder for Kodi.

STATUS: Enthusiast Mod / Custom Build

This addon is designed for users who want to experience tracker music (MOD, IT, XM, S3M, etc.) in full, discretely-mixed 5.1 surround sound within Kodi.

🚨 IMPORTANT NOTICES

  1. Kodi Compatibility: This addon has been specifically built and tested for Kodi v21 (Omega). Compatibility with other versions (e.g., v20 Nexus or v22 Piers) is not guaranteed.
  2. Dependency: This addon requires a custom-compiled version of the underlying libopenmpt library which includes the necessary 5.1 mixing engine. This library fork is maintained in a separate repository: https://github.com/mainLink0435/openmpt
  3. Official Status: This addon is not affiliated with the official Kodi or libopenmpt projects. For the foreseeable future, this feature will not be part of the official Kodi addon, as it conflicts with the upstream libopenmpt philosophy of strict archival fidelity.

✨ The 5.1 Surround Mix Advantage

This custom build provides a superior spatial experience for module files:

  • Pre-Mix Panning: Unlike generic AVR upmixers or matrix filters, this mod works directly with the module's raw spatial data, before the audio is mixed to stereo. This is the only way to genuinely distribute the sound across all six channels (FL, FR, Center, SL, SR, LFE).
  • Enhanced Immersion: For the enthusiast community, this technique creates an immediate and subjectively enhanced spatial experience that opens up the sound beautifully for modern multi-channel systems.

License: GPL-2.0-or-later Build and run tests Build Status Build Status

Build Instructions

These instructions are for building the addon on a Linux-based system.

Prerequisites

  1. A pre-compiled libopenmpt.a library. This addon requires a specific custom version of the libopenmpt library that has 5.1 surround mixing capabilities. You can get the source code to compile it yourself from this repository:

  2. Build Tools: You will also need the following tools installed:

    • git
    • build-essential (on Debian/Ubuntu for g++, make)
    • cmake
    • patchelf
    • zip

1. Directory & Library Setup

The build system requires a specific directory structure to locate the libopenmpt.a library.

First, clone this audiodecoder.openmpt repository. Then, create a parallel directory named openmpt and place the library within it as shown below.

/your/build/folder/
├───openmpt/
│   └───bin/
│       └───libopenmpt.a  <-- Place the pre-compiled library here
│
└───audiodecoder.openmpt/  <-- The repository you are currently in

2. Build & Package the Addon

Once the prerequisites are met and the directory structure is correct, you can build the addon.

# From the 'audiodecoder.openmpt' directory

# Step 2.1: Configure with CMake, compile, and copy addon resources
bash -c "cmake -S . -B build && cmake --build build && bash copy_resources.sh build"

# Step 2.2: Navigate into the build directory to create the zip
cd build

# Step 2.3: Create the final installable package
zip -r audiodecoder.openmpt.zip audiodecoder.openmpt

The resulting audiodecoder.openmpt.zip can be installed in Kodi via the "Install from zip file" option.

About

OpenMPT decoder addon

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CMake 54.3%
  • C++ 38.9%
  • Shell 6.8%