Difference between revisions of "Ncmpcpp"

From ArchWiki
Jump to: navigation, search
m (use a blank line to create a new paragraph)
(Updated a bit, formatting)
(12 intermediate revisions by 9 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 (ncmpc++)}}
Line 6: Line 7:
 
{{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.
 
[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:
+
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:
+
== Basic configuration ==
  
* mpd_host (should point to the host on which mpd resides, can be "localhost" or "127.0.0.1" if on the same machine)
+
After installation a sample configuration file can be found in {{ic|/usr/share/doc/ncmpcpp/config}}.
* 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==
+
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:
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>
+
* '''mpd_host''' - Should point to the host on which mpd resides, can be "localhost" or "127.0.0.1" if on the same machine
audio_output {
+
* '''mpd_port''' - Unless you've changed the defaults of mpd, this should be "6600"
    type                    "fifo"
+
* '''mpd_music_dir''' - The same directory value as specified in "music_directory" in {{ic|mpd.conf}}
    name                    "my_fifo"
+
    path                    "/tmp/mpd.fifo"
+
}
+
</pre>
+
  
Additional lines need to be added to {{Filename|~/.ncmpcpp/config}}
+
== Enabling visualization ==
  
<pre>
+
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:
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.
 
  
==Basic Usage==
+
audio_output {
===Loading ncmpc++===
+
    type                    "fifo"
 +
    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 ncmpc++ in a shell  
 
Load ncmpc++ 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++
 
Partial list of views within ncmpc++
 
*{{Keypress|0}} - Clock
 
*{{Keypress|0}} - Clock
Line 69: Line 74:
 
*{{Keypress|9}} - Music visualizer
 
*{{Keypress|9}} - Music visualizer
  
===Other UI keys===
+
=== Other UI keys ===
 +
 
 
*{{Keypress|\}} - Switch between classic and alternative views
 
*{{Keypress|\}} - Switch between classic and alternative views
 
*{{Keypress|#}} - Display bitrate of file
 
*{{Keypress|#}} - Display bitrate of file
 
*{{Keypress|i}} - Show song info
 
*{{Keypress|i}} - Show song info
*{{Keypress|I}} - Show artist info (saved in {{Filename|~/.ncmpcpp/artists/ARTIST.txt}})
+
*{{Keypress|I}} - Show artist info (saved in {{ic|~/.ncmpcpp/artists/ARTIST.txt}})
 
*{{Keypress|L}} - Shuffle between available lyric databases
 
*{{Keypress|L}} - Shuffle between available lyric databases
 
*{{Keypress|l}} - Retrieve song lyrics for current song Show/hide lyrics
 
*{{Keypress|l}} - Retrieve song lyrics for current song Show/hide lyrics
  
{{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.}}
+
=== Playback modes ===
 
+
===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 98: Line 102:
  
 
The final "-" is only active when the user forces an update to the datebase via {{Keypress|u}}.
 
The final "-" is only active when the user forces an update to the datebase via {{Keypress|u}}.
 +
 +
== 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 {{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 21:25, 28 May 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 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 ~/.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 ncmpc++ in a shell

$ ncmpcpp


Different views

Partial list of views within ncmpc++

Other UI keys

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:

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

Remapping keys

A listing of keys and their respective functions is available from within npmpcpp itself via hitting Template:Keypress. 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.