Skip to content

Resamplers and Wavtools

Jump to bottom Edit New page
keitaiware edited this page Jan 6, 2025 · 30 revisions

In UTAU, resampler is the core engine that does the major works of synthesis: changing the pitch and duration of the audio sample, and applying flags to the audio. Audio rendered with different resamplers has different sound quality. Different resamplers also provide different set of flags. OpenUtau ships with a resampler, worldline. There are also many third-party resamplers.

Wavtool is the program that concatenates the audio slices from resampler into the final audio. OpenUtau ships with two wavtools, simple and convergence. There are also many third-party wavtools.

Installing Resamplers

After you install resampler, please switch to "CLASSIC" renderer to use the resampler you installed.

Windows

Resampler must be an executable (.exe). Resamplers can be placed in subfolders inside the Resamplers folder.

  1. In the OpenUtau folder, locate the resampler folder named Resamplers.
  2. Open the resampler folder and place the resampler in the folder.

In OpenUtau version 0.1.119 or higher, resamplers can be installed by dragging and dropping the .exe file onto the main OpenUtau window and selecting "Install as resampler".

MacOS

Before we get into this process, I need to clarify that it is only possible on MacOS 13.7.1 (Ventura) or later, as Homebrew has discontinued its service for any older versions of MacOS. For older versions of MacOS, Macres provides a native macOS version. Put it into the resamplers folder of OpenUtau.

You can also use Windows resamplers with Wine: (tested on macOS 11.6)

Section 1, “Installing Homebrew.”

To install Homebrew you will need to head over to the Homebrew website.

https://brew.sh/

From here, you will want to copy the installation command, and open Terminal. If you are not familiar with Terminal, here is the path. Applications > Utilities > Terminal.

  1. In the Terminal control panel, you will want to paste the installation command into the console. It will begin running the installation.
  2. The installation will pause and ask for your computer’s passkey. Input the passkey and the installation will continue.
  3. After it installs the, “X code command line tools,” it may run into a fatal error when updating the Homebrew install. Do not worry, head over to, System Preferences > Security and Privacy, and scroll down until you see, “allow install–sh.” Select OK to continue. Now it will run the rest of the install and you have successfully Homebrewed your Mac.

Section 2, "Installing Wine.”

In order to install Wine, head to the WineHQ website.

https://github.com/Gcenx/macOS_Wine_builds/releases

  1. Download Wine Staging from the Github releases page.
  2. Drag the Wine Staging .zip to your desktop and extract.
  3. After extracting the zip, run the Wine Staging application.
  4. The Wine installer will run into an error since it is an external application downloaded from the internet. Head to System Preferences > Security and Privacy, and allow Wine access to run. After this, Wine will be installed to your computer.

After performing these two steps, we will then prepare the environment for the resamplers. Inside of Terminal we will want to begin a new session and run the installation for Wine Crossover.

    brew tap gcenx/wine
    brew install –cask –no-quarantine wine-crossover

After running these two commands your environment is set!

Section 3, “How to run resamplers on MacOS.”

Now that you have installed both Wine and Homebrew onto your computer, we will now begin the process for installing the resamplers into MacOS. Before we get started, I will like to clarify that for this step we will be converting the executables (.exe) into .sh files. That will be the result we want in order to run resamplers. Here is how.

  1. From the OpenUTAU github release page, download the “Mac_Additional.zip.” This will be the package we use to convert the resamplers into .sh files.

  2. Before we get started, let’s find the version of wine that you have installed.

For Intel MacOS …

Perform CMND+SHIFT+G, to locate the directory. Now input the following path, /usr/local/bin/. What you will be looking for is either Wine32 or Wine64. Depending on what you have will be important information for a future step. Remember this!

For Silicon MacOS …

Open Terminal and run the following command.

    which wine

After running this prompt you will receive the location of your Wine installation. *( eg. /opt/homebrew/bin/wine ) Please copy this location as it is very important for the following steps.

  1. Download the resampler of your choice, for this tutorial, I will be installing TIPS. Extract the resampler, and run OpenUTAU.

  2. Drag the resampler.exe into the OpenUTAU window. It will then ask you if you want to install as a resampler or wavtool, select the resampler option since that is what we are working with today.

MacOS_Install_Samp1

  1. Extract the Mac_Additional.zip, by extracting it, it will generate a, moresampler.sh file. Rename the file after the resampler you will be working with, *(eg. TIPS.sh ).

  2. Open this file with textedit by double-clicking, or right-clicking. Select, “Open with textedit.” Now we will edit the .sh file with resampler’s information.

