[all-devices-app] Refactor Chime audio architecture for POSIX platforms (#71623)

* Refactor Chime audio architecture for POSIX platforms

* Include missing chime core and factory changes in PR

* Remove chime/impl directory and its BUILD.gn

* Restyled by clang-format

* Restyled by gn

* Use PosixChimeDevice to share implementation between Linux and Darwin

* Address review comments and improve status handling in PosixChimeDevice

* Restyled by gn

* Fix ESP32 build by removing reference to deleted chime/impl directory

---------

Co-authored-by: Restyled.io <commits@restyled.io>

Author: soares-sergio

examples/all-devices-app/all-devices-common/devices/chime/ChimeDevice.cpp

@@ -16,16 +16,17 @@
  */
 #include <devices/Types.h>
 #include <devices/chime/ChimeDevice.h>
+#include <lib/support/StringBuilder.h>
 #include <lib/support/logging/CHIPLogging.h>
 
 using namespace chip::app::Clusters;
 
 namespace chip {
 namespace app {
 
-ChimeDevice::ChimeDevice(Clusters::ChimeDelegate & delegate, TimerDelegate & timerDelegate) :
-    SingleEndpointDevice(Span<const DataModel::DeviceTypeEntry>(&Device::Type::kChime, 1)), mDelegate(delegate),
-    mTimerDelegate(timerDelegate)
+ChimeDevice::ChimeDevice(TimerDelegate & timerDelegate, Span<const Sound> sounds) :
+    SingleEndpointDevice(Span<const DataModel::DeviceTypeEntry>(&Device::Type::kChime, 1)), mTimerDelegate(timerDelegate),
+    mSounds(sounds)
 {}
 
 CHIP_ERROR ChimeDevice::Register(chip::EndpointId endpoint, CodeDrivenDataModelProvider & provider, EndpointId parentId)
@@ -35,7 +36,7 @@ CHIP_ERROR ChimeDevice::Register(chip::EndpointId endpoint, CodeDrivenDataModelP
     mIdentifyCluster.Create(IdentifyCluster::Config(endpoint, mTimerDelegate));
     ReturnErrorOnFailure(provider.AddCluster(mIdentifyCluster.Registration()));
 
-    mChimeCluster.Create(endpoint, mDelegate);
+    mChimeCluster.Create(endpoint, *this);
     ReturnErrorOnFailure(provider.AddCluster(mChimeCluster.Registration()));
 
     return provider.AddEndpoint(mEndpointRegistration);
@@ -62,5 +63,45 @@ Clusters::ChimeCluster & ChimeDevice::ChimeCluster()
     return mChimeCluster.Cluster();
 }
 
+CHIP_ERROR ChimeDevice::GetChimeSoundByIndex(uint8_t chimeIndex, uint8_t & chimeID, MutableCharSpan & name)
+{
+    if (chimeIndex >= mSounds.size())
+    {
+        return CHIP_ERROR_PROVIDER_LIST_EXHAUSTED;
+    }
+
+    const auto & sound = mSounds[chimeIndex];
+    chimeID            = sound.id;
+    return CopyCharSpanToMutableCharSpan(sound.name, name);
+}
+
+CHIP_ERROR ChimeDevice::GetChimeIDByIndex(uint8_t chimeIndex, uint8_t & chimeID)
+{
+    if (chimeIndex >= mSounds.size())
+    {
+        return CHIP_ERROR_PROVIDER_LIST_EXHAUSTED;
+    }
+
+    chimeID = mSounds[chimeIndex].id;
+    return CHIP_NO_ERROR;
+}
+
+Protocols::InteractionModel::Status ChimeDevice::PlayChimeSound(uint8_t chimeID)
+{
+    CharSpan soundName = "Unknown"_span;
+    for (const auto & sound : mSounds)
+    {
+        if (sound.id == chimeID)
+        {
+            soundName = sound.name;
+            break;
+        }
+    }
+
+    ChipLogProgress(AppServer, "ChimeDevice: Playing sound %s", chip::NullTerminated(soundName).c_str());
+
+    return Protocols::InteractionModel::Status::Success;
+}
+
 } // namespace app
 } // namespace chip

examples/all-devices-app/all-devices-common/devices/chime/ChimeDevice.h

@@ -20,15 +20,23 @@
 #include <app/clusters/identify-server/IdentifyCluster.h>
 #include <data-model-providers/codedriven/CodeDrivenDataModelProvider.h>
 #include <devices/interface/SingleEndpointDevice.h>
+#include <lib/support/Span.h>
 #include <lib/support/TimerDelegate.h>
 
 namespace chip {
 namespace app {
 
-class ChimeDevice : public SingleEndpointDevice
+class ChimeDevice : public SingleEndpointDevice, public Clusters::ChimeDelegate
 {
 public:
-    ChimeDevice(Clusters::ChimeDelegate & delegate, TimerDelegate & timerDelegate);
+    struct Sound
+    {
+        uint8_t id;
+        CharSpan name;
+    };
+
+    // Note: sounds array must outlive the ChimeDevice lifetime (i.e. often static or similar)
+    ChimeDevice(TimerDelegate & timerDelegate, Span<const Sound> sounds);
     ~ChimeDevice() override = default;
 
     CHIP_ERROR Register(chip::EndpointId endpoint, CodeDrivenDataModelProvider & provider,
@@ -37,9 +45,14 @@ class ChimeDevice : public SingleEndpointDevice
 
     Clusters::ChimeCluster & ChimeCluster();
 
+    // ChimeDelegate
+    CHIP_ERROR GetChimeSoundByIndex(uint8_t chimeIndex, uint8_t & chimeID, MutableCharSpan & name) override;
+    CHIP_ERROR GetChimeIDByIndex(uint8_t chimeIndex, uint8_t & chimeID) override;
+    virtual Protocols::InteractionModel::Status PlayChimeSound(uint8_t chimeID) override;
+
 protected:
-    Clusters::ChimeDelegate & mDelegate;
     TimerDelegate & mTimerDelegate;
+    Span<const Sound> mSounds;
     LazyRegisteredServerCluster<Clusters::IdentifyCluster> mIdentifyCluster;
     LazyRegisteredServerCluster<Clusters::ChimeCluster> mChimeCluster;
 };

examples/all-devices-app/all-devices-common/devices/chime/impl/BUILD.gn

@@ -20,7 +20,7 @@ source_set("device-factory") {
 
   public_deps = [
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/boolean-state-sensor",
-    "${chip_root}/examples/all-devices-app/all-devices-common/devices/chime/impl:logging",
+    "${chip_root}/examples/all-devices-app/all-devices-common/devices/chime",
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/dimmable-light/impl:logging",
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/occupancy-sensor/impl:toggling",
     "${chip_root}/examples/all-devices-app/all-devices-common/devices/on-off-light",

examples/all-devices-app/all-devices-common/devices/chime/impl/LoggingChimeDevice.cpp

@@ -19,7 +19,7 @@
 
 #include <devices/Types.h>
 #include <devices/boolean-state-sensor/BooleanStateSensorDevice.h>
-#include <devices/chime/impl/LoggingChimeDevice.h>
+#include <devices/chime/ChimeDevice.h>
 #include <devices/dimmable-light/impl/LoggingDimmableLightDevice.h>
 #include <devices/occupancy-sensor/impl/TogglingOccupancySensorDevice.h>
 #include <devices/on-off-light/LoggingOnOffLightDevice.h>
@@ -60,6 +60,11 @@ class DeviceFactory
 
     void Init(const Context & context) { mContext.emplace(context); }
 
+    void RegisterCreator(const std::string & deviceTypeArg, DeviceCreator && creator)
+    {
+        mRegistry[deviceTypeArg] = std::move(creator);
+    }
+
     bool IsValidDevice(const std::string & deviceTypeArg) { return mRegistry.find(deviceTypeArg) != mRegistry.end(); }
 
     std::unique_ptr<DeviceInterface> Create(const std::string & deviceTypeArg)
@@ -105,13 +110,20 @@ class DeviceFactory
                 &mContext->timerDelegate, Span<const DataModel::DeviceTypeEntry>(&Device::Type::kWaterLeakDetector, 1));
         };
         mRegistry["occupancy-sensor"] = []() { return std::make_unique<TogglingOccupancySensorDevice>(); };
-        mRegistry["chime"]            = []() { return std::make_unique<LoggingChimeDevice>(); };
-        mRegistry["dimmable-light"]   = [this]() {
+        mRegistry["chime"]            = [this]() {
+            VerifyOrDie(mContext.has_value());
+            static const ChimeDevice::Sound kDefaultSounds[] = {
+                { 0, "Ding Dong"_span },
+                { 1, "Ring Ring"_span },
+            };
+            return std::make_unique<ChimeDevice>(mContext->timerDelegate, Span<const ChimeDevice::Sound>(kDefaultSounds));
+        };
+        mRegistry["dimmable-light"] = [this]() {
             VerifyOrDie(mContext.has_value());
             return std::make_unique<LoggingDimmableLightDevice>(LoggingDimmableLightDevice::Context{
-                  .groupDataProvider = mContext->groupDataProvider,
-                  .fabricTable       = mContext->fabricTable,
-                  .timerDelegate     = mContext->timerDelegate,
+                .groupDataProvider = mContext->groupDataProvider,
+                .fabricTable       = mContext->fabricTable,
+                .timerDelegate     = mContext->timerDelegate,
             });
         };
         mRegistry["on-off-light"] = [this]() {

examples/all-devices-app/all-devices-common/devices/chime/impl/LoggingChimeDevice.h

@@ -43,7 +43,6 @@ set(SRC_DIRS_LIST
     # all-devices-common device modules
     "${ALL_DEVICES_COMMON_DIR}/devices/boolean-state-sensor"
     "${ALL_DEVICES_COMMON_DIR}/devices/chime"
-    "${ALL_DEVICES_COMMON_DIR}/devices/chime/impl"
     "${ALL_DEVICES_COMMON_DIR}/devices/interface"
     "${ALL_DEVICES_COMMON_DIR}/devices/occupancy-sensor"
     "${ALL_DEVICES_COMMON_DIR}/devices/occupancy-sensor/impl"

examples/all-devices-app/all-devices-common/devices/device-factory/BUILD.gn

@@ -18,6 +18,7 @@ import("${chip_root}/src/platform/device.gni")
 
 executable("all-devices-app") {
   sources = [
+    "PosixChimeDevice.cpp",
     "include/CHIPProjectAppConfig.h",
     "main.cpp",
   ]

examples/all-devices-app/all-devices-common/devices/device-factory/DeviceFactory.h

@@ -0,0 +1,35 @@
+/*
+ *
+ *    Copyright (c) 2026 Project CHIP Authors
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *        http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+#include <PosixChimeDevice.h>
+#include <lib/support/logging/CHIPLogging.h>
+
+namespace chip {
+namespace app {
+
+Protocols::InteractionModel::Status PosixChimeDevice::PlayChimeSound(uint8_t chimeID)
+{
+    // Call base class to log the default message
+    auto status = ChimeDevice::PlayChimeSound(chimeID);
+
+    // TODO: play a real sound on POSIX (Linux/Darwin)
+    ChipLogProgress(DeviceLayer, "PosixChimeDevice: TODO: Play real sound for ID %d", chimeID);
+
+    return status;
+}
+
+} // namespace app
+} // namespace chip