1 /******************************************************************************* 2 * Copyright 2009-2016 Jörg Müller 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 ******************************************************************************/ 16 17 #pragma once 18 19 /** 20 * @file Sine.h 21 * @ingroup generator 22 * The Sine class. 23 */ 24 25 #include "ISound.h" 26 #include "respec/Specification.h" 27 28 AUD_NAMESPACE_BEGIN 29 30 /** 31 * This sound creates a reader that plays a sine tone. 32 */ 33 class AUD_API Sine : public ISound 34 { 35 private: 36 /** 37 * The frequence of the sine wave. 38 */ 39 const float m_frequency; 40 41 /** 42 * The target sample rate for output. 43 */ 44 const SampleRate m_sampleRate; 45 46 // delete copy constructor and operator= 47 Sine(const Sine&) = delete; 48 Sine& operator=(const Sine&) = delete; 49 50 public: 51 /** 52 * Creates a new sine sound. 53 * \param frequency The desired frequency. 54 * \param sampleRate The target sample rate for playback. 55 */ 56 Sine(float frequency, SampleRate sampleRate = RATE_48000); 57 58 /** 59 * Returns the frequency of the sine wave. 60 */ 61 float getFrequency() const; 62 63 virtual std::shared_ptr<IReader> createReader(); 64 }; 65 66 AUD_NAMESPACE_END 67