MacOS_Install_Samp2

  1. Locate the, moresampler-0.8.4/moresampler.exe delete it, and replace with only the resampler name, eg. “TIPS.exe.

MacOS_Install_Samp3

For MacOS Intel …

In the field for, exec /usr/local/bin/wine32on64 replace the Wine extension with your version of Wine. This will look like, exec /usr/local/bin/wine64 since my computer is running Wine64.

MacOS_Install_Samp4

For MacOS Silicon …

In the field for, exec /usr/local/bin/wine32on64 replace this field with the location of your wine installation. This will may like, /opt/homebrew/bin/wine.

It should look like this!

MacOS_Install_Samp5

  1. In OpenUTAU, to quickly access to resampler folder, select the, “help,” tag, and, "Open Logs Location.” We will not be working with the logs, from here you will open the resampler folder.

  2. OpenUTAU will have already generated a .sh file for TIPS.exe in this scenario. With the edited TIPS.sh on your desktop, drag and drop it in the resampler folder, and replace.

  3. Return to OpenUTAU, and select, “CLASSIC,” in the resampler field, and to the right there will be a cog icon. From here you will be able to select your downloaded resamplers.

MacOS_Install_Samp6

The first render may take awhile if this is your first time running the instance.

You can repeat this process and download as many resamplers as you like.

Linux

Macres provides a native Linux version. Put it into the resamplers folder of OpenUtau.

For wrapping Windows resamplers into Linux, use this method:

  1. Install Wine
  2. Open the Resamplers folder (should be on ~/.local/share/OpenUtau/Resamplers)
  3. Create a new text file with the name of your resampler (no file extension required).
  4. Open the text file and add this script.
#!/bin/bash
LANG="ja_JP.UTF8" wine "/absolute/path/to/your/resampler.exe" "${@,-1}"
  1. Change "/absolute/path/to/your/resampler.exe" to the path of the resampler.
  2. Restart OpenUtau.

Tested Resamplers and Directories

This is a list of all UTAU resamplers tested with OpenUtau.

Windows

Resampler Author Resample Manifest Additional Notes
worldline StAkira Built into OpenUtau. Works on all platforms.
bkh01.exe Zteer
doppeltler32.exe Ameya doppeltler32.yaml
doppeltler64.exe Ameya doppeltler64.yaml
EFB-GT.exe Custom.Maid
EFB-PB.exe Custom.maid
f2resamp32.exe Ameya f2resamp32.yaml
f2resamp64.exe Ameya f2resamp64.yaml
fresamp11.exe Ameya
fresamp12.exe Ameya
fresamp14.exe Ameya
fresamp14omp.exe Ameya Ported to OpenMP with faster rendering speed than fresamp14.exe.
lessampler.exe YuzukiTsuru See additonal notes.
macres.exe titinko
model4.exe Ameya
moresampler.exe Kanru Hua moresampler.yaml See adjustments for compatibility.
phavoco.exe Ameya
phaavoco.exe Ameya
resampler.exe Ameya UTAU built-in resampler.
SpaceWorld_win64.exe LovelyA72 See adjustments for compatibility.
StrayCatRunner.exe Astel123457 StrayCatRunner.yaml
straycat-rs.exe UtaUtaUtau straycat-rs.yaml
StrayCat.py UtaUtaUtau StrayCat.yaml Deprecated in place of straycat-rs (above)
TIPS.exe ScientistB
tn_fnds.exe Zteer tn_fnds.yaml
UDB YuzukiTsuru UDB means UTAU Debug Engine.
vs4u.exe AckieSound
w4u.exe Zany w4u.yaml
WARP.exe Custom.Maid
wn4u.exe Zany See adjustments for compatibility.
young3.exe Zany

Compatible with adjustments

  • moresampler.exe
    • Add moresampler.exe and the default moreconfig.txt to the Resamplers folder.
    • Add moresampler.exe to Wavtools folder without moreconfig.txt.
    • Moresampler should now function as either resampler only, or as both wavtool and resampler.
  • SpaceWorld_win64.exe and wn4u.exe
    • May experience issues if the voicebank is missing any frq files. SpaceWorld version 1.0.1 will not crash in the event of a missing frq file.
  • lessampler
    • In development, lack of flag support
    • Oversized Audio Model Attention

MacOS

Resampler Author Resample Manifest Additional Notes
worldline StAkira Built into OpenUtau. Works on all platforms.
macres titinko macres.yaml

