blob: 85b4327bb5cb61dd7ef67fbc868ea39c8905b63c [file] [log] [blame]
henrike@webrtc.org28e20752013-07-10 00:45:36 +00001/*
kjellander1afca732016-02-07 20:46:45 -08002 * Copyright (c) 2004 The WebRTC project authors. All Rights Reserved.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00003 *
kjellander1afca732016-02-07 20:46:45 -08004 * 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.
henrike@webrtc.org28e20752013-07-10 00:45:36 +00009 */
10
kjellandera96e2d72016-02-04 23:52:28 -080011#ifndef WEBRTC_MEDIA_BASE_CODEC_H_
12#define WEBRTC_MEDIA_BASE_CODEC_H_
henrike@webrtc.org28e20752013-07-10 00:45:36 +000013
14#include <map>
15#include <set>
16#include <string>
17#include <vector>
18
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -070019#include "webrtc/api/rtpparameters.h"
magjed1e45cc62016-10-28 07:43:45 -070020#include "webrtc/common_types.h"
kjellanderf4752772016-03-02 05:42:30 -080021#include "webrtc/media/base/mediaconstants.h"
henrike@webrtc.org28e20752013-07-10 00:45:36 +000022
23namespace cricket {
24
25typedef std::map<std::string, std::string> CodecParameterMap;
26
27class FeedbackParam {
28 public:
29 FeedbackParam(const std::string& id, const std::string& param)
30 : id_(id),
31 param_(param) {
32 }
wu@webrtc.org91053e72013-08-10 07:18:04 +000033 explicit FeedbackParam(const std::string& id)
34 : id_(id),
35 param_(kParamValueEmpty) {
36 }
henrike@webrtc.org28e20752013-07-10 00:45:36 +000037 bool operator==(const FeedbackParam& other) const;
38
39 const std::string& id() const { return id_; }
40 const std::string& param() const { return param_; }
41
42 private:
43 std::string id_; // e.g. "nack", "ccm"
44 std::string param_; // e.g. "", "rpsi", "fir"
45};
46
47class FeedbackParams {
48 public:
49 bool operator==(const FeedbackParams& other) const;
50
51 bool Has(const FeedbackParam& param) const;
52 void Add(const FeedbackParam& param);
53
54 void Intersect(const FeedbackParams& from);
55
56 const std::vector<FeedbackParam>& params() const { return params_; }
57 private:
58 bool HasDuplicateEntries() const;
59
60 std::vector<FeedbackParam> params_;
61};
62
63struct Codec {
64 int id;
65 std::string name;
66 int clockrate;
henrike@webrtc.org28e20752013-07-10 00:45:36 +000067 CodecParameterMap params;
68 FeedbackParams feedback_params;
69
70 // Creates a codec with the given parameters.
deadbeef67cf2c12016-04-13 10:07:16 -070071 Codec(int id, const std::string& name, int clockrate);
henrike@webrtc.org28e20752013-07-10 00:45:36 +000072 // Creates an empty codec.
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +000073 Codec();
74 Codec(const Codec& c);
magjed3663c522016-11-07 10:14:36 -080075 Codec(Codec&& c);
Henrik Kjellander3fe372d2016-05-12 08:10:52 +020076 virtual ~Codec();
henrike@webrtc.org28e20752013-07-10 00:45:36 +000077
78 // Indicates if this codec is compatible with the specified codec.
79 bool Matches(const Codec& codec) const;
80
81 // Find the parameter for |name| and write the value to |out|.
82 bool GetParam(const std::string& name, std::string* out) const;
83 bool GetParam(const std::string& name, int* out) const;
84
85 void SetParam(const std::string& name, const std::string& value);
86 void SetParam(const std::string& name, int value);
87
buildbot@webrtc.orgfbd13282014-06-19 19:50:55 +000088 // It is safe to input a non-existent parameter.
89 // Returns true if the parameter existed, false if it did not exist.
90 bool RemoveParam(const std::string& name);
91
henrike@webrtc.org28e20752013-07-10 00:45:36 +000092 bool HasFeedbackParam(const FeedbackParam& param) const;
93 void AddFeedbackParam(const FeedbackParam& param);
94
henrike@webrtc.org28e20752013-07-10 00:45:36 +000095 // Filter |this| feedbacks params such that only those shared by both |this|
96 // and |other| are kept.
97 void IntersectFeedbackParams(const Codec& other);
98
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -070099 virtual webrtc::RtpCodecParameters ToCodecParameters() const;
100
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000101 Codec& operator=(const Codec& c);
magjed3663c522016-11-07 10:14:36 -0800102 Codec& operator=(Codec&& c);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000103
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000104 bool operator==(const Codec& c) const;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000105
106 bool operator!=(const Codec& c) const {
107 return !(*this == c);
108 }
109};
110
111struct AudioCodec : public Codec {
112 int bitrate;
Peter Kasting69558702016-01-12 16:26:35 -0800113 size_t channels;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000114
115 // Creates a codec with the given parameters.
pkasting25702cb2016-01-08 13:50:27 -0800116 AudioCodec(int id,
117 const std::string& name,
118 int clockrate,
119 int bitrate,
deadbeef67cf2c12016-04-13 10:07:16 -0700120 size_t channels);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000121 // Creates an empty codec.
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000122 AudioCodec();
123 AudioCodec(const AudioCodec& c);
magjed3663c522016-11-07 10:14:36 -0800124 AudioCodec(AudioCodec&& c);
Henrik Kjellander3fe372d2016-05-12 08:10:52 +0200125 virtual ~AudioCodec() = default;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000126
127 // Indicates if this codec is compatible with the specified codec.
128 bool Matches(const AudioCodec& codec) const;
129
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000130 std::string ToString() const;
131
Taylor Brandstetter0cd086b2016-04-20 16:23:10 -0700132 webrtc::RtpCodecParameters ToCodecParameters() const override;
133
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000134 AudioCodec& operator=(const AudioCodec& c);
magjed3663c522016-11-07 10:14:36 -0800135 AudioCodec& operator=(AudioCodec&& c);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000136
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000137 bool operator==(const AudioCodec& c) const;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000138
139 bool operator!=(const AudioCodec& c) const {
140 return !(*this == c);
141 }
142};
143
144struct VideoCodec : public Codec {
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000145 // Creates a codec with the given parameters.
pkasting25702cb2016-01-08 13:50:27 -0800146 VideoCodec(int id, const std::string& name);
magjed1e45cc62016-10-28 07:43:45 -0700147 // Creates a codec with the given name and empty id.
148 explicit VideoCodec(const std::string& name);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000149 // Creates an empty codec.
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000150 VideoCodec();
151 VideoCodec(const VideoCodec& c);
magjed3663c522016-11-07 10:14:36 -0800152 VideoCodec(VideoCodec&& c);
Henrik Kjellander3fe372d2016-05-12 08:10:52 +0200153 virtual ~VideoCodec() = default;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000154
magjedf823ede2016-11-12 09:53:04 -0800155 // Indicates if this video codec is the same as the other video codec, e.g. if
156 // they are both VP8 or VP9, or if they are both H264 with the same H264
157 // profile. H264 levels however are not compared.
158 bool Matches(const VideoCodec& codec) const;
159
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000160 std::string ToString() const;
161
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000162 VideoCodec& operator=(const VideoCodec& c);
magjed3663c522016-11-07 10:14:36 -0800163 VideoCodec& operator=(VideoCodec&& c);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000164
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000165 bool operator==(const VideoCodec& c) const;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000166
167 bool operator!=(const VideoCodec& c) const {
168 return !(*this == c);
169 }
pbos@webrtc.orgb5a22b12014-05-13 11:07:01 +0000170
171 static VideoCodec CreateRtxCodec(int rtx_payload_type,
172 int associated_payload_type);
173
174 enum CodecType {
175 CODEC_VIDEO,
176 CODEC_RED,
177 CODEC_ULPFEC,
brandtr87d7d772016-11-07 03:03:41 -0800178 CODEC_FLEXFEC,
pbos@webrtc.orgb5a22b12014-05-13 11:07:01 +0000179 CODEC_RTX,
180 };
181
182 CodecType GetCodecType() const;
183 // Validates a VideoCodec's payload type, dimensions and bitrates etc. If they
184 // don't make sense (such as max < min bitrate), and error is logged and
185 // ValidateCodecFormat returns false.
186 bool ValidateCodecFormat() const;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000187};
188
189struct DataCodec : public Codec {
deadbeef67cf2c12016-04-13 10:07:16 -0700190 DataCodec(int id, const std::string& name);
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000191 DataCodec();
192 DataCodec(const DataCodec& c);
magjed3663c522016-11-07 10:14:36 -0800193 DataCodec(DataCodec&& c);
Henrik Kjellander3fe372d2016-05-12 08:10:52 +0200194 virtual ~DataCodec() = default;
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000195
guoweis@webrtc.orgbc6961f2015-02-19 17:55:18 +0000196 DataCodec& operator=(const DataCodec& c);
magjed3663c522016-11-07 10:14:36 -0800197 DataCodec& operator=(DataCodec&& c);
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000198
199 std::string ToString() const;
200};
201
changbin.shao@webrtc.org2d25b442015-03-16 04:14:34 +0000202// Get the codec setting associated with |payload_type|. If there
magjedb05fa242016-11-11 04:00:16 -0800203// is no codec associated with that payload type it returns nullptr.
changbin.shao@webrtc.org2d25b442015-03-16 04:14:34 +0000204template <class Codec>
magjedb05fa242016-11-11 04:00:16 -0800205const Codec* FindCodecById(const std::vector<Codec>& codecs, int payload_type) {
changbin.shao@webrtc.org2d25b442015-03-16 04:14:34 +0000206 for (const auto& codec : codecs) {
magjedb05fa242016-11-11 04:00:16 -0800207 if (codec.id == payload_type)
208 return &codec;
changbin.shao@webrtc.org2d25b442015-03-16 04:14:34 +0000209 }
magjedb05fa242016-11-11 04:00:16 -0800210 return nullptr;
changbin.shao@webrtc.org2d25b442015-03-16 04:14:34 +0000211}
212
Shao Changbine62202f2015-04-21 20:24:50 +0800213bool CodecNamesEq(const std::string& name1, const std::string& name2);
magjed1e45cc62016-10-28 07:43:45 -0700214bool CodecNamesEq(const char* name1, const char* name2);
stefanba4c0e42016-02-04 04:12:24 -0800215bool HasNack(const Codec& codec);
216bool HasRemb(const Codec& codec);
217bool HasTransportCc(const Codec& codec);
magjedf823ede2016-11-12 09:53:04 -0800218// Returns the first codec in |supported_codecs| that matches |codec|, or
219// nullptr if no codec matches.
220const VideoCodec* FindMatchingCodec(
221 const std::vector<VideoCodec>& supported_codecs,
222 const VideoCodec& codec);
Shao Changbine62202f2015-04-21 20:24:50 +0800223
henrike@webrtc.org28e20752013-07-10 00:45:36 +0000224} // namespace cricket
225
kjellandera96e2d72016-02-04 23:52:28 -0800226#endif // WEBRTC_MEDIA_BASE_CODEC_H_