1 /*
2  *  Copyright (c) 2018 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 
11 #ifndef API_AUDIO_ECHO_CANCELLER3_CONFIG_JSON_H_
12 #define API_AUDIO_ECHO_CANCELLER3_CONFIG_JSON_H_
13 
14 #include <string>
15 
16 #include "absl/strings/string_view.h"
17 #include "api/audio/echo_canceller3_config.h"
18 #include "rtc_base/system/rtc_export.h"
19 
20 namespace webrtc {
21 // Parses a JSON-encoded string into an Aec3 config. Fields corresponds to
22 // substruct names, with the addition that there must be a top-level node
23 // "aec3". Produces default config values for anything that cannot be parsed
24 // from the string. If any error was found in the parsing, parsing_successful is
25 // set to false.
26 RTC_EXPORT void Aec3ConfigFromJsonString(absl::string_view json_string,
27                                          EchoCanceller3Config* config,
28                                          bool* parsing_successful);
29 
30 // To be deprecated.
31 // Parses a JSON-encoded string into an Aec3 config. Fields corresponds to
32 // substruct names, with the addition that there must be a top-level node
33 // "aec3". Returns default config values for anything that cannot be parsed from
34 // the string.
35 RTC_EXPORT EchoCanceller3Config
36 Aec3ConfigFromJsonString(absl::string_view json_string);
37 
38 // Encodes an Aec3 config in JSON format. Fields corresponds to substruct names,
39 // with the addition that the top-level node is named "aec3".
40 RTC_EXPORT std::string Aec3ConfigToJsonString(
41     const EchoCanceller3Config& config);
42 
43 }  // namespace webrtc
44 
45 #endif  // API_AUDIO_ECHO_CANCELLER3_CONFIG_JSON_H_
46