properties to audio_properties

Author: oliviamiller

src/viam/examples/modules/audioin/main.cpp

@@ -37,7 +37,7 @@ class SineWaveAudioIn : public AudioIn, public Reconfigurable {
         throw Exception("method not supported");
     }
 
-    properties get_properties(const ProtoStruct&) override;
+    audio_properties get_properties(const ProtoStruct&) override;
 
     void get_audio(std::string const& codec,
                    std::function<bool(audio_chunk&& chunk)> const& chunk_handler,
@@ -133,8 +133,8 @@ AudioIn::audio_chunk SineWaveAudioIn::create_audio_chunk(const std::vector<int16
     return chunk;
 }
 
-properties SineWaveAudioIn::get_properties(const ProtoStruct&) {
-    properties props;
+audio_properties SineWaveAudioIn::get_properties(const ProtoStruct&) {
+    audio_properties props;
     props.supported_codecs = {audio_codecs::PCM_16};
     props.sample_rate_hz = 44100;
     props.num_channels = 1;

src/viam/sdk/common/audio.cpp

@@ -13,7 +13,7 @@ void write_value(std::ofstream& out, const T& value) {
 }
 }  // anonymous namespace
 
-bool operator==(const properties& lhs, const properties& rhs) {
+bool operator==(const audio_properties& lhs, const audio_properties& rhs) {
     return std::tie(lhs.supported_codecs, lhs.sample_rate_hz, lhs.num_channels) ==
            std::tie(rhs.supported_codecs, rhs.sample_rate_hz, rhs.num_channels);
 }

src/viam/sdk/common/audio.hpp

@@ -19,9 +19,9 @@ constexpr const char* OPUS = "opus";
 constexpr const char* FLAC = "flac";
 }  // namespace audio_codecs
 
-/// @struct properties
+/// @struct audio_properties
 /// @brief Properties of an audio component (input or output)
-struct properties {
+struct audio_properties {
     std::vector<std::string> supported_codecs;
     int sample_rate_hz;
     int num_channels;
@@ -36,7 +36,7 @@ struct audio_info {
 };
 
 /// @brief Equality operator for properties
-bool operator==(const properties& lhs, const properties& rhs);
+bool operator==(const audio_properties& lhs, const audio_properties& rhs);
 
 uint16_t get_bits_per_sample(const std::string& codec);
 

src/viam/sdk/components/audio_in.hpp

@@ -71,14 +71,14 @@ class AudioIn : public Component {
 
     /// @brief Returns properties of the audio in device (supported codecs, sample rate, number of
     /// channels)
-    inline properties get_properties() {
+    inline audio_properties get_properties() {
         return get_properties({});
     }
 
     /// @brief Returns properties of the audio in device (supported codecs, sample rate, number of
     /// channels)
     /// @param extra Any additional arguments to the method
-    virtual properties get_properties(const ProtoStruct& extra) = 0;
+    virtual audio_properties get_properties(const ProtoStruct& extra) = 0;
 
     // @brief Send/receive arbitrary commands to the resource.
     /// @param Command the command to execute.

src/viam/sdk/components/private/audio_in_client.cpp

@@ -58,7 +58,7 @@ void AudioInClient::get_audio(std::string const& codec,
             return chunk_handler(std::move(chunk));
         });
 }
-properties AudioInClient::get_properties(const ProtoStruct& extra) {
+audio_properties AudioInClient::get_properties(const ProtoStruct& extra) {
     return make_client_helper(this, *stub_, &StubType::GetProperties)
         .with(extra)
         .invoke([](auto& response) {
@@ -69,7 +69,7 @@ properties AudioInClient::get_properties(const ProtoStruct& extra) {
                 codecs.push_back(codec);
             }
 
-            return properties{
+            return audio_properties{
                 std::move(codecs), response.sample_rate_hz(), response.num_channels()};
         });
 }

src/viam/sdk/components/private/audio_in_client.hpp

@@ -27,7 +27,7 @@ class AudioInClient : public AudioIn {
                    int64_t const& previous_timestamp,
                    const ProtoStruct& extra) override;
 
-    properties get_properties(const ProtoStruct& extra) override;
+    audio_properties get_properties(const ProtoStruct& extra) override;
     ProtoStruct do_command(const ProtoStruct& command) override;
     std::vector<GeometryConfig> get_geometries(const ProtoStruct& extra) override;
 

src/viam/sdk/components/private/audio_in_server.cpp

@@ -74,7 +74,7 @@ ::grpc::Status AudioInServer::GetProperties(
     viam::common::v1::GetPropertiesResponse* response) noexcept {
     return make_service_helper<AudioIn>(
         "AudioInServer::GetProperties", this, request)([&](auto& helper, auto& audio_in) {
-        const properties result = audio_in->get_properties(helper.getExtra());
+        const audio_properties result = audio_in->get_properties(helper.getExtra());
         for (const auto& codec : result.supported_codecs) {
             response->add_supported_codecs(codec);
         }

src/viam/sdk/tests/mocks/mock_audio_in.cpp

@@ -43,7 +43,7 @@ void MockAudioIn::get_audio(std::string const& codec,
     }
 }
 
-properties MockAudioIn::get_properties(const ProtoStruct& extra) {
+audio_properties MockAudioIn::get_properties(const ProtoStruct& extra) {
     return properties_;
 }
 
@@ -62,8 +62,8 @@ std::shared_ptr<MockAudioIn> MockAudioIn::get_mock_audio_in() {
     return audio_in;
 }
 
-properties fake_properties() {
-    properties props;
+audio_properties fake_properties() {
+    audio_properties props;
     props.supported_codecs = {audio_codecs::PCM_16, audio_codecs::PCM_32};
     props.sample_rate_hz = 48000;
     props.num_channels = 1;

src/viam/sdk/tests/mocks/mock_audio_in.hpp

@@ -20,7 +20,7 @@ class MockAudioIn : public AudioIn {
                    int64_t const& previous_timestamp,
                    const sdk::ProtoStruct& extra) override;
 
-    properties get_properties(const sdk::ProtoStruct& extra) override;
+    audio_properties get_properties(const sdk::ProtoStruct& extra) override;
 
     viam::sdk::ProtoStruct do_command(const viam::sdk::ProtoStruct& command) override;
 
@@ -34,13 +34,13 @@ class MockAudioIn : public AudioIn {
     using AudioIn::get_properties;
 
    private:
-    properties properties_;
+    audio_properties properties_;
     viam::sdk::ProtoStruct map_;
     std::vector<audio_chunk> mock_chunks_;
     std::vector<GeometryConfig> geometries_;
 };
 
-properties fake_properties();
+audio_properties fake_properties();
 std::vector<AudioIn::audio_chunk> fake_audio_chunks();
 
 }  // namespace audioin

src/viam/sdk/tests/test_audio_in.cpp

@@ -112,8 +112,8 @@ BOOST_AUTO_TEST_CASE(test_do_command) {
 BOOST_AUTO_TEST_CASE(test_get_properties) {
     std::shared_ptr<MockAudioIn> mock = MockAudioIn::get_mock_audio_in();
     client_to_mock_pipeline<AudioIn>(mock, [](AudioIn& client) {
-        properties props = client.get_properties();
-        properties expected = fake_properties();
+        audio_properties props = client.get_properties();
+        audio_properties expected = fake_properties();
 
         BOOST_CHECK(expected == props);
     });