API tweaks

microsoft · Mar 7, 2024 · 6cd9fe0 · 6cd9fe0
1 parent 4891953
commit 6cd9fe0
Show file tree

Hide file tree

Showing 15 changed files with 61 additions and 25 deletions.
diff --git a/src/api/Client/Midi2Client/IMidiUniversalPacket.idl b/src/api/Client/Midi2Client/IMidiUniversalPacket.idl
@@ -29,8 +29,8 @@ namespace Windows.Devices.Midi2
 
 
         IVector<UInt32> GetAllWords();
-        UInt8 AppendAllMessageWordsToVector(IVector<UInt32> targetVector);
+        UInt8 AppendAllMessageWordsToList(IVector<UInt32> targetList);
 
-        UInt8 AddAllMessageBytesToBuffer(UInt32 byteOffset, Windows.Foundation.IMemoryBuffer buffer);
+        UInt8 FillBuffer(UInt32 byteOffset, Windows.Foundation.IMemoryBuffer buffer);
     };
 }
diff --git a/src/api/Client/Midi2Client/MidiEndpointDeviceInformation.cpp b/src/api/Client/Midi2Client/MidiEndpointDeviceInformation.cpp
@@ -113,20 +113,22 @@ namespace winrt::Windows::Devices::Midi2::implementation
         additionalProperties.Append(STRING_PKEY_MIDI_TransportMnemonic);
 
         additionalProperties.Append(STRING_PKEY_MIDI_NativeDataFormat);
+        additionalProperties.Append(STRING_PKEY_MIDI_SupportsMulticlient);
         additionalProperties.Append(STRING_PKEY_MIDI_SupportedDataFormats);
 
+        additionalProperties.Append(STRING_PKEY_MIDI_ManufacturerName);
+        additionalProperties.Append(STRING_PKEY_MIDI_GenerateIncomingTimestamp);
+
         additionalProperties.Append(STRING_PKEY_MIDI_TransportSuppliedEndpointName);
         additionalProperties.Append(STRING_PKEY_MIDI_TransportSuppliedDescription);
 
-        additionalProperties.Append(STRING_PKEY_MIDI_SupportsMulticlient);
-        additionalProperties.Append(STRING_PKEY_MIDI_GenerateIncomingTimestamp);
+
 
         // USB / KS Properties ===============================================================
         // TODO: Group Terminal Blocks will likely be a single property
         additionalProperties.Append(STRING_PKEY_MIDI_IN_GroupTerminalBlocks);
         additionalProperties.Append(STRING_PKEY_MIDI_OUT_GroupTerminalBlocks);
         additionalProperties.Append(STRING_PKEY_MIDI_AssociatedUMP);
-        additionalProperties.Append(STRING_PKEY_MIDI_ManufacturerName);
         additionalProperties.Append(STRING_PKEY_MIDI_SerialNumber);
         additionalProperties.Append(STRING_PKEY_MIDI_UsbVID);
         additionalProperties.Append(STRING_PKEY_MIDI_UsbPID);
@@ -135,13 +137,16 @@ namespace winrt::Windows::Devices::Midi2::implementation
         // Major Known Endpoint Types ========================================================
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointDevicePurpose);
 
+        additionalProperties.Append(STRING_PKEY_MIDI_EndpointRequiresMetadataHandler);
+
         // In-protocol Endpoint information ==================================================
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointSupportsMidi2Protocol);
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointSupportsMidi1Protocol);
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointSupportsReceivingJRTimestamps);
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointSupportsSendingJRTimestamps);
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointUmpVersionMajor);
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointUmpVersionMinor);
+
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointProvidedName);
         additionalProperties.Append(STRING_PKEY_MIDI_EndpointProvidedProductInstanceId);
         additionalProperties.Append(STRING_PKEY_MIDI_DeviceIdentity);
@@ -176,6 +181,13 @@ namespace winrt::Windows::Devices::Midi2::implementation
         additionalProperties.Append(STRING_PKEY_MIDI_FunctionBlocksLastUpdateTime);
 
 
