Difference between revisions of "Ncmpcpp"

From ArchWiki
Jump to: navigation, search
(Other UI keys)
m (colon)
(16 intermediate revisions by 10 users not shown)
Line 1: Line 1:
[[Category:Audio/Video (English)]]
+
[[Category:Audio/Video]]
 +
[[it:Ncmpcpp]]
 
{{Article summary start}}
 
{{Article summary start}}
{{Article summary text|Covers installation and usage of ncmpcpp (ncmpc++)}}
+
{{Article summary text|Covers installation and usage of ncmpcpp}}
 
{{Article summary heading|Related}}
 
{{Article summary heading|Related}}
 
{{Article summary wiki|mpd}} - Music Player Daemon
 
{{Article summary wiki|mpd}} - Music Player Daemon
 
{{Article summary end}}
 
{{Article summary end}}
  
==Introduction==
+
== Introduction ==
[http://unkart.ovh.org/ncmpcpp/ Ncmpcpp] or ncmpc++ is an [[mpd]] client with a UI very similar to ncmpc, but it provides new useful features such as support for regular expressions in search engine, extended song format, items filtering, last.fm support, ability to sort playlist, local filesystem browser and other minor functions.  To use it, a functional [[mpd]] must be present on the system since ncmpcpp/mpd work together in a client/server relationship.
+
  
The shell "GUI" for ncmpcpp is highly customizable.  Edit {{Filename|~/.ncmpcpp/config}} to your liking.  For inspiration, see the following resources:
+
[http://unkart.ovh.org/ncmpcpp/ Ncmpcpp] or ncmpcpp is an [[mpd]] client with a UI very similar to ncmpc, but it provides new useful features such as support for regular expressions in search engine, extended song format, items filtering, last.fm support, ability to sort playlist, local filesystem browser and other minor functions.  To use it, a functional [[mpd]] must be present on the system since ncmpcpp/mpd work together in a client/server relationship.
 +
 
 +
The shell "GUI" for ncmpcpp is highly customizable.  Edit {{ic|~/.ncmpcpp/config}} to your liking.  For inspiration, see the following resources:
  
 
* [https://bbs.archlinux.org/viewtopic.php?id=66488 Show your .ncmpcpp/config with Screenshot forum thread]
 
* [https://bbs.archlinux.org/viewtopic.php?id=66488 Show your .ncmpcpp/config with Screenshot forum thread]
 
* [http://unkart.ovh.org/ncmpcpp/screenshots.php Project screenshots page]
 
* [http://unkart.ovh.org/ncmpcpp/screenshots.php Project screenshots page]
  
==Installation==
+
== Installation ==
The official package resides in [community]
+
# pacman -S ncmpcpp
+
  
==(Very) Basic configuration==
+
[[pacman|Install]] {{Pkg|ncmpcpp}} from the [[official repositories]].
After installation a sample configuration file can be found in /usr/share/doc/ncmpcpp/config
+
If, after installation, ~/.ncmpcpp/config has not been created, you could copy the sample config and edit at the very least the following three configuration options:
+
  
* mpd_host (should point to the host on which mpd resides, can be "localhost" or "127.0.0.1" if on the same machine)
+
== Basic configuration ==
* mpd_port (unless you've changed the defaults of mpd, this should be "6600")
+
* mpd_music_dir (the same directory value as specified in "music_directory" in mpd.conf)
+
  
==Enabling visualization==
+
After installation a sample configuration file can be found in {{ic|/usr/share/doc/ncmpcpp/config}}.
For visualization, one needs the {{Package AUR|ncmpcpp-fftw}} package from the [[AUR]].  Once built, add a few lines to {{Filename|/etc/mpd.conf}} to enable the generation of the [[Wikipedia:Fast Fourier transform|fast Fourier transform]] data for the visualization:
+
  
<pre>
+
If, after installation, {{ic|~/.ncmpcpp/config}} has not been created, you could copy the sample config, [[chmod#chown|change owner]] and edit at the very least the following three configuration options:
audio_output {
+
    type                    "fifo"
+
    name                    "my_fifo"
+
    path                    "/tmp/mpd.fifo"
+
}
+
</pre>
+
  
Additional lines need to be added to {{Filename|~/.ncmpcpp/config}}
+
* '''mpd_host''' - Should point to the host on which mpd resides, can be "localhost" or "127.0.0.1" if on the same machine
 +
* '''mpd_port''' - Unless you've changed the defaults of mpd, this should be "6600"
 +
* '''mpd_music_dir''' - The same directory value as specified in "music_directory" in {{ic|mpd.conf}}
  
<pre>
+
== Enabling visualization ==
visualizer_fifo_path = "/tmp/mpd.fifo"
+
visualizer_output_name = "my_fifo"
+
visualizer_sync_interval = "1"
+
#visualizer_type = "wave" (spectrum/wave)
+
visualizer_type = "spectrum" (spectrum/wave)
+
</pre>
+
  
Users can chose between either a spectrum analyzer or wave form.
+
For visualization, add a few lines to {{ic|/etc/mpd.conf}} to enable the generation of the [[Wikipedia:Fast Fourier transform|fast Fourier transform]] data for the visualization:
  
==Basic Usage==
+
audio_output {
===Loading ncmpc++===
+
    type                    "fifo"
Load ncmpc++ in a shell  
+
    name                    "my_fifo"
 +
    path                    "/tmp/mpd.fifo"
 +
    format                  "44100:16:2"
 +
}
 +
 
 +
Additional lines need to be added to {{ic|~/.ncmpcpp/config}}
 +
 
 +
visualizer_fifo_path = "/tmp/mpd.fifo"
 +
visualizer_output_name = "my_fifo"
 +
visualizer_sync_interval = "1"
 +
#visualizer_type = "wave" (spectrum/wave)
 +
visualizer_type = "spectrum" (spectrum/wave)
 +
 
 +
Users can choose between either a spectrum analyzer or wave form.
 +
 
 +
== Basic usage ==
 +
 
 +
=== Loading ncmpcpp ===
 +
 
 +
Load ncmpcpp in a shell:
 
  $ ncmpcpp
 
  $ ncmpcpp
===Remapping keys===
 
A listing of keys and their respective functions is available from within npmpcpp itself via hitting {{Keypress|1}}.  Users may remap any of the default keys simply by copying {{Filename|/usr/share/doc/ncmpcpp/keys}} ~/.ncmpcpp and editing it.
 
  
===Different views===
+
=== Different views ===
Partial list of views within ncmpc++
+
*{{Keypress|0}} - Clock
+
*{{Keypress|1}} - Help
+
*{{Keypress|2}} - Current playlist
+
*{{Keypress|3}} - Filesystem browser
+
*{{Keypress|4}} - DB search
+
*{{Keypress|5}} - Library
+
*{{Keypress|6}} - Playlist editor
+
*{{Keypress|7}} - Tag editor (very powerful!)
+
*{{Keypress|9}} - Music visualizer
+
  
===Other UI keys===
+
Partial list of views within ncmpcpp:
*{{Keypress|\}} - Switch between classic and alternative views
+
*{{ic|0}} - Clock
*{{Keypress|#}} - Display bitrate of file
+
*{{ic|1}} - Help
*{{Keypress|i}} - Show song info
+
*{{ic|2}} - Current playlist
*{{Keypress|I}} - Show artist info (saved in {{Filename|~/.ncmpcpp/artists/ARTIST.txt}})
+
*{{ic|3}} - Filesystem browser
*{{Keypress|L}} - Shuffle between available lyric databases
+
*{{ic|4}} - DB search
*{{Keypress|l}} - Retrieve song lyrics for current song Show/hide lyrics
+
*{{ic|5}} - Library
 +
*{{ic|6}} - Playlist editor
 +
*{{ic|7}} - Tag editor (very powerful!)
 +
*{{ic|9}} - Music visualizer
  
{{Note|As mentioned above, the visualizer is not enabled in the ncmpcpp package in the repo.  Users will need to build the fftw version from the AUR.}}
+
=== Other UI keys ===
  
===Playback modes===
+
*{{ic|\}} - Switch between classic and alternative views
 +
*{{ic|#}} - Display bitrate of file
 +
*{{ic|i}} - Show song info
 +
*{{ic|I}} - Show artist info (saved in {{ic|~/.ncmpcpp/artists/ARTIST.txt}})
 +
*{{ic|L}} - Shuffle between available lyric databases
 +
*{{ic|l}} - Retrieve song lyrics for current song Show/hide lyrics
 +
 
 +
=== Playback modes ===
  
 
Noticed the control panel in the upper right; shown in alternative mode:
 
Noticed the control panel in the upper right; shown in alternative mode:
Line 90: Line 92:
 
This corresponds to the playback modes; ordered from left to right, they are:
 
This corresponds to the playback modes; ordered from left to right, they are:
  
*{{Keypress|r}} - repeat mode '''[r-----]'''
+
*{{ic|r}} - repeat mode '''[r-----]'''
*{{Keypress|z}} - random mode '''[-z----]'''
+
*{{ic|z}} - random mode '''[-z----]'''
*{{Keypress|y}} - single mode '''[--s---]'''
+
*{{ic|y}} - single mode '''[--s---]'''
*{{Keypress|R}} - consume mode '''[---c--]'''
+
*{{ic|R}} - consume mode '''[---c--]'''
*{{Keypress|x}} - crossfade mode '''[----x-]'''
+
*{{ic|x}} - crossfade mode '''[----x-]'''
 +
 
 +
The final "-" is only active when the user forces an update to the datebase via {{ic|u}}.
 +
 
 +
== Remapping keys ==
  
The final "-" is only active when the user forces an update to the datebase via {{Keypress|u}}.
+
A listing of keys and their respective functions is available from within npmpcpp itself via hitting {{ic|1}}.  Users may remap any of the default keys simply by copying {{ic|/usr/share/doc/ncmpcpp/keys}} to ~/.ncmpcpp/ and editing it.
 +
'''ncmpcpp-git''' users have to copy {{ic|/usr/share/doc/ncmpcpp/bindings}} instead.

Revision as of 13:01, 22 June 2013

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary wiki - Music Player Daemon Template:Article summary end

Introduction

Ncmpcpp or ncmpcpp is an mpd client with a UI very similar to ncmpc, but it provides new useful features such as support for regular expressions in search engine, extended song format, items filtering, last.fm support, ability to sort playlist, local filesystem browser and other minor functions. To use it, a functional mpd must be present on the system since ncmpcpp/mpd work together in a client/server relationship.

The shell "GUI" for ncmpcpp is highly customizable. Edit ~/.ncmpcpp/config to your liking. For inspiration, see the following resources:

Installation

Install ncmpcpp from the official repositories.

Basic configuration

After installation a sample configuration file can be found in /usr/share/doc/ncmpcpp/config.

If, after installation, ~/.ncmpcpp/config has not been created, you could copy the sample config, change owner and edit at the very least the following three configuration options:

  • mpd_host - Should point to the host on which mpd resides, can be "localhost" or "127.0.0.1" if on the same machine
  • mpd_port - Unless you've changed the defaults of mpd, this should be "6600"
  • mpd_music_dir - The same directory value as specified in "music_directory" in mpd.conf

Enabling visualization

For visualization, add a few lines to /etc/mpd.conf to enable the generation of the fast Fourier transform data for the visualization:

audio_output {
    type                    "fifo"
    name                    "my_fifo"
    path                    "/tmp/mpd.fifo"
    format                  "44100:16:2"
}

Additional lines need to be added to ~/.ncmpcpp/config

visualizer_fifo_path = "/tmp/mpd.fifo"
visualizer_output_name = "my_fifo"
visualizer_sync_interval = "1"
#visualizer_type = "wave" (spectrum/wave)
visualizer_type = "spectrum" (spectrum/wave)

Users can choose between either a spectrum analyzer or wave form.

Basic usage

Loading ncmpcpp

Load ncmpcpp in a shell:

$ ncmpcpp

Different views

Partial list of views within ncmpcpp:

  • 0 - Clock
  • 1 - Help
  • 2 - Current playlist
  • 3 - Filesystem browser
  • 4 - DB search
  • 5 - Library
  • 6 - Playlist editor
  • 7 - Tag editor (very powerful!)
  • 9 - Music visualizer

Other UI keys

  • \ - Switch between classic and alternative views
  • # - Display bitrate of file
  • i - Show song info
  • I - Show artist info (saved in ~/.ncmpcpp/artists/ARTIST.txt)
  • L - Shuffle between available lyric databases
  • l - Retrieve song lyrics for current song Show/hide lyrics

Playback modes

Noticed the control panel in the upper right; shown in alternative mode:

1:40/4:16 1082 kbps                            ──┤ Criminal ├──                                       Vol: 98%
[playing]                             Disturbed - Indestructible (2008)                               [-z-c--]

And again in classic mode:

─────────────────────────────────────────────────────────────────────────────────────────────────────────[zc]

This corresponds to the playback modes; ordered from left to right, they are:

  • r - repeat mode [r-----]
  • z - random mode [-z----]
  • y - single mode [--s---]
  • R - consume mode [---c--]
  • x - crossfade mode [----x-]

The final "-" is only active when the user forces an update to the datebase via u.

Remapping keys

A listing of keys and their respective functions is available from within npmpcpp itself via hitting 1. Users may remap any of the default keys simply by copying /usr/share/doc/ncmpcpp/keys to ~/.ncmpcpp/ and editing it. ncmpcpp-git users have to copy /usr/share/doc/ncmpcpp/bindings instead.