Merge pull request #33 from music-assistant/16-support-pin-based-pairing

Implementation of PIN-based pairing

Author: bradkeifer

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

@@ -81,17 +81,17 @@
 #include "mass.h"
 #include "wrappers.h"
 
-#define MASS_UPDATE_INTERVAL_SEC 1 // every second
-#define MASS_MS_TILL_EXIT 5000 // exit after 5 seconds of pause
-#define MASS_METADATA_KEYVAL_SEP "="  // Key-value separator in metadata
+#define MASS_UPDATE_INTERVAL_SEC   1 // every second
+#define MASS_METADATA_KEYVAL_SEP   "="  // Key-value separator in metadata
 #define MASS_METADATA_PROGRESS_KEY "PROGRESS"
 #define MASS_METADATA_VOLUME_KEY   "VOLUME"
 #define MASS_METADATA_ARTWORK_KEY  "ARTWORK"
 #define MASS_METADATA_ALBUM_KEY    "ALBUM"
 #define MASS_METADATA_TITLE_KEY    "TITLE"
 #define MASS_METADATA_ARTIST_KEY   "ARTIST"
-#define MASS_METADATA_DURATION_KEY  "DURATION"
-#define MASS_METADATA_ACTION_KEY    "ACTION"
+#define MASS_METADATA_DURATION_KEY "DURATION"
+#define MASS_METADATA_ACTION_KEY   "ACTION"
+#define MASS_METADATA_PIN_KEY      "PIN"
 
 /* from cliap2.c */
 extern mass_named_pipes_t mass_named_pipes;
@@ -137,6 +137,7 @@ enum pipe_metadata_msg
   PIPE_METADATA_MSG_STOP             = (1 << 6),
   PIPE_METADATA_MSG_PAUSE            = (1 << 7),
   PIPE_METADATA_MSG_PLAY             = (1 << 8),
+  PIPE_METADATA_MSG_PIN              = (1 << 9),
 };
 
 struct pipe
@@ -164,6 +165,8 @@ struct pipe_metadata_prepared
   char pict_tmpfile_path[sizeof(PIPE_TMPFILE_TEMPLATE)];
   // Volume
   int volume;
+  // PIN
+  char *pin; // 4 digit PIN
   // Mutex to share the prepared metadata
   pthread_mutex_t lock;
 };
@@ -835,7 +838,6 @@ void extract_key_value(const char *input_string, char **key, char **value) {
 }
 
 // Parse one metadata item from Music Assistant
