xref: /aosp_15_r20/external/webrtc/modules/audio_coding/neteq/dtmf_tone_generator.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1 /*
2  *  Copyright (c) 2012 The WebRTC project authors. All Rights Reserved.
3  *
4  *  Use of this source code is governed by a BSD-style license
5  *  that can be found in the LICENSE file in the root of the source
6  *  tree. An additional intellectual property rights grant can be found
7  *  in the file PATENTS.  All contributing project authors may
8  *  be found in the AUTHORS file in the root of the source tree.
9  */
10 
11 #ifndef MODULES_AUDIO_CODING_NETEQ_DTMF_TONE_GENERATOR_H_
12 #define MODULES_AUDIO_CODING_NETEQ_DTMF_TONE_GENERATOR_H_
13 
14 #include <stddef.h>
15 #include <stdint.h>
16 
17 #include "modules/audio_coding/neteq/audio_multi_vector.h"
18 
19 namespace webrtc {
20 
21 // This class provides a generator for DTMF tones.
22 class DtmfToneGenerator {
23  public:
24   enum ReturnCodes {
25     kNotInitialized = -1,
26     kParameterError = -2,
27   };
28 
29   DtmfToneGenerator();
~DtmfToneGenerator()30   virtual ~DtmfToneGenerator() {}
31 
32   DtmfToneGenerator(const DtmfToneGenerator&) = delete;
33   DtmfToneGenerator& operator=(const DtmfToneGenerator&) = delete;
34 
35   virtual int Init(int fs, int event, int attenuation);
36   virtual void Reset();
37   virtual int Generate(size_t num_samples, AudioMultiVector* output);
38   virtual bool initialized() const;
39 
40  private:
41   static const int kCoeff1[4][16];  // 1st oscillator model coefficient table.
42   static const int kCoeff2[4][16];  // 2nd oscillator model coefficient table.
43   static const int kInitValue1[4][16];  // Initialization for 1st oscillator.
44   static const int kInitValue2[4][16];  // Initialization for 2nd oscillator.
45   static const int kAmplitude[64];      // Amplitude for 0 through -63 dBm0.
46   static const int16_t kAmpMultiplier = 23171;  // 3 dB attenuation (in Q15).
47 
48   bool initialized_;            // True if generator is initialized properly.
49   int coeff1_;                  // 1st oscillator coefficient for this event.
50   int coeff2_;                  // 2nd oscillator coefficient for this event.
51   int amplitude_;               // Amplitude for this event.
52   int16_t sample_history1_[2];  // Last 2 samples for the 1st oscillator.
53   int16_t sample_history2_[2];  // Last 2 samples for the 2nd oscillator.
54 };
55 
56 }  // namespace webrtc
57 #endif  // MODULES_AUDIO_CODING_NETEQ_DTMF_TONE_GENERATOR_H_
58