Skip to content

Commit

Permalink
deploy: 177a0d6
Browse files Browse the repository at this point in the history
  • Loading branch information
hagenw committed Nov 29, 2023
1 parent 319fc1a commit 9b4a6b5
Show file tree
Hide file tree
Showing 42 changed files with 129 additions and 111 deletions.
Binary file modified .doctrees/benchmark.doctree
Binary file not shown.
Binary file modified .doctrees/changelog.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified _images/audiofile-read-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/audiofile-read-3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/audiofile-read-4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/audiofile-read-5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/audiofile-read-6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/benchmark_mp3-mp4_info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/benchmark_mp3-mp4_read.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/benchmark_wav-flac-ogg_info.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/benchmark_wav-flac-ogg_read.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions _modules/audiofile/core/info.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@


<div class="version">
v1.3.0
v1.3.1
</div>


Expand Down Expand Up @@ -425,7 +425,7 @@ <h1>Source code for audiofile.core.info</h1><div class="highlight"><pre>



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/07/12 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/11/29 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions _modules/audiofile/core/io.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@


<div class="version">
v1.3.0
v1.3.1
</div>


Expand Down Expand Up @@ -683,7 +683,7 @@ <h1>Source code for audiofile.core.io</h1><div class="highlight"><pre>



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/07/12 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/11/29 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>
Expand Down
4 changes: 2 additions & 2 deletions _modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@


<div class="version">
v1.3.0
v1.3.1
</div>


Expand Down Expand Up @@ -157,7 +157,7 @@ <h1>All modules for which code is available</h1>



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/07/12 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/11/29 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>
Expand Down
22 changes: 11 additions & 11 deletions _sources/benchmark.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,12 @@ Python packages

The following Python packages are benchmarked against each other:

* aubio_ 0.4.5
* audioread_ 2.1.9
* :mod:`audiofile` 1.1.0
* librosa_ 0.9.1
* scipy_ 1.8.0
* soundfile_ 0.10.3.post1
* audioread_ 3.0.1
* :mod:`audiofile` 1.3.0
* librosa_ 0.10.1
* pedalboard_ 0.8.6
* scipy_ 1.11.4
* soundfile_ 0.21.1
* sox_ 1.4.1

scipy_ and librosa_ are only tested for reading files,
Expand Down Expand Up @@ -74,7 +74,7 @@ The benchmark was executed on the following machine:
* RAM: 15.37 GB
* Hard drive: Samsung SSD 860
* Linux: Ubuntu 18.04.6
* Python: 3.8.13
* Python: 3.10.11

To rerun the benchmark yourself,
clone the repository
Expand All @@ -87,7 +87,7 @@ and execute:
$ bash generate_audio.sh
$ bash run.sh
This requires that Python 3.8 is installed
This requires that Python 3.10 is installed
and will ask for a sudo password
to install missing apt packages.

Expand Down Expand Up @@ -126,7 +126,7 @@ Reading files

soundfile_ does not support
reading MP3 and MP4 files,
audioread_ (mad) only MP3 files.
audioread_ (mad) and pedalboard_ only MP3 files.

.. image:: ./benchmark/results/benchmark_mp3-mp4_read.png

Expand All @@ -135,7 +135,7 @@ Accessing metadata

soundfile_ does not support
accessing MP3 and MP4 metadata.
sox_ and audioread_ (mad) only for MP3 files.
sox_, audioread_ (mad) and pedalboard_ only for MP3 files.

.. image:: ./benchmark/results/benchmark_mp3-mp4_info.png

Expand All @@ -152,12 +152,12 @@ and is shown as audiofile (sloppy)
in the figure.


.. _aubio: https://github.com/aubio/aubio/
.. _audioread: https://github.com/beetbox/audioread/
.. _ffmpeg: https://ffmpeg.org/
.. _gstreamer: https://gstreamer.freedesktop.org/
.. _librosa: https://github.com/librosa/librosa/
.. _mad: https://sourceforge.net/projects/mad/
.. _pedalboard: https://github.com/spotify/pedalboard
.. _scipy: https://docs.scipy.org/doc/scipy/reference/generated/scipy.io.wavfile.read.html
.. _soundfile: https://github.com/bastibe/SoundFile/
.. _sox: https://github.com/rabitt/pysox/
Expand Down
1 change: 1 addition & 0 deletions _static/pygments.css
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
.highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
Expand Down
10 changes: 5 additions & 5 deletions api/audiofile.bit_depth.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@


<div class="version">
v1.3.0
v1.3.1
</div>


Expand Down Expand Up @@ -163,16 +163,16 @@ <h1>bit_depth()<a class="headerlink" href="#bit-depth" title="Permalink to this
<code class="docutils literal notranslate"><span class="pre">None</span></code> is returned as they have a varying bit depth.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – file name of input audio file</p>
<dd class="field-odd"><p><strong>file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – file name of input audio file</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.11)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</p>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/typing.html#typing.Optional" title="(in Python v3.12)"><code class="xref py py-data docutils literal notranslate"><span class="pre">Optional</span></code></a>[<a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a>]</p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>bit depth of audio file</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a> – if <code class="docutils literal notranslate"><span class="pre">file</span></code> is missing,
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.12)"><strong>RuntimeError</strong></a> – if <code class="docutils literal notranslate"><span class="pre">file</span></code> is missing,
broken or format is not supported</p>
</dd>
</dl>
Expand Down Expand Up @@ -208,7 +208,7 @@ <h1>bit_depth()<a class="headerlink" href="#bit-depth" title="Permalink to this



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/07/12 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/11/29 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>
Expand Down
12 changes: 6 additions & 6 deletions api/audiofile.channels.html
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@


<div class="version">
v1.3.0
v1.3.1
</div>


Expand Down Expand Up @@ -161,19 +161,19 @@ <h1>channels()<a class="headerlink" href="#channels" title="Permalink to this he
<dd><p>Number of channels in audio file.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
<dd class="field-odd"><p><strong>file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – file name of input audio file</p>
<dd class="field-odd"><p><strong>file</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>) – file name of input audio file</p>
</dd>
<dt class="field-even">Return type</dt>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></p>
<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><code class="xref py py-class docutils literal notranslate"><span class="pre">int</span></code></a></p>
</dd>
<dt class="field-odd">Returns</dt>
<dd class="field-odd"><p>number of channels in audio file</p>
</dd>
<dt class="field-even">Raises</dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#FileNotFoundError" title="(in Python v3.11)"><strong>FileNotFoundError</strong></a> – if mediainfo binary is needed,
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#FileNotFoundError" title="(in Python v3.12)"><strong>FileNotFoundError</strong></a> – if mediainfo binary is needed,
but cannot be found</p></li>
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.11)"><strong>RuntimeError</strong></a> – if <code class="docutils literal notranslate"><span class="pre">file</span></code> is missing,
<li><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#RuntimeError" title="(in Python v3.12)"><strong>RuntimeError</strong></a> – if <code class="docutils literal notranslate"><span class="pre">file</span></code> is missing,
broken or format is not supported</p></li>
</ul>
</dd>
Expand Down Expand Up @@ -210,7 +210,7 @@ <h1>channels()<a class="headerlink" href="#channels" title="Permalink to this he



Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/07/12 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>
Built with <a href="https://www.sphinx-doc.org/en/master/">Sphinx</a> on 2023/11/29 using the <a href="https://github.com/audeering/sphinx-audeering-theme/">audEERING theme</a>

</p>
</div>
Expand Down
Loading

0 comments on commit 9b4a6b5

Please sign in to comment.