Joerg Mueller
fe891d581d
- Changing API for time values from float to double for better precision. - Fixing minor mistakes in the documentation. - Fixing minor unnecessary large memory allocation.
74 lines
1.7 KiB
C++
74 lines
1.7 KiB
C++
/*******************************************************************************
|
|
* Copyright 2009-2016 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
|
|
|
|
/**
|
|
* @file Limiter.h
|
|
* @ingroup fx
|
|
* The Limiter class.
|
|
*/
|
|
|
|
#include "fx/Effect.h"
|
|
|
|
AUD_NAMESPACE_BEGIN
|
|
|
|
/**
|
|
* This sound limits another sound in start and end time.
|
|
*/
|
|
class AUD_API Limiter : public Effect
|
|
{
|
|
private:
|
|
/**
|
|
* The start time.
|
|
*/
|
|
const double m_start;
|
|
|
|
/**
|
|
* The end time.
|
|
*/
|
|
const double m_end;
|
|
|
|
// delete copy constructor and operator=
|
|
Limiter(const Limiter&) = delete;
|
|
Limiter& operator=(const Limiter&) = delete;
|
|
|
|
public:
|
|
/**
|
|
* Creates a new limiter sound.
|
|
* \param sound The input sound.
|
|
* \param start The desired start time.
|
|
* \param end The desired end time, a negative value signals that it should
|
|
* play to the end.
|
|
*/
|
|
Limiter(std::shared_ptr<ISound> sound,
|
|
double start = 0, double end = -1);
|
|
|
|
/**
|
|
* Returns the start time.
|
|
*/
|
|
double getStart() const;
|
|
|
|
/**
|
|
* Returns the end time.
|
|
*/
|
|
double getEnd() const;
|
|
|
|
virtual std::shared_ptr<IReader> createReader();
|
|
};
|
|
|
|
AUD_NAMESPACE_END
|