+        additionalProperties.Append(STRING_PKEY_MIDI_MidiOutCalculatedLatencyTicks);
+        additionalProperties.Append(STRING_PKEY_MIDI_MidiOutUserSuppliedLatencyTicks);
+        additionalProperties.Append(STRING_PKEY_MIDI_MidiOutLatencyTicksUserOverride);
+
+
+        additionalProperties.Append(STRING_PKEY_MIDI_VirtualMidiEndpointAssociator);
+
 
         // Calculated metrics =================================================================
         // we don't load them here because they would spam device information update events

diff --git a/src/api/Client/Midi2Client/MidiEndpointDeviceInformation.idl b/src/api/Client/Midi2Client/MidiEndpointDeviceInformation.idl
@@ -136,9 +136,6 @@ namespace Windows.Devices.Midi2
 
 
 
-
-
-
         // The settings app allows the user to add some metadata, like a description
         String UserSuppliedName{ get; };            // name supplied by the user, if available
         String UserSuppliedDescription{ get; };

diff --git a/src/api/Client/Midi2Client/MidiMessage128.cpp b/src/api/Client/Midi2Client/MidiMessage128.cpp
@@ -25,7 +25,7 @@ namespace winrt::Windows::Devices::Midi2::implementation
     }
 
     _Use_decl_annotations_
-    uint8_t MidiMessage128::AppendAllMessageWordsToVector(collections::IVector<uint32_t> targetVector) const noexcept
+    uint8_t MidiMessage128::AppendAllMessageWordsToList(collections::IVector<uint32_t> targetVector) const noexcept
     {
         targetVector.Append(m_ump.word0);
         targetVector.Append(m_ump.word1);
@@ -36,7 +36,7 @@ namespace winrt::Windows::Devices::Midi2::implementation
     }
 
     _Use_decl_annotations_
