Support windows build

Author: vporpo

README.md

@@ -5,6 +5,8 @@ This is an unofficial Linux client for the Q2 Wi-Fi Internet Radio.
 It uses libusb for the communication with the device in userspace.
 This program provides some basic functionality for loading radio stations to each side of the radio.
 
+A [windows executable](https://github.com/vporpo/q2radio/releases) can be found in the releases. Please download the zip file containing the windows executable along with the dlls.
+
 ## Requirements
 * libusb: You need to have the libusb developers package (The header file libusb.h is required).
 * A c++ compiler
@@ -13,10 +15,26 @@ This program provides some basic functionality for loading radio stations to eac
 ## Build Instructions
 ```bash
 $ git clone https://github.com/vporpo/q2radio.git
-$ cd q2radio
-$ make
-$ sudo make install
+$ make -C q2radio/src
+$ sudo make install # or just run the binary: q2radio/src/q2radio
+```
+### Windows build (thanks to user @Untitled-Document-1)
+You can use [MSYS2 UCRT64](https://www.msys2.org/) as a build environment.
 ```
+# In the MSYS2 UCRT64 terminal window:
+pacman -S git make mingw-w64-ucrt-x86_64-gcc mingw-w64-ucrt-x86_64-libusb
+git clone https://github.com/vporpo/q2radio.git
+make -C q2radio/src windows # Don't forget the 'windows' target
+# Run
+./q2radio/src/q2radio.exe
+```
+The chances are that you will get an error.
+
+You need to make sure the Q2Radio device uses the WinUSB driver.
+There is a tool for changing the driver called [Zadig](https://zadig.akeo.ie) (check out the [libusb windows documentation](https://github.com/libusb/libusb/wiki/Windows#how-to-use-libusb-on-windows).
+In the Zadig tool click on Options > List All Devices. Then Q2Radio should show up as a "USB Serial Device" in the drop-down list.
+Switch it to the "WinUSB" driver by selecting it on the right hand side of the green arrow, and click on the "Replace Driver" button.
+Then try running `q2radio.exe` once again, this time it should work.
 
 ## Run examples:
 ```bash

src/Makefile

@@ -1,6 +1,15 @@
 all:
 	$(CXX) -O q2radio.cpp -lusb-1.0 -o q2radio
 
+windows:
+	$(CXX) -O q2radio.cpp -lusb-1.0 -o q2radio -DWINDOWS
+
+# For development use
+win_dst=q2radio_win
+windows_release: windows
+	mkdir -p $(win_dst)
+	zip -r $(win_dst).zip $(win_dst)/
+
 install:
 	cp q2radio /usr/local/bin/
 clean:

src/q2radio.cpp

@@ -16,6 +16,8 @@
 // #define DBG(CMD) CMD
 #define DBG(CMD)
 
+static constexpr const char *version = "0.1";
+
 #include <assert.h>
 #include <getopt.h>
 #include <iomanip> // setfill(), setw()
@@ -146,7 +148,7 @@ struct Args {
   char *stationName = nullptr;
   char *stationUrl = nullptr;
   bool list = false;
-  char *custom = nullptr;
+  char *passthru = nullptr;
   char *ssid = nullptr;
   char *key = nullptr;
 
@@ -178,9 +180,9 @@ struct Args {
     }
     std::cout << "\n";
     std::cout << "list: " << list << "\n";
-    std::cout << "Custom: ";
-    if (custom) {
-      std::cout << custom;
+    std::cout << "Passthru: ";
+    if (passthru) {
+      std::cout << passthru;
     }
     std::cout << "\n";
     std::cout << "SSID: \"";
@@ -203,7 +205,7 @@ static struct option long_options[] = {
     {"wifi-ssid", required_argument, 0, 'w'},
     {"wifi-key", required_argument, 0, 'k'},
     {"list", no_argument, 0, 'l'},
-    {"custom", required_argument, 0, 'c'},
+    {"passthru", required_argument, 0, 'c'},
     // WARNING: Keep "help" last for automatically generated usage() message
     {"help", no_argument, 0, 'h'}};
 
@@ -231,10 +233,10 @@ void usage(char **argv) {
     }
     ++i;
   }
-  std::cerr << "Example: --side 0 --name \"Rebel State Radio\" --url "
-               "\"http://eco.onestreaming.com:8142\"\n";
-  std::cerr << "Example: --wifi-ssid \"<SSID>\" --wifi-key \"<WIFI KEY>\"\n";
-  std::cerr << "Example: --custom \"gpre 0 name\":\n";
+  std::cerr << "Example: --side 0 --name 'Rebel State Radio' --url 'http://eco.onestreaming.com:8142'\n";
+  std::cerr << "Example: --wifi-ssid '<SSID>' --wifi-key '<WIFI KEY>'\n";
+  std::cerr << "Example: --list                   (prints the stations on each side of the radio)\n";
+  std::cerr << "Example: --passthru 'gpre 0 name' (passes raw commands directly to the radio - try 'help')\n";
 }
 
 void parseArgs(int argc, char **argv, Args *args) {
@@ -267,7 +269,7 @@ void parseArgs(int argc, char **argv, Args *args) {
       args->list = true;
       return;
     case 'c':
-      args->custom = (char *)optarg;
+      args->passthru = (char *)optarg;
       break;
     case 'w':
       args->ssid = (char *)optarg;
@@ -307,9 +309,9 @@ void printResponse(libusb_device_handle *handle, bool out = true) {
 }
 
 void banner(void) {
-  std::cout << "+--------------- Q2 Radio Setup --------------+\n";
-  std::cout << "|                                             |\n";
   std::cout << "+---------------------------------------------+\n";
+  std::cout << "|                Q2 Radio Setup               |\n";
+  std::cout << "+------------------------------------- v" << version << " --+\n";
 }
 
 int main(int argc, char **argv) {
@@ -319,31 +321,33 @@ int main(int argc, char **argv) {
   args.check();
   // args.dump();
 
-  libusb_device **devs; // list of devices
   libusb_context *ctx = NULL;
   int r;
   if ((r = libusb_init(&ctx)) < 0) {
     std::cerr << "libusb_init() error\n";
     exit(1);
   }
 
-  libusb_set_debug(ctx, 3);
+  libusb_set_debug(ctx, 1);
+  // libusb_device **devs; // list of devices
   // ssize_t dev_cnt;
   // if ((dev_cnt = libusb_get_device_list(ctx, &devs)) < 0) {
   //   std::cerr << "libusb_get_device_list() error\n";
   //   exit(1);
   // };
   // printAllDevs(devs, dev_cnt);
+  // libusb_free_device_list(devs, 1);
 
   libusb_device_handle *handle;
   int VID = 0x1f2e;
   int PID = 0x000a;
   if ((handle = libusb_open_device_with_vid_pid(ctx, VID, PID)) == NULL) {
-    DBG(fprintf(stderr, "libusb_open_device_with_vid_pid(%04x:%04x)\n", VID,
+    DBG(fprintf(stderr, "FAILED: libusb_open_device_with_vid_pid(%04x:%04x)\n", VID,
                 PID));
+    fprintf(stderr, "ERROR: Could not connect to the device!\n");
+    fprintf(stderr, "Please make sure it is connected and turned on!\n");
     exit(1);
   }
-  // libusb_free_device_list(devs, 1);
 
   if (libusb_kernel_driver_active(handle, 0) == 1) {
     DBG(std::cerr << "Kernel driver active\n");
@@ -353,13 +357,16 @@ int main(int argc, char **argv) {
   }
 
   int IF = 0;
-  if (libusb_claim_interface(handle, IF) < 0) {
+#ifdef WINDOWS
+  IF = 1;
+#endif
+  if (libusb_claim_interface(handle, IF) != 0) {
     std::cerr << "libusb_claim_interface(" << IF << ") failed!\n";
     exit(1);
   }
 
-  if (args.custom) {
-    sendStr(handle, args.custom);
+  if (args.passthru) {
+    sendStr(handle, args.passthru);
     printResponse(handle);
     return 0;
   }