Metadata-Version: 1.1
Name: audiodiff
Version: 0.2
Summary: compares audio files
Home-page: https://github.com/clee704/audiodiff
Author: Choongmin Lee
Author-email: choongmin@me.com
License: Copyright (c) 2013 Choongmin Lee

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Description: audiodiff
        =========
        
        audiodiff is a library that can be used to compare audio files. Two audio flies
        are considered equal if they have the same audio streams and normalized tags.
        
        Examples::
        
            >>> import audiodiff
            >>> audiodiff.equal('airplane.flac', 'airplane.m4a')
            False
            >>> audiodiff.audio_equal('airplane.flac', 'airplane.m4a')
            True
            >>> audiodiff.tags_equal('airplane.flac', 'airplane.m4a')
            False
        
        If you want more, you can get audio checksums and tags::
        
            >>> audiodiff.checksum('airplane.flac')
            'ffa0d242f8642b20e90f521a898a0ab5'
            >>> audiodiff.checksum('airplane.m4a')
            'ffa0d242f8642b20e90f521a898a0ab5'
            >>> tags1 = audiodiff.tags('airplane.flac')
            >>> tags1
            {'artist': 'f(x)', 'album': 'Pink Tape', 'title': 'Airplane'}
            >>> tags2 = audiodiff.tags('airplane.m4a')
            >>> tags2
            {'title': 'f(x) - Pink Tape - Airplane'}
        
        It can be also used as a commandline tool. When used as a commandline tool,
        it supports comparing audio files in two directories recursively. Audio files
        with the same name except for the extensions are considered to be compared.
        
        Commandline examples::
        
            $ ls . -R
            mylib1:
            a.flac  b.flac  cover.jpg
        
            mylib2:
            a.m4a  b.m4a  cover.jpg
            $ audiodiff mylib1 mylib2
            Audio streams in mylib1/a.flac and mylib2/a.m4a differ
            Audio streams in mylib1/b.flac and mylib2/b.m4a differ
            --- mylib1/b.flac
            +++ mylib2/b.m4a
            -album: [u'Purple Heart']
            +album: [u'Blue Jean']
            +date: [u'2001']
            Binary files mylib1/cover.jpg and mylib2/cover.jpg differ
        
        
        Supported audio formats
        -----------------------
        
        Currently audiodiff can only read FLAC, M4A, MP3 files. They must have `flac`,
        `m4a`, `mp3` file extensions respectively.
        
        
        Caveats
        -------
        
        Tag reading is done by mutagenwrapper_ for which there isn't a stable
        version yet. It may omit some tags, thus incorrectly reporting tags in files
        being compared are equal while they are not.
        
        
        .. _mutagenwrapper: https://mutagenwrapper.readthedocs.org/en/latest/
        
        
        Install
        -------
        
        audiodiff can be installed with `pip`. To install, run:
        
            pip install audiodiff
        
        For help using the commandline tool, run ``audiodiff -h``.
        
        
        Dependencies
        ------------
        
        audiodiff requires `ffmpeg` to be installed in your system. The path is
        ``ffmpeg`` by default, but you can change it by following ways (later rules
        take precedence over earlier ones):
        
        1. ``audiodiff.FFMPEG_BIN`` module property
        2. ``FFMPEG_BIN`` environment variable
        3. ``--ffmpeg_bin`` flag (commandline tool only)
        
Keywords: lossless audio metadata comparison
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Topic :: Multimedia :: Sound/Audio :: Analysis
Classifier: Topic :: Utilities
