From e482ff8f7087dfad60906491c6a89fdde1bd3443 Mon Sep 17 00:00:00 2001 From: Karl Wiberg Date: Thu, 18 Oct 2018 22:29:39 +0200 Subject: [PATCH] Audio codecs API: Remove some weasel words in the docs These things are no longer brand new, so it makes even less sense than it once did to warn users that they may change at any time. Bug: none Change-Id: I43a6915d9e00fbfef30fdb89869873b129297c8d No-Try: true Reviewed-on: https://webrtc-review.googlesource.com/c/106980 Reviewed-by: Fredrik Solenberg Commit-Queue: Karl Wiberg Cr-Commit-Position: refs/heads/master@{#25283} --- api/audio_codecs/L16/audio_decoder_L16.h | 2 -- api/audio_codecs/L16/audio_encoder_L16.h | 2 -- api/audio_codecs/audio_decoder_factory.h | 1 - api/audio_codecs/audio_decoder_factory_template.h | 2 -- api/audio_codecs/audio_encoder_factory.h | 1 - api/audio_codecs/audio_encoder_factory_template.h | 2 -- api/audio_codecs/audio_format.h | 1 - api/audio_codecs/builtin_audio_decoder_factory.h | 1 - api/audio_codecs/builtin_audio_encoder_factory.h | 1 - api/audio_codecs/g711/audio_decoder_g711.h | 2 -- api/audio_codecs/g711/audio_encoder_g711.h | 2 -- api/audio_codecs/g722/audio_decoder_g722.h | 2 -- api/audio_codecs/g722/audio_encoder_g722.h | 2 -- api/audio_codecs/g722/audio_encoder_g722_config.h | 1 - api/audio_codecs/ilbc/audio_decoder_ilbc.h | 2 -- api/audio_codecs/ilbc/audio_encoder_ilbc.h | 2 -- api/audio_codecs/ilbc/audio_encoder_ilbc_config.h | 1 - api/audio_codecs/isac/audio_decoder_isac_fix.h | 2 -- api/audio_codecs/isac/audio_decoder_isac_float.h | 2 -- api/audio_codecs/isac/audio_encoder_isac_fix.h | 2 -- api/audio_codecs/isac/audio_encoder_isac_float.h | 2 -- api/audio_codecs/opus/audio_decoder_opus.h | 2 -- api/audio_codecs/opus/audio_encoder_opus.h | 2 -- api/audio_codecs/opus/audio_encoder_opus_config.h | 1 - 24 files changed, 40 deletions(-) diff --git a/api/audio_codecs/L16/audio_decoder_L16.h b/api/audio_codecs/L16/audio_decoder_L16.h index b38627dcc3..f0be03659c 100644 --- a/api/audio_codecs/L16/audio_decoder_L16.h +++ b/api/audio_codecs/L16/audio_decoder_L16.h @@ -24,8 +24,6 @@ namespace webrtc { // L16 decoder API for use as a template parameter to // CreateAudioDecoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioDecoderL16 { struct Config { bool IsOk() const { diff --git a/api/audio_codecs/L16/audio_encoder_L16.h b/api/audio_codecs/L16/audio_encoder_L16.h index eef4da6cc3..b410286802 100644 --- a/api/audio_codecs/L16/audio_encoder_L16.h +++ b/api/audio_codecs/L16/audio_encoder_L16.h @@ -24,8 +24,6 @@ namespace webrtc { // L16 encoder API for use as a template parameter to // CreateAudioEncoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioEncoderL16 { struct Config { bool IsOk() const { diff --git a/api/audio_codecs/audio_decoder_factory.h b/api/audio_codecs/audio_decoder_factory.h index 90f93f0cd5..55e197a14a 100644 --- a/api/audio_codecs/audio_decoder_factory.h +++ b/api/audio_codecs/audio_decoder_factory.h @@ -23,7 +23,6 @@ namespace webrtc { // A factory that creates AudioDecoders. -// NOTE: This class is still under development and may change without notice. class AudioDecoderFactory : public rtc::RefCountInterface { public: virtual std::vector GetSupportedDecoders() = 0; diff --git a/api/audio_codecs/audio_decoder_factory_template.h b/api/audio_codecs/audio_decoder_factory_template.h index cdbe8bde7a..22bb7de472 100644 --- a/api/audio_codecs/audio_decoder_factory_template.h +++ b/api/audio_codecs/audio_decoder_factory_template.h @@ -112,8 +112,6 @@ class AudioDecoderFactoryT : public AudioDecoderFactory { // decoder types in the order they were specified in the template argument // list, stopping at the first one that claims to be able to do the job. // -// NOTE: This function is still under development and may change without notice. -// // TODO(kwiberg): Point at CreateBuiltinAudioDecoderFactory() for an example of // how it is used. template diff --git a/api/audio_codecs/audio_encoder_factory.h b/api/audio_codecs/audio_encoder_factory.h index fb4e23ffe7..b290967c78 100644 --- a/api/audio_codecs/audio_encoder_factory.h +++ b/api/audio_codecs/audio_encoder_factory.h @@ -23,7 +23,6 @@ namespace webrtc { // A factory that creates AudioEncoders. -// NOTE: This class is still under development and may change without notice. class AudioEncoderFactory : public rtc::RefCountInterface { public: // Returns a prioritized list of audio codecs, to use for signaling etc. diff --git a/api/audio_codecs/audio_encoder_factory_template.h b/api/audio_codecs/audio_encoder_factory_template.h index 376b39e4c6..2088619019 100644 --- a/api/audio_codecs/audio_encoder_factory_template.h +++ b/api/audio_codecs/audio_encoder_factory_template.h @@ -131,8 +131,6 @@ class AudioEncoderFactoryT : public AudioEncoderFactory { // encoders in the order they were specified in the template argument list, // stopping at the first one that claims to be able to do the job. // -// NOTE: This function is still under development and may change without notice. -// // TODO(kwiberg): Point at CreateBuiltinAudioEncoderFactory() for an example of // how it is used. template diff --git a/api/audio_codecs/audio_format.h b/api/audio_codecs/audio_format.h index 5c370052b8..7748812051 100644 --- a/api/audio_codecs/audio_format.h +++ b/api/audio_codecs/audio_format.h @@ -20,7 +20,6 @@ namespace webrtc { // SDP specification for a single audio codec. -// NOTE: This class is still under development and may change without notice. struct SdpAudioFormat { using Parameters = std::map; diff --git a/api/audio_codecs/builtin_audio_decoder_factory.h b/api/audio_codecs/builtin_audio_decoder_factory.h index 3127403e24..3accd4a302 100644 --- a/api/audio_codecs/builtin_audio_decoder_factory.h +++ b/api/audio_codecs/builtin_audio_decoder_factory.h @@ -17,7 +17,6 @@ namespace webrtc { // Creates a new factory that can create the built-in types of audio decoders. -// NOTE: This function is still under development and may change without notice. rtc::scoped_refptr CreateBuiltinAudioDecoderFactory(); } // namespace webrtc diff --git a/api/audio_codecs/builtin_audio_encoder_factory.h b/api/audio_codecs/builtin_audio_encoder_factory.h index d37ff257e6..3c67dd30e6 100644 --- a/api/audio_codecs/builtin_audio_encoder_factory.h +++ b/api/audio_codecs/builtin_audio_encoder_factory.h @@ -17,7 +17,6 @@ namespace webrtc { // Creates a new factory that can create the built-in types of audio encoders. -// NOTE: This function is still under development and may change without notice. rtc::scoped_refptr CreateBuiltinAudioEncoderFactory(); } // namespace webrtc diff --git a/api/audio_codecs/g711/audio_decoder_g711.h b/api/audio_codecs/g711/audio_decoder_g711.h index 0c67e5e3ef..ccd1ee0480 100644 --- a/api/audio_codecs/g711/audio_decoder_g711.h +++ b/api/audio_codecs/g711/audio_decoder_g711.h @@ -24,8 +24,6 @@ namespace webrtc { // G711 decoder API for use as a template parameter to // CreateAudioDecoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioDecoderG711 { struct Config { enum class Type { kPcmU, kPcmA }; diff --git a/api/audio_codecs/g711/audio_encoder_g711.h b/api/audio_codecs/g711/audio_encoder_g711.h index 8dbc881f08..23ae18b5e3 100644 --- a/api/audio_codecs/g711/audio_encoder_g711.h +++ b/api/audio_codecs/g711/audio_encoder_g711.h @@ -24,8 +24,6 @@ namespace webrtc { // G711 encoder API for use as a template parameter to // CreateAudioEncoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioEncoderG711 { struct Config { enum class Type { kPcmU, kPcmA }; diff --git a/api/audio_codecs/g722/audio_decoder_g722.h b/api/audio_codecs/g722/audio_decoder_g722.h index 7601b3cf1a..2a674926db 100644 --- a/api/audio_codecs/g722/audio_decoder_g722.h +++ b/api/audio_codecs/g722/audio_decoder_g722.h @@ -24,8 +24,6 @@ namespace webrtc { // G722 decoder API for use as a template parameter to // CreateAudioDecoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioDecoderG722 { struct Config { bool IsOk() const { return num_channels == 1 || num_channels == 2; } diff --git a/api/audio_codecs/g722/audio_encoder_g722.h b/api/audio_codecs/g722/audio_encoder_g722.h index 3029e116e1..327c0af04a 100644 --- a/api/audio_codecs/g722/audio_encoder_g722.h +++ b/api/audio_codecs/g722/audio_encoder_g722.h @@ -25,8 +25,6 @@ namespace webrtc { // G722 encoder API for use as a template parameter to // CreateAudioEncoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioEncoderG722 { using Config = AudioEncoderG722Config; static absl::optional SdpToConfig( diff --git a/api/audio_codecs/g722/audio_encoder_g722_config.h b/api/audio_codecs/g722/audio_encoder_g722_config.h index 773e430ce3..287898589f 100644 --- a/api/audio_codecs/g722/audio_encoder_g722_config.h +++ b/api/audio_codecs/g722/audio_encoder_g722_config.h @@ -13,7 +13,6 @@ namespace webrtc { -// NOTE: This struct is still under development and may change without notice. struct AudioEncoderG722Config { bool IsOk() const { return frame_size_ms > 0 && frame_size_ms % 10 == 0 && num_channels >= 1; diff --git a/api/audio_codecs/ilbc/audio_decoder_ilbc.h b/api/audio_codecs/ilbc/audio_decoder_ilbc.h index 20f6ffd287..9ab847977d 100644 --- a/api/audio_codecs/ilbc/audio_decoder_ilbc.h +++ b/api/audio_codecs/ilbc/audio_decoder_ilbc.h @@ -23,8 +23,6 @@ namespace webrtc { // ILBC decoder API for use as a template parameter to // CreateAudioDecoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct AudioDecoderIlbc { struct Config {}; // Empty---no config values needed! static absl::optional SdpToConfig(const SdpAudioFormat& audio_format); diff --git a/api/audio_codecs/ilbc/audio_encoder_ilbc.h b/api/audio_codecs/ilbc/audio_encoder_ilbc.h index 0a86b162e8..e4aeca70de 100644 --- a/api/audio_codecs/ilbc/audio_encoder_ilbc.h +++ b/api/audio_codecs/ilbc/audio_encoder_ilbc.h @@ -24,8 +24,6 @@ namespace webrtc { // ILBC encoder API for use as a template parameter to // CreateAudioEncoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct AudioEncoderIlbc { using Config = AudioEncoderIlbcConfig; static absl::optional SdpToConfig( diff --git a/api/audio_codecs/ilbc/audio_encoder_ilbc_config.h b/api/audio_codecs/ilbc/audio_encoder_ilbc_config.h index 22909a957b..4d82f9901c 100644 --- a/api/audio_codecs/ilbc/audio_encoder_ilbc_config.h +++ b/api/audio_codecs/ilbc/audio_encoder_ilbc_config.h @@ -13,7 +13,6 @@ namespace webrtc { -// NOTE: This struct is still under development and may change without notice. struct AudioEncoderIlbcConfig { bool IsOk() const { return (frame_size_ms == 20 || frame_size_ms == 30 || frame_size_ms == 40 || diff --git a/api/audio_codecs/isac/audio_decoder_isac_fix.h b/api/audio_codecs/isac/audio_decoder_isac_fix.h index a4ce685838..b7a5cef6dc 100644 --- a/api/audio_codecs/isac/audio_decoder_isac_fix.h +++ b/api/audio_codecs/isac/audio_decoder_isac_fix.h @@ -23,8 +23,6 @@ namespace webrtc { // iSAC decoder API (fixed-point implementation) for use as a template // parameter to CreateAudioDecoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct AudioDecoderIsacFix { struct Config {}; // Empty---no config values needed! static absl::optional SdpToConfig(const SdpAudioFormat& audio_format); diff --git a/api/audio_codecs/isac/audio_decoder_isac_float.h b/api/audio_codecs/isac/audio_decoder_isac_float.h index b0793e4ff8..e78f8b81ee 100644 --- a/api/audio_codecs/isac/audio_decoder_isac_float.h +++ b/api/audio_codecs/isac/audio_decoder_isac_float.h @@ -24,8 +24,6 @@ namespace webrtc { // iSAC decoder API (floating-point implementation) for use as a template // parameter to CreateAudioDecoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioDecoderIsacFloat { struct Config { bool IsOk() const { diff --git a/api/audio_codecs/isac/audio_encoder_isac_fix.h b/api/audio_codecs/isac/audio_encoder_isac_fix.h index 731e48d0c2..c3c3672b58 100644 --- a/api/audio_codecs/isac/audio_encoder_isac_fix.h +++ b/api/audio_codecs/isac/audio_encoder_isac_fix.h @@ -23,8 +23,6 @@ namespace webrtc { // iSAC encoder API (fixed-point implementation) for use as a template // parameter to CreateAudioEncoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct AudioEncoderIsacFix { struct Config { bool IsOk() const { return frame_size_ms == 30 || frame_size_ms == 60; } diff --git a/api/audio_codecs/isac/audio_encoder_isac_float.h b/api/audio_codecs/isac/audio_encoder_isac_float.h index 81b5c2e2c7..0cb9c17d71 100644 --- a/api/audio_codecs/isac/audio_encoder_isac_float.h +++ b/api/audio_codecs/isac/audio_encoder_isac_float.h @@ -24,8 +24,6 @@ namespace webrtc { // iSAC encoder API (floating-point implementation) for use as a template // parameter to CreateAudioEncoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioEncoderIsacFloat { struct Config { bool IsOk() const { diff --git a/api/audio_codecs/opus/audio_decoder_opus.h b/api/audio_codecs/opus/audio_decoder_opus.h index 0fc720bec3..6fbbcb598a 100644 --- a/api/audio_codecs/opus/audio_decoder_opus.h +++ b/api/audio_codecs/opus/audio_decoder_opus.h @@ -24,8 +24,6 @@ namespace webrtc { // Opus decoder API for use as a template parameter to // CreateAudioDecoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioDecoderOpus { struct Config { int num_channels; diff --git a/api/audio_codecs/opus/audio_encoder_opus.h b/api/audio_codecs/opus/audio_encoder_opus.h index bb4aa275ec..03cb0d6b38 100644 --- a/api/audio_codecs/opus/audio_encoder_opus.h +++ b/api/audio_codecs/opus/audio_encoder_opus.h @@ -25,8 +25,6 @@ namespace webrtc { // Opus encoder API for use as a template parameter to // CreateAudioEncoderFactory<...>(). -// -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioEncoderOpus { using Config = AudioEncoderOpusConfig; static absl::optional SdpToConfig( diff --git a/api/audio_codecs/opus/audio_encoder_opus_config.h b/api/audio_codecs/opus/audio_encoder_opus_config.h index 98a6ef5cbc..0a3ee2c8df 100644 --- a/api/audio_codecs/opus/audio_encoder_opus_config.h +++ b/api/audio_codecs/opus/audio_encoder_opus_config.h @@ -20,7 +20,6 @@ namespace webrtc { -// NOTE: This struct is still under development and may change without notice. struct RTC_EXPORT AudioEncoderOpusConfig { static constexpr int kDefaultFrameSizeMs = 20;