rockbox.ffi.player — io.github.tsirysndr/rockbox-clj-ffi 0.3.0

Queue-based player with native ReplayGain and Rockbox crossfade.

A player owns a live audio output device and a background engine thread — construct it only where an output device exists. A handle is an opaque MemorySegment; every function takes it as the first argument. Free it with free (or use with-player).

ReplayGain mode here uses the player values (rockbox.ffi.enums/replaygain-mode: :off :track :album) — distinct from the DSP encoding.

Mutating functions return the player handle, so they thread cleanly with ->:

(-> p
    (player/set-queue tracks)
    (player/set-shuffle true)
    (player/set-repeat :all)
    (player/play))

Getters/queries (volume, status, queue, dsp-settings, …) return their values as usual.

clear-resume clj

(clear-resume p)

Delete the player's resume file. Returns p for threading.

default-config clj

dsp-settings clj

(dsp-settings p)

A snapshot of the player's DSP settings as a map (keyword keys).

enqueue clj

(enqueue p path)

Append one track to the queue. path may be a local file path, an http(s):// URL to a finite remote file, or a live-radio / streaming URL. Returns p for threading.

eq-enabled? clj

(eq-enabled? p)

Whether the parametric EQ is currently enabled.

export-m3u clj

(export-m3u p path)

Export the current queue to an .m3u8 at path (atomic). Returns true on success, false on error.

free clj

(free p)

Free the native handle. Safe to call with nil.

import-m3u clj

(import-m3u p path)

(import-m3u p path position)

(import-m3u p path position index)

Import the playlist file at path into the queue at position (rockbox.ffi.enums/insert-position; default :insert-last). index is only used when position is :index. Returns the imported paths as a vector, or nil on error.

insert clj

(insert p paths)

(insert p paths position)

(insert p paths position index)

