Handle change of DPTZRelativeMove -> DPTZStreams (list of int to list of struct) (#38850)

* XML update of CameraAVStreamManagement from Alchemy

* Zap regen

* Align with updated XML

* Adding Push AV

* Zap regen after adding PushAV

* Restyled by whitespace

* Restyled by clang-format

* Restyled by prettier-json

* Handle watermark in snapshot stream modify
Correctly handle setting of nightvision based on the HAL

* Restyled by whitespace

* Restyled by clang-format

* Revert optattr setting

* Restyled by clang-format

* Align with latest PR that makes enum values contiguous

* Add regen code

* Align with latest camera spec.
Change DPTZRelativeMove attribute to DPTZStreams, which is now a struct that takes a viewport and a stream ID.
Handle plumbing in the app to correctly set values based on stream allocation and deallocation.

* Zap Regen after merge with master

* Restyled by whitespace

* Restyled by clang-format

* Remove debug log

* Zap formatting fixes

* Add static cast

* Remove inadvertant inclusions

* Update AVSUM 2_1 to reflect the new attribute name and type

* Zap changes

---------

Co-authored-by: Restyled.io <[email protected]>

Author: marktrayer

examples/all-clusters-app/all-clusters-common/all-clusters-app.matter

@@ -7287,10 +7287,15 @@ provisional cluster CameraAvSettingsUserLevelManagement = 1362 {
     int16u y2 = 3;
   }
 
+  struct DPTZStruct {
+    int16u videoStreamID = 0;
+    ViewportStruct viewport = 1;
+  }
+
   readonly attribute optional MPTZStruct MPTZPosition = 0;
   readonly attribute optional int8u maxPresets = 1;
   readonly attribute optional MPTZPresetStruct MPTZPresets[] = 2;
-  readonly attribute optional int16u DPTZRelativeMove[] = 3;
+  readonly attribute optional DPTZStruct DPTZStreams[] = 3;
   readonly attribute optional int8u zoomMax = 4;
   readonly attribute optional int16s tiltMin = 5;
   readonly attribute optional int16s tiltMax = 6;
@@ -7341,7 +7346,7 @@ provisional cluster CameraAvSettingsUserLevelManagement = 1362 {
 
   /** This command SHALL set the values for the pan, tilt, and zoom in the mechanical PTZ. */
   command MPTZSetPosition(MPTZSetPositionRequest): DefaultSuccess = 0;
-  /** This command SHALL move the device by the delta values relative to the currently defined position. */
+  /** This command SHALL move the camera by the delta values relative to the currently defined position. */
   command MPTZRelativeMove(MPTZRelativeMoveRequest): DefaultSuccess = 1;
   /** This command SHALL move the camera to the positions specified by the Preset passed. */
   command MPTZMoveToPreset(MPTZMoveToPresetRequest): DefaultSuccess = 2;
@@ -7351,7 +7356,7 @@ provisional cluster CameraAvSettingsUserLevelManagement = 1362 {
   command MPTZRemovePreset(MPTZRemovePresetRequest): DefaultSuccess = 4;
   /** This command allows for setting the digital viewport for a specific Video Stream. */
   command DPTZSetViewport(DPTZSetViewportRequest): DefaultSuccess = 5;
-  /** This command SHALL change the viewports location by the amount specified in a relative fashion. */
+  /** This command SHALL change the per stream viewport by the amount specified in a relative fashion. */
   command DPTZRelativeMove(DPTZRelativeMoveRequest): DefaultSuccess = 6;
 }
 
@@ -9699,7 +9704,7 @@ endpoint 1 {
     callback attribute MPTZPosition;
     ram      attribute maxPresets default = 5;
     callback attribute MPTZPresets;
-    callback attribute DPTZRelativeMove;
+    callback attribute DPTZStreams;
     ram      attribute zoomMax default = 100;
     ram      attribute tiltMin default = -90;
     ram      attribute tiltMax default = 90;

examples/all-clusters-app/all-clusters-common/include/camera-av-settings-user-level-management-instance.h

@@ -33,12 +33,15 @@ class AVSettingsUserLevelManagementDelegate : public Delegate
     ~AVSettingsUserLevelManagementDelegate() = default;
 
     bool CanChangeMPTZ() override;
-    bool IsValidVideoStreamID(uint16_t videoStreamID) override;
 
     CHIP_ERROR LoadMPTZPresets(std::vector<MPTZPresetHelper> & mptzPresetHelpers) override;
-    CHIP_ERROR LoadDPTZRelativeMove(std::vector<uint16_t> dptzRelativeMove) override;
+    CHIP_ERROR LoadDPTZStreams(std::vector<Structs::DPTZStruct::Type> dptzStream) override;
     CHIP_ERROR PersistentAttributesLoadedCallback() override;
 
+    virtual void VideoStreamAllocated(uint16_t aStreamID) override;
+    virtual void VideoStreamDeallocated(uint16_t aStreamID) override;
+    virtual void DefaultViewportUpdated(Structs::ViewportStruct::Type aViewport) override;
+
     /**
      * delegate command handlers
      */
@@ -52,7 +55,8 @@ class AVSettingsUserLevelManagementDelegate : public Delegate
     Protocols::InteractionModel::Status MPTZRemovePreset(uint8_t aPreset) override;
     Protocols::InteractionModel::Status DPTZSetViewport(uint16_t aVideoStreamID, Structs::ViewportStruct::Type aViewport) override;
     Protocols::InteractionModel::Status DPTZRelativeMove(uint16_t aVideoStreamID, Optional<int16_t> aDeltaX,
-                                                         Optional<int16_t> aDeltaY, Optional<int8_t> aZoomDelta) override;
+                                                         Optional<int16_t> aDeltaY, Optional<int8_t> aZoomDelta,
+                                                         Structs::ViewportStruct::Type & aViewport) override;
 };
 
 void Shutdown();

examples/all-clusters-app/all-clusters-common/src/camera-av-settings-user-level-management-stub.cpp

@@ -46,12 +46,26 @@ bool AVSettingsUserLevelManagementDelegate::CanChangeMPTZ()
     return true;
 }
 
