Welcome to mirror list, hosted at ThFree Co, Russian Federation.

Sine.h « generator « include « audaspace « extern - git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: ee78fc7d06b50cbc66430f1c56c130004542bbb8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
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