Splice paths (local paths or http(s):// URLs) into the queue at position (rockbox.ffi.enums/insert-position; default :insert-last). index is only used when position is :index. Returns p for threading.

is-url? clj

(is-url? s)

Whether s looks like an http(s):// URL.

load-m3u clj

(load-m3u p path)

Replace the queue with the playlist file at path. Returns the loaded paths as a vector, or nil on error.

load-resume clj

(load-resume path)

Peek at a resume/.m3u8 file at path without a player. Returns a map {:tracks [...] :index n :elapsed_ms n}, or nil if absent/invalid.

m3u-read clj

(m3u-read path)

Parse a playlist file at path into a vector of maps {:path s :duration_ms n :title s}, or nil on error. No player needed.

m3u-write clj

(m3u-write path paths)

Write paths (a seq of path/URL strings) as an .m3u8 at path. Returns true on success, false on error. No player needed.

new-player clj

(new-player)

(new-player config)

Create a player. config overrides default-config (see the C ABI's rb_player_new_with_config / _ex). Throws if no output device is available.

If :resume-file is set, the queue and exact position are auto-persisted to that .m3u8 every :resume-save-interval-ms ms (0 => 5 s), enabling resume/save-resume/clear-resume.

next clj

(next p)

Skip to the next track. Returns p for threading.

pause clj

(pause p)

Pause playback. Returns p for threading.

play clj

(play p)

Start playback. Returns p for threading.

previous clj

(previous p)

Skip to the previous track. Returns p for threading.

queue clj

(queue p)

The current queue as a vector of path/URL strings.

repeat clj

(repeat p)

The current repeat mode as its raw int (0 off, 1 one, 2 all).

resume clj

(resume p)

Restore the queue + exact position from the player's resume file (does NOT auto-play). Returns a map {:tracks [...] :index n :elapsed_ms n}, or nil if there was nothing to resume.

sample-rate clj

(sample-rate p)

save-resume clj

(save-resume p)

Persist the queue + current position to the player's resume file now. Returns p for threading.

seek-ms clj

(seek-ms p ms)

Seek to ms in the current track. Returns p for threading.

set-bass clj

(set-bass p bass-db)

Set the bass tone gain in dB. Returns p for threading.

set-bass-cutoff clj

(set-bass-cutoff p hz)

Set the bass tone-control cutoff frequency in Hz. Returns p for threading.

set-bass-enhancement clj

(set-bass-enhancement p strength precut)

Configure bass enhancement: strength and precut. Returns p for threading.

set-channel-mode clj

(set-channel-mode p mode)

Set the channel mode (rockbox.ffi.enums/channel-mode; e.g. :stereo :mono). Returns p for threading.

set-compressor clj

(set-compressor p threshold-db makeup-gain ratio knee attack-ms release-ms)

Configure the dynamic-range compressor. Returns p for threading.

set-crossfade clj

(set-crossfade p
               mode
               &
               {:keys [fade-out-delay-ms fade-out-duration-ms fade-in-delay-ms
                       fade-in-duration-ms mix-mode]
                :or {fade-out-delay-ms 0
                     fade-out-duration-ms 2000
                     fade-in-delay-ms 0
                     fade-in-duration-ms 2000
                     mix-mode :crossfade}})

Configure crossfade. Returns p for threading.

set-crossfeed clj

(set-crossfeed p mode direct-gain cross-gain hf-gain hf-cutoff)

Configure the crossfeed effect (headphone spatialization).

mode is rockbox.ffi.enums/crossfeed-mode (:off :meier :custom). The gains (direct-gain, cross-gain, hf-gain) and hf-cutoff (Hz) are only used in :custom mode. Returns p for threading.

set-dither clj

(set-dither p enabled?)

Enable or disable dithering. Returns p for threading.

set-eq-band clj

(set-eq-band p band cutoff-hz q gain-db)

Configure one EQ band. q and gain-db are plain (not tenths) values. Returns p for threading.

set-eq-enabled clj

(set-eq-enabled p enabled?)

Enable or disable the parametric EQ. Returns p for threading.

set-eq-precut clj

(set-eq-precut p db)

Set the EQ pre-cut (attenuation) in dB. Returns p for threading.

set-eq-preset clj

(set-eq-preset p preset)

Apply a built-in EQ preset (rockbox.ffi.enums/eq-preset; e.g. :flat :rock). Returns p for threading.

set-fatigue-reduction clj

(set-fatigue-reduction p strength)

Set the listening-fatigue reduction strength. Returns p for threading.

set-pitch clj

(set-pitch p ratio)

Set the playback pitch ratio. Returns p for threading.

set-queue clj

(set-queue p paths)

Replace the queue. Each entry may be a local file path, an http(s):// URL to a finite remote file, or a live-radio / streaming URL. Returns p for threading.

set-repeat clj

(set-repeat p mode)

Set the repeat mode (rockbox.ffi.enums/repeat-mode; :off :one :all). Returns p for threading.

set-replaygain clj

(set-replaygain p mode preamp-db prevent-clipping?)

mode: rockbox.ffi.enums/replaygain-mode (:off :track :album). Returns p for threading.

set-shuffle clj

(set-shuffle p enabled?)

Enable or disable shuffle playback. Returns p for threading.

set-stereo-width clj

(set-stereo-width p percent)

Set the stereo width as a percentage. Returns p for threading.

set-surround clj

(set-surround p delay-ms balance cutoff-low-hz cutoff-high-hz)

Configure the surround effect: delay (ms), balance, and low/high cutoffs (Hz). Returns p for threading.

set-tone clj

(set-tone p bass-db treble-db bass-cutoff-hz treble-cutoff-hz)

Set the tone controls: bass/treble gain (dB) and their cutoffs (Hz). Returns p for threading.

set-treble clj

(set-treble p treble-db)

Set the treble tone gain in dB. Returns p for threading.

set-treble-cutoff clj

(set-treble-cutoff p hz)

Set the treble tone-control cutoff frequency in Hz. Returns p for threading.

set-volume clj

(set-volume p vol)

Set the output volume (0.0–1.0). Returns p for threading.

shuffle-enabled? clj

(shuffle-enabled? p)

Whether shuffle playback is currently enabled.

skip-to clj

(skip-to p index)

Jump to queue index. Returns p for threading.

status clj

(status p)

A snapshot of the player's status as a map (keyword keys).

stop clj

(stop p)

Stop playback. Returns p for threading.

toggle clj

(toggle p)

Toggle play/pause. Returns p for threading.

volume clj

(volume p)

with-player clj macro

(with-player [sym & [config]] & body)

Bind sym to a fresh player (optional config), run body, then free it.