A lighter and less dev-oriented version of this README can be found at vidify.org. The official site also has translations available.
Table of contents
- Usage and configuration
- Development resources
Vidify is intended to be modular. By default, it includes support for the most popular music players (a.k.a. APIs). Same goes for the video players (currently, VLC by default). This can be extended by installing the required dependencies listed in their sections.
Here are the different ways to install Vidify, depending on your Operating System:
- Cross-platform: With pip:
pip install --user vidify. Optional APIs and Players can be installed with
pip install --user vidify[extra1,extra2], which is equivalent to installing the list of dependencies needed for
- Windows or Linux: Using the binaries from the latest stable releases. These include support for all optional APIs, and use mpv as the player.
- Arch Linux: you can install it from the AUR:
vidify. Maintained by me (marioortizmanero).
- Gentoo Linux: there's an ebuild maintained by AndrewAmmerlaan in the main repository at media-video/vidify:
- Feel free to upload it to your distro's repositories! Let me know in an issue so that I can add it to this list.
- Arch Linux: you can install it from the AUR:
Note: Vidify requires Python >= 3.6.
An API is simply a source of information about the music playing on a device. For example, the Spotify desktop client, or iTunes. Here are the currently supported ones:
|Name||Wiki link||Extra requirements||Description|
|Linux Media Players (
||Installed by default (see the wiki)||Any MPRIS compatible media player for Linux or BSD (99% of them, like Spotify, Clementine, VLC...).|
|Spotify for Windows & MacOS (
||Installed by default||The Spotify desktop app for Windows & MacOS, using the SwSpotify library.|
|Spotify Web (
||Installed by default||The official Spotify Web API, using Tekore. Check the wiki for more details on how to set it up.|
* The name inside parenthesis is used as a key for the arguments and the config options.
--api mpris_linux would force using the Linux Media Players API, for instance. It's also used for the extra dependencies installation with pip:
pip install vidify[extra1] would install all the extra requirements for
extra1 with pip.
The embedded video players inside the app. The default one is VLC because it's more popular, but you can use others if you have the player itself installed, and the Python extra dependencies.
|Name||Extra requirements||Description||Arguments/config options|
||VLC||The default video player. Widely used and very solid.||
||A command-line portable video player. More lightweight and precise than VLC.||
||Installed by default||Play the videos on external devices. Check the external players section for more.||None|
[Defaults] player = mpv
The external player
The external player lets you play Vidify's music videos essentially anywhere. It will send all the music video information to an external application. Here are the current implementations:
- Vidify TV: available on Android, Android TV and Amazon Fire Stick TV. Play Store page.
Vidify has an audio synchronization feature. The full repository is in vidify/audiosync. It's still Work-In-Progress.
Audiosync is only available on Linux for now. It's strongly recommended to use Mpv as the video player. You can install it with
pip install vidify[audiosync], along with the following dependencies:
libfftw3on Debian-based distros.
ffmpegon most repositories. It must be available on your path.
pulseaudio, pre-installed on most repos.
- yt-dlp: this is installed by default with Vidify, but make sure it's available on your path.
It's also available as
vidify-audiosync on the AUR, and it comes pre-installed in the binaries.
It can be activated with
--audiosync, or inside your config file:
[Defaults] audiosync = true
You can calibrate the audiosync results with the option
audiosync_calibration. By default it's 0 milliseconds, but it may depend on your hardware.
Note: if when using audiosync there's no sound, you might need to disable stream target device restore by editing the corresponing line in
load-module module-stream-restore restore_device=false.
Note 2: you should make sure that the sink being recorded is either
audiosync, or the one where the music is playing. Here's an example on Pavucontrol (it's usually called 'Monitor of ...'):
The app has an interface that will guide you through most of the set-up, but you can use command line arguments and the config file for more advanced options (and until the GUI is completely finished):
usage: vidify [-h] [-v] [--debug] [--config-file CONFIG_FILE] [-n] [-f] [--dark-mode] [--stay-on-top] [--width WIDTH] [--height HEIGHT] [-a API] [-p PLAYER] [--audiosync] [--audiosync-calibration AUDIOSYNC_CALIBRATION] [--vlc-args VLC_ARGS] [--mpv-flags MPV_FLAGS] [--client-id CLIENT_ID] [--client-secret CLIENT_SECRET] [--redirect-uri REDIRECT_URI]
||do not print lyrics.|
||play videos in fullscreen mode.|
||enables dark mode for the GUI.|
||the app window will stay on top of other apps.|
||set the width for the downloaded videos (this is useful to play lower quality videos if your connection isn't good).|
||set the height for the downloaded videos.|
||specify the API to use. See the APIs section for more info about the supported APIs.|
||specify the player to use. See the Players section for more info about the supported players.|
||enables the Audio Synchronization feature (disabled by default).|
||You can calibrate the delay in milliseconds audiosync returns with this. It can be positive or negative. The default is 0ms.|
||indicate the path of your config file.|
The config file
The configuration file is created by default at your usual config directory:
$XDG_CONFIG_HOME, if defined)
- Mac OS X:
You can use a custom one by passing
--config-file <PATH> as an argument. The config file is overriden by the configuration passed as arguments, but keeps your settings for future usage. Here's an example of one. It uses the INI config file formatting. Most options are inside the
All the available options for the config file are the same as the arguments listed in the Usage section, except for
--config-file <PATH>, which is only an argument. Their names are the same but with underscores instead of dashes. For example,
--use-mpv would be equivalent to
use_mpv = true.
Vidify doesn't work correctly with Python 3.8 and PySide2
PySide2 started supporting Python 3.8 with the 5.14 release. Make sure you're using an updated version and try again.
TypeError: 'Shiboken.ObjectType' object is not iterable will be raised otherwise.
ModuleNotFoundError: No module named 'gi' when using a virtual environment
For some reason,
python-gobject may not be available inside a virtual environment. You can create a symlink inside it with:
ln -s "/usr/lib/python3.8/site-packages/gi" "$venv_dir/lib/python3.8/site-packages"
or install it with pip following this guide.
Vidify doesn't recognize some downloaded songs
If the song doesn't have a metadata field with its title and artist (the latter is optional), Vidify is unable to know what song is playing. Try to modify the metadata of your downloaded songs with VLC or any other tool.
FileNotFoundError: Could not find module 'libvlc.dll'.
Make sure that both Python and VLC are either 32 bits, or 64 bits, but not different. You should have a directory called
C:\Program Files (x86)\VideoLAN\VLC (32b), or
C:\Program Files\VideoLAN\VLC (64b).
Not playing any videos (
HTTP Error 403: Forbidden)
If Vidify is not playing any videos, and is throwing 403 Forbidden errors (with the
--debug argument). The YouTube-DL cache has likely become corrupt or needs to be regenerated because of other reasons, please try deleting
Helpful documentation links for contributing:
The changelog and more information about this program's versions can be found in the Releases page.
External player implementations
The Vidify external player has an open protocol for anyone to implement their own app or program to play the videos. You can read more about how it works in this wiki article.
You can run the module locally with
python -m vidify.
This project uses
unittest for testing. Run them with
python -m unittest. You'll need all the extra dependencies installed for this to work.