TimeStretchPitchScale.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright 2009-2025 Jörg Müller
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 ******************************************************************************/

#pragma once

#include "fx/Effect.h"

AUD_NAMESPACE_BEGIN

enum class StretcherQuality
{
    HIGH = 0,      // Prioritize high-quality pitch processing
    FAST = 1,      // Prioritize speed over audio quality
    CONSISTENT = 2 // Prioritize consistency for dynamic pitch changes
};

class AUD_API TimeStretchPitchScale : public Effect
{
private:
    double m_timeRatio;

    double m_pitchScale;

    StretcherQuality m_quality;

    bool m_preserveFormant;

    // delete copy constructor and operator=
    TimeStretchPitchScale(const TimeStretchPitchScale&) = delete;
    TimeStretchPitchScale& operator=(const TimeStretchPitchScale&) = delete;

public:
    TimeStretchPitchScale(std::shared_ptr<ISound> sound, double timeRatio, double pitchScale, StretcherQuality quality, bool preserveFormant);

    double getTimeRatio() const;

    double getPitchScale() const;

    bool getPreserveFormant() const;

    StretcherQuality getStretcherQuality() const;

    virtual std::shared_ptr<IReader> createReader();
};

AUD_NAMESPACE_END