diff options
Diffstat (limited to 'extern/audaspace/include/generator/Sine.h')
-rw-r--r-- | extern/audaspace/include/generator/Sine.h | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/extern/audaspace/include/generator/Sine.h b/extern/audaspace/include/generator/Sine.h new file mode 100644 index 00000000000..ee78fc7d06b --- /dev/null +++ b/extern/audaspace/include/generator/Sine.h @@ -0,0 +1,67 @@ +/******************************************************************************* + * 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 Sine.h + * @ingroup generator + * The Sine class. + */ + +#include "ISound.h" +#include "respec/Specification.h" + +AUD_NAMESPACE_BEGIN + +/** + * This sound creates a reader that plays a sine tone. + */ +class AUD_API Sine : public ISound +{ +private: + /** + * The frequence of the sine wave. + */ + const float m_frequency; + + /** + * The target sample rate for output. + */ + const SampleRate m_sampleRate; + + // delete copy constructor and operator= + Sine(const Sine&) = delete; + Sine& operator=(const Sine&) = delete; + +public: + /** + * Creates a new sine sound. + * \param frequency The desired frequency. + * \param sampleRate The target sample rate for playback. + */ + Sine(float frequency, + SampleRate sampleRate = RATE_48000); + + /** + * Returns the frequency of the sine wave. + */ + float getFrequency() const; + + virtual std::shared_ptr<IReader> createReader(); +}; + +AUD_NAMESPACE_END |