niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2011 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 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 11 | #ifndef VOICE_ENGINE_CHANNEL_MANAGER_H_ |
| 12 | #define VOICE_ENGINE_CHANNEL_MANAGER_H_ |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 13 | |
kwiberg | b7f89d6 | 2016-02-17 10:04:18 -0800 | [diff] [blame] | 14 | #include <memory> |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 15 | #include <vector> |
| 16 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 17 | #include "rtc_base/constructormagic.h" |
| 18 | #include "rtc_base/criticalsection.h" |
| 19 | #include "rtc_base/random.h" |
| 20 | #include "rtc_base/scoped_ref_ptr.h" |
| 21 | #include "system_wrappers/include/atomic32.h" |
Mirko Bonadei | 7120742 | 2017-09-15 13:58:09 +0200 | [diff] [blame^] | 22 | #include "typedefs.h" // NOLINT(build/include) |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 23 | #include "voice_engine/include/voe_base.h" |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 24 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 25 | namespace webrtc { |
minyue@webrtc.org | e509f94 | 2013-09-12 17:03:00 +0000 | [diff] [blame] | 26 | |
ossu | 5f7cfa5 | 2016-05-30 08:11:28 -0700 | [diff] [blame] | 27 | class AudioDecoderFactory; |
minyue@webrtc.org | e509f94 | 2013-09-12 17:03:00 +0000 | [diff] [blame] | 28 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 29 | namespace voe { |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 30 | |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 31 | class Channel; |
| 32 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 33 | // Shared-pointer implementation for keeping track of Channels. The underlying |
| 34 | // shared instance will be dropped when no more ChannelOwners point to it. |
| 35 | // |
| 36 | // One common source of ChannelOwner instances are |
| 37 | // ChannelManager::CreateChannel() and ChannelManager::GetChannel(...). |
| 38 | // It has a similar use case to shared_ptr in C++11. Should this move to C++11 |
| 39 | // in the future, this class should be replaced by exactly that. |
| 40 | // |
| 41 | // To access the underlying Channel, use .channel(). |
| 42 | // IsValid() implements a convenience method as an alternative for checking |
| 43 | // whether the underlying pointer is NULL or not. |
| 44 | // |
| 45 | // Channel channel_owner = channel_manager.GetChannel(channel_id); |
| 46 | // if (channel_owner.IsValid()) |
| 47 | // channel_owner.channel()->...; |
| 48 | // |
| 49 | class ChannelOwner { |
| 50 | public: |
| 51 | explicit ChannelOwner(Channel* channel); |
| 52 | ChannelOwner(const ChannelOwner& channel_owner); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 53 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 54 | ~ChannelOwner(); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 55 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 56 | ChannelOwner& operator=(const ChannelOwner& other); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 57 | |
Minyue | 2013aec | 2015-05-13 14:14:42 +0200 | [diff] [blame] | 58 | Channel* channel() const { return channel_ref_->channel.get(); } |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 59 | bool IsValid() { return channel_ref_->channel.get() != NULL; } |
Minyue | 2013aec | 2015-05-13 14:14:42 +0200 | [diff] [blame] | 60 | int use_count() const { return channel_ref_->ref_count.Value(); } |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 61 | private: |
| 62 | // Shared instance of a Channel. Copying ChannelOwners increase the reference |
| 63 | // count and destroying ChannelOwners decrease references. Channels are |
| 64 | // deleted when no references to them are held. |
| 65 | struct ChannelRef { |
| 66 | ChannelRef(Channel* channel); |
kwiberg | b7f89d6 | 2016-02-17 10:04:18 -0800 | [diff] [blame] | 67 | const std::unique_ptr<Channel> channel; |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 68 | Atomic32 ref_count; |
| 69 | }; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 70 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 71 | ChannelRef* channel_ref_; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 72 | }; |
| 73 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 74 | class ChannelManager { |
| 75 | public: |
solenberg | 88499ec | 2016-09-07 07:34:41 -0700 | [diff] [blame] | 76 | ChannelManager(uint32_t instance_id); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 77 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 78 | // Upon construction of an Iterator it will grab a copy of the channel list of |
| 79 | // the ChannelManager. The iteration will then occur over this state, not the |
| 80 | // current one of the ChannelManager. As the Iterator holds its own references |
| 81 | // to the Channels, they will remain valid even if they are removed from the |
| 82 | // ChannelManager. |
| 83 | class Iterator { |
| 84 | public: |
| 85 | explicit Iterator(ChannelManager* channel_manager); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 86 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 87 | Channel* GetChannel(); |
| 88 | bool IsValid(); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 89 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 90 | void Increment(); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 91 | |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 92 | private: |
| 93 | size_t iterator_pos_; |
| 94 | std::vector<ChannelOwner> channels_; |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 95 | |
henrikg | 3c089d7 | 2015-09-16 05:37:44 -0700 | [diff] [blame] | 96 | RTC_DISALLOW_COPY_AND_ASSIGN(Iterator); |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 97 | }; |
| 98 | |
solenberg | 88499ec | 2016-09-07 07:34:41 -0700 | [diff] [blame] | 99 | // CreateChannel will always return a valid ChannelOwner instance. |
| 100 | ChannelOwner CreateChannel(const VoEBase::ChannelConfig& config); |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 101 | |
| 102 | // ChannelOwner.channel() will be NULL if channel_id is invalid or no longer |
| 103 | // exists. This should be checked with ChannelOwner::IsValid(). |
| 104 | ChannelOwner GetChannel(int32_t channel_id); |
| 105 | void GetAllChannels(std::vector<ChannelOwner>* channels); |
| 106 | |
| 107 | void DestroyChannel(int32_t channel_id); |
| 108 | void DestroyAllChannels(); |
| 109 | |
| 110 | size_t NumOfChannels() const; |
| 111 | |
| 112 | private: |
| 113 | uint32_t instance_id_; |
| 114 | |
| 115 | Atomic32 last_channel_id_; |
| 116 | |
pbos | d8de115 | 2016-02-01 09:00:51 -0800 | [diff] [blame] | 117 | rtc::CriticalSection lock_; |
pbos@webrtc.org | 676ff1e | 2013-08-07 17:57:36 +0000 | [diff] [blame] | 118 | std::vector<ChannelOwner> channels_; |
| 119 | |
nisse | 7d59f6b | 2017-02-21 03:40:24 -0800 | [diff] [blame] | 120 | // For generation of random ssrc:s. |
| 121 | webrtc::Random random_; |
| 122 | |
henrikg | 3c089d7 | 2015-09-16 05:37:44 -0700 | [diff] [blame] | 123 | RTC_DISALLOW_COPY_AND_ASSIGN(ChannelManager); |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 124 | }; |
pbos@webrtc.org | d900e8b | 2013-07-03 15:12:26 +0000 | [diff] [blame] | 125 | } // namespace voe |
pbos@webrtc.org | d900e8b | 2013-07-03 15:12:26 +0000 | [diff] [blame] | 126 | } // namespace webrtc |
niklase@google.com | 470e71d | 2011-07-07 08:21:25 +0000 | [diff] [blame] | 127 | |
Mirko Bonadei | 92ea95e | 2017-09-15 06:47:31 +0200 | [diff] [blame] | 128 | #endif // VOICE_ENGINE_CHANNEL_MANAGER_H_ |