Skip to content

Commit 0e042d3

Browse files
committed
better Chromaprint installation instructions
1 parent 99aa2c6 commit 0e042d3

File tree

1 file changed

+33
-16
lines changed

1 file changed

+33
-16
lines changed

docs/plugins/chroma.rst

Lines changed: 33 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,25 +27,48 @@ To get fingerprinting working, you'll need to install three things: the
2727
`Chromaprint`_ library or command-line tool, an audio decoder, and the
2828
`pyacoustid`_ Python library (version 0.6 or later).
2929

30-
First, you will need to install `Chromaprint`_, either as a dynamic library or
31-
in the form of a command-line tool (``fpcalc``). The Chromaprint site has links
32-
to packages for major Linux distributions. If you use `Homebrew`_ on Mac OS X,
33-
you can install the library with ``brew install chromaprint``. Otherwise, on Mac
34-
OS X and Windows, download the appropriate binary package and place the
35-
``fpcalc`` (or ``fpcalc.exe``) on your shell search path (e.g., in
36-
``/usr/local/bin`` on Mac OS X or ``C:\\Program Files`` on Windows).
30+
First, install pyacoustid itself. You can do this using `pip`_, like so::
31+
32+
$ pip install pyacoustid
33+
34+
.. _pip: http://pip.openplans.org/
35+
36+
Then, you will need to install `Chromaprint`_, either as a dynamic library or
37+
in the form of a command-line tool (``fpcalc``).
38+
39+
Installing the Binary Command-Line Tool
40+
'''''''''''''''''''''''''''''''''''''''
41+
42+
The simplest way to get up and running, especially on Windows, is to
43+
`download`_ the appropriate Chromaprint binary package and place the
44+
``fpcalc`` (or ``fpcalc.exe``) on your shell search path. On Windows, this
45+
means something like ``C:\\Program Files``. On OS X or Linux, put the
46+
executable somewhere like ``/usr/local/bin``.
47+
48+
.. _download: http://acoustid.org/chromaprint
49+
50+
Installing the Library
51+
''''''''''''''''''''''
52+
53+
On OS X and Linux, you can also use a library installed by your package
54+
manager, which has some advantages (automatic upgrades, etc.). The Chromaprint
55+
site has links to packages for major Linux distributions. If you use
56+
`Homebrew`_ on Mac OS X, you can install the library with ``brew install
57+
chromaprint``.
3758

3859
.. _Homebrew: http://mxcl.github.com/homebrew/
3960

40-
Next, you will need a mechanism for decoding audio files supported by the
61+
You will also need a mechanism for decoding audio files supported by the
4162
`audioread`_ library:
4263

43-
* Mac OS X has a number of decoders already built into Core Audio
64+
* OS X has a number of decoders already built into Core Audio, so there's no
65+
need to install anything.
4466

4567
* On Linux, you can install `GStreamer for Python`_, `FFmpeg`_, or `MAD`_ and
4668
`pymad`_. How you install these will depend on your distribution. For example,
4769
on Ubuntu, run ``apt-get install python-gst0.10-dev``. On Arch Linux, you want
48-
``pacman -S gstreamer0.10-python``.
70+
``pacman -S gstreamer0.10-python``. If you use GStreamer, be sure to install
71+
its codec plugins also.
4972

5073
* On Windows, try the Gstreamer "WinBuilds" from the `OSSBuild`_ project.
5174

@@ -64,12 +87,6 @@ standard set of Gstreamer plugins. For example, on Ubuntu, install the packages
6487
``gstreamer0.10-plugins-good``, ``gstreamer0.10-plugins-bad``, and
6588
``gstreamer0.10-plugins-ugly``.
6689

67-
Then, install pyacoustid itself. You can do this using `pip`_, like so::
68-
69-
$ pip install pyacoustid
70-
71-
.. _pip: http://pip.openplans.org/
72-
7390
Using
7491
-----
7592

0 commit comments

Comments
 (0)