PIN-based pairing working

Author: bradkeifer

src/airplay.c

@@ -3972,9 +3972,6 @@ airplay_device_authorize(struct output_device *device, const char *pin, int call
   if (!rs)
     return -1;
 
-  DPRINTF(E_DBG, L_AIRPLAY, "%s:Calling sequence_start(AIRPLAY_SEQ_PAIR_SETUP,...) for %s with PIN %s\n",
-    __func__, device->name, pin
-  );
   sequence_start(AIRPLAY_SEQ_PAIR_SETUP, rs, (void *)pin, "device_authorize");
 
   return 1;

src/cliap2.c

@@ -147,12 +147,13 @@ usage(char *program)
   printf("  --loglevel <number>               Log level (0-5)\n");
   printf("  --logfile <filename>              Log filename. Not supplying this argument will result in logging to stderr only.\n");
   printf("  --logdomains <dom,dom..>          Log domains\n");
-  printf("  --config <file>                   Use <file> as the configuration file\n");
+  printf("  --config <file>                   Use <file> for the configuration file.\n");
   printf("  --name <name>                     Name of the airplay 2 device. Mandatory in absence of --ntpstart.\n");
   printf("  --hostname <hostname>             Hostname of AirPlay 2 device. Mandatory in absence of --ntpstart.\n");
   printf("  --address <address>               IP address to bind to for AirPlay 2 service. Mandatory in absence of --ntpstart.\n");
   printf("  --port <port>                     Port number to bind to for AirPlay 2 service. Mandatory in absence of --ntpstart.\n");
   printf("  --txt <txt>                       txt keyvals returned in mDNS for AirPlay 2 service. Mandatory in absence of --ntpstart.\n");
+  printf("  --auth <auth_key>                 Authorization key.\n");
   printf("  --pipe <audio_filename>           filename of named pipe to read streamed audio. Mandatory in absence of --ntpstart.\n");
   printf("  --command_pipe <command_filename> filename of named pipe to read commands and metadata. Defaults to <audio_filename>.metadata\n");
   printf("  --ntp                             Print current NTP time and exit.\n");
@@ -524,6 +525,7 @@ main(int argc, char **argv)
     { "testrun",       0, NULL, 514 }, // Used for CI, not documented to user
     { "pipe",          1, NULL, 515 },
     { "command_pipe",  1, NULL, 517 },
+    { "auth",          1, NULL, 518 },
 
     { NULL,            0, NULL, 0   }
   };
@@ -629,6 +631,10 @@ main(int argc, char **argv)
         mass_named_pipes.metadata_pipe = optarg;
         break;
 
+      case 518: // authorization key
+        ap2_device_info.auth_key = optarg;
+        break;
+
         default:
       case '?':
         usage(argv[0]);
@@ -683,7 +689,6 @@ main(int argc, char **argv)
     conffile_unload();
     return EXIT_FAILURE;
   }
