ｖａｐｏｒｉｓｅｒ is a Python script that creates a vaporwave (slowed, with reverb) remix of a given MP3 file, with the option of playing over a looped GIF as a video. It applies audio effects to an input MP3 file, and writes the result to a new MP3 file. If a GIF is given in the command, an MP4 video file of the GIF on repeat for the duration of the remix is also created. Vaporiser can apply the following audio effects:

Speed shift
Pitch shift
Reverb
Lowpass filter
Bass boost
Gain adjustment
Out Of Phase Stereo (karaoke) effect
Phaser effect
Tremolo effect
Compand

See usage for details of available effects.

System requirements
Setup instructions
Usage

System requirements

Required software

Python 3.10 or higher
Python modules in requirements.txt
Sound eXchange (SoX)
libsox-fmt-mp3 for SoX MP3 support
A UNIX operating system (Linux or macOS)

Using vaporiser on Windows

This project is written to be used through a UNIX (Linux or Mac with macOS Mojave or later) operating system (OS). If you are using Windows, you can use this project on a Linux OS (e.g. Ubuntu) through either:

Installing SoX

SoX and libson-fmt-mp3 can be installed with the following commands:

$ sudo apt install sox
$ sudo apt-get install libsox-fmt-mp3

Installing Python 3.10 and venv on Ubuntu

$ sudo apt install python3.10
$ sudo apt-get install python3.10-venv

Setup instructions

Clone the repo

$ git clone https://github.com/rnnh/vaporiser.git
$ cd vaporiser/

Create a virtual environment

/vaporiser$ python3.10 -m venv env
/vaporiser$ source env/bin/activate

Install required packages

(env) /vaporiser$ pip install --upgrade pip
(env) /vaporiser$ pip install -r requirements.txt

Optional: Make script executable

Making the script executable will allow it to be called from the command line using $ ./vaporiser.py instead of $ python vaporiser.py when the virtual environment is active.

(env) $ chmod +x vaporiser.py

Usage

Example

Vaporiser can be used to create a remix of the file audio_file.mp3 with the following command:

$ python vaporiser.py --audio audio_file.mp3

The remixed audio will be written to the file audio_file_vaporised.mp3. By default, _vaporised is added to the end of the output filenames, unless an output filename is specified using the --output argument.

Help text

$ python vaporiser.py --help

usage: vaporiser.py [-h] [-o OUTPUT_NAME] -a AUDIO_INPUT [-s SPEED_RATIO]
                    [-p PITCH_SHIFT] [-l LOWPASS_CUTOFF] [-b BASS_BOOST]
                    [-ga GAIN_DB] [-op] [-ph] [-tr] [-co] [-nr] [-g GIF_FILE]
                    [-sb]

Creates a vaporwave (slowed, with reverb) remix of a given MP3 file, with
multiple audio effects available, and the option of playing over a looped GIF
as a video.

options:
  -h, --help            show this help message and exit
  -o OUTPUT_NAME, --output OUTPUT_NAME
                        Name of output file(s), instead of audio file name
                        with the addition of '_vaporised'. (default: None)

required arguments:
  -a AUDIO_INPUT, --audio AUDIO_INPUT
                        Input audio file to vaporise (.mp3) (default: None)

audio arguments:
  these arguments control audio effects that will be applied by default

  -s SPEED_RATIO, --speed SPEED_RATIO
                        Ratio of new playback speed to old speed. (default:
                        0.75)
  -p PITCH_SHIFT, --pitch PITCH_SHIFT
                        Pitch shift (100ths of a semitone). (default: -75)
  -l LOWPASS_CUTOFF, --lowpass LOWPASS_CUTOFF
                        Cutoff for lowpass filter (Hz). (default: 3500)

extra audio arguments:
  these arguments control extra, optional audio effects

  -b BASS_BOOST, --bass BASS_BOOST
                        Add a bass boost effect (e.g. --bass 3). (default:
                        None)
  -ga GAIN_DB, --gain GAIN_DB
                        Applies gain (dB). (default: None)
  -op, --oops           Applies Out Of Phase Stereo effect. This is sometimes
                        known as the ‘karaoke’ effect as it often has the
                        effect of removing most or all of the vocals from a
                        recording. (default: False)
  -ph, --phaser         Enable phaser effect. (default: False)
  -tr, --tremolo        Enable tremolo effect. (default: False)
  -co, --compand        Enable compand, which compresses the dynamic range of
                        the audio. (default: False)
  -nr, --noreverb       Disables reverb. (default: False)

video arguments:
  optional arguments, result in an MP4 video output in addition to the MP3
  audio

  -g GIF_FILE, --gif GIF_FILE
                        Input GIF file to loop. Without a GIF, only an MP3 is
                        created. With a GIF, an MP4 video is also created.
                        (default: None)
  -sb, --sobel          Applies a Sobel filter to video output. (default:
                        False)

rnnh / vaporiser Goto Github PK

vaporiser's Introduction

Contents

System requirements

Required software

Using vaporiser on Windows

Installing SoX

Installing Python 3.10 and venv on Ubuntu

Setup instructions

Clone the repo

Create a virtual environment

Install required packages

Optional: Make script executable

Usage

Example

Help text

vaporiser's People

Contributors

Stargazers

Watchers

Forkers

vaporiser's Issues

Recommend Projects

Recommend Topics

Recommend Org