Merge pull request #29 from music-assistant/26-specify-file-name-for-metadatacommands-named-pipe-as-a-command-line-argument

Command/Metadata named pipe filename via argument

Author: bradkeifer

src/cliap2.c

@@ -79,7 +79,7 @@ struct event_base *evbase_main;
 static struct event *sig_event;
 static int main_exit;
 ap2_device_info_t ap2_device_info;
-char* gnamed_pipe = NULL;
+mass_named_pipes_t mass_named_pipes = {0, 0};
 
 static inline void
 timespec_to_ntp(struct timespec *ts, struct ntp_timestamp *ns)
@@ -144,22 +144,23 @@ usage(char *program)
   printf("\n");
   printf("Usage: %s [options]\n\n", program);
   printf("Options:\n");
-  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("  --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("  --pipe                    filename of named pipe to read streamed audio. Mandatory in absence of --ntpstart.\n");
-  printf("  --ntp                     Print current NTP time and exit.\n");
-  printf("  --wait                    Start playback after <wait> milliseconds\n");
-  printf("  --ntpstart                Start playback at NTP <start> + <wait>. Mandatory in absence of --ntpstart.\n");
-  printf("  --latency                 Latency to apply in frames\n");
-  printf("  --volume                  Initial volume (0-100). Mandatory in absence of --ntpstart.\n");
-  printf("  -v, --version             Display version information and exit\n");
+  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("  --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("  --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");
+  printf("  --wait                            Start playback after <wait> milliseconds\n");
+  printf("  --ntpstart                        Start playback at NTP <start> + <wait>. Mandatory in absence of --ntpstart.\n");
+  printf("  --latency                         Latency to apply in frames. Not yet implemented.\n");
+  printf("  --volume                          Initial volume (0-100). Mandatory in absence of --ntpstart.\n");
+  printf("  -v, --version                     Display version information and exit\n");
   printf("\n\n");
   printf("Available log domains:\n");
   logger_domains();
@@ -367,24 +368,6 @@ int check_pipe(const char *pipe_path)
   return 0;
 }
 
-// Check for valid named pipe(s).
-// @param name the filename of the audio streaming named pipe
-// @returns 0 on success, -1 on failure
-static
-int check_pipes(const char *pipe_path)
-{
-  if (check_pipe(pipe_path) == 0) {
-    int ret;
-    char *metadata_path = NULL;
-
-    asprintf(&metadata_path, "%s.metadata", pipe_path);
-    ret = check_pipe(metadata_path);
-    free(metadata_path);
-    return ret;
-  }
-  return -1;
-}
-
 // Create named pipe.
 // @param name the filename of the named pipe
 // @returns 0 on success, -1 on failure
@@ -496,6 +479,7 @@ main(int argc, char **argv)
   bool mdns_no_cname = true;
   bool mdns_no_web = true;
   bool mdns_no_mpd = true;
+  bool metadata_pipe_defaulted = false;
   int loglevel = -1;
   char *logdomains = NULL;
   char *logfile = NULL;
@@ -539,6 +523,7 @@ main(int argc, char **argv)
     { "version",       0, NULL, 513 },
     { "testrun",       0, NULL, 514 }, // Used for CI, not documented to user
     { "pipe",          1, NULL, 515 },
+    { "command_pipe",  1, NULL, 517 },
 
     { NULL,            0, NULL, 0   }
   };
@@ -637,7 +622,11 @@ main(int argc, char **argv)
         break;
 
       case 515: // named pipe filename
-        gnamed_pipe = optarg;
+        mass_named_pipes.audio_pipe = optarg;
+        break;
+
+      case 517: // command/metadata named pipe filename
+        mass_named_pipes.metadata_pipe = optarg;
         break;
 
         default:
@@ -655,7 +644,7 @@ main(int argc, char **argv)
       hostname == (char *)NULL ||
       address == (char*)NULL ||
       txt == (char*)NULL ||
-      gnamed_pipe == (char*)NULL ||
+      mass_named_pipes.audio_pipe == (char*)NULL ||
       ntpstart == 0 ||
       volume == 0
       )
@@ -702,11 +691,20 @@ main(int argc, char **argv)
       remove_pipes(TESTRUN_PIPE);
       return EXIT_FAILURE;
     }