-bool AVSettingsUserLevelManagementDelegate::IsValidVideoStreamID(uint16_t aVideoStreamID)
+void AVSettingsUserLevelManagementDelegate::VideoStreamAllocated(uint16_t aStreamID)
 {
-    // The server needs to verify that the provided Video Stream ID is valid and known and subject to digital modification
-    // The camera app needs to also have an instance of AV Stream Management, querying that to determine validity of the provided
-    // id.
-    return true;
+    // The app needs to invoke this whenever the AV Stream Manager allocates a video stream; this informs the server of the
+    // id that is now subject to DPTZ, and the default viewport of the device
+    Structs::ViewportStruct::Type viewport = { 0, 0, 1920, 1080 };
+    this->GetServer()->AddMoveCapableVideoStream(aStreamID, viewport);
+}
+
+void AVSettingsUserLevelManagementDelegate::VideoStreamDeallocated(uint16_t aStreamID)
+{
+    // The app needs to invoke this whenever the AV Stream Manager deallocates a video stream; this informs the server of the
+    // deallocated id that is now not subject to DPTZ
+    this->GetServer()->RemoveMoveCapableVideoStream(aStreamID);
+}
+
+void AVSettingsUserLevelManagementDelegate::DefaultViewportUpdated(Structs::ViewportStruct::Type aViewport)
+{
+    // The app needs to invoke this whenever the AV Stream Manager updates the device level default Viewport.  This informs
+    // the server of the new viewport that shall be appled to all known streams.
+    this->GetServer()->UpdateMoveCapableVideoStreams(aViewport);
 }
 
 Status AVSettingsUserLevelManagementDelegate::MPTZSetPosition(Optional<int16_t> aPan, Optional<int16_t> aTilt,
@@ -109,12 +123,17 @@ Status AVSettingsUserLevelManagementDelegate::DPTZSetViewport(uint16_t aVideoStr
 }
 
 Status AVSettingsUserLevelManagementDelegate::DPTZRelativeMove(uint16_t aVideoStreamID, Optional<int16_t> aDeltaX,
-                                                               Optional<int16_t> aDeltaY, Optional<int8_t> aZoomDelta)
+                                                               Optional<int16_t> aDeltaY, Optional<int8_t> aZoomDelta,
+                                                               Structs::ViewportStruct::Type & aViewport)
 {
     // The Cluster implementation has ensured that the videoStreamID represents a valid stream.
-    // The application needs to interact with its instance of AVStreamManagement to access the stream, validate the viewport
-    // and set the new values for the viewpoort based on the pixel movement requested
+    // The application needs to interact with its instance of AVStreamManagement to access the stream, validate
+    // new dimensions after application of the deltas, and set the new values for the viewport based on the pixel movement
+    // requested
+    // The passed in viewport is empty, and needs to be populated by the delegate with the value of the viewport after
+    // applying all deltas within the constraints of the sensor.
     //
+    aViewport = { 0, 0, 1920, 1080 };
     return Status::Success;
 }
 
