2016-05-30 08:26:08 +00:00
# musikcube
2017-05-29 21:42:06 +00:00
a cross-platform audio engine and player written in c++.
2016-05-30 08:26:08 +00:00
# musikbox
2016-09-20 20:30:49 +00:00
a curses frontend to musikcube.
2016-05-30 08:26:43 +00:00
2017-05-29 21:42:06 +00:00
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.
2016-05-30 08:32:37 +00:00
2016-05-31 04:33:58 +00:00
it looks something like this on windows:
2016-08-10 07:02:39 +00:00
2016-05-31 04:33:58 +00:00
2017-05-29 21:42:06 +00:00
and this on macos:
2016-05-31 04:33:58 +00:00
2016-08-10 07:02:39 +00:00
2016-05-31 04:33:58 +00:00
2017-05-29 21:42:06 +00:00
and on linux:
2016-06-27 02:18:26 +00:00
2016-08-10 07:02:39 +00:00
2016-06-27 02:18:26 +00:00
2017-05-01 03:07:48 +00:00
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:
2017-02-19 05:57:58 +00:00
2017-02-20 08:35:51 +00:00
# raspberry pi
2017-05-29 21:42:42 +00:00
want to run musikbox on a raspberry pi, connected to you home stereo? [see here ](https://github.com/clangen/musikcube/wiki/raspberry-pi ).
2017-05-29 21:42:06 +00:00
# streaming server documentation
if you're interested in writing your own frontend, [api documentation is available here ](https://github.com/clangen/musikcube/wiki/remote-api-documentation ). the streaming server api uses a combination of websockets and vanilla http, and is included in every `musikbox` distribution.
2017-02-20 08:35:51 +00:00
2016-05-31 01:36:41 +00:00
# compiling
## windows
2017-04-09 07:02:58 +00:00
- grab the [Visual Studio 2017 Community Edition ](https://www.visualstudio.com/en-us/downloads/download-visual-studio-vs.aspx ) and install the 32-bit c++ compiler.
2016-05-31 01:36:41 +00:00
- clone the musikcube sources: `git clone https://github.com/clangen/musikcube.git`
2017-06-08 02:52:50 +00:00
- install the [32 bit version of boost 1.64 ](https://sourceforge.net/projects/boost/files/boost-binaries/1.64.0/boost_1_64_0-msvc-14.1-32.exe/download ). 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.
2016-05-31 04:38:10 +00:00
- open `musikcube.sln` and build/run.
2016-05-31 01:36:41 +00:00
## mac
2016-05-31 04:38:54 +00:00
you'll need [homebrew ](http://brew.sh/ ) to install the required dependencies.
2016-05-31 01:36:41 +00:00
2016-08-28 20:16:09 +00:00
### automatic
2016-08-28 21:59:51 +00:00
- `brew tap clangen/musikbox`
- `brew install musikbox`
2016-08-28 20:16:09 +00:00
- `musikbox`
### manual
2017-06-18 05:41:44 +00:00
- `brew install cmake boost libogg libvorbis flac faad2 libmicrohttpd lame`
2016-05-31 01:36:41 +00:00
- `git clone https://github.com/clangen/musikcube.git`
- `cd musikcube`
- `cmake .`
- `make`
- `cd bin`
2016-05-31 03:09:38 +00:00
- `./musikbox`
2016-05-31 01:36:41 +00:00
2016-06-10 05:54:39 +00:00
## linux
2017-05-30 00:34:56 +00:00
- install the following libraries and their development packages: `cmake boost libogg vorbis flac faad2 ncurses zlib asound pulse libcurl libmicrohttpd libmp3lame`
2016-06-10 05:54:39 +00:00
- `git clone https://github.com/clangen/musikcube.git`
- `cd musikcube`
- `cmake .`
- `make`
2016-08-28 20:16:09 +00:00
- `sudo make install`
- `musikbox`
2016-06-10 05:54:39 +00:00
2016-05-31 04:45:13 +00:00
## keyboard shortcuts
2016-08-23 04:28:56 +00:00
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.
2017-03-05 21:24:29 +00:00
you may also change hotkeys by editing `~/.musikcube/hotkeys.json` and restarting the app. a hotkey tester is provided in the settings screen.
2016-05-31 04:45:13 +00:00
2016-06-24 05:22:26 +00:00
- `TAB` select next window
- `SHIFT+TAB` select previous window
2016-08-23 04:28:56 +00:00
- `~` switch to console view
- `a` switch to library view
- `s` switch to settings view
- `i` volume up 5%
- `k` volume down 5%
2016-11-20 05:41:43 +00:00
- `m` toggle volume mute
2016-08-23 04:28:56 +00:00
- `j` previous track
- `l` next track
- `u` back 10 seconds
- `o` forward 10 seconds
2016-11-09 00:10:24 +00:00
- `v` show / hide visualizer
2016-08-23 04:28:56 +00:00
- `r` repaint the screen
2016-09-20 19:17:15 +00:00
- `.` toggle repeat mode (off/track/list)
- `,` (un)shuffle play queue
2016-05-31 04:45:13 +00:00
- `CTRL+p` pause/resume (globally)
2016-06-25 18:40:24 +00:00
- `CTRL+x` stop (unload streams, free resources)
2016-05-31 04:45:13 +00:00
- `CTRL+d` quit
2017-06-18 05:41:44 +00:00
and a couple hotkeys that are specific to the `library` view:
2016-06-04 05:29:01 +00:00
2016-08-23 04:28:56 +00:00
- `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
2017-06-27 14:16:15 +00:00
- `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
2016-11-20 05:41:43 +00:00
- `x` jump to playing artist/album/genre in browse view
2017-06-18 05:57:50 +00:00
- `M-ENTER` show a context menu for the currently selected item (album, artist, genre, track)
2016-06-04 05:29:01 +00:00
- `SPACE` pause/resume
2017-06-27 14:16:15 +00:00
you can manipulate the play `play queue` as follows:
2017-06-18 05:41:44 +00:00
- `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
2017-06-27 14:16:15 +00:00
- `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
2017-06-18 05:41:44 +00:00
2017-06-18 05:48:47 +00:00
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 `M` odifier key in the windows build
2016-05-31 05:03:36 +00:00
2016-05-30 08:32:37 +00:00
# sdk
2017-06-18 05:48:47 +00:00
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
2017-03-05 21:24:29 +00:00
# dependencies
2017-06-18 05:48:47 +00:00
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:
2017-03-05 21:24:29 +00:00
2017-07-01 02:05:45 +00:00
| core | decoders | outputs | metadata | networking | miscellaneous | ui |
|-----------------------------------------------------------|-----------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------|--------------------------------------------------------------------------------|---------------------------------------------------------------------------|----------------------------------------------------------------------|
| [boost ](http://www.boost.org/ ) | [flac ](https://xiph.org/flac/ ) | [alsa ](https://www.alsa-project.org ) | [taglib ](http://taglib.org/ ) | [websocketpp ](https://github.com/zaphoyd/websocketpp ) | [rxjava ](https://github.com/ReactiveX/RxJava ) | [ncurses ](https://www.gnu.org/software/ncurses/ ) |
| [sqlite ](https://www.sqlite.org/ ) | [ogg/vorbis ](http://www.vorbis.com/ ) | [pulseaudio ](https://www.freedesktop.org/wiki/Software/PulseAudio/ ) | [glide ](https://github.com/bumptech/glide ) | [libmicrohttpd ](https://www.gnu.org/software/libmicrohttpd/ ) | [rxandroid ](https://github.com/ReactiveX/RxAndroid ) | [pdcurses (win32a variant) ](https://www.projectpluto.com/win32a.htm ) |
| [utfcpp ](https://github.com/nemtrif/utfcpp ) | [mad ](http://www.underbit.com/products/mad/ ) + [nomad ](https://github.com/cmus/cmus/tree/master/ip ) | [core audio ](https://developer.apple.com/library/content/documentation/MusicAudio/Conceptual/CoreAudioOverview/Introduction/Introduction.html ) | | [libcurl ](https://curl.haxx.se/libcurl/ ) | [recycler-fast-scroll ](https://github.com/plusCubed/recycler-fast-scroll ) | |
| [json.hpp ](https://github.com/nlohmann/json ) | [faad2 ](http://www.audiocoding.com/faad2.html ) | [wasapi ](https://msdn.microsoft.com/en-us/library/windows/desktop/dd371455(v=vs.85 ).aspx) | | [libressl ](https://www.libressl.org/ ) | | |
| [kissfft ](http://kissfft.sourceforge.net/ ) | [exoplayer ](https://github.com/google/ExoPlayer ) | [directsound ](https://msdn.microsoft.com/en-us/library/windows/desktop/ee416960(v=vs.85 ).aspx) | | [nv-websocket-client ](https://github.com/TakahikoKawasaki/nv-websocket-client ) | | |
| [sigslot ](http://sigslot.sourceforge.net/ ) | | [waveout ](https://msdn.microsoft.com/en-us/library/windows/desktop/dd743876(v=vs.85 ).aspx) | | [okhttp ](http://square.github.io/okhttp/ ) | | |
| [wcwidth.c ](http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c ) | | | | | | |