-// TODO: @bradkeifer - check memory management to ensure key and value are freed properly
 static int
 parse_mass_item(enum pipe_metadata_msg *out_msg, struct pipe_metadata_prepared *prepared, const char *item)
 {
@@ -924,6 +926,21 @@ parse_mass_item(enum pipe_metadata_msg *out_msg, struct pipe_metadata_prepared *
     free(value);
     DPRINTF(E_DBG, L_PLAYER, "%s:Parsed Music Assistant volume: %d\n", __func__, prepared->volume);
   }
+  else if (!strncmp(key,MASS_METADATA_PIN_KEY, strlen(MASS_METADATA_PIN_KEY))) {
+    message = PIPE_METADATA_MSG_PIN;
+    uint32_t pin;
+    ret = safe_atou32(value, &pin);
+    if (ret < 0 || ret > 9999) { // PIN's limited to 4 digits
+        DPRINTF(E_LOG, L_PLAYER, "%s:Invalid PIN value in Music Assistant metadata: '%s'\n", __func__, value);
+        free(key);
+        free(value);
+        return -1;
+    }
+    asprintf(&prepared->pin, "%0.4u", pin);
+    free(key);
+    free(value);
+    DPRINTF(E_DBG, L_PLAYER, "%s:Parsed Music Assistant PIN: %0.4s\n", __func__, prepared->pin);
+  }
   else if (!strncmp(key,MASS_METADATA_ACTION_KEY, strlen(MASS_METADATA_ACTION_KEY))) {
       if (strncmp(value, "SENDMETA", strlen("SENDMETA")) == 0) {
          message = PIPE_METADATA_MSG_METADATA;
@@ -962,75 +979,6 @@ parse_mass_item(enum pipe_metadata_msg *out_msg, struct pipe_metadata_prepared *
   return 0;
 }
 
-static int
-parse_item(enum pipe_metadata_msg *out_msg, struct pipe_metadata_prepared *prepared, const char *item)
-{
-  struct input_metadata *m = &prepared->input_metadata;
-  uint32_t type;
-  uint32_t code;
-  uint8_t *data;
-  int data_len;
-  char **dstptr;
-  enum pipe_metadata_msg message;
-  int ret;
-
-  ret = parse_item_xml(&type, &code, &data, &data_len, item);
-  if (ret < 0)
-    return -1;
-
-  dstptr = NULL;
-  message = PIPE_METADATA_MSG_METADATA;
-
-  if (code == dmap_str2val("asal"))
-    dstptr = &m->album;
-  else if (code == dmap_str2val("asar"))
-    dstptr = &m->artist;
-  else if (code == dmap_str2val("minm"))
-    dstptr = &m->title;
-  else if (code == dmap_str2val("asgn"))
-    dstptr = &m->genre;
-  else if (code == dmap_str2val("prgr"))
-    message = PIPE_METADATA_MSG_PROGRESS;
-  else if (code == dmap_str2val("pvol"))
-    message = PIPE_METADATA_MSG_VOLUME;
-  else if (code == dmap_str2val("PICT"))
-    message = PIPE_METADATA_MSG_PICTURE;
-  else if (code == dmap_str2val("pfls"))
-    message = PIPE_METADATA_MSG_FLUSH;
-  else
-    goto ignore;
-
-  if (message != PIPE_METADATA_MSG_FLUSH && (!data || data_len == 0))
-    {
-      log_incoming(E_DBG, "Missing or pending Shairport metadata payload", type, code, data_len);
-      goto ignore;
-    }
-
-  ret = 0;
-  if (message == PIPE_METADATA_MSG_PROGRESS)
-    ret = parse_progress(prepared, (char *)data);
-  else if (message == PIPE_METADATA_MSG_VOLUME)
-    ret = parse_volume(prepared, (char *)data);
-  else if (message == PIPE_METADATA_MSG_PICTURE)
-    ret= parse_picture(prepared, data, data_len);
-  else if (dstptr)
-    swap_pointers(dstptr, (char **)&data);
-
-  if (ret < 0)
-    goto ignore;
-
-  log_incoming(E_DBG, "Applying Shairport metadata", type, code, data_len);
-
-  *out_msg = message;
-  free(data);
-  return 0;
-
- ignore:
-  *out_msg = 0;
-  free(data);
-  return 0;
-}
-
 // Music Assistant terminates commands/metadata with a newline. This extracts
 // one item from the evbuffer, or NULL if there is no complete item.
 static char *
@@ -1092,6 +1040,7 @@ pipe_read_cb(evutil_socket_t fd, short event, void *arg)
 {
   struct pipe *pipe = arg;
   struct player_status status;
+  struct player_speaker_info speaker_info;
   int ret;
 
   ret = player_get_status(&status);
@@ -1287,6 +1236,14 @@ pipe_metadata_read_cb(evutil_socket_t fd, short event, void *arg)
     DPRINTF(E_DBG, L_PLAYER, "%s:Setting volume from metadata pipe to %d\n", __func__, pipe_metadata.prepared.volume);
     player_volume_set(pipe_metadata.prepared.volume);
   }
+  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);
+    // 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);
+
+  }
   if (message & PIPE_METADATA_MSG_FLUSH) {
     DPRINTF(E_DBG, L_PLAYER, "%s:Flushing playback from metadata pipe command\n", __func__);
     player_playback_flush();
@@ -1635,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));
@@ -1644,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

@@ -1645,6 +1645,7 @@ device_activate_cb(struct output_device *device, enum output_device_state status
   if (status == OUTPUT_STATE_PASSWORD)
     {
       DPRINTF(E_LOG, L_PLAYER, "The %s device '%s' requires a valid PIN or password\n", device->type_name, device->name);
+      // We need to figure out how to prevent playback starting until such time as PIN or password has been supplied??
 
       outputs_device_deselect(device);
 
@@ -2114,6 +2115,10 @@ playback_start_item(void *arg, int *retval)
   // Start sessions on selected devices. We shouldn't see any callbacks to
   // device_shutdown_cb, since the unselected devices shouldn't have sessions.
   *retval = outputs_start(device_activate_cb, device_shutdown_cb, false);
+  DPRINTF(E_DBG, L_PLAYER, 
+    "%s:outputs_start(device_activate_cb, device_shutdown_cb, false) returned %d\n",
+    __func__, *retval
+  );
   if (*retval < 0)
     DPRINTF(E_WARN, L_PLAYER, "All selected speakers failed to start\n");
 
@@ -2129,6 +2134,13 @@ playback_start_item(void *arg, int *retval)
 	    continue;
 
 	  *retval = outputs_device_start(device, device_activate_cb, false);
+    DPRINTF(E_DBG, L_PLAYER, 
+      "%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;
 
@@ -3861,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)
 {