Merge pull request #88 from microsoft/pete-dev

Updated main architecture diagram and also continued work on SDK shaping
microsoft · Jun 26, 2023 · 5d8f178 · 5d8f178
2 parents 0990fd8 + 235132a
commit 5d8f178
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 30 deletions.
diff --git a/img/high-level-view.png b/img/high-level-view.png
diff --git a/src/app-dev-sdk/sdk-core/Microsoft.Devices.Midi2.Core.vcxproj b/src/app-dev-sdk/sdk-core/Microsoft.Devices.Midi2.Core.vcxproj
@@ -143,18 +143,18 @@
     <ClInclude Include="MidiDeviceInformation.h">
       <DependentUpon>MidiDeviceInformation.idl</DependentUpon>
     </ClInclude>
-	  <ClInclude Include="MidiMessageReader.h">
-		  <DependentUpon>MidiMessageReader.idl</DependentUpon>
-	  </ClInclude>
-	  <ClInclude Include="MidiMessagesReceivedEventArgs.h">
-		  <DependentUpon>MidiMessagesReceivedEventArgs.idl</DependentUpon>
-	  </ClInclude>
+    <ClInclude Include="MidiMessageReader.h">
+      <DependentUpon>MidiMessageReader.idl</DependentUpon>
+    </ClInclude>
+    <ClInclude Include="MidiMessagesReceivedEventArgs.h">
+      <DependentUpon>MidiMessagesReceivedEventArgs.idl</DependentUpon>
+    </ClInclude>
     <ClInclude Include="MidiMessageTranslator.h">
       <DependentUpon>MidiMessageTranslator.idl</DependentUpon>
     </ClInclude>
-	  <ClInclude Include="MidiMessageWriter.h">
-		  <DependentUpon>MidiMessageWriter.idl</DependentUpon>
-	  </ClInclude>
+    <ClInclude Include="MidiMessageWriter.h">
+      <DependentUpon>MidiMessageWriter.idl</DependentUpon>
+    </ClInclude>
     <ClInclude Include="MidiServices.h">
       <DependentUpon>MidiServices.idl</DependentUpon>
     </ClInclude>
@@ -216,18 +216,18 @@
     <ClCompile Include="MidiDeviceInformation.cpp">
       <DependentUpon>MidiDeviceInformation.idl</DependentUpon>
     </ClCompile>
-	  <ClCompile Include="MidiMessageReader.cpp">
-		  <DependentUpon>MidiMessageReader.idl</DependentUpon>
-	  </ClCompile>
-	  <ClCompile Include="MidiMessagesReceivedEventArgs.cpp">
-		  <DependentUpon>MidiMessagesReceivedEventArgs.idl</DependentUpon>
-	  </ClCompile>
+    <ClCompile Include="MidiMessageReader.cpp">
+      <DependentUpon>MidiMessageReader.idl</DependentUpon>
+    </ClCompile>
+    <ClCompile Include="MidiMessagesReceivedEventArgs.cpp">
+      <DependentUpon>MidiMessagesReceivedEventArgs.idl</DependentUpon>
+    </ClCompile>
     <ClCompile Include="MidiMessageTranslator.cpp">
       <DependentUpon>MidiMessageTranslator.idl</DependentUpon>
     </ClCompile>
-	  <ClCompile Include="MidiMessageWriter.cpp">
-		  <DependentUpon>MidiMessageWriter.idl</DependentUpon>
-	  </ClCompile>
+    <ClCompile Include="MidiMessageWriter.cpp">
+      <DependentUpon>MidiMessageWriter.idl</DependentUpon>
+    </ClCompile>
     <ClCompile Include="MidiServices.cpp">
       <DependentUpon>MidiServices.idl</DependentUpon>
     </ClCompile>

diff --git a/src/app-dev-sdk/sdk-core/Microsoft.Devices.Midi2.Core.vcxproj.filters b/src/app-dev-sdk/sdk-core/Microsoft.Devices.Midi2.Core.vcxproj.filters
@@ -157,9 +157,6 @@
     <Midl Include="MidiGroupTerminalBlock.idl">
       <Filter>SDK\Enumeration</Filter>
     </Midl>
-    <Midl Include="MidiMessagesReceivedEvent.idl">
-      <Filter>SDK\Endpoints</Filter>
-    </Midl>
     <Midl Include="UmpWithTimestamp.idl">
       <Filter>SDK\Messages</Filter>
     </Midl>
@@ -172,6 +169,7 @@
     <Midl Include="MidiMessageWriter.idl">
       <Filter>SDK\Endpoints</Filter>
     </Midl>
+    <Midl Include="MidiMessagesReceivedEventArgs.idl" />
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />

diff --git a/src/app-dev-sdk/sdk-core/MidiMessageReader.idl b/src/app-dev-sdk/sdk-core/MidiMessageReader.idl
@@ -25,7 +25,7 @@ namespace Microsoft.Devices.Midi2
     };
 
     [default_interface]
-    runtimeclass MidiMessageReader // : Windows.Foundation.IClosable
+    runtimeclass MidiMessageReader // not IClosable because this needs to keep the lifetime of the EndpointConnection
     {
         //MidiMessageReader();
 

diff --git a/src/app-dev-sdk/sdk-core/MidiMessageWriter.idl b/src/app-dev-sdk/sdk-core/MidiMessageWriter.idl
@@ -25,7 +25,7 @@ namespace Microsoft.Devices.Midi2
     };
 
     [default_interface]
-    runtimeclass MidiMessageWriter // : Windows.Foundation.IClosable
+    runtimeclass MidiMessageWriter // not IClosable because this needs to keep the lifetime of the EndpointConnection
     {
         //MidiMessageWriter();
 

diff --git a/src/app-dev-sdk/sdk-core/MidiServices.idl b/src/app-dev-sdk/sdk-core/MidiServices.idl
@@ -10,6 +10,7 @@ import "MidiTransportInformation.idl";
 
 namespace Microsoft.Devices.Midi2
 {
+    // I strongly dislike the name of this enum
     enum WindowsMidiServicesCheckError
     {
         IncompatibleVersion = 100,

diff --git a/src/app-dev-sdk/sdk-core/UmpWithTimestamp.idl b/src/app-dev-sdk/sdk-core/UmpWithTimestamp.idl
@@ -6,12 +6,6 @@
 // Further information: https://github.com/microsoft/MIDI/
 // ============================================================================
 
-
-// NOTE: This is likely to change. We're working on the correct buffers to speak to the service
-// and API. That buffer also deals with timestamps and more. Intent is to provide UMP types
-// for folks who wish to use them, and direct access to buffers of MIDI words for those who
-// prefer that approach.
-
 import "Ump.idl";
 
 namespace Microsoft.Devices.Midi2
@@ -21,7 +15,7 @@ namespace Microsoft.Devices.Midi2
     // JR timestamp if we decide to just pass them through
 
     [default_interface]
-    unsealed runtimeclass UmpWithTimestamp
+    runtimeclass UmpWithTimestamp
     {
         UmpWithTimestamp();