Zoom G3 Patches is a dataset that contains 2161 unique patches from the Zoom G3 device (image on right).
The data presented here was extracted around the 2019 from the Guitar Patches - Zoom G3 and G3X, a popular audio plugins configurations repository where specialists and amateurs share patches.
A patch to this audio equipment is a sequence of 6 audio plugins. Any of the 117 audio plugins supported for this device can be used in any position. There are M^R
possible patches if you consider only the audio plugins information. Each audio plugin has a unique identifier. There is a example of a patch from the dataset:
Above: A sequence of 6 numbers that represents the patch. Each blocks correspond to the instances of the audio plugins in the position defined in the patch; numbers correspond to the unique identifiers of the audio plugins. Below: Corresponding figure representation of the audio plugins.
Image extrated from the dissertation Sistemas de Recomendação de Plugins de Áudio para Produção Musical (Figure 14).
Audio Plugins Recommendation System for Music Production
- Recommends audio plugins from a incomplete patch:
- Plugin recommendation on a single position;
- Plugin recommendation on multiple positions;
- Full patch recommendation;
- Plugins positioning in a given patch: As the audio plugins aplies non linear transformation in the audio, the plugins positioning is important.
A visual representation of the tasks:
Audio plugins recommendation cases:- user selects some audio plugins and requires that the recommender system suggests audio plugins to the missing positions;
- Model recommends all the audio plugins from a patch (model generates a patch);
- user selects 6 audio plugins and the recommender system model defines the audio plugins best positioning.
Image extrated from the dissertation Sistemas de Recomendação de Plugins de Áudio para Produção Musical (Figure 6).
TLTR: Check the Database.ipynb notebook to obtain the files description.
This repository contains:
images/
:- Visual representation of the 117 audio plugins.
- The file name has in the pattern
<audio plugin id>.png
. - The images was extracted from the Zoom G3 manual^1.
data/
:plugins-categories.csv
:
Contains the plugins identifiers, the plugin names and your category. There are 13 plugins categories. See above to more information;pedalboard-info.csv
:
All the entries that the plugin data was extracted;pedalboards.csv
:
All the pedalboards extracted, without data adjustment;patches-error.csv
:
Patches that wasn't possible collect the pedalboard data;patches-filtered.csv
:
2161 patches with your id, your and your six audio plugins;patches-bag-of-words.csv
:
2161 patches in a bag-of-words encoding;patches-one-hot-encoding.csv
:
2161 patches in a one-hot enconding.
^1 Legal Warning: Zoom is a trademark of ZOOM Corporation (<www.zoom.co.jp>), registered in the USA and/or other countries. All companies, products and service names used in this work are for identification purposes only and are not intended to infringe the copyright of their respective owners. The use of these names, trademarks and brands does not imply endorsement.
Check the Database.ipynb notebook to obtain the files description.
The 117 audio plugins are distributed in 13 categories by the official Zoom G3 patch editor software (see data/plugins-categories.csv
).
The following table shows 11 categories and the number of plugins by category after joining categories with with similar purposes:
Category | # plugins | # plugins occurrence |
---|---|---|
Amp (Original Amp ∪ Amp Modeling) | 28 | 1678 |
Combination Fx | 7 | 225 |
Delay | 12 | 1069 |
Dynamics | 7 | 2451 |
Filter_EQ | 10 | 1140 |
Modulation | 22 | 1168 |
None | 1 | 2131 |
Pedal Fx | 4 | 248 |
Reverb | 8 | 1320 |
SFX | 3 | 40 |
Stomp (Original Stomp ∪ Stomp Modeling) | 15 | 1496 |
That table was Number of audio plugins and their occurrences by category |
One of the available audio plugins is named None
: specialists can use it if they do not want a signal transformation in a specific position of the patch. Your visual representation is a funny audio cable: .
Is noteworthy that the use of audio plugins is imbalanced, the five most commonly used audio plugins correspond to 38.84% of the instances, namely: 107 - None
(16.43%), 27 - ZNR
to noise reduction (10.08%), 30 - Equalizer
(5.66%), 23 - Compressor
(3.91%) and 71 - Booster
(2.73%).
Distribution of the number of audio plugin contained in the dataset. Listed only plugins whose number of usages is greater than 60.
Image extrated and adapted from the dissertation Sistemas de Recomendação de Plugins de Áudio para Produção Musical (Figure 15).
We can see in the following figure some relationship between the audio plugins categories with the plugins positioning in the patch. In this Sankey Diagram, each grouping of columns on the x axis represents one of the six positions in the patch (the first position is the most left grouping of columns). The size of each column in the y axis informs the proporsion of the use of audio plugins by the same category in the specific position in the patch. The category name is next to the corresponding column. An edge connects two columns and indicates the proportion of the left column that is preceded by the right column.
Sankey Diagram indicating the categories of the audio plugins by position in the patches. Same edge colors for the same source categories.
Image extrated from the dissertation Sistemas de Recomendação de Plugins de Áudio para Produção Musical (Figure 16).
By this figure, we can note some relationships between the positioning of categories and the relationships between categories of neighboring positions:
- The
Dynamics
category corresponds to about 50% of the audio plugins used in the first position; - The
Dynamics
usage is widespread, so that several categories appear after it: aDynamics
column precedes several columns; - For the first three positions, there is a tendency that after an
Stomp
there is anmp
. The same is not true for aStomp
in fifth position; - A significant proportion of the predecessor categories of
Amp
areDynamics
andStomp
; - Given the standardization of the
None
position (all theNone
are moved to the right), there is always aNone
after aNone
, except at the end of the chain; - A
Reverb
, when used, tends to be the last plugin in the effects chain (pedalboard), that is, after aReverb
it will most likely appear aNone
or the end of the chain. \end{itemize}
As the data has colected around 2019, if you want to obtain more data, you can do this by following this steps:
- Create virtualenv:
python3 -m venv venv
- Start virtualenv:
source venv/bin/activate
- Install dependencies:
python setup.py develop
- Maybe requires
sudo apt-get update -y sudo apt-get install -y python3-dev sudo apt-get install -y libxml2-dev libxslt1-dev sudo apt-get install -y libssl-dev libffi-dev sudo apt install bsdtar
- Remove the old pedalboards data
rm data/pedalboard-info.csv
- Obtain the Zoom G3 and G3X entries from the Guitar Patches:
scrapy runspider scrap.py -o data/pedalboard-info.csv -t csv
Run in the following order:
- Open the jupyter notebook:
jupyter notebook
- Generates the
data/plugins-categories.csv
(Optinal) Open and run all:
Processing_data_1_-_audio_plugins.ipynb
- Download all the pedalboard files and generates:
data/patches.csv
,data/patches-error.csv
Open and execute all steps:
Processing_data_2_-_Collect_patches_data.ipynb
- Organize data, removing duplication and moving None plugins to right. Generates
data/patches-filtered.csv
Open and execute all steps:
Processing_data_3_-_data_transformations
- Generates:
patches-one-hot-encoding.csv
andpatches-bag-of-words.csv
Open and execute all steps:Processing_data_3_-_Bag_of_plugins.ipynb
This dataset is created and firstly used in the Audio Plugin Recommendation Systems for Music Production paper. If you interested in using it in a research, please add a reference to this:
@inproceedings{da2019audio,
title={Audio Plugin Recommendation Systems for Music Production},
author={da Silva, Paulo Mateus Moura and Mattos, C{\'e}sar Lincoln Cavalcante and de Souza J{\'u}nior, Amauri Holanda},
booktitle={2019 8th Brazilian Conference on Intelligent Systems (BRACIS)},
pages={854--859},
year={2019},
organization={IEEE}
}
If you are interested to the Audio Plugin Recommendation Systems for Music Production paper, maybe the dissertation Sistemas de Recomendação de Plugins de Áudio para Produção Musical would be a good reference. It contains more details about the dataset, the models used and the training processes, but it was wrote in Brazilian Portuguese.