Linux

Resampler Author Resample Manifest Additional Notes
worldline StAkira Built into OpenUtau. Works on all platforms.
macres titinko macres.yaml

Resampler Manifest

A resampler manifest is a YAML file used to store the expressions supported by a resampler. With resampler manifests, users can add all of a resampler's supported flags at once using the Add all expressions suggested by renderers button in the Expressions editor.

image

Resampler manifests should have the same name as the resampler executable, stored in the same folder. The manifest must have a .yaml file extension. For example, the resampler manifest for moresampler.exe should be moresampler.yaml located in the same folder with moresampler.exe.

Below is a full example of a resampler manifest for Moresampler. To create a resampler manifest with OpenUtau, add the resampler's expressions to any .ustx project file. Open the project file in a text editor and copy the expressions: section into a blank manifest file.

expressions:
  gen:
    name: Gender Factor
    abbr: gen
    type: Numerical
    min: -100
    max: 100
    default_value: 0
    is_flag: true
    flag: g
  mbre:
    name: Breathiness (Moresampler)
    abbr: mbre
    type: Numerical
    min: -100
    max: 100
    default_value: 0
    is_flag: true
    flag: Mb
  tens:
    name: Tension
    abbr: tens
    type: Numerical
    min: -100
    max: 100
    default_value: 0
    is_flag: true
    flag: Mt
  pit:
    name: Pitch deviation (flag)
    abbr: pit
    type: Numerical
    min: -1200
    max: 1200
    default_value: 0
    is_flag: true
    flag: t
  pkcp:
    name: Peak Compressor
    abbr: pkcp
    type: Numerical
    min: 0
    max: 100
    default_value: 86
    is_flag: true
    flag: P
  amp:
    name: Amplitude Modulation
    abbr: amp
    type: Numerical
    min: -100
    max: 100
    default_value: 0
    is_flag: true
    flag: A
  cons:
    name: Unvoiced Consonant Gain
    abbr: cons
    type: Numerical
    min: -20
    max: 100
    default_value: 0
    is_flag: true
    flag: b
  fstr:
    name: Force Stretch
    abbr: fstr
    type: Options
    min: 0
    max: 1
    default_value: 0
    is_flag: true
    options:
    - ''
    - e
    - Me
  opn:
    name: Openness
    abbr: opn
    type: Numerical
    min: -100
    max: 100
    default_value: 0
    is_flag: true
    flag: Mo
  res:
    name: Resonance
    abbr: res
    type: Numerical
    min: -100
    max: 100
    default_value: 0
    is_flag: true
    flag: Mr
  dry:
    name: Dryness
    abbr: dry
    type: Numerical
    min: -100
    max: 100
    default_value: 0
    is_flag: true
    flag: Md
  cors:
    name: Coarseness
    abbr: cors
    type: Numerical
    min: 0
    max: 100
    default_value: 0
    is_flag: true
    flag: MC
  grwl:
    name: Growl
    abbr: grwl
    type: Numerical
    min: 0
    max: 100
    default_value: 0
    is_flag: true
    flag: MG
  dist:
    name: Distortion
    abbr: dist
    type: Numerical
    min: 0
    max: 100
    default_value: 0
    is_flag: true
    flag: MD
  stbl:
    name: Stabilization
    abbr: stbl
    type: Numerical
    min: 0
    max: 10
    default_value: 0
    is_flag: true
    flag: Ms
  mint:
    name: Model Interpolation
    abbr: mint
    type: Numerical
    min: 0
    max: 100
    default_value: 100
    is_flag: true
    flag: Mm

Installing Wavtools

Windows

  1. On your unzipped OpenUtau folder, locate the wavtool folder named Wavtools.
  2. Open the wavtool folder and place the downloaded wavtool on the folder.

In OpenUtau version 0.1.119 or higher, wavtools can be installed by dragging and dropping the .exe file onto the main OpenUtau window and selecting "Install as wavtool".

macOS / Linux

External wavtools are not supported on macOS or Linux at this time.

Tested Wavtools and Directories

Below is a list of all UTAU wavtools tested with OpenUtau.

Wavtool Author Additonal Notes
simple StAkira Built into OpenUtau. Works on all platforms.
convergence StAkira Also built into OpenUtau. Uses phase compensation.
moresampler.exe Kanru Hua See adjustments for compatibility.
wavtool64 Ameya
wavtool4vcv nmasao

OpenUtau: a free, open-source editor made for the UTAU community.

Add a custom sidebar
Clone this wiki locally