-  // logger_detach();  // Eliminate logging to stderr
 
   if (testrun) {
     ret = create_pipes(TESTRUN_PIPE);
@@ -694,7 +699,7 @@ main(int argc, char **argv)
     mass_named_pipes.audio_pipe = TESTRUN_PIPE;
   }
   else {
-    // Check that named pipe exists for audio streaming. Metadata one too?
+    // Check that named pipes exist for audio streaming and metadata
     ret = check_pipe(mass_named_pipes.audio_pipe);
     if (ret < 0) {
       return EXIT_FAILURE;

src/cliap2.h

@@ -10,6 +10,7 @@ typedef struct ap2_device_info
   const char *address;
   int port;
   struct keyval *txt;
+  const char *auth_key;
   uint64_t ntpstart;
   uint32_t wait;
   struct timespec start_ts;

src/conffile.c

@@ -52,7 +52,7 @@ static cfg_opt_t sec_general[] =
     CFG_STR_LIST("trusted_networks", "{lan}", CFGF_NONE),
     CFG_BOOL("ipv6", cfg_false, CFGF_NONE),
     CFG_STR("bind_address", NULL, CFGF_NONE),
-    CFG_BOOL("speaker_autoselect", cfg_false, CFGF_NONE),
+    CFG_BOOL("speaker_autoselect", cfg_true, CFGF_NONE),
 #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__)
     CFG_BOOL("high_resolution_clock", cfg_false, CFGF_NONE),
 #else
@@ -70,7 +70,7 @@ static cfg_opt_t sec_general[] =
 /* library section structure */
 static cfg_opt_t sec_library[] =
   {
-    CFG_STR("name", "My Music on %h", CFGF_NONE),
+    CFG_STR("name", "Music Assistant", CFGF_NONE),
     CFG_INT("port", 3689, CFGF_NONE),
     CFG_STR("password", NULL, CFGF_NONE),
     CFG_STR_LIST("directories", NULL, CFGF_NONE),

src/mass.c

@@ -1238,7 +1238,9 @@ pipe_metadata_read_cb(evutil_socket_t fd, short event, void *arg)
   }
   if (message & PIPE_METADATA_MSG_PIN) {
     DPRINTF(E_DBG, L_PLAYER, "%s:Setting PIN from metadata pipe to %s\n", __func__, pipe_metadata.prepared.pin);
-    player_raop_verification_kickoff(&pipe_metadata.prepared.pin);
+    // We only support AirPlay2 at the moment. The below code will need to be changed if we add support
+    // for RAOP.
+    player_verification_kickoff(&pipe_metadata.prepared.pin, OUTPUT_TYPE_AIRPLAY);
     free(pipe_metadata.prepared.pin);
 
   }
@@ -1590,6 +1592,9 @@ mass_timer_cb(int fd, short what, void *arg)
 int
 mass_init(void)
 {
+  // Maybe we can add a call to player_device_add(device) in here somewhere to initiate device connection before
+  // audio is streamed to the named pipe. Currently, device connection is initiatied on receipt of data on the 
+  // audio named pipe.
   DPRINTF(E_DBG, L_PLAYER, "mass_init()\n");
 
   CHECK_ERR(L_PLAYER, mutex_init(&pipe_metadata.prepared.lock));
@@ -1599,6 +1604,8 @@ mass_init(void)
   if (!tid_pipe) {
     // main thread
     // Create a persistent event timer in the main event loop to monitor and report playback status
+    // Using the main thread may not be necessary anymore - test moving this into the pipe thread at some time
+    // to understand the implications.
     mass_timer_event = event_new(evbase_main, -1, EV_PERSIST | EV_TIMEOUT, mass_timer_cb, NULL);
     DPRINTF(E_DBG, L_PLAYER, 
       "%s:Activating persistent event timer with timeval %d sec, %d usec\n,",

src/player.c

@@ -1494,8 +1494,6 @@ device_auth_kickoff(void *arg, int *retval)
     }
 
   // We're async, so we don't care about return values or callbacks with result
-  DPRINTF(E_DBG, L_PLAYER, "%s:Device: %d sending PIN: %s to outputs_device_authorize()\n", 
-    __func__, device->name, cmdarg->auth.pin);
   outputs_device_authorize(device, cmdarg->auth.pin, NULL);
 
   *retval = 0;
@@ -2137,8 +2135,11 @@ playback_start_item(void *arg, int *retval)
 
 	  *retval = outputs_device_start(device, device_activate_cb, false);
     DPRINTF(E_DBG, L_PLAYER, 
-      "%s:outputs_device_start(device, device_activate_cb, false) returned %d for device %s, requires auth:%s\n",
-      __func__, *retval, device->name, device->requires_auth ? "true" : "false"
+      "%s:retval %d, Device %s, state: %d, requires auth:%s, prevent playback:%s, busy:%s\n",
+      __func__, *retval, device->name, device->state,
+      device->requires_auth ? "true" : "false",
+      device->prevent_playback ? "true" : "false",
+      device->busy ? "true" : "false"
     );
 	  if (*retval < 0)
 	    continue;
@@ -3872,6 +3873,25 @@ player_raop_verification_kickoff(char **arglist)
 
 }
 
+void
+player_verification_kickoff(char **arglist, enum output_types type)
+{
+  union player_arg *cmdarg;
+
+  cmdarg = calloc(1, sizeof(union player_arg));
+  if (!cmdarg)
+    {
+      DPRINTF(E_LOG, L_PLAYER, "Could not allocate player_command\n");
+      return;
+    }
+
+  cmdarg->auth.type = type;
+  memcpy(cmdarg->auth.pin, arglist[0], 4);
+
+  commands_exec_async(cmdbase, device_auth_kickoff, cmdarg);
+
+}
+
 
 /* ---------------------------- Thread: player ------------------------------ */
 

src/player.h

@@ -203,6 +203,9 @@ player_device_remove(void *device);
 void
 player_raop_verification_kickoff(char **arglist);
 
+void
+player_verification_kickoff(char **arglist, enum output_types type);
+
 const char *
 player_pmap(void *p);
 

src/wrappers.c

@@ -387,7 +387,11 @@ db_perthread_deinit(void)
 int
 db_speaker_save(struct output_device *device)
 {
-    // It has been tested that it is ok to do nothing
+    if (device->auth_key) {
+        DPRINTF(E_DBG, L_DB, "%s:Device %s has authorization key '%s'\n", 
+            __func__, device->name, device->auth_key
+        );
+    }
     return 0;
 }
 
@@ -397,7 +401,7 @@ db_speaker_get(struct output_device *device, uint64_t id)
     device->id = id;
     device->selected = 1;
     device->volume = ap2_device_info.volume;
-    //device->auth_key = ?? // might need to pass this as command line argument for some devices
+    device->auth_key = (char *)ap2_device_info.auth_key; // lose the const qualifier
     device->selected_format = MEDIA_FORMAT_ALAC;
 
     return 0;
@@ -472,6 +476,12 @@ db_escape_string(const char *str)
 /*
  * Wrappers for mdns.c
  */
+
+ // Immediately call the mdns_browse_cb with the information about the 
+ // airplay device we want to stream to.
+ // TODO: @bradkeifer - see if we can trigger device connection after
+ // the callback is complete. At the moment, device connection is triggered 
+ // on receipt of first audio streaming data on the named pipe.
 int
 mdns_browse(char *type, mdns_browse_cb cb, enum mdns_options flags)
 {