mirror/musikcube
1
0
Fork 0
mirror of https://github.com/clangen/musikcube.git synced 2024-11-19 11:10:52 +00:00
Code Issues Packages Projects Releases Wiki Activity
a cross-platform, terminal-based music player, audio engine, metadata indexer, and server in c++
1,365 Commits 30 Branches 114 Tags 76 MiB
C++ 79.3%
Kotlin 12.5%
C 4.8%
CMake 1.3%
Shell 1%
Other 0.9%
f77023f121
Go to file
casey langen f77023f121 Update README.md
2017-06-17 22:42:06 -07:00
src Version bump musikdroid to 0.10.1. 2017-06-17 18:46:17 -07:00
.gitignore Fixed .gitignore 2017-05-28 22:58:49 -07:00
archive-macos.sh Updated CHANGELOG for release, and tweaked the archive filenames. 2017-03-26 20:53:05 -07:00
archive-win32.sh Moved curl and libressl dlls to the plugins directory for windows build. 2017-04-20 23:16:11 -07:00
CHANGELOG.txt Version bump musikdroid to 0.10.1. 2017-06-17 18:46:17 -07:00
CMakeLists.txt Updated version and CHANGELOG for 0.17.0 -- should be ready for a 2017-06-13 11:32:28 -07:00
CONTRIBUTORS.txt dang 2017-03-27 00:50:52 -07:00
LICENSE.txt
musikcube.sln Renamed "contrib" to "plugins". 2017-05-22 17:10:35 -07:00
README.md Update README.md 2017-06-17 22:42:06 -07:00

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:

windows screenshot

and this on macos:

osx screenshot

and on linux:

linux screenshot

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:

android screenshot

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
  • x jump to playing artist/album/genre in browse view
  • SPACE pause/resume

these only work in the play queue view:

  • 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
  • note 1: on OSX make sure you configure your terminal emulator to treat your left alt key as "+Esc" or "Meta".
  • note 2: ALT is the Modifier key in Windows

sdk

musikcube is built around its own SDK interfaces. they're still in the process of being refined. you can see what they 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:

ui:

decoders:

outputs:

metadata-related:

networking:

miscellaneous