opencubicplayer-docker

This repository contains files for building Docker images for the Unix fork of Open Cubic Player.

UNIX port of Open Cubic Player, which is a text-based player with some few graphical views. Visual output can be done through nCurses, Linux console (VCSA + FrameBuffer), X11 or SDL/SDL2. It can be compiled on various different unix based operating systems.

Two image targets are available in the provided Dockerfile:

• ocp: Produces an image containing Open Cubic Player and libpulse0.
• ocp-midi: Produces an ocp image with MIDI playback support.

The libpulse0 library provides support for PulseAudio servers when using the SDL2 playback driver in Open Cubic Player. This provides out of the box support for modern desktop environments.

All images are based on the official openSUSE Tumbleweed image. This base image was chosen for the following reasons: (1) the openSUSE Tumbleweed package repositories contain an up-to-date version of Open Cubic Player and (2) the base image is very small.

For MIDI playback support, the ocp-midi target pre-configures Timidity and bundles Shan's GM Soundfont. This Soundfont provides high quality MIDI audio rendering. Other Soundfont files can be used as well.

Refer to the usage section for more details.

Usage

Ready to use images are available in the GitHub Container Registry.

Note Use the opencubicplayer-midi:latest image/tag for MIDI playback support.

Linux

The images can be used in Linux with ALSA (without audio servers) or PulseAudio.

Two versions of Docker are available for Linux:

• Docker Desktop for Linux (limited as it uses virtualization)
• Docker Engine (the recommended version)

When using graphical mode in Linux, access to X11 must be granted to root by running:

xhost +local:root

Warning The above access grant is lost when the X11 server is restarted.

Using ALSA

To run Open Cubic Player in Linux using ALSA (ncurses mode):

docker run --rm -it \
    --device /dev/snd
    -v /path/to/media:/media:ro \
    ghcr.io/hhromic/opencubicplayer:latest \
    ocp-curses

To run Open Cubic Player in Linux using ALSA (graphical mode):

docker run --rm -it \
    --device /dev/snd
    -v /path/to/media:/media:ro \
    -v /tmp/.X11-unix:/tmp/.X11-unix \
    -e DISPLAY \
    ghcr.io/hhromic/opencubicplayer:latest \
    ocp-sdl2

Using PulseAudio

Note The examples below are for Debian/Ubuntu desktops. Please review the paths in other distributions.

To run Open Cubic Player in Linux using PulseAudio (ncurses mode):

docker run --rm -it \
    -v /path/to/media:/media:ro \
    -v /run/user/$(id -u):/run/user/$(id -u) \
    -v $HOME/.config/pulse:/root/.config/pulse:ro \
    -e PULSE_SERVER=/run/user/$(id -u)/pulse/native \
    ghcr.io/hhromic/opencubicplayer:latest \
    ocp-curses -spdevpSDL2

To run Open Cubic Player in Linux using PulseAudio (graphical mode):

docker run --rm -it \
    -v /path/to/media:/media:ro \
    -v /run/user/$(id -u):/run/user/$(id -u) \
    -v $HOME/.config/pulse:/root/.config/pulse:ro \
    -v /tmp/.X11-unix:/tmp/.X11-unix \
    -e PULSE_SERVER=/run/user/$(id -u)/pulse/native \
    -e DISPLAY \
    ghcr.io/hhromic/opencubicplayer:latest \
    ocp-sdl2 -spdevpSDL2

Windows Subsystem for Linux (WSL2)

The images can be used in WSL2 with WSLg and Docker Desktop for Windows in Windows 10/11.

WSLg provides support for PulseAudio and graphical mode via X11.

To run Open Cubic Player in WSL2 with WSLg (ncurses mode):

docker run --rm -it \
    -v /path/to/media:/media:ro \
    -v /mnt/wslg:/mnt/wslg \
    -e PULSE_SERVER \
    ghcr.io/hhromic/opencubicplayer:latest \
    ocp-curses -spdevpSDL2

To run Open Cubic Player in WSL2 with WSLg (graphical mode):

docker run --rm -it \
    -v /path/to/media:/media:ro \
    -v /mnt/wslg:/mnt/wslg \
    -v /tmp/.X11-unix:/tmp/.X11-unix \
    -e PULSE_SERVER \
    -e DISPLAY \
    ghcr.io/hhromic/opencubicplayer:latest \
    ocp-sdl2 -spdevpSDL2

Custom MIDI Soundfont

To use a custom Soundfont file for MIDI playback (ncurses mode):

docker run --rm -it \
    -v /path/to/media:/media:ro \
    -v /path/to/soundfont.sf2:/usr/share/soundfonts/default.sf2:ro \
    -v /mnt/wslg:/mnt/wslg \
    -e PULSE_SERVER \
    ghcr.io/hhromic/opencubicplayer-midi:latest \
    ocp-curses -spdevpSDL2

Building

To build the opencubicplayer:latest image locally:

docker buildx build --tag opencubicplayer:latest --target ocp .

To build the opencubicplayer-midi:latest image locally:

docker buildx build --tag opencubicplayer-midi:latest --target ocp-midi .

Licenses

This project is licensed under the Apache License Version 2.0.

Open Cubic Player (Unix fork) is licensed under the GNU General Public License v2.0.

The bundled SGM Soundfont is under Copyright (c) 2002-2004 David Shan.