xref: /aosp_15_r20/external/webrtc/api/transport/bitrate_settings.h (revision d9f758449e529ab9291ac668be2861e7a55c2422)
1 /*
2  *  Copyright (c) 2018 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 API_TRANSPORT_BITRATE_SETTINGS_H_
12 #define API_TRANSPORT_BITRATE_SETTINGS_H_
13 
14 #include <algorithm>
15 
16 #include "absl/types/optional.h"
17 #include "rtc_base/system/rtc_export.h"
18 
19 namespace webrtc {
20 
21 // Configuration of send bitrate. The `start_bitrate_bps` value is
22 // used for multiple purposes, both as a prior in the bandwidth
23 // estimator, and for initial configuration of the encoder. We may
24 // want to create separate apis for those, and use a smaller struct
25 // with only the min and max constraints.
26 struct RTC_EXPORT BitrateSettings {
27   BitrateSettings();
28   ~BitrateSettings();
29   BitrateSettings(const BitrateSettings&);
30   // 0 <= min <= start <= max should hold for set parameters.
31   absl::optional<int> min_bitrate_bps;
32   absl::optional<int> start_bitrate_bps;
33   absl::optional<int> max_bitrate_bps;
34 };
35 
36 // TODO(srte): BitrateConstraints and BitrateSettings should be merged.
37 // Both represent the same kind data, but are using different default
38 // initializer and representation of unset values.
39 struct BitrateConstraints {
40   int min_bitrate_bps = 0;
41   int start_bitrate_bps = kDefaultStartBitrateBps;
42   int max_bitrate_bps = -1;
43 
44  private:
45   static constexpr int kDefaultStartBitrateBps = 300000;
46 };
47 
48 }  // namespace webrtc
49 
50 #endif  // API_TRANSPORT_BITRATE_SETTINGS_H_
51