..  This file is part of Audio Tuner.

    Copyright 2025, 2026 Jessie Blue Cassell <bluesloth600@gmail.com>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

Installation on Microsoft Windows
=================================

Audio Tuner and its GUI are available on PyPI:

https://pypi.org/project/audio-tuner/

https://pypi.org/project/audio-tuner-gui/

You will have to install some dependencies manually.

Dependencies
~~~~~~~~~~~~

You'll need to make sure **Python version 3.11 or higher** and **libmpv2
version 0.40.0 or higher** are installed.  If you have a package manager than
can install those, use that.

If not, install Python and libmpv2 according to the following instructions:

Python
^^^^^^

Python is available at https://www.python.org/downloads/\ .  Download the
appropriate installer and run it.

libmpv2
^^^^^^^

#. Go to https://github.com/shinchiro/mpv-winbuild-cmake/releases\ .

#. Download one of the **mpv-dev-x86_64** compressed archives (there's one for
   x86_64 architecture and one for x86_64-v3 architecture.  Either one should
   work on a modern computer.)

#. Extract the archive.  It should have ``libmpv-2.dll`` in it somewhere.

#. Put ``libmpv-2.dll`` in a folder where where Audio Tuner can find it (in
   other words, somewhere in your system's ``%PATH%``).

.. note::

    Audio Tuner can use **ffmpeg** instead of **libmpv2**, with some caveats:
    The player and export functionality in the GUI won't work, among other
    things.  See the :code:`backends` option in the :ref:`config_file` for
    details.

Everything Else
^^^^^^^^^^^^^^^

The following dependencies will be installed automatically by :command:`pip`:

* `numpy`_
* `python-mpv`_
* `namedpipe`_
* `platformdirs`_
* `shtab`_

.. versionadded:: 0.12.0
   shtab dependency

If you install the GUI, one more dependency will be automatically installed:

* `PyQt6`_

.. _numpy: https://www.numpy.org
.. _PyQt6: https://www.riverbankcomputing.com/software/pyqt/
.. _python-mpv: https://github.com/jaseg/python-mpv
.. _namedpipe: https://github.com/python-ffmpegio/python-namedpipe
.. _platformdirs: https://github.com/platformdirs/platformdirs
.. _shtab: https://github.com/iterative/shtab


Installing the Audio Tuner base package (CLI and library):
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Open a terminal and run:

.. code:: bash

    py -m pip install audio-tuner

The ``tuner`` command and the ``audio_tuner`` python library should now be
installed and ready to use.

Installing the GUI
~~~~~~~~~~~~~~~~~~

Open a terminal and run:

.. code:: bash

    py -m pip install audio-tuner-gui

``tuner-gui`` should now be available.

.. note::

    If you didn't install the base package, it will be installed automatically
    as a dependency when you install audio-tuner-gui.

Uninstalling
~~~~~~~~~~~~

To uninstall the GUI:

.. code:: doscon

    py -m pip uninstall audio_tuner_gui

To uninstall the base package:

.. code:: doscon

    py -m pip uninstall audio_tuner

Upgrading from a Previous Version
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To upgrade the base package:

.. code:: doscon
   
   py -m pip install --upgrade audio_tuner

If the GUI is installed, run this to upgrade it:

.. code:: doscon
   
   py -m pip install --upgrade audio_tuner-gui

Optional Extras
~~~~~~~~~~~~~~~

You can install additional dependencies for more functionality.

Colorama
^^^^^^^^

https://github.com/tartley/colorama

Audio Tuner's command line interface ``tuner`` controls the color of it's
output to make it easier to read.  This is more difficult on Windows because
the Windows terminal doesn't understand standard ANSI escape sequences.  To
make colored terminal output work on Windows, Colorama needs to be installed.

To install:

.. code:: doscon

    py -m pip install colorama

Matplotlib
^^^^^^^^^^

http://matplotlib.org/

Matplotlib enables ``tuner`` and ``tuner-gui`` to display plots of the audio
spectrum.

To install:

.. code:: doscon

    py -m pip install matplotlib