-    uint8_t MidiMessage128::AddAllMessageBytesToBuffer(uint32_t const byteOffset, foundation::IMemoryBuffer const& buffer) const noexcept
+    uint8_t MidiMessage128::FillBuffer(uint32_t const byteOffset, foundation::IMemoryBuffer const& buffer) const noexcept
     {
         const uint8_t numWordsInPacket = 4;
         const uint8_t numBytesInPacket = numWordsInPacket * sizeof(uint32_t);

diff --git a/src/api/Client/Midi2Client/MidiMessage128.h b/src/api/Client/Midi2Client/MidiMessage128.h
@@ -66,10 +66,10 @@ namespace winrt::Windows::Devices::Midi2::implementation
 
 
         collections::IVector<uint32_t> GetAllWords() const noexcept;
-        uint8_t AppendAllMessageWordsToVector(
+        uint8_t AppendAllMessageWordsToList(
             _Inout_ collections::IVector<uint32_t> targetVector) const noexcept;
 
-        uint8_t AddAllMessageBytesToBuffer(
+        uint8_t FillBuffer(
             _In_ uint32_t const byteOffset,
             _In_ foundation::IMemoryBuffer const& buffer
         ) const noexcept;

diff --git a/src/api/Client/Midi2Client/MidiMessage32.cpp b/src/api/Client/Midi2Client/MidiMessage32.cpp
@@ -25,15 +25,15 @@ namespace winrt::Windows::Devices::Midi2::implementation
     }
 
     _Use_decl_annotations_
-    uint8_t MidiMessage32::AppendAllMessageWordsToVector(collections::IVector<uint32_t> targetVector) const noexcept
+    uint8_t MidiMessage32::AppendAllMessageWordsToList(collections::IVector<uint32_t> targetVector) const noexcept
     {
         targetVector.Append(m_ump.word0);
 
         return 1;
     }
 
     _Use_decl_annotations_
-    uint8_t MidiMessage32::AddAllMessageBytesToBuffer(uint32_t const byteOffset, foundation::IMemoryBuffer const& buffer) const noexcept
+    uint8_t MidiMessage32::FillBuffer(uint32_t const byteOffset, foundation::IMemoryBuffer const& buffer) const noexcept
     {
         const uint8_t numWordsInPacket = 2;
         const uint8_t numBytesInPacket = numWordsInPacket * sizeof(uint32_t);

diff --git a/src/api/Client/Midi2Client/MidiMessage32.h b/src/api/Client/Midi2Client/MidiMessage32.h
@@ -47,11 +47,11 @@ namespace winrt::Windows::Devices::Midi2::implementation
         uint32_t PeekFirstWord() { return Word0(); }
 
         collections::IVector<uint32_t> GetAllWords() const noexcept;
-        uint8_t AppendAllMessageWordsToVector(
+        uint8_t AppendAllMessageWordsToList(
             _Inout_ collections::IVector<uint32_t> targetVector
         ) const noexcept;
 
-        uint8_t AddAllMessageBytesToBuffer(
+        uint8_t FillBuffer(
             _In_ uint32_t const byteOffset,
             _In_ foundation::IMemoryBuffer const& buffer
             ) const noexcept;

diff --git a/src/api/Client/Midi2Client/MidiMessage64.cpp b/src/api/Client/Midi2Client/MidiMessage64.cpp
@@ -24,7 +24,7 @@ namespace winrt::Windows::Devices::Midi2::implementation
     }
 
     _Use_decl_annotations_
-    uint8_t MidiMessage64::AppendAllMessageWordsToVector(collections::IVector<uint32_t> targetVector) const noexcept
+    uint8_t MidiMessage64::AppendAllMessageWordsToList(collections::IVector<uint32_t> targetVector) const noexcept
     {
         targetVector.Append(m_ump.word0);
         targetVector.Append(m_ump.word1);
@@ -33,7 +33,7 @@ namespace winrt::Windows::Devices::Midi2::implementation
     }
 
     _Use_decl_annotations_
-    uint8_t MidiMessage64::AddAllMessageBytesToBuffer(uint32_t const byteOffset, foundation::IMemoryBuffer const& buffer) const noexcept
+    uint8_t MidiMessage64::FillBuffer(uint32_t const byteOffset, foundation::IMemoryBuffer const& buffer) const noexcept
     {
         const uint8_t numWordsInPacket = 2;
         const uint8_t numBytesInPacket = numWordsInPacket * sizeof(uint32_t);

diff --git a/src/api/Client/Midi2Client/MidiMessage64.h b/src/api/Client/Midi2Client/MidiMessage64.h
@@ -59,10 +59,10 @@ namespace winrt::Windows::Devices::Midi2::implementation
         winrt::hstring ToString();
 
         collections::IVector<uint32_t> GetAllWords() const noexcept;
-        uint8_t AppendAllMessageWordsToVector(
+        uint8_t AppendAllMessageWordsToList(
             _Inout_ collections::IVector<uint32_t> targetVector) const noexcept;
 
-        uint8_t AddAllMessageBytesToBuffer(
+        uint8_t FillBuffer(
             _In_ uint32_t const byteOffset,
             _In_ foundation::IMemoryBuffer const& buffer
         ) const noexcept;

diff --git a/src/api/Client/Midi2Client/MidiMessage96.cpp b/src/api/Client/Midi2Client/MidiMessage96.cpp
@@ -24,7 +24,7 @@ namespace winrt::Windows::Devices::Midi2::implementation
     }
 
     _Use_decl_annotations_
-    uint8_t MidiMessage96::AppendAllMessageWordsToVector(collections::IVector<uint32_t> targetVector) const noexcept
+    uint8_t MidiMessage96::AppendAllMessageWordsToList(collections::IVector<uint32_t> targetVector) const noexcept
     {
         targetVector.Append(m_ump.word0);
         targetVector.Append(m_ump.word1);
@@ -35,7 +35,7 @@ namespace winrt::Windows::Devices::Midi2::implementation
 
 
     _Use_decl_annotations_
-    uint8_t MidiMessage96::AddAllMessageBytesToBuffer(uint32_t const byteOffset, foundation::IMemoryBuffer const& buffer) const noexcept
+    uint8_t MidiMessage96::FillBuffer(uint32_t const byteOffset, foundation::IMemoryBuffer const& buffer) const noexcept
     {
         const uint8_t numWordsInPacket = 3;
         const uint8_t numBytesInPacket = numWordsInPacket * sizeof(uint32_t);

diff --git a/src/api/Client/Midi2Client/MidiMessage96.h b/src/api/Client/Midi2Client/MidiMessage96.h
@@ -61,10 +61,10 @@ namespace winrt::Windows::Devices::Midi2::implementation
             { return midi2::MidiPacketType::UniversalMidiPacket96; }
 
         collections::IVector<uint32_t> GetAllWords() const noexcept;
-        uint8_t AppendAllMessageWordsToVector(
+        uint8_t AppendAllMessageWordsToList(
             _Inout_ collections::IVector<uint32_t> targetVector) const noexcept;
 
-        uint8_t AddAllMessageBytesToBuffer(
+        uint8_t FillBuffer(
             _In_ uint32_t const byteOffset,
             _In_ foundation::IMemoryBuffer const& buffer
         ) const noexcept;

diff --git a/src/api/Client/Midi2Client/MidiMessageReceivedEventArgs.cpp b/src/api/Client/Midi2Client/MidiMessageReceivedEventArgs.cpp
@@ -276,6 +276,26 @@ namespace winrt::Windows::Devices::Midi2::implementation
         return messageWordCount;
     }
 
+    _Use_decl_annotations_
+    uint8_t MidiMessageReceivedEventArgs::AppendWordsToList(
+        collections::IVector<uint32_t> wordList
+        )
+    {
+        uint8_t messageWordCount = GetValidMessageWordCount();
+
+        // copy over the words
+
+        uint32_t* umpData = (uint32_t*)&m_data;
+
+        for (int i = 0; i < messageWordCount; i++)
+        {
+            wordList.Append(umpData[i]);
+        }
+
+        return messageWordCount;
+    }
+
+
     _Use_decl_annotations_
     uint8_t MidiMessageReceivedEventArgs::FillByteArray(
         uint32_t const startIndex,

diff --git a/src/api/Client/Midi2Client/MidiMessageReceivedEventArgs.h b/src/api/Client/Midi2Client/MidiMessageReceivedEventArgs.h
@@ -75,6 +75,10 @@ namespace winrt::Windows::Devices::Midi2::implementation
             _In_ foundation::IMemoryBuffer const& buffer
         );
 
+        uint8_t AppendWordsToList(
+            _In_ collections::IVector<uint32_t> wordList
+        );
+
     private:
         uint8_t GetValidMessageWordCount() { return internal::GetUmpLengthInMidiWordsFromFirstWord(m_data.Word0); }
 

diff --git a/src/api/Client/Midi2Client/MidiMessageReceivedEventArgs.idl b/src/api/Client/Midi2Client/MidiMessageReceivedEventArgs.idl
@@ -68,5 +68,8 @@ namespace Windows.Devices.Midi2
         // Fill a spot in an existing IMemoryBuffer controlled by the caller. Returns the number of BYTES written
         UInt8 FillBuffer(UInt32 byteOffset, Windows.Foundation.IMemoryBuffer buffer);
 
+        // Adds the message words to the end of the provided list, and returns the number of words added.
+        UInt8 AppendWordsToList(IVector<UInt32> wordList);
+
     }
 }
diff --git a/src/api/Client/Midi2Client/MidiMessageUtility.cpp b/src/api/Client/Midi2Client/MidiMessageUtility.cpp
@@ -97,7 +97,7 @@ namespace winrt::Windows::Devices::Midi2::implementation
 
         for (auto const& message : messages)
         {
-            message.AppendAllMessageWordsToVector(result);
+            message.AppendAllMessageWordsToList(result);
         }
 
         return result;