zqz/platform-external-webrtc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Audio codecs API: Remove some weasel words in the docs

Browse Source 
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 <solenberg@webrtc.org>
Commit-Queue: Karl Wiberg <kwiberg@webrtc.org>
Cr-Commit-Position: refs/heads/master@{#25283}
This commit is contained in:
Karl Wiberg
2018-10-18 22:29:39 +02:00
committed by Commit Bot
parent 57dd8811c9
commit e482ff8f70
24 changed files with 0 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
api/audio_codecs/L16/audio_decoder_L16.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// L16 decoder API for use as a template parameter to // L16 decoder API for use as a template parameter to
// CreateAudioDecoderFactory<...>(). // CreateAudioDecoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioDecoderL16 { struct RTC_EXPORT AudioDecoderL16 {
struct Config { struct Config {
bool IsOk() const { bool IsOk() const {

2
api/audio_codecs/L16/audio_encoder_L16.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// L16 encoder API for use as a template parameter to // L16 encoder API for use as a template parameter to
// CreateAudioEncoderFactory<...>(). // CreateAudioEncoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioEncoderL16 { struct RTC_EXPORT AudioEncoderL16 {
struct Config { struct Config {
bool IsOk() const { bool IsOk() const {

1
api/audio_codecs/audio_decoder_factory.h
View File

@ -23,7 +23,6 @@
namespace webrtc { namespace webrtc {
// A factory that creates AudioDecoders. // A factory that creates AudioDecoders.
// NOTE: This class is still under development and may change without notice.
class AudioDecoderFactory : public rtc::RefCountInterface { class AudioDecoderFactory : public rtc::RefCountInterface {
public: public:
virtual std::vector<AudioCodecSpec> GetSupportedDecoders() = 0; virtual std::vector<AudioCodecSpec> GetSupportedDecoders() = 0;

2
api/audio_codecs/audio_decoder_factory_template.h
View File

@ -112,8 +112,6 @@ class AudioDecoderFactoryT : public AudioDecoderFactory {
// decoder types in the order they were specified in the template argument // 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. // 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 // TODO(kwiberg): Point at CreateBuiltinAudioDecoderFactory() for an example of
// how it is used. // how it is used.
template <typename... Ts> template <typename... Ts>

1
api/audio_codecs/audio_encoder_factory.h
View File

@ -23,7 +23,6 @@
namespace webrtc { namespace webrtc {
// A factory that creates AudioEncoders. // A factory that creates AudioEncoders.
// NOTE: This class is still under development and may change without notice.
class AudioEncoderFactory : public rtc::RefCountInterface { class AudioEncoderFactory : public rtc::RefCountInterface {
public: public:
// Returns a prioritized list of audio codecs, to use for signaling etc. // Returns a prioritized list of audio codecs, to use for signaling etc.

2
api/audio_codecs/audio_encoder_factory_template.h
View File

@ -131,8 +131,6 @@ class AudioEncoderFactoryT : public AudioEncoderFactory {
// encoders in the order they were specified in the template argument list, // 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. // 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 // TODO(kwiberg): Point at CreateBuiltinAudioEncoderFactory() for an example of
// how it is used. // how it is used.
template <typename... Ts> template <typename... Ts>

1
api/audio_codecs/audio_format.h
View File

@ -20,7 +20,6 @@
namespace webrtc { namespace webrtc {
// SDP specification for a single audio codec. // SDP specification for a single audio codec.
// NOTE: This class is still under development and may change without notice.
struct SdpAudioFormat { struct SdpAudioFormat {
using Parameters = std::map<std::string, std::string>; using Parameters = std::map<std::string, std::string>;

1
api/audio_codecs/builtin_audio_decoder_factory.h
View File

@ -17,7 +17,6 @@
namespace webrtc { namespace webrtc {
// Creates a new factory that can create the built-in types of audio decoders. // 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<AudioDecoderFactory> CreateBuiltinAudioDecoderFactory(); rtc::scoped_refptr<AudioDecoderFactory> CreateBuiltinAudioDecoderFactory();
} // namespace webrtc } // namespace webrtc

1
api/audio_codecs/builtin_audio_encoder_factory.h
View File

@ -17,7 +17,6 @@
namespace webrtc { namespace webrtc {
// Creates a new factory that can create the built-in types of audio encoders. // 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<AudioEncoderFactory> CreateBuiltinAudioEncoderFactory(); rtc::scoped_refptr<AudioEncoderFactory> CreateBuiltinAudioEncoderFactory();
} // namespace webrtc } // namespace webrtc

2
api/audio_codecs/g711/audio_decoder_g711.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// G711 decoder API for use as a template parameter to // G711 decoder API for use as a template parameter to
// CreateAudioDecoderFactory<...>(). // CreateAudioDecoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioDecoderG711 { struct RTC_EXPORT AudioDecoderG711 {
struct Config { struct Config {
enum class Type { kPcmU, kPcmA }; enum class Type { kPcmU, kPcmA };

2
api/audio_codecs/g711/audio_encoder_g711.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// G711 encoder API for use as a template parameter to // G711 encoder API for use as a template parameter to
// CreateAudioEncoderFactory<...>(). // CreateAudioEncoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioEncoderG711 { struct RTC_EXPORT AudioEncoderG711 {
struct Config { struct Config {
enum class Type { kPcmU, kPcmA }; enum class Type { kPcmU, kPcmA };

2
api/audio_codecs/g722/audio_decoder_g722.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// G722 decoder API for use as a template parameter to // G722 decoder API for use as a template parameter to
// CreateAudioDecoderFactory<...>(). // CreateAudioDecoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioDecoderG722 { struct RTC_EXPORT AudioDecoderG722 {
struct Config { struct Config {
bool IsOk() const { return num_channels == 1 || num_channels == 2; } bool IsOk() const { return num_channels == 1 || num_channels == 2; }

2
api/audio_codecs/g722/audio_encoder_g722.h
View File

@ -25,8 +25,6 @@ namespace webrtc {
// G722 encoder API for use as a template parameter to // G722 encoder API for use as a template parameter to
// CreateAudioEncoderFactory<...>(). // CreateAudioEncoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioEncoderG722 { struct RTC_EXPORT AudioEncoderG722 {
using Config = AudioEncoderG722Config; using Config = AudioEncoderG722Config;
static absl::optional<AudioEncoderG722Config> SdpToConfig( static absl::optional<AudioEncoderG722Config> SdpToConfig(

1
api/audio_codecs/g722/audio_encoder_g722_config.h
View File

@ -13,7 +13,6 @@
namespace webrtc { namespace webrtc {
// NOTE: This struct is still under development and may change without notice.
struct AudioEncoderG722Config { struct AudioEncoderG722Config {
bool IsOk() const { bool IsOk() const {
return frame_size_ms > 0 && frame_size_ms % 10 == 0 && num_channels >= 1; return frame_size_ms > 0 && frame_size_ms % 10 == 0 && num_channels >= 1;

2
api/audio_codecs/ilbc/audio_decoder_ilbc.h
View File

@ -23,8 +23,6 @@ namespace webrtc {
// ILBC decoder API for use as a template parameter to // ILBC decoder API for use as a template parameter to
// CreateAudioDecoderFactory<...>(). // CreateAudioDecoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct AudioDecoderIlbc { struct AudioDecoderIlbc {
struct Config {}; // Empty---no config values needed! struct Config {}; // Empty---no config values needed!
static absl::optional<Config> SdpToConfig(const SdpAudioFormat& audio_format); static absl::optional<Config> SdpToConfig(const SdpAudioFormat& audio_format);

2
api/audio_codecs/ilbc/audio_encoder_ilbc.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// ILBC encoder API for use as a template parameter to // ILBC encoder API for use as a template parameter to
// CreateAudioEncoderFactory<...>(). // CreateAudioEncoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct AudioEncoderIlbc { struct AudioEncoderIlbc {
using Config = AudioEncoderIlbcConfig; using Config = AudioEncoderIlbcConfig;
static absl::optional<AudioEncoderIlbcConfig> SdpToConfig( static absl::optional<AudioEncoderIlbcConfig> SdpToConfig(

1
api/audio_codecs/ilbc/audio_encoder_ilbc_config.h
View File

@ -13,7 +13,6 @@
namespace webrtc { namespace webrtc {
// NOTE: This struct is still under development and may change without notice.
struct AudioEncoderIlbcConfig { struct AudioEncoderIlbcConfig {
bool IsOk() const { bool IsOk() const {
return (frame_size_ms == 20 || frame_size_ms == 30 || frame_size_ms == 40 || return (frame_size_ms == 20 || frame_size_ms == 30 || frame_size_ms == 40 ||

2
api/audio_codecs/isac/audio_decoder_isac_fix.h
View File

@ -23,8 +23,6 @@ namespace webrtc {
// iSAC decoder API (fixed-point implementation) for use as a template // iSAC decoder API (fixed-point implementation) for use as a template
// parameter to CreateAudioDecoderFactory<...>(). // parameter to CreateAudioDecoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct AudioDecoderIsacFix { struct AudioDecoderIsacFix {
struct Config {}; // Empty---no config values needed! struct Config {}; // Empty---no config values needed!
static absl::optional<Config> SdpToConfig(const SdpAudioFormat& audio_format); static absl::optional<Config> SdpToConfig(const SdpAudioFormat& audio_format);

2
api/audio_codecs/isac/audio_decoder_isac_float.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// iSAC decoder API (floating-point implementation) for use as a template // iSAC decoder API (floating-point implementation) for use as a template
// parameter to CreateAudioDecoderFactory<...>(). // parameter to CreateAudioDecoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioDecoderIsacFloat { struct RTC_EXPORT AudioDecoderIsacFloat {
struct Config { struct Config {
bool IsOk() const { bool IsOk() const {

2
api/audio_codecs/isac/audio_encoder_isac_fix.h
View File

@ -23,8 +23,6 @@ namespace webrtc {
// iSAC encoder API (fixed-point implementation) for use as a template // iSAC encoder API (fixed-point implementation) for use as a template
// parameter to CreateAudioEncoderFactory<...>(). // parameter to CreateAudioEncoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct AudioEncoderIsacFix { struct AudioEncoderIsacFix {
struct Config { struct Config {
bool IsOk() const { return frame_size_ms == 30 || frame_size_ms == 60; } bool IsOk() const { return frame_size_ms == 30 || frame_size_ms == 60; }

2
api/audio_codecs/isac/audio_encoder_isac_float.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// iSAC encoder API (floating-point implementation) for use as a template // iSAC encoder API (floating-point implementation) for use as a template
// parameter to CreateAudioEncoderFactory<...>(). // parameter to CreateAudioEncoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioEncoderIsacFloat { struct RTC_EXPORT AudioEncoderIsacFloat {
struct Config { struct Config {
bool IsOk() const { bool IsOk() const {

2
api/audio_codecs/opus/audio_decoder_opus.h
View File

@ -24,8 +24,6 @@ namespace webrtc {
// Opus decoder API for use as a template parameter to // Opus decoder API for use as a template parameter to
// CreateAudioDecoderFactory<...>(). // CreateAudioDecoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioDecoderOpus { struct RTC_EXPORT AudioDecoderOpus {
struct Config { struct Config {
int num_channels; int num_channels;

2
api/audio_codecs/opus/audio_encoder_opus.h
View File

@ -25,8 +25,6 @@ namespace webrtc {
// Opus encoder API for use as a template parameter to // Opus encoder API for use as a template parameter to
// CreateAudioEncoderFactory<...>(). // CreateAudioEncoderFactory<...>().
//
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioEncoderOpus { struct RTC_EXPORT AudioEncoderOpus {
using Config = AudioEncoderOpusConfig; using Config = AudioEncoderOpusConfig;
static absl::optional<AudioEncoderOpusConfig> SdpToConfig( static absl::optional<AudioEncoderOpusConfig> SdpToConfig(

1
api/audio_codecs/opus/audio_encoder_opus_config.h
View File

@ -20,7 +20,6 @@
namespace webrtc { namespace webrtc {
// NOTE: This struct is still under development and may change without notice.
struct RTC_EXPORT AudioEncoderOpusConfig { struct RTC_EXPORT AudioEncoderOpusConfig {
static constexpr int kDefaultFrameSizeMs = 20; static constexpr int kDefaultFrameSizeMs = 20;