Whisperization.cpp

Go to the documentation of this file.

 
// Copyright (c) 2008-2019 OpenShot Studios, LLC
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#include "Whisperization.h"
#include "Exceptions.h"
#include "Frame.h"
 
using namespace openshot;
using namespace juce;
 
Whisperization::Whisperization():
    Whisperization::Whisperization(FFT_SIZE_512, HOP_SIZE_8, RECTANGULAR) {}
 
Whisperization::Whisperization(openshot::FFTSize fft_size,
                               openshot::HopSize hop_size,
                               openshot::WindowType window_type) :
    fft_size(fft_size), hop_size(hop_size),
    window_type(window_type), stft(*this)
{
    // Init effect properties
    init_effect_details();
}
 
// Init effect settings
void Whisperization::init_effect_details()
{
    InitEffectInfo();
 
    info.class_name = "Whisperization";
    info.name = "Whisperization";
    info.description = "Transform the voice present in an audio track into a whispering voice effect.";
    info.has_audio = true;
    info.has_video = false;
}
 
// This method is required for all derived classes of EffectBase, and returns a
// modified openshot::Frame object
std::shared_ptr<openshot::Frame> Whisperization::GetFrame(std::shared_ptr<openshot::Frame> frame, int64_t frame_number)
{
    const std::lock_guard<std::recursive_mutex> lock(mutex);
    ScopedNoDenormals noDenormals;
 
    const int num_input_channels = frame->audio->getNumChannels();
    const int num_output_channels = frame->audio->getNumChannels();
    const int num_samples = frame->audio->getNumSamples();
    const int hop_size_value = 1 << ((int)hop_size + 1);
    const int fft_size_value = 1 << ((int)fft_size + 5);
 
    stft.setup(num_output_channels);
    stft.updateParameters((int)fft_size_value,
                          (int)hop_size_value,
                          (int)window_type);
 
    stft.process(*frame->audio);
 
    // return the modified frame
    return frame;
}
 
void Whisperization::WhisperizationEffect::modification(const int channel)
{
    fft->perform(time_domain_buffer, frequency_domain_buffer, false);
 
    for (int index = 0; index < fft_size / 2 + 1; ++index) {
        float magnitude = abs(frequency_domain_buffer[index]);
        float phase = 2.0f * M_PI * (float)rand() / (float)RAND_MAX;
 
        frequency_domain_buffer[index].real(magnitude * cosf(phase));
        frequency_domain_buffer[index].imag(magnitude * sinf(phase));
 
        if (index > 0 && index < fft_size / 2) {
            frequency_domain_buffer[fft_size - index].real(magnitude * cosf (phase));
            frequency_domain_buffer[fft_size - index].imag(magnitude * sinf (-phase));
        }
    }
 
    fft->perform(frequency_domain_buffer, time_domain_buffer, true);
}
 
 
// Generate JSON string of this object
std::string Whisperization::Json() const {
 
    // Return formatted string
    return JsonValue().toStyledString();
}
 
// Generate Json::Value for this object
Json::Value Whisperization::JsonValue() const {
 
    // Create root json object
    Json::Value root = EffectBase::JsonValue(); // get parent properties
    root["type"] = info.class_name;
    root["fft_size"] = fft_size;
    root["hop_size"] = hop_size;
    root["window_type"] = window_type;
 
    // return JsonValue
    return root;
}
 
// Load JSON string into this object
void Whisperization::SetJson(const std::string value) {
 
    // Parse JSON string into JSON objects
    try
    {
        const Json::Value root = openshot::stringToJson(value);
        // Set all values that match
        SetJsonValue(root);
    }
    catch (const std::exception& e)
    {
        // Error parsing JSON (or missing keys)
        throw InvalidJSON("JSON is invalid (missing keys or invalid data types)");
    }
}
 
// Load Json::Value into this object
void Whisperization::SetJsonValue(const Json::Value root) {
 
    // Set parent data
    EffectBase::SetJsonValue(root);
 
    if (!root["fft_size"].isNull())
        fft_size = (FFTSize)root["fft_size"].asInt();
 
    if (!root["hop_size"].isNull())
        hop_size = (HopSize)root["hop_size"].asInt();
 
    if (!root["window_type"].isNull())
        window_type = (WindowType)root["window_type"].asInt();
}
 
// Get all properties for a specific frame
std::string Whisperization::PropertiesJSON(int64_t requested_frame) const {
 
    // Generate JSON properties list
    Json::Value root = BasePropertiesJSON(requested_frame);
 
    // Keyframes
    root["fft_size"] = add_property_json("FFT Size", fft_size, "int", "", NULL, 0, 8, false, requested_frame);
    root["hop_size"] = add_property_json("Hop Size", hop_size, "int", "", NULL, 0, 2, false, requested_frame);
    root["window_type"] = add_property_json("Window Type", window_type, "int", "", NULL, 0, 3, false, requested_frame);
 
    // Add fft_size choices (dropdown style)
    root["fft_size"]["choices"].append(add_property_choice_json("128", FFT_SIZE_128, fft_size));
    root["fft_size"]["choices"].append(add_property_choice_json("256", FFT_SIZE_256, fft_size));
    root["fft_size"]["choices"].append(add_property_choice_json("512", FFT_SIZE_512, fft_size));
    root["fft_size"]["choices"].append(add_property_choice_json("1024", FFT_SIZE_1024, fft_size));
    root["fft_size"]["choices"].append(add_property_choice_json("2048", FFT_SIZE_2048, fft_size));
 
    // Add hop_size choices (dropdown style)
    root["hop_size"]["choices"].append(add_property_choice_json("1/2", HOP_SIZE_2, hop_size));
    root["hop_size"]["choices"].append(add_property_choice_json("1/4", HOP_SIZE_4, hop_size));
    root["hop_size"]["choices"].append(add_property_choice_json("1/8", HOP_SIZE_8, hop_size));
 
    // Add window_type choices (dropdown style)
    root["window_type"]["choices"].append(add_property_choice_json("Rectangular", RECTANGULAR, window_type));
    root["window_type"]["choices"].append(add_property_choice_json("Bart Lett", BART_LETT, window_type));
    root["window_type"]["choices"].append(add_property_choice_json("Hann", HANN, window_type));
    root["window_type"]["choices"].append(add_property_choice_json("Hamming", HAMMING, window_type));
 
 
    // Return formatted string
    return root.toStyledString();
}