@@ -124,9 +143,9 @@ CHIP_ERROR AVSettingsUserLevelManagementDelegate::LoadMPTZPresets(std::vector<MP
     return CHIP_NO_ERROR;
 }
 
-CHIP_ERROR AVSettingsUserLevelManagementDelegate::LoadDPTZRelativeMove(std::vector<uint16_t> dptzRelativeMove)
+CHIP_ERROR AVSettingsUserLevelManagementDelegate::LoadDPTZStreams(std::vector<DPTZStruct> dptzStreams)
 {
-    dptzRelativeMove.clear();
+    dptzStreams.clear();
     return CHIP_NO_ERROR;
 }
 
@@ -156,7 +175,7 @@ void emberAfCameraAvSettingsUserLevelManagementClusterInitCallback(chip::Endpoin
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kMptzPosition,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kMaxPresets,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kMptzPresets,
-        CameraAvSettingsUserLevelManagement::OptionalAttributes::kDptzRelativeMove,
+        CameraAvSettingsUserLevelManagement::OptionalAttributes::kDptzStreams,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kZoomMax,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kTiltMin,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kTiltMax,

examples/camera-app/camera-common/camera-app.matter

@@ -2385,10 +2385,15 @@ provisional cluster CameraAvSettingsUserLevelManagement = 1362 {
     int16u y2 = 3;
   }
 
+  struct DPTZStruct {
+    int16u videoStreamID = 0;
+    ViewportStruct viewport = 1;
+  }
+
   readonly attribute optional MPTZStruct MPTZPosition = 0;
   readonly attribute optional int8u maxPresets = 1;
   readonly attribute optional MPTZPresetStruct MPTZPresets[] = 2;
-  readonly attribute optional int16u DPTZRelativeMove[] = 3;
+  readonly attribute optional DPTZStruct DPTZStreams[] = 3;
   readonly attribute optional int8u zoomMax = 4;
   readonly attribute optional int16s tiltMin = 5;
   readonly attribute optional int16s tiltMax = 6;
@@ -2439,7 +2444,7 @@ provisional cluster CameraAvSettingsUserLevelManagement = 1362 {
 
   /** This command SHALL set the values for the pan, tilt, and zoom in the mechanical PTZ. */
   command MPTZSetPosition(MPTZSetPositionRequest): DefaultSuccess = 0;
-  /** This command SHALL move the device by the delta values relative to the currently defined position. */
+  /** This command SHALL move the camera by the delta values relative to the currently defined position. */
   command MPTZRelativeMove(MPTZRelativeMoveRequest): DefaultSuccess = 1;
   /** This command SHALL move the camera to the positions specified by the Preset passed. */
   command MPTZMoveToPreset(MPTZMoveToPresetRequest): DefaultSuccess = 2;
@@ -2449,7 +2454,7 @@ provisional cluster CameraAvSettingsUserLevelManagement = 1362 {
   command MPTZRemovePreset(MPTZRemovePresetRequest): DefaultSuccess = 4;
   /** This command allows for setting the digital viewport for a specific Video Stream. */
   command DPTZSetViewport(DPTZSetViewportRequest): DefaultSuccess = 5;
-  /** This command SHALL change the viewports location by the amount specified in a relative fashion. */
+  /** This command SHALL change the per stream viewport by the amount specified in a relative fashion. */
   command DPTZRelativeMove(DPTZRelativeMoveRequest): DefaultSuccess = 6;
 }
 
@@ -3206,7 +3211,7 @@ endpoint 1 {
     callback attribute MPTZPosition;
     ram      attribute maxPresets default = 5;
     callback attribute MPTZPresets;
-    callback attribute DPTZRelativeMove;
+    callback attribute DPTZStreams;
     ram      attribute zoomMax default = 100;
     ram      attribute tiltMin default = -90;
     ram      attribute tiltMax default = 90;

examples/camera-app/camera-common/src/camera-app.cpp

@@ -95,7 +95,7 @@ CameraApp::CameraApp(chip::EndpointId aClustersEndpoint, CameraDeviceInterface *
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kMptzPosition,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kMaxPresets,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kMptzPresets,
-        CameraAvSettingsUserLevelManagement::OptionalAttributes::kDptzRelativeMove,
+        CameraAvSettingsUserLevelManagement::OptionalAttributes::kDptzStreams,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kZoomMax,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kTiltMin,
         CameraAvSettingsUserLevelManagement::OptionalAttributes::kTiltMax,

examples/camera-app/linux/include/camera-device.h

@@ -237,7 +237,7 @@ class CameraDevice : public CameraDeviceInterface, public CameraDeviceInterface:
     int16_t mTilt = chip::app::Clusters::CameraAvSettingsUserLevelManagement::kDefaultTilt;
     uint8_t mZoom = chip::app::Clusters::CameraAvSettingsUserLevelManagement::kDefaultZoom;
     // Use a standard 1080p aspect ratio
-    chip::app::Clusters::CameraAvStreamManagement::ViewportStruct mViewport = { 320, 585, 2240, 1665 };
+    chip::app::Clusters::CameraAvStreamManagement::ViewportStruct mViewport = { 0, 0, 1920, 1080 };
     uint16_t mCurrentVideoFrameRate                                         = 0;
     bool mHDREnabled                                                        = false;
     bool mMicrophoneMuted                                                   = false;

examples/camera-app/linux/include/clusters/camera-avsettingsuserlevel-mgmt/camera-avsettingsuserlevel-manager.h

@@ -37,10 +37,9 @@ class CameraAVSettingsUserLevelManager : public Delegate
     ~CameraAVSettingsUserLevelManager() = default;
 
     bool CanChangeMPTZ() override;
-    bool IsValidVideoStreamID(uint16_t videoStreamID) override;
 
     CHIP_ERROR LoadMPTZPresets(std::vector<MPTZPresetHelper> & mptzPresetHelpers) override;
-    CHIP_ERROR LoadDPTZRelativeMove(std::vector<uint16_t> dptzRelativeMove) override;
+    CHIP_ERROR LoadDPTZStreams(std::vector<DPTZStruct> dptzStreams) override;
     CHIP_ERROR PersistentAttributesLoadedCallback() override;
 
     /**
@@ -56,12 +55,20 @@ class CameraAVSettingsUserLevelManager : public Delegate
     Protocols::InteractionModel::Status MPTZRemovePreset(uint8_t aPreset) override;
     Protocols::InteractionModel::Status DPTZSetViewport(uint16_t aVideoStreamID, Structs::ViewportStruct::Type aViewport) override;
     Protocols::InteractionModel::Status DPTZRelativeMove(uint16_t aVideoStreamID, Optional<int16_t> aDeltaX,
-                                                         Optional<int16_t> aDeltaY, Optional<int8_t> aZoomDelta) override;
+                                                         Optional<int16_t> aDeltaY, Optional<int8_t> aZoomDelta,
+                                                         Structs::ViewportStruct::Type & aViewport) override;
 
-    void SetCameraDeviceHAL(CameraDeviceInterface::CameraHALInterface * aCameraDevice);
+    void SetCameraDeviceHAL(CameraDeviceInterface * aCameraDevice);
+
+    /**
+     * DPTZ Stream Indication
+     */
+    void VideoStreamAllocated(uint16_t aStreamID) override;
+    void VideoStreamDeallocated(uint16_t aStreamID) override;
+    void DefaultViewportUpdated(Structs::ViewportStruct::Type aViewport) override;
 
 private:
-    CameraDeviceInterface::CameraHALInterface * mCameraDeviceHAL = nullptr;
+    CameraDeviceInterface * mCameraDeviceHAL = nullptr;
 };
 
 } // namespace CameraAvSettingsUserLevelManagement

examples/camera-app/linux/include/clusters/camera-avstream-mgmt/camera-av-stream-manager.h

@@ -78,10 +78,10 @@ class CameraAVStreamManager : public CameraAVStreamMgmtDelegate
     CameraAVStreamManager()  = default;
     ~CameraAVStreamManager() = default;
 
-    void SetCameraDeviceHAL(CameraDeviceInterface::CameraHALInterface * aCameraDevice);
+    void SetCameraDeviceHAL(CameraDeviceInterface * aCameraDevice);
 
 private:
-    CameraDeviceInterface::CameraHALInterface * mCameraDeviceHAL = nullptr;
+    CameraDeviceInterface * mCameraDeviceHAL = nullptr;
 };
 
 } // namespace CameraAvStreamManagement

examples/camera-app/linux/src/camera-device.cpp

@@ -65,8 +65,6 @@ CameraDevice::CameraDevice()
 
     // Provider manager uses the Media controller to register WebRTC Transport with media controller for AV source data
     mWebRTCProviderManager.SetMediaController(&mMediaController);
-
-    mCameraAVSettingsUserLevelManager.SetCameraDeviceHAL(this);
 }
 
 CameraDevice::~CameraDevice()