winmidi: add winrt::init_apartment in every example so that users do not encounter crashes

jcelerier · jcelerier · commit 84ea68f9fa33 · 2026-01-02T15:38:20.000-05:00
diff --git a/examples/c_api.c b/examples/c_api.c
@@ -104,6 +104,11 @@ int enumerate_ports(libremidi_midi_observer_handle* observer, struct enumerated_
 
 int main(void)
 {
+#if defined(_WIN32)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  CoInitializeEx(NULL, COINIT_MULTITHREADED);
+#endif
+
   int ret = 0;
 
   /// Create an observer for MIDI ports
diff --git a/examples/cmidiin.cpp b/examples/cmidiin.cpp
@@ -11,11 +11,20 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <cstdlib>
 #include <iostream>
 
 int main(int argc, const char** argv)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   // Read command line arguments
   libremidi::examples::arguments args{argc, argv};
 
diff --git a/examples/cmidiin2.cpp b/examples/cmidiin2.cpp
@@ -11,11 +11,20 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <cstdlib>
 #include <iostream>
 
 int main(int argc, const char** argv)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   // Read command line arguments
   libremidi::examples::arguments args{argc, argv};
 
diff --git a/examples/coroutines.cpp b/examples/coroutines.cpp
@@ -2,6 +2,10 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <boost/asio/detached.hpp>
 #include <boost/cobalt.hpp>
 
@@ -25,6 +29,11 @@ struct channel
 
 cobalt::main co_main(int argc, char** argv)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   cobalt::channel<libremidi::message> channel_impl{64};
   libremidi::channel channel{channel_impl};
   libremidi::midi_in midiin{{.on_message = channel}};
diff --git a/examples/echo.cpp b/examples/echo.cpp
@@ -2,13 +2,22 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <chrono>
 #include <cstdlib>
 #include <iostream>
 #include <thread>
 
 int main()
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   libremidi::observer obs;
   auto inputs = obs.get_input_ports();
   auto outputs = obs.get_output_ports();
diff --git a/examples/gui/main.cpp b/examples/gui/main.cpp
@@ -8,6 +8,10 @@
 #include <QSplitter>
 #include <QWidget>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 Q_DECLARE_METATYPE(libremidi::port_information);
 
 struct port_equal
@@ -27,6 +31,11 @@ struct port_name_sort
 
 int main(int argc, char** argv)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  // In addition, we are using Qt in this example which requires COM to be in single-thread mode.
+  winrt::init_apartment(winrt::apartment_type::single_threaded);
+#endif
   using namespace libremidi;
   auto in_api = libremidi::midi1::in_default_configuration();
   auto out_api = libremidi::midi1::out_default_configuration();
diff --git a/examples/jack_share.cpp b/examples/jack_share.cpp
@@ -87,6 +87,11 @@ struct my_app
 
 int main()
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   my_app app{};
 
   for (;;)
diff --git a/examples/midi1_to_midi2.cpp b/examples/midi1_to_midi2.cpp
@@ -3,6 +3,10 @@
 #include <libremidi/backends.hpp>
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <iostream>
 
 /**
@@ -12,6 +16,11 @@
 int main()
 try
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   // The observer object enumerates available inputs and outputs
   // jack is a MIDI 1 API (there's also jack_ump which leverages the newer
   // JACK / PipeWire MIDI 2 support).
diff --git a/examples/midi2_echo.cpp b/examples/midi2_echo.cpp
@@ -1,12 +1,21 @@
 #include <libremidi/backends.hpp>
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <iostream>
 #include <mutex>
 
 int main()
 try
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   using namespace libremidi;
   namespace lm2 = libremidi::midi2;
   // The observer object enumerates available inputs and outputs
diff --git a/examples/midi2_interop.cpp b/examples/midi2_interop.cpp
@@ -2,6 +2,10 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <midi/capability_inquiry.h>
 #include <midi/midi1_byte_stream.h>
 #include <midi/sysex_collector.h>
@@ -330,6 +334,11 @@ struct midi_ci_processor
 int main()
 try
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   midi_ci_processor processor;
 
   processor.open();
diff --git a/examples/midiclock_in.cpp b/examples/midiclock_in.cpp
@@ -13,11 +13,20 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <cstdlib>
 #include <iostream>
 
 int main(int argc, const char** argv)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   unsigned int clock_count = 0;
   auto midi_callback = [&](const libremidi::message& message) {
     // Ignore longer messages
diff --git a/examples/midiclock_out.cpp b/examples/midiclock_out.cpp
@@ -13,13 +13,22 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <chrono>
 #include <cstdlib>
 #include <iostream>
 #include <thread>
 
 int main(int argc, const char** argv)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   using namespace std::literals;
   // Read command line arguments
   libremidi::examples::arguments args{argc, argv};
diff --git a/examples/midifile_dump.cpp b/examples/midifile_dump.cpp
@@ -1,5 +1,9 @@
 #include <libremidi/reader.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <cmath>
 
 #include <fstream>
@@ -9,6 +13,11 @@
 
 int main(int argc, char** argv)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   if (argc < 2)
   {
     perror("Usage: ./midifile_dump <midifile.mid>");
diff --git a/examples/midiobserve.cpp b/examples/midiobserve.cpp
@@ -2,6 +2,10 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <cstdlib>
 #include <iostream>
 #include <map>
@@ -12,6 +16,11 @@
 
 int main()
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   std::vector<libremidi::observer> observers;
   for (auto api : libremidi::available_apis())
   {
diff --git a/examples/midiout.cpp b/examples/midiout.cpp
@@ -10,12 +10,21 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <array>
 #include <chrono>
 #include <thread>
 
 int main(int argc, const char** argv)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   using namespace std::literals;
 
   // Read command line arguments
diff --git a/examples/midiprobe.cpp b/examples/midiprobe.cpp
@@ -8,13 +8,22 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <chrono>
 #include <cstdlib>
 #include <iostream>
 #include <thread>
 
 void enumerate_api(libremidi::API api)
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   std::string_view api_name = libremidi::get_api_display_name(api);
   std::cout << "Displaying ports for: " << api_name << std::endl;
 
diff --git a/examples/minimal.cpp b/examples/minimal.cpp
@@ -3,11 +3,20 @@
 
 #include <libremidi/libremidi.hpp>
 
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #include <cstdlib>
 #include <iostream>
 
 int main()
 {
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+#endif
+
   libremidi::observer observer;
   if (observer.get_input_ports().empty())
     return 1;
diff --git a/examples/multithread_midiout.cpp b/examples/multithread_midiout.cpp
@@ -4,6 +4,11 @@
 #include <mutex>
 #include <thread>
 #include <vector>
+
+#if defined(_WIN32) && __has_include(<winrt/base.h>)
+  #include <winrt/base.h>
+#endif
+
 #if __has_include(<stop_token>)
   #include <deque>
   #include <stop_token>
@@ -51,6 +56,11 @@ class threadsafe_queue
 
 int main()
 {
+  #if defined(_WIN32) && __has_include(<winrt/base.h>)
+  // Necessary for using WinUWP and WinMIDI, must be done as early as possible in your main()
+  winrt::init_apartment();
+  #endif
+
   using namespace std::literals;
   using clk = std::chrono::steady_clock;
 
diff --git a/examples/protocols/remote_control.cpp b/examples/protocols/remote_control.cpp
diff --git a/examples/qmidiin.cpp b/examples/qmidiin.cpp
diff --git a/examples/rawmidiin.cpp b/examples/rawmidiin.cpp
diff --git a/examples/sysextest.cpp b/examples/sysextest.cpp
