Skip to content
a cross-platform, terminal-based music player, audio engine, metadata indexer, and server in c++
C++ C Kotlin Objective-C CMake Makefile Other
Branch: master
Clone or download
Latest commit 874eec1 Jan 25, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Fixed file naming to reduce manual labor for cpack'd debs. Oct 29, 2019
.cmake More robust detection of libatomic Oct 28, 2019
.vscode Updated .gitignore and added a `msbuild-tools.json` to make it possible Jan 22, 2020
src SDK constants cleanup. Jan 26, 2020
.gitignore Another .gitignore tweak. Jan 24, 2020
.gitmodules - use the new `musikcube-bin` git repo as a submodule for including Dec 17, 2017
CHANGELOG.txt Added Ubuntu 19.10 "Eoan" support Oct 27, 2019
CMakeLists.txt Version bump for next release. Jan 12, 2020
CONTRIBUTORS.txt dang Mar 27, 2017
LICENSE.txt License date update. Dec 30, 2018
README.md Typo fix Jan 19, 2020
archive-macos.sh Fixed static macOS compiles. Jan 9, 2020
archive-rpi.sh Also clean the bin dir Jan 13, 2019
archive-win32.sh Standardize windows dist directory. Oct 27, 2019
archive-win64.sh Standardize windows dist directory. Oct 27, 2019
clean-nix.sh Fixed issue defining `FFMPEG_ENABLED` that resulted in some formats n… Jan 12, 2020
musikcube-musikwin.sln Repaired broken musikwin project -- even though it'll probably never be Feb 24, 2018
musikcube-no-ffmpeg.sln GmeDecoder is working on Windows. Jan 4, 2019
musikcube.sln Added 64-bit support. Oct 24, 2019
musikcube.spec Version bump for next release. Jan 12, 2020
strip-nix.sh Ensure we actually strip binaries as part of the release build process. Oct 27, 2019
update-version.sh Added update-version.sh to automate version bumping. Jan 7, 2019

README.md

musikcube

a cross-platform, terminal-based audio engine, library, player and server written in c++.

musikcube compiles and runs easily on windows, macos and linux. it also runs well on a raspberry pi with raspbian, and can be setup as a streaming audio server.

check out the installation guide to get up and running.

be sure to also read through a the user guide, which describes app's navigation paradigm and lists all the default keyboard shortcuts.

screenshots

it looks something like this on windows:

windows screenshot

and this on macos:

osx screenshot

and on linux:

linux screenshot

here's a demo (made with asciinema):

asciicast

while the main musikcube app runs in the console, you can also stream audio from (and even remote control) musikcube using the musikdroid android app, which can be downloaded in the releases section above. it looks like this:

android screenshot

installation

binaries are available in the releases page.

while macos binaries are provided, you can also install via homebrew as follows:

  • brew tap clangen/musikcube
  • brew install musikcube
  • musikcube

on freebsd musikcube can be installed as follows:

  • pkg install musikcube

on windows, you can install via chocolatey:

  • choco install musikcube

then run using shell, Win+R dialog or by typing in Start Menu musikcube or mcube.

raspberry pi

musikcube runs well on a raspberry pi, connected to your home stereo. see here for detailed setup instructions.

compiling

if you'd like to compile the project yourself, you can check out the build instructions.

keyboard shortcuts

a list of all keyboard shortcuts can be found in the user guide

streaming server

musikcube ships with a streaming audio server enabled by default. it runs a websocket server on port 7905, used for metadata retrieval. an http server runs on port 7906, and is used to serve (optionally transcoded) audio data to clients.

it's important to understand that, out of the box, the server (and remote api) should NOT be considered safe for use outside of a local network. the websockets service only supports a simple password challenge, and the audio http server just handles Basic authorization. it does not provide ssl or tls. the server also stores the password in plain text in a settings file on the local machine.

you can fix some of this using a reverse proxy to provide ssl termination. details in the ssl-server-setup section. while this improves things, you should exercise caution exposing these services over the internet.

if you're interested in writing your own frontend, api documentation is available here.

sdk

the musikcube sdk is a set of small, pure-virtual c++ classes and a handful of enums and constants. they're still in the process of being slimmed down. you can see what they currently look like here: https://github.com/clangen/musikcube/tree/master/src/core/sdk

dependencies

musikcube would not be possible without the following excellent free, open source, and (in the case of some macos and win32 APIs) non-free projects and libraries:

core decoders outputs metadata networking miscellaneous ui
boost flac alsa taglib websocketpp rxjava ncurses
sqlite ogg/vorbis pulseaudio glide libmicrohttpd rxandroid pdcurses (win32a variant)
utfcpp mad + nomad core audio libcurl stetho recycler-fast-scroll
nlohmann json faad2 wasapi libressl fabric
kissfft exoplayer directsound nv-websocket-client AndroidVideoCache
sigslot waveout okhttp
wcwidth.c

license

Copyright (c) 2004-2019 musikcube team

All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice,
   this list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.

 * Neither the name of the author nor the names of other contributors may
   be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
You can’t perform that action at this time.