blob: af604b74dcf8bd4351ca10a4a07be94dd5fad5fc [file] [log] [blame]
* Copyright (c) 2004 The WebRTC project authors. All Rights Reserved.
* Use of this source code is governed by a BSD-style license
* that can be found in the LICENSE file in the root of the source
* tree. An additional intellectual property rights grant can be found
* in the file PATENTS. All contributing project authors may
* be found in the AUTHORS file in the root of the source tree.
#include <map>
#include <set>
#include <string>
#include <vector>
#include "absl/container/inlined_vector.h"
#include "absl/strings/string_view.h"
#include "absl/types/optional.h"
#include "api/audio_codecs/audio_format.h"
#include "api/rtp_parameters.h"
#include "api/video_codecs/sdp_video_format.h"
#include "media/base/media_constants.h"
#include "rtc_base/system/rtc_export.h"
namespace cricket {
class FeedbackParam {
FeedbackParam() = default;
FeedbackParam(absl::string_view id, const std::string& param)
: id_(id), param_(param) {}
explicit FeedbackParam(absl::string_view id)
: id_(id), param_(kParamValueEmpty) {}
bool operator==(const FeedbackParam& other) const;
bool operator!=(const FeedbackParam& c) const { return !(*this == c); }
const std::string& id() const { return id_; }
const std::string& param() const { return param_; }
std::string id_; // e.g. "nack", "ccm"
std::string param_; // e.g. "", "rpsi", "fir"
class FeedbackParams {
bool operator==(const FeedbackParams& other) const;
bool operator!=(const FeedbackParams& c) const { return !(*this == c); }
bool Has(const FeedbackParam& param) const;
void Add(const FeedbackParam& param);
void Intersect(const FeedbackParams& from);
const std::vector<FeedbackParam>& params() const { return params_; }
bool HasDuplicateEntries() const;
std::vector<FeedbackParam> params_;
struct RTC_EXPORT Codec {
enum class Type {
enum class ResiliencyType {
Type type;
int id;
std::string name;
int clockrate;
// Audio only
// Can be used to override the target bitrate in the encoder.
// TODO(orphis): Remove in favor of alternative APIs
int bitrate;
size_t channels;
// Video only
absl::optional<std::string> packetization;
absl::InlinedVector<webrtc::ScalabilityMode, webrtc::kScalabilityModeCount>
// H.265 only
absl::optional<std::string> tx_mode;
// Non key-value parameters such as the telephone-event "0‐15" are
// represented using an empty string as key, i.e. {"": "0-15"}.
webrtc::CodecParameterMap params;
FeedbackParams feedback_params;
Codec(const Codec& c);
Codec(Codec&& c);
virtual ~Codec();
// Indicates if this codec is compatible with the specified codec by
// checking the assigned id and profile values for the relevant video codecs.
// The rules for this comparison, in particular the parameters are
// codec-specific as described in RFC 3264 6.1:
// For H.264, packetization modes will be compared.
// If H.265 is enabled, TxModes will be compared.
// H.264 (and H.265, if enabled) levels are not compared.
// In all other cases, parameters do not need to match.
// This is used in SDP offer/answer codec matching.
bool Matches(const Codec& codec) const;
// This is an exact match similar to what is described in
// with two differences:
// - rtx which is included in capabilities without the apt parameter
// so number of channels, clock rate or the equality of the parameters
// are not compared.
// - parameters is compared element-wise, not as a string comparison.
// This method should only be used to compare input on our end to something we
// generated, done e.g. by setCodecPreferences or setParameters.
bool MatchesRtpCodec(const webrtc::RtpCodec& capability) const;
// Find the parameter for `name` and write the value to `out`.
bool GetParam(const std::string& name, std::string* out) const;
bool GetParam(const std::string& name, int* out) const;
void SetParam(const std::string& name, const std::string& value);
void SetParam(const std::string& name, int value);
// It is safe to input a non-existent parameter.
// Returns true if the parameter existed, false if it did not exist.
bool RemoveParam(const std::string& name);
bool HasFeedbackParam(const FeedbackParam& param) const;
void AddFeedbackParam(const FeedbackParam& param);
// Filter `this` feedbacks params such that only those shared by both `this`
// and `other` are kept.
void IntersectFeedbackParams(const Codec& other);
virtual webrtc::RtpCodecParameters ToCodecParameters() const;
// The codec represent an actual media codec, and not a resiliency codec.
bool IsMediaCodec() const;
// The codec represent a resiliency codec such as RED, RTX or FEC variants.
bool IsResiliencyCodec() const;
ResiliencyType GetResiliencyType() const;
// Validates a VideoCodec's payload type, dimensions and bitrates etc. If they
// don't make sense (such as max < min bitrate), and error is logged and
// ValidateCodecFormat returns false.
bool ValidateCodecFormat() const;
std::string ToString() const;
Codec& operator=(const Codec& c);
Codec& operator=(Codec&& c);
bool operator==(const Codec& c) const;
bool operator!=(const Codec& c) const { return !(*this == c); }
// Creates an empty codec.
explicit Codec(Type type);
// Creates a codec with the given parameters.
Codec(Type type, int id, const std::string& name, int clockrate);
Codec(Type type,
int id,
const std::string& name,
int clockrate,
size_t channels);
explicit Codec(const webrtc::SdpAudioFormat& c);
explicit Codec(const webrtc::SdpVideoFormat& c);
friend Codec CreateAudioCodec(int id,
const std::string& name,
int clockrate,
size_t channels);
friend Codec CreateAudioCodec(const webrtc::SdpAudioFormat& c);
friend Codec CreateAudioRtxCodec(int rtx_payload_type,
int associated_payload_type);
friend Codec CreateVideoCodec(int id, const std::string& name);
friend Codec CreateVideoCodec(const webrtc::SdpVideoFormat& c);
friend Codec CreateVideoRtxCodec(int rtx_payload_type,
int associated_payload_type);
// TODO(webrtc:15214): Compatibility names, to be migrated away and removed.
using VideoCodec = Codec;
using AudioCodec = Codec;
using VideoCodecs = std::vector<Codec>;
using AudioCodecs = std::vector<Codec>;
Codec CreateAudioCodec(int id,
const std::string& name,
int clockrate,
size_t channels);
Codec CreateAudioCodec(const webrtc::SdpAudioFormat& c);
Codec CreateAudioRtxCodec(int rtx_payload_type, int associated_payload_type);
Codec CreateVideoCodec(const std::string& name);
Codec CreateVideoCodec(int id, const std::string& name);
Codec CreateVideoCodec(const webrtc::SdpVideoFormat& c);
Codec CreateVideoRtxCodec(int rtx_payload_type, int associated_payload_type);
// Get the codec setting associated with `payload_type`. If there
// is no codec associated with that payload type it returns nullptr.
const Codec* FindCodecById(const std::vector<Codec>& codecs, int payload_type);
bool HasLntf(const Codec& codec);
bool HasNack(const Codec& codec);
bool HasRemb(const Codec& codec);
bool HasRrtr(const Codec& codec);
bool HasTransportCc(const Codec& codec);
// Returns the first codec in `supported_codecs` that matches `codec`, or
// nullptr if no codec matches.
const Codec* FindMatchingVideoCodec(const std::vector<Codec>& supported_codecs,
const Codec& codec);
// Returns all codecs in `supported_codecs` that matches `codec`.
std::vector<const Codec*> FindAllMatchingCodecs(
const std::vector<Codec>& supported_codecs,
const Codec& codec);
RTC_EXPORT void AddH264ConstrainedBaselineProfileToSupportedFormats(
std::vector<webrtc::SdpVideoFormat>* supported_formats);
} // namespace cricket