-    gnamed_pipe = TESTRUN_PIPE;
+    mass_named_pipes.audio_pipe = TESTRUN_PIPE;
   }
   else {
     // Check that named pipe exists for audio streaming. Metadata one too?
-    ret = check_pipes(gnamed_pipe);
+    ret = check_pipe(mass_named_pipes.audio_pipe);
+    if (ret < 0) {
+      return EXIT_FAILURE;
+    }
+    if (!mass_named_pipes.metadata_pipe) {
+      // Adopt the default
+      metadata_pipe_defaulted = true;
+      asprintf(&mass_named_pipes.metadata_pipe, "%s%s", mass_named_pipes.audio_pipe, METADATA_NAMED_PIPE_DEFAULT_SUFFIX);
+    }
+    ret = check_pipe(mass_named_pipes.metadata_pipe);
     if (ret < 0) {
       return EXIT_FAILURE;
     }
@@ -955,6 +953,10 @@ main(int argc, char **argv)
  txt_fail:
   if (txt_kv) keyval_clear(txt_kv);
 
+  if (metadata_pipe_defaulted) {
+    free(mass_named_pipes.metadata_pipe);
+  }
+
   DPRINTF(E_LOG, L_MAIN, "Exiting.\n");
   conffile_unload();
   logger_deinit();

src/cliap2.h

@@ -1,6 +1,8 @@
 #ifndef __CLIAP2_H__
 #define __CLIAP2_H__
 
+#define METADATA_NAMED_PIPE_DEFAULT_SUFFIX ".metadata"
+
 typedef struct ap2_device_info
 {
   const char *name;
@@ -15,4 +17,10 @@ typedef struct ap2_device_info
   int volume;
 } ap2_device_info_t;
 
+typedef struct mass_named_pipes
+{
+  char *audio_pipe; // receives raw pcm audio to be streamed
+  char *metadata_pipe; // receives metadata and commands
+} mass_named_pipes_t;
+
 #endif /* !__CLIAP2_H__ */

src/mass.c

@@ -94,7 +94,7 @@
 #define MASS_METADATA_ACTION_KEY    "ACTION"
 
 /* from cliap2.c */
-extern char* gnamed_pipe;
+extern mass_named_pipes_t mass_named_pipes;
 extern struct event_base *evbase_main;
 
 /* from player.c */
@@ -1325,7 +1325,7 @@ pipe_metadata_watch_add(void *arg)
   char path[PATH_MAX];
   int ret;
 
-  ret = snprintf(path, sizeof(path), "%s.metadata", base_path);
+  ret = snprintf(path, sizeof(path), "%s", base_path);
   if ((ret < 0) || (ret > sizeof(path)))
     return;
 
@@ -1390,9 +1390,9 @@ pipelist_create(void)
   int id;
   int ret;
 
-  DPRINTF(E_DBG, L_PLAYER, "Adding %s to the pipelist\n", gnamed_pipe);
+  DPRINTF(E_DBG, L_PLAYER, "Adding %s to the pipelist\n", mass_named_pipes.audio_pipe);
   head = NULL;
-  pipe = pipe_create(gnamed_pipe, 1, PIPE_PCM, pipe_read_cb);
+  pipe = pipe_create(mass_named_pipes.audio_pipe, 1, PIPE_PCM, pipe_read_cb);
   pipelist_add(&head, pipe);
 
   return head;
@@ -1450,7 +1450,9 @@ setup(struct input_source *source)
   pipe->fd = fd;
   pipe->is_autostarted = (source->id == pipe_autostart_id);
 
-  worker_execute(pipe_metadata_watch_add, source->path, strlen(source->path) + 1, 0);
+  // We override default owntones behaviour and allow specification of the metadata named pipe
+  worker_execute(pipe_metadata_watch_add, mass_named_pipes.metadata_pipe, strlen(mass_named_pipes.metadata_pipe) + 1, 0);
+  // worker_execute(pipe_metadata_watch_add, source->path, strlen(source->path) + 1, 0);
 
   source->input_ctx = pipe;
 

src/wrappers.c

@@ -35,7 +35,7 @@
 #define AIRPLAY_SERVICE_TYPE "_airplay._tcp"
 
 extern ap2_device_info_t ap2_device_info;
-extern char* gnamed_pipe;
+extern mass_named_pipes_t mass_named_pipes;
 
 /*
  * Wrappers for db.c
@@ -309,7 +309,7 @@ db_queue_add_by_query(struct query_params *qp, char reshuffle, uint32_t item_id,
             item->shuffle_pos = 1;
             item->data_kind = DATA_KIND_PIPE; // this is all we support for the moment
             item->media_kind = MEDIA_KIND_MUSIC; // we only support audio
-            item->path = gnamed_pipe;
+            item->path = mass_named_pipes.audio_pipe;
             item->bitrate = 0; // I don't think value matters for us.
             item->samplerate = cfg_getint(cfg_getsec(cfg, "mass"), "pcm_sample_rate");
             item->channels = 2;