blob: 8cf20191357ba70d0100b4ccf769fd7c303a861d [file] [log] [blame]
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +00001/*
2 * Copyright (c) 2012 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 Bonadei92ea95e2017-09-15 06:47:31 +020011#ifndef MODULES_AUDIO_CODING_NETEQ_DECODER_DATABASE_H_
12#define MODULES_AUDIO_CODING_NETEQ_DECODER_DATABASE_H_
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000013
14#include <map>
kwiberg84be5112016-04-27 01:19:58 -070015#include <memory>
henrik.lundin4cf61dd2015-12-09 06:20:58 -080016#include <string>
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000017
Ali Tofigh714e3cb2022-07-20 12:53:07 +020018#include "absl/strings/string_view.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020019#include "api/audio_codecs/audio_decoder_factory.h"
20#include "api/audio_codecs/audio_format.h"
Mirko Bonadeid9708072019-01-25 20:26:48 +010021#include "api/scoped_refptr.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020022#include "modules/audio_coding/codecs/cng/webrtc_cng.h"
Mirko Bonadei92ea95e2017-09-15 06:47:31 +020023#include "modules/audio_coding/neteq/packet.h"
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000024
25namespace webrtc {
26
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000027class DecoderDatabase {
28 public:
29 enum DatabaseReturnCodes {
30 kOK = 0,
31 kInvalidRtpPayloadType = -1,
32 kCodecNotSupported = -2,
33 kInvalidSampleRate = -3,
34 kDecoderExists = -4,
35 kDecoderNotFound = -5,
36 kInvalidPointer = -6
37 };
38
kwiberg0fa0a972016-04-19 05:03:45 -070039 // Class that stores decoder info in the database.
40 class DecoderInfo {
41 public:
kwiberge9413062016-11-03 05:29:05 -070042 DecoderInfo(const SdpAudioFormat& audio_format,
Danil Chapovalovb6021232018-06-19 13:26:36 +020043 absl::optional<AudioCodecPairId> codec_pair_id,
kwiberge9413062016-11-03 05:29:05 -070044 AudioDecoderFactory* factory,
Ali Tofigh714e3cb2022-07-20 12:53:07 +020045 absl::string_view codec_name);
ossuf1b08da2016-09-23 02:19:43 -070046 explicit DecoderInfo(const SdpAudioFormat& audio_format,
Danil Chapovalovb6021232018-06-19 13:26:36 +020047 absl::optional<AudioCodecPairId> codec_pair_id,
ossuf1b08da2016-09-23 02:19:43 -070048 AudioDecoderFactory* factory = nullptr);
kwiberg0fa0a972016-04-19 05:03:45 -070049 DecoderInfo(DecoderInfo&&);
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +000050 ~DecoderInfo();
51
kwiberg0fa0a972016-04-19 05:03:45 -070052 // Get the AudioDecoder object, creating it first if necessary.
ossu84bc9852016-08-26 05:41:23 -070053 AudioDecoder* GetDecoder() const;
kwiberg0fa0a972016-04-19 05:03:45 -070054
55 // Delete the AudioDecoder object, unless it's external. (This means we can
56 // always recreate it later if we need it.)
ossu84bc9852016-08-26 05:41:23 -070057 void DropDecoder() const { decoder_.reset(); }
kwiberg0fa0a972016-04-19 05:03:45 -070058
kwibergc0f2dcf2016-05-31 06:28:03 -070059 int SampleRateHz() const {
solenberg2779bab2016-11-17 04:45:19 -080060 if (IsDtmf()) {
61 // DTMF has a 1:1 mapping between clock rate and sample rate.
62 return audio_format_.clockrate_hz;
63 }
ossu09f15602016-08-29 03:59:05 -070064 const AudioDecoder* decoder = GetDecoder();
65 RTC_DCHECK_EQ(1, !!decoder + !!cng_decoder_);
66 return decoder ? decoder->SampleRateHz() : cng_decoder_->sample_rate_hz;
67 }
68
ossuf1b08da2016-09-23 02:19:43 -070069 const SdpAudioFormat& GetFormat() const { return audio_format_; }
kwibergc0f2dcf2016-05-31 06:28:03 -070070
ossuf1b08da2016-09-23 02:19:43 -070071 // Returns true if the decoder's format is comfort noise.
ossu9f38c212016-10-04 05:23:32 -070072 bool IsComfortNoise() const {
73 RTC_DCHECK_EQ(!!cng_decoder_, subtype_ == Subtype::kComfortNoise);
74 return subtype_ == Subtype::kComfortNoise;
75 }
ossu84bc9852016-08-26 05:41:23 -070076
ossuf1b08da2016-09-23 02:19:43 -070077 // Returns true if the decoder's format is DTMF.
Yves Gerey665174f2018-06-19 15:03:05 +020078 bool IsDtmf() const { return subtype_ == Subtype::kDtmf; }
ossu84bc9852016-08-26 05:41:23 -070079
ossuf1b08da2016-09-23 02:19:43 -070080 // Returns true if the decoder's format is RED.
Yves Gerey665174f2018-06-19 15:03:05 +020081 bool IsRed() const { return subtype_ == Subtype::kRed; }
ossu84bc9852016-08-26 05:41:23 -070082
Artem Titovd00ce742021-07-28 20:00:17 +020083 // Returns true if the decoder's format is named `name`.
Ali Tofigh714e3cb2022-07-20 12:53:07 +020084 bool IsType(absl::string_view name) const;
ossuf1b08da2016-09-23 02:19:43 -070085
kwiberge9413062016-11-03 05:29:05 -070086 const std::string& get_name() const { return name_; }
kwiberg0fa0a972016-04-19 05:03:45 -070087
88 private:
Artem Titovd00ce742021-07-28 20:00:17 +020089 // TODO(ossu): `name_` is kept here while we retain the old external
kwiberge9413062016-11-03 05:29:05 -070090 // decoder interface. Remove this once using an
91 // AudioDecoderFactory has supplanted the old functionality.
92 const std::string name_;
93
ossuf1b08da2016-09-23 02:19:43 -070094 const SdpAudioFormat audio_format_;
Danil Chapovalovb6021232018-06-19 13:26:36 +020095 const absl::optional<AudioCodecPairId> codec_pair_id_;
ossuf1b08da2016-09-23 02:19:43 -070096 AudioDecoderFactory* const factory_;
ossu84bc9852016-08-26 05:41:23 -070097 mutable std::unique_ptr<AudioDecoder> decoder_;
kwibergc0f2dcf2016-05-31 06:28:03 -070098
kwibergc0f2dcf2016-05-31 06:28:03 -070099 // Set iff this is a comfort noise decoder.
100 struct CngDecoder {
Danil Chapovalovb6021232018-06-19 13:26:36 +0200101 static absl::optional<CngDecoder> Create(const SdpAudioFormat& format);
kwibergc0f2dcf2016-05-31 06:28:03 -0700102 int sample_rate_hz;
103 };
Danil Chapovalovb6021232018-06-19 13:26:36 +0200104 const absl::optional<CngDecoder> cng_decoder_;
ossu9f38c212016-10-04 05:23:32 -0700105
Yves Gerey665174f2018-06-19 15:03:05 +0200106 enum class Subtype : int8_t { kNormal, kComfortNoise, kDtmf, kRed };
ossu9f38c212016-10-04 05:23:32 -0700107
108 static Subtype SubtypeFromFormat(const SdpAudioFormat& format);
109
110 const Subtype subtype_;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000111 };
112
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000113 // Maximum value for 8 bits, and an invalid RTP payload type (since it is
114 // only 7 bits).
115 static const uint8_t kRtpPayloadTypeError = 0xFF;
116
ossue725f7c2016-05-19 10:48:04 -0700117 DecoderDatabase(
Karl Wiberg08126342018-03-20 19:18:55 +0100118 const rtc::scoped_refptr<AudioDecoderFactory>& decoder_factory,
Danil Chapovalovb6021232018-06-19 13:26:36 +0200119 absl::optional<AudioCodecPairId> codec_pair_id);
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000120
pbos@webrtc.org2d1a55c2013-07-31 15:54:00 +0000121 virtual ~DecoderDatabase();
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000122
Byoungchan Lee604fd2f2022-01-21 09:49:39 +0900123 DecoderDatabase(const DecoderDatabase&) = delete;
124 DecoderDatabase& operator=(const DecoderDatabase&) = delete;
125
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000126 // Returns true if the database is empty.
pbos@webrtc.org2d1a55c2013-07-31 15:54:00 +0000127 virtual bool Empty() const;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000128
129 // Returns the number of decoders registered in the database.
pbos@webrtc.org2d1a55c2013-07-31 15:54:00 +0000130 virtual int Size() const;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000131
kwiberg1c07c702017-03-27 07:15:49 -0700132 // Replaces the existing set of decoders with the given set. Returns the
133 // payload types that were reassigned or removed while doing so.
134 virtual std::vector<int> SetCodecs(
135 const std::map<int, SdpAudioFormat>& codecs);
136
kwiberg5adaf732016-10-04 09:33:27 -0700137 // Registers a decoder for the given payload type. Returns kOK on success;
138 // otherwise an error code.
139 virtual int RegisterPayload(int rtp_payload_type,
140 const SdpAudioFormat& audio_format);
141
Artem Titovd00ce742021-07-28 20:00:17 +0200142 // Removes the entry for `rtp_payload_type` from the database.
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000143 // Returns kDecoderNotFound or kOK depending on the outcome of the operation.
144 virtual int Remove(uint8_t rtp_payload_type);
145
kwiberg6b19b562016-09-20 04:02:25 -0700146 // Remove all entries.
147 virtual void RemoveAll();
148
Artem Titovd00ce742021-07-28 20:00:17 +0200149 // Returns a pointer to the DecoderInfo struct for `rtp_payload_type`. If
150 // no decoder is registered with that `rtp_payload_type`, NULL is returned.
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000151 virtual const DecoderInfo* GetDecoderInfo(uint8_t rtp_payload_type) const;
152
Artem Titovd00ce742021-07-28 20:00:17 +0200153 // Sets the active decoder to be `rtp_payload_type`. If this call results in a
154 // change of active decoder, `new_decoder` is set to true. The previous active
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000155 // decoder's AudioDecoder object is deleted.
156 virtual int SetActiveDecoder(uint8_t rtp_payload_type, bool* new_decoder);
157
158 // Returns the current active decoder, or NULL if no active decoder exists.
ossu84bc9852016-08-26 05:41:23 -0700159 virtual AudioDecoder* GetActiveDecoder() const;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000160
Artem Titovd00ce742021-07-28 20:00:17 +0200161 // Sets the active comfort noise decoder to be `rtp_payload_type`. If this
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000162 // call results in a change of active comfort noise decoder, the previous
163 // active decoder's AudioDecoder object is deleted.
164 virtual int SetActiveCngDecoder(uint8_t rtp_payload_type);
165
166 // Returns the current active comfort noise decoder, or NULL if no active
167 // comfort noise decoder exists.
ossu84bc9852016-08-26 05:41:23 -0700168 virtual ComfortNoiseDecoder* GetActiveCngDecoder() const;
169
170 // The following are utility methods: they will look up DecoderInfo through
171 // GetDecoderInfo and call the respective method on that info object, if it
172 // exists.
173
174 // Returns a pointer to the AudioDecoder object associated with
Artem Titovd00ce742021-07-28 20:00:17 +0200175 // `rtp_payload_type`, or NULL if none is registered. If the AudioDecoder
ossu84bc9852016-08-26 05:41:23 -0700176 // object does not exist for that decoder, the object is created.
177 AudioDecoder* GetDecoder(uint8_t rtp_payload_type) const;
178
Artem Titovd00ce742021-07-28 20:00:17 +0200179 // Returns true if `rtp_payload_type` is registered as comfort noise.
ossu84bc9852016-08-26 05:41:23 -0700180 bool IsComfortNoise(uint8_t rtp_payload_type) const;
181
Artem Titovd00ce742021-07-28 20:00:17 +0200182 // Returns true if `rtp_payload_type` is registered as DTMF.
ossu84bc9852016-08-26 05:41:23 -0700183 bool IsDtmf(uint8_t rtp_payload_type) const;
184
Artem Titovd00ce742021-07-28 20:00:17 +0200185 // Returns true if `rtp_payload_type` is registered as RED.
ossu84bc9852016-08-26 05:41:23 -0700186 bool IsRed(uint8_t rtp_payload_type) const;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000187
Artem Titovd00ce742021-07-28 20:00:17 +0200188 // Returns kOK if all packets in `packet_list` carry payload types that are
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000189 // registered in the database. Otherwise, returns kDecoderNotFound.
ossu84bc9852016-08-26 05:41:23 -0700190 int CheckPayloadTypes(const PacketList& packet_list) const;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000191
192 private:
193 typedef std::map<uint8_t, DecoderInfo> DecoderMap;
194
195 DecoderMap decoders_;
ossu97ba30e2016-04-25 07:55:58 -0700196 int active_decoder_type_;
197 int active_cng_decoder_type_;
ossu84bc9852016-08-26 05:41:23 -0700198 mutable std::unique_ptr<ComfortNoiseDecoder> active_cng_decoder_;
ossue725f7c2016-05-19 10:48:04 -0700199 rtc::scoped_refptr<AudioDecoderFactory> decoder_factory_;
Danil Chapovalovb6021232018-06-19 13:26:36 +0200200 const absl::optional<AudioCodecPairId> codec_pair_id_;
henrik.lundin@webrtc.orgd94659d2013-01-29 12:09:21 +0000201};
202
203} // namespace webrtc
Mirko Bonadei92ea95e2017-09-15 06:47:31 +0200204#endif // MODULES_AUDIO_CODING_NETEQ_DECODER_DATABASE_H_