musikcube/README.md

musikcube

a cross-platform audio engine and player written in c++.

musikbox

a curses frontend to musikcube.

musicbox 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.

it looks something like this on windows:

and this on macos:

and on linux:

you can also stream audio from, or remote control musikbox using the musikdroid android app, which can be downloaded in the releases section above. it looks like this:

raspberry pi

want to run musikbox on a raspberry pi, connected to you home stereo? see here.

streaming server documentation

if you're interested in writing your own frontend, api documentation is available here. the streaming server api uses a combination of websockets and vanilla http, and is included in every musikbox distribution.

compiling

windows

• grab the Visual Studio 2017 Community Edition and install the 32-bit c++ compiler.
• clone the musikcube sources: git clone https://github.com/clangen/musikcube.git
• install the 32 bit version of boost 1.64. ensure it shares the same parent directory with musikcube. e.g: c:\src\musikcube and c:\src\boost_1_64_0 -- the project's solution will reference it via relative path.
• open musikcube.sln and build/run.

mac

you'll need homebrew to install the required dependencies.

automatic

• brew tap clangen/musikbox
• brew install musikbox
• musikbox

manual

• brew install cmake boost libogg libvorbis flac faad2 libmicrohttpd lame
• git clone https://github.com/clangen/musikcube.git
• cd musikcube
• cmake .
• make
• cd bin
• ./musikbox

linux

• install the following libraries and their development packages: cmake boost libogg vorbis flac faad2 ncurses zlib asound pulse libcurl libmicrohttpd libmp3lame
• git clone https://github.com/clangen/musikcube.git
• cd musikcube
• cmake .
• make
• sudo make install
• musikbox

keyboard shortcuts

the hotkeys listed below can generally be used at any time; however, if an input field is focused some may not work. you can enter command mode by pressing ESC, which will highlight the bottom command bar and accept all hotkeys. command mode may be deactivated by pressing ESC again.

you may also change hotkeys by editing ~/.musikcube/hotkeys.json and restarting the app. a hotkey tester is provided in the settings screen.

• TAB select next window
• SHIFT+TAB select previous window
• ~ switch to console view
• a switch to library view
• s switch to settings view
• i volume up 5%
• k volume down 5%
• m toggle volume mute
• j previous track
• l next track
• u back 10 seconds
• o forward 10 seconds
• v show / hide visualizer
• r repaint the screen
• . toggle repeat mode (off/track/list)
• , (un)shuffle play queue
• CTRL+p pause/resume (globally)
• CTRL+x stop (unload streams, free resources)
• CTRL+d quit

and a couple hotkeys that are specific to the library view:

• b show browse view
• n show play queue
• f show album/artist/genre search
• t show track search
• 1 browse by artist
• 2 browse by album
• 3 browse by genre
• 4 browse by album artist
• 5 browse by playlist
  • M-n create a new empty playlist
  • M-s save the currently selected playlist
  • DEL (BACKSPACE on macos) in the playlists pane: delete the selected playlist
  • M-r rename the selected playlist
  • M-UP (CTRL-UP on macos) move the selected track up
  • M-DOWN (CTRL-DOWN on macos) move the selected track down
  • DEL (BACKSPACE on macos) in the tracks pane: delete the selected track
• x jump to playing artist/album/genre in browse view
• M-ENTER show a context menu for the currently selected item (album, artist, genre, track)
• SPACE pause/resume

you can manipulate the play play queue as follows:

• M-s save current queue as a playlist
• M-l load a previously saved playlist
• M-x delete a previously saved playlist
• M-r rename a playlist
• M-UP (CTRL-UP on macos) move the selected track up
• M-DOWN (CTRL-DOWN on macos) move the selected track down
• DEL (BACKSPACE on macos) delete the selected track

a couple important notes:

• on macos make sure you configure your terminal emulator to treat your left alt key as "+Esc" or "Meta"
• ALT is the Modifier key in the windows build

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 refined. 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	recycler-fast-scroll
json.hpp	faad2	wasapi		libressl
kissfft	exoplayer	directsound		nv-websocket-client
sigslot		waveout		okhttp
wcwidth.c