Skip to content

Commit e2779f5

Browse files
authored
Update README.rst
fixed some typos
1 parent c7fafb2 commit e2779f5

File tree

1 file changed

+17
-35
lines changed

1 file changed

+17
-35
lines changed

README.rst

+17-35
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
==========
2+
23
audiomatch
4+
35
==========
46

57
.. image:: https://github.com/unmade/audiomatch/workflows/lint%20and%20test/badge.svg?branch=master
@@ -18,31 +20,26 @@ audiomatch
1820
:alt: MIT License
1921
:target: https://github.com/unmade/audiomatch/blob/master/LICENSE
2022

21-
2223
A small command-line tool to find similar audio files
2324

2425
Installation
2526
============
2627

27-
First, install the Chromaprint_ fingerprinting library by Lukáš Lalinský. (The library
28-
itself depends on an FFT library, but it's smart enough to use an algorithm from
29-
software you probably already have installed; see the Chromaprint page for details)
28+
First, install the Chromaprint_ fingerprinting library by Lukáš Lalinský. (The library itself depends on an FFT library, but it's smart enough to use an algorithm from software you probably already have installed; see the Chromaprint page for details.)
3029

3130
Then you can install this library:
3231

3332
.. code-block:: bash
3433
3534
pip install audiomatch
3635
37-
To do things fast *audiomatch* requires C compiler and Python headers to be installed.
38-
You can skip compilation by setting ``AUDIOMATCH_NO_EXTENSIONS`` environment variable:
36+
To perform tasks quickly, *audiomatch* requires a C compiler and Python headers to be installed. You can skip the compilation by setting the ``AUDIOMATCH_NO_EXTENSIONS`` environment variable:
3937

4038
.. code-block:: bash
4139
4240
AUDIOMATCH_NO_EXTENSIONS=1 pip install audiomatch
4341
44-
You can avoid installing all this libraries on your computer and run everything in
45-
docker:
42+
You can avoid installing all these libraries on your computer and run everything in Docker:
4643

4744
.. code-block:: bash
4845
@@ -51,7 +48,7 @@ docker:
5148
Quickstart
5249
==========
5350

54-
Suppose, we have a directory with Nirvana songs:
51+
Suppose we have a directory with Nirvana songs:
5552

5653
.. code-block:: bash
5754
@@ -82,62 +79,47 @@ Let's find out which files sound similar:
8279
./demo/Pennyroyal Tea (Solo Acoustic).mp3
8380
./demo/Pennyroyal Tea (Unplugged in NYC).m4a
8481
85-
*Note #1: input audio files should be at least 10 seconds long*
82+
*Note #1: Input audio files should be at least 10 seconds long.*
8683

87-
*Note #2: in some rare cases false positives are possible*
84+
*Note #2: In some rare cases, false positives are possible.*
8885

89-
What's happening here is that *audiomatch* takes all audio files from the directory and
90-
compares them with each other.
86+
What's happening here is that *audiomatch* takes all audio files from the directory and compares them with each other.
9187

92-
You can also compare file with another file, file and directory, or directory to
93-
directory. If you need to, you can provide glob-style patterns, but don't forget to
94-
quote it, because otherwise shell expanded it for you. For example, let's compare all
95-
``.mp3`` files with ``.m4a`` files:
88+
You can also compare a file with another file, a file and a directory, or a directory with another directory. If you need to, you can provide glob-style patterns, but don't forget to quote them, because otherwise the shell will expand it for you. For example, let's compare all ``.mp3`` files with ``.m4a`` files:
9689

9790
.. code-block:: bash
9891
99-
$ audiomatch "./demo/*.mp3" "./demo/*.m4a"
92+
$ audiomatch "./demo/*.mp3" "./demo/*.m4a"
10093
These files sound similar:
10194
10295
../demo/Pennyroyal Tea (Solo Acoustic).mp3
10396
../demo/Pennyroyal Tea (Unplugged in NYC).m4a
10497
105-
This time, *audiomatch* took all files with ``.mp3`` extension and compare them with
106-
all files with ``.m4a`` extension.
98+
This time, *audiomatch* took all files with the ``.mp3`` extension and compared them with all files with the ``.m4a`` extension.
10799

108-
Note, how there is no In Utero version in the output. The reason it is present in the
109-
previous output, because it actually similar with Unplugged version and then transitive
110-
law applies: if ``a = b`` and ``b = c``, then ``a = c``.
100+
Note how there is no In Utero version in the output. The reason it is present in the previous output is because it is actually similar to the Unplugged version, and then the transitive law applies: if ``a = b`` and ``b = c``, then ``a = c``.
111101

112102
--length
113103
--------
114104

115-
The ``--length`` specifies how many seconds to take for analysis from the song. Default
116-
value is 120 and it is good enough to find exactly the same song, but maybe in different
117-
quality. However, for a more complicated cases like same song played in different tempo
118-
the more input we have the more accurate results are.
105+
The ``--length`` option specifies how many seconds to take for analysis from the song. The default value is 120, and it is good enough to find exactly the same song, but maybe in different quality. However, for more complicated cases like the same song played in a different tempo, the more input we have, the more accurate results are.
119106

120107
--extension
121108
-----------
122109

123-
By default, ``audiomatch`` looks for files with ``.m4a``, ``mp3``, ``.caf`` extensions.
124-
In theory, audio formats supported by ffmpeg_ also supported by *audiomatch*. You can
125-
tell to *audiomatch* to look for a specific format by using ``--extension`` flag:
110+
By default, ``audiomatch`` looks for files with ``.m4a``, ``.mp3``, ``.caf`` extensions. In theory, audio formats supported by ffmpeg_ are also supported by *audiomatch*. You can tell *audiomatch* to look for a specific format by using the ``--extension`` flag:
126111

127112
.. code-block:: bash
128113
129114
$ audiomatch -e .ogg -e .wav ./demo
130115
Not enough input files.
131116
132-
Indeed, we tried to compare files with ``.ogg`` and ``.wav`` extension, but there are
133-
no such files in the demo directory.
117+
Indeed, we tried to compare files with ``.ogg`` and ``.wav`` extensions, but there are no such files in the demo directory.
134118

135119
Motivation
136120
==========
137121

138-
I play guitar and do recordings from time to time mainly with Voice Memos on iPhone.
139-
Over the years, I have hundreds of recordings like that and I though it would be cool
140-
to find all the similar ones and see how I progress over the years.
122+
I play guitar and do recordings from time to time, mainly with Voice Memos on iPhone. Over the years, I have hundreds of recordings like that, and I thought it would be cool to find all the similar ones and see how I have progressed over the years.
141123

142124
That's why I wrote this library.
143125

0 commit comments

Comments
 (0)