Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(4)

Side by Side Diff: webrtc/modules/audio_mixer/audio_mixer.h

Issue 2408683002: Cleanup of the mixer interface. (Closed)
Patch Set: Added clarifying comments for adding/removing sources and threading aspects of the interface. Created 4 years, 2 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
« no previous file with comments | « webrtc/modules/BUILD.gn ('k') | webrtc/modules/audio_mixer/audio_mixer_impl.h » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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_MODULES_AUDIO_MIXER_AUDIO_MIXER_H_
12 #define WEBRTC_MODULES_AUDIO_MIXER_AUDIO_MIXER_H_ 12 #define WEBRTC_MODULES_AUDIO_MIXER_AUDIO_MIXER_H_
13 13
14 #include <memory> 14 #include <memory>
15 15
16 #include "webrtc/base/refcount.h"
16 #include "webrtc/modules/include/module_common_types.h" 17 #include "webrtc/modules/include/module_common_types.h"
17 18
18 namespace webrtc { 19 namespace webrtc {
19 20
20 class AudioMixer { 21 class AudioMixer : public rtc::RefCountInterface {
21 public: 22 public:
22 static const int kMaximumAmountOfMixedAudioSources = 3;
23 // A callback class that all mixer participants must inherit from/implement. 23 // A callback class that all mixer participants must inherit from/implement.
24 class Source { 24 class Source {
25 public: 25 public:
26 enum class AudioFrameInfo { 26 enum class AudioFrameInfo {
27 kNormal, // The samples in audio_frame are valid and should be used. 27 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 28 kMuted, // The samples in audio_frame should not be used, but should be
29 // implicitly interpreted as zero. Other fields in audio_frame 29 // implicitly interpreted as zero. Other fields in audio_frame
30 // may be read and should contain meaningful values. 30 // may be read and should contain meaningful values.
31 kError // audio_frame will not be used. 31 kError // audio_frame will not be used.
32 }; 32 };
33 33
34 struct AudioFrameWithInfo { 34 struct AudioFrameWithInfo {
35 AudioFrame* audio_frame; 35 AudioFrame* audio_frame;
36 AudioFrameInfo audio_frame_info; 36 AudioFrameInfo audio_frame_info;
37 }; 37 };
38 38
39 // The implementation of GetAudioFrameWithInfo should update 39 // The implementation of GetAudioFrameWithInfo should update
40 // audio_frame with new audio every time it's called. Implementing 40 // audio_frame with new audio every time it's called. Implementing
41 // classes are allowed to return the same AudioFrame pointer on 41 // classes are allowed to return the same AudioFrame pointer on
42 // different calls. The pointer must stay valid until the next 42 // different calls. The pointer must stay valid until the next
43 // mixing call or until this audio source is disconnected from the 43 // mixing call or until this audio source is disconnected from the
44 // mixer. The mixer may modify the contents of the passed 44 // mixer. The mixer may modify the contents of the passed
45 // AudioFrame pointer at any time until the next call to 45 // AudioFrame pointer at any time until the next call to
46 // GetAudioFrameWithInfo, or until the source is removed from the 46 // GetAudioFrameWithInfo, or until the source is removed from the
47 // mixer. 47 // mixer.
48 virtual AudioFrameWithInfo GetAudioFrameWithInfo(int sample_rate_hz) = 0; 48 virtual AudioFrameWithInfo GetAudioFrameWithInfo(int sample_rate_hz) = 0;
49 49
50 // A way for a mixer implementation do distinguish participants.
51 virtual int ssrc() = 0;
52
50 protected: 53 protected:
51 virtual ~Source() {} 54 virtual ~Source() {}
52 }; 55 };
53 56
54 // Factory method. Constructor disabled. 57 // Since the mixer is reference counted, the destructor may be
55 static std::unique_ptr<AudioMixer> Create(); 58 // called from any thread.
56 virtual ~AudioMixer() {} 59 ~AudioMixer() override {}
57 60
58 // Add/remove audio sources as candidates for mixing. 61 // Returns true if adding/removing was successful. A source is never
59 virtual int32_t SetMixabilityStatus(Source* audio_source, bool mixable) = 0; 62 // added twice and removal is never attempted if a source has not
63 // been successfully added to the mixer. Addition and removal can
64 // happen on different threads.
65 virtual bool AddSource(Source* audio_source) = 0;
66 virtual bool RemoveSource(Source* audio_source) = 0;
60 67
61 // Performs mixing by asking registered audio sources for audio. The 68 // Performs mixing by asking registered audio sources for audio. The
62 // mixed result is placed in the provided AudioFrame. Will only be 69 // mixed result is placed in the provided AudioFrame. Will only be
63 // called from a single thread. The rate and channels arguments 70 // called from a single thread. The rate and channels arguments
64 // specify the rate and number of channels of the mix result. 71 // specify the rate and number of channels of the mix result.
65 virtual void Mix(int sample_rate_hz, 72 virtual void Mix(int sample_rate_hz,
66 size_t number_of_channels, 73 size_t number_of_channels,
67 AudioFrame* audio_frame_for_mixing) = 0; 74 AudioFrame* audio_frame_for_mixing) = 0;
68 }; 75 };
69 } // namespace webrtc 76 } // namespace webrtc
70 77
71 #endif // WEBRTC_MODULES_AUDIO_MIXER_AUDIO_MIXER_H_ 78 #endif // WEBRTC_MODULES_AUDIO_MIXER_AUDIO_MIXER_H_
OLDNEW
« no previous file with comments | « webrtc/modules/BUILD.gn ('k') | webrtc/modules/audio_mixer/audio_mixer_impl.h » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698