OLD | NEW |
---|---|
1 /* | 1 /* |
2 * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. | 2 * Copyright (c) 2011 The WebRTC project authors. All Rights Reserved. |
3 * | 3 * |
4 * Use of this source code is governed by a BSD-style license | 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 | 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 | 6 * tree. An additional intellectual property rights grant can be found |
7 * in the file PATENTS. All contributing project authors may | 7 * in the file PATENTS. All contributing project authors may |
8 * be found in the AUTHORS file in the root of the source tree. | 8 * be found in the AUTHORS file in the root of the source tree. |
9 */ | 9 */ |
10 | 10 |
11 #ifndef WEBRTC_MODULES_AUDIO_MIXER_AUDIO_MIXER_H_ | 11 #ifndef WEBRTC_API_AUDIO_AUDIO_MIXER_H_ |
12 #define WEBRTC_MODULES_AUDIO_MIXER_AUDIO_MIXER_H_ | 12 #define WEBRTC_API_AUDIO_AUDIO_MIXER_H_ |
13 | 13 |
14 #include <memory> | 14 #include <memory> |
the sun
2016/10/20 09:13:05
not needed?
aleloi
2016/10/20 09:35:18
There is a unique_ptr<AudioProcessing> argument to
| |
15 | 15 |
16 #include "webrtc/base/refcount.h" | 16 #include "webrtc/base/refcount.h" |
17 #include "webrtc/modules/include/module_common_types.h" | 17 #include "webrtc/modules/include/module_common_types.h" |
18 | 18 |
19 namespace webrtc { | 19 namespace webrtc { |
20 | 20 |
21 // WORK IN PROGRESS | |
kwiberg-webrtc
2016/10/20 09:24:12
Are we allowed to use Unicode in source files yet?
aleloi
2016/10/20 09:35:18
Hm... I wonder what that will do to peoples editor
| |
22 // This class is under development and is not yet intended for for use outside | |
23 // of WebRtc/Libjingle. | |
21 class AudioMixer : public rtc::RefCountInterface { | 24 class AudioMixer : public rtc::RefCountInterface { |
22 public: | 25 public: |
23 // A callback class that all mixer participants must inherit from/implement. | 26 // A callback class that all mixer participants must inherit from/implement. |
24 class Source { | 27 class Source { |
25 public: | 28 public: |
26 enum class AudioFrameInfo { | 29 enum class AudioFrameInfo { |
27 kNormal, // The samples in audio_frame are valid and should be used. | 30 kNormal, // The samples in audio_frame are valid and should be used. |
28 kMuted, // The samples in audio_frame should not be used, but should be | 31 kMuted, // The samples in audio_frame should not be used, but |
29 // implicitly interpreted as zero. Other fields in audio_frame | 32 // should be implicitly interpreted as zero. Other |
30 // may be read and should contain meaningful values. | 33 // fields in audio_frame may be read and should |
31 kError // audio_frame will not be used. | 34 // contain meaningful values. |
35 kError, // The audio_frame will not be used. | |
32 }; | 36 }; |
33 | 37 |
34 struct AudioFrameWithInfo { | 38 struct AudioFrameWithInfo { |
35 AudioFrame* audio_frame; | 39 AudioFrame* audio_frame; |
36 AudioFrameInfo audio_frame_info; | 40 AudioFrameInfo audio_frame_info; |
37 }; | 41 }; |
38 | 42 |
39 // The implementation of GetAudioFrameWithInfo should update | 43 // The implementation of GetAudioFrameWithInfo should update |
40 // audio_frame with new audio every time it's called. Implementing | 44 // audio_frame with new audio every time it's called. Implementing |
41 // classes are allowed to return the same AudioFrame pointer on | 45 // classes are allowed to return the same AudioFrame pointer on |
42 // different calls. The pointer must stay valid until the next | 46 // different calls. The pointer must stay valid until the next |
43 // mixing call or until this audio source is disconnected from the | 47 // mixing call or until this audio source is disconnected from the |
44 // mixer. The mixer may modify the contents of the passed | 48 // mixer. The mixer may modify the contents of the passed |
45 // AudioFrame pointer at any time until the next call to | 49 // AudioFrame pointer at any time until the next call to |
46 // GetAudioFrameWithInfo, or until the source is removed from the | 50 // GetAudioFrameWithInfo, or until the source is removed from the |
47 // mixer. | 51 // mixer. |
48 virtual AudioFrameWithInfo GetAudioFrameWithInfo(int sample_rate_hz) = 0; | 52 virtual AudioFrameWithInfo GetAudioFrameWithInfo(int sample_rate_hz) = 0; |
49 | 53 |
50 // A way for a mixer implementation do distinguish participants. | 54 // A way for a mixer implementation to distinguish participants. |
51 virtual int ssrc() = 0; | 55 virtual int Ssrc() = 0; |
52 | 56 |
53 protected: | 57 protected: |
54 virtual ~Source() {} | 58 virtual ~Source() {} |
55 }; | 59 }; |
56 | 60 |
57 // Since the mixer is reference counted, the destructor may be | 61 // Since the mixer is reference counted, the destructor may be |
58 // called from any thread. | 62 // called from any thread. |
59 ~AudioMixer() override {} | 63 ~AudioMixer() override {} |
60 | 64 |
61 // Returns true if adding/removing was successful. A source is never | 65 // Returns true if adding/removing was successful. A source is never |
62 // added twice and removal is never attempted if a source has not | 66 // added twice and removal is never attempted if a source has not |
63 // been successfully added to the mixer. Addition and removal can | 67 // been successfully added to the mixer. Addition and removal can |
64 // happen on different threads. | 68 // happen on different threads. |
65 virtual bool AddSource(Source* audio_source) = 0; | 69 virtual bool AddSource(Source* audio_source) = 0; |
66 virtual bool RemoveSource(Source* audio_source) = 0; | 70 virtual bool RemoveSource(Source* audio_source) = 0; |
67 | 71 |
68 // Performs mixing by asking registered audio sources for audio. The | 72 // Performs mixing by asking registered audio sources for audio. The |
69 // mixed result is placed in the provided AudioFrame. Will only be | 73 // mixed result is placed in the provided AudioFrame. Will only be |
70 // called from a single thread. The rate and channels arguments | 74 // called from a single thread. The rate and channels arguments |
71 // specify the rate and number of channels of the mix result. | 75 // specify the rate and number of channels of the mix result. |
the sun
2016/10/20 09:13:05
Why isn't the information in AudioFrame used? (Sor
aleloi
2016/10/20 09:35:18
Yes, I also think that we had this discussion a wh
| |
72 virtual void Mix(int sample_rate_hz, | 76 virtual void Mix(int sample_rate_hz, |
73 size_t number_of_channels, | 77 size_t number_of_channels, |
74 AudioFrame* audio_frame_for_mixing) = 0; | 78 AudioFrame* audio_frame_for_mixing) = 0; |
75 }; | 79 }; |
76 } // namespace webrtc | 80 } // namespace webrtc |
77 | 81 |
78 #endif // WEBRTC_MODULES_AUDIO_MIXER_AUDIO_MIXER_H_ | 82 #endif // WEBRTC_API_AUDIO_AUDIO_MIXER_H_ |
OLD | NEW |