Giter Club home page Giter Club logo

chromaprint's Introduction

Chromaprint

Chromaprint is an audio fingerprint library developed for the AcoustID project. It's designed to identify near-identical audio and the fingerprints it generates are as compact as possible to achieve that. It's not a general purpose audio fingerprinting solution. It trades precision and robustness for search performance. The target use cases are full audio file identifcation, duplicate audio file detection and long audio stream monitoring.

Building

The most common way to build Chromaprint is like this:

$ cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TOOLS=ON .
$ make
$ sudo make install

This will build Chromaprint as a shared library and also include the fpcalc utility (which is used by MusicBrainz Picard, for example). For this to work, you will need to have the FFmpeg libraries installed.

See below for other options.

FFT Library

Chromaprint can use multiple FFT libraries -- FFmpeg, FFTW3, KissFFT or vDSP (macOS).

FFmpeg is preferred on all systems except for macOS, where you should use the standard vDSP framework. These are the fastest options.

FFTW3 can be also used, but this library is released under the GPL license, which makes also the resulting Chromaprint binary GPL licensed.

KissFFT is the slowest option, but it's distributed with a permissive license and it's very easy to build on platforms that do not have packaged versions of FFmpeg or FFTW3. We ship a copy of KissFFT, so if the build system is unable to find another FFT library it will use that as a fallback.

You can explicitly set which library to use with the FFT_LIB option. For example:

$ cmake -DFFT_LIB=kissfft .

FFmpeg

FFmpeg is as a FFT library and also for audio decoding and resampling in fpcalc. If you have FFmpeg installed in a non-standard location, you can use the FFMPEG_ROOT option to specify where:

$ cmake -DFFMPEG_ROOT=/path/to/local/ffmpeg/install .

While we try to make sure things work also with libav, FFmpeg is preferred.

API Documentation

You can use Doxygen to generate a HTML version of the API documentation:

$ make docs
$ $BROWSER docs/html/index.html

Unit Tests

The test suite can be built and run using the following commands:

$ cmake -DBUILD_TESTS=ON .
$ make check

In order to build the test suite, you will need the sources of the Google Test library.

Related Projects

Bindings, wrappers and reimplementations in other languages:

Integrations:

If you know about a project that is not listed here, but should be, please let me know.

Standing on the Shoulders of Giants

I've learned a lot while working on this project, which would not be possible without having information from past research. I've read many papers, but the concrete ideas implemented in this library are based on the following papers:

chromaprint's People

Contributors

lalinsky avatar phw avatar petteyg avatar wpla avatar derdakon avatar rednoah avatar ufleisch avatar wallisch avatar intgr avatar jcowgill avatar teaalltr avatar fluffykaon avatar diogo464 avatar mineo avatar radhermit avatar cybersinh avatar mgdigital avatar catmanix avatar desiderantes avatar johnsheu avatar hatstand avatar tragicwarrior avatar billyoneal avatar talih0 avatar realender avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.