+ new command phiola rename - Auto-rename files

Author: stsaz

README.md

@@ -264,6 +264,9 @@ Other use-cases:
 # List all available audio playback and recording devices
 phiola device list
 
+# Auto-rename all .opus files according to a pattern
+phiola rename *.opus -o "@tracknumber. @artist - @title"
+
 # Start HTTP audio streaming server (Opus, 128kbps)
 phiola server "My Music" -inc "*.flac" -shuffle -opus_q 128
 ```
@@ -280,6 +283,7 @@ Currently supported commands:
 | [play](src/exe/play.h)       | Play audio |
 | [record](src/exe/record.h)   | Record audio |
 | [remote](src/exe/remote.h)   | Send remote command |
+| [rename](src/exe/rename.h)   | Auto-rename files |
 | [server](src/exe/server.h)   | Start audio streaming server |
 | [tag](src/exe/tag.h)         | Edit file tags |
 

src/core/file-write.h

@@ -192,7 +192,7 @@ static void fw_name_var(ffvec *buf, ffstr var, phi_track *t)
 
 data:
 	ffvec_grow(buf, val.len, 1);
-	buf->len += ffpath_makefn(ffslice_end(buf, 1), -1, val, '_', _ffpath_charmask_filename);
+	buf->len += ffpath_makename(ffslice_end(buf, 1), -1, val, '_', _ffpath_charmask_filename);
 }
 
 static const char* fw_name(ffstr *sbuf, const char *name, phi_track *t)

src/core/queue-entry.h

@@ -409,3 +409,80 @@ int qe_rename(struct q_entry *e, const char *new, uint flags)
 		ffmem_free((char*)new);
 	return rc;
 }
+
+/** All printable, plus SPACE, except: ", *, /, :, <, >, ?, \, | */
+static const uint _ffpath_charmask_filename[] = {
+	0,
+	            // ?>=< ;:98 7654 3210  /.-, +*)( '&%$ #"!
+	0x2bff7bfb, // 0010 1011 1111 1111  0111 1011 1111 1011
+	            // _^]\ [ZYX WVUT SRQP  ONML KJIH GFED CBA@
+	0xefffffff, // 1110 1111 1111 1111  1111 1111 1111 1111
+	            //  ~}| {zyx wvut srqp  onml kjih gfed cba`
+	0x6fffffff, // 0110 1111 1111 1111  1111 1111 1111 1111
+	0xffffffff,
+	0xffffffff,
+	0xffffffff,
+	0xffffffff
+};
+
+static void q_rename_first_close(void *f, phi_track *t)
+{
+	struct q_entry *e = t->qent;
+	ffstr s, val, dir, ext;
+	ffvec buf = {};
+
+	// Extract file meta components to prepare the target file name
+	ffstr out = FFSTR_INITZ(e->q->rename_pattern);
+	while (out.len) {
+		if ('v' == ffstr_var_next(&out, &s, '@')) {
+			ffstr_shift(&s, 1);
+			core->metaif->find(&t->meta, s, &val, 0);
+			ffvec_grow(&buf, val.len, 1);
+			buf.len += ffpath_makename(ffslice_end(&buf, 1), -1, val, '_', _ffpath_charmask_filename);
+
+		} else {
+			ffvec_addstr(&buf, &s);
+		}
+	}
+
+	ffpath_split3_str(FFSTR_Z(t->conf.ifile.name), &dir, NULL, &ext);
+	if (dir.len)
+		dir.len++; // "dir" -> "dir/"
+	if (ext.len)
+		ext.ptr--,  ext.len++; // "ext" -> ".ext"
+	char *fn = ffsz_allocfmt("%S%S%S", &dir, &buf, &ext);
+	qe_rename(t->qent, fn, PHI_QRN_ACQUIRE);
+
+	qe_unref(e);
+	core->metaif->destroy(&t->meta);
+	ffvec_free(&buf);
+	q_rename_next(e->q);
+}
+
+static int q_rename_first_process(void *f, phi_track *t)
+{
+	return PHI_DONE;
+}
+
+static const phi_filter q_rename_first = {
+	NULL, q_rename_first_close, q_rename_first_process,
+	"q-rename-first"
+};
+
+void qe_rename_start(struct q_entry *e)
+{
+	struct phi_track_conf c = {
+		.ifile.name = e->pub.url,
+		.info_only = 1,
+	};
+	phi_track *t = core->track->create(&c);
+
+	core->track->filter(t, e->q->conf.first_filter, 0);
+	core->track->filter(t, &q_rename_first, 0);
+	core->track->filter(t, core->mod("core.auto-input"), 0);
+	core->track->filter(t, core->mod("format.detect"), 0);
+
+	e->used++;
+	t->qent = &e->pub;
+	core->track->start(t);
+}

src/core/queue.c

@@ -32,6 +32,7 @@ struct phi_queue {
 	fflock lock;
 	phi_task task;
 	struct q_entry *cursor;
+	const char *rename_pattern;
 	uint cursor_index;
 	uint active_n, finished_n;
 	uint track_closed_flags;
@@ -56,6 +57,7 @@ enum Q_TKCL_F {
 };
 static void q_ent_closed(struct phi_queue *q, uint flags);
 static void q_modified(struct phi_queue *q);
+static void q_rename_next(struct phi_queue *q);
 
 #include <core/queue-entry.h>
 
@@ -686,6 +688,27 @@ static void q_read_meta(phi_queue_id q)
 	qe_read_meta(e);
 }
 
+static void q_rename_next(struct phi_queue *q)
+{
+	int i = (q->cursor) ? qe_index(q->cursor) + 1 : 0;
+	struct q_entry *e = q_get(q, i);
+	if (!e) {
+		qm->on_change(q, '.', 0);
+		return;
+	}
+	q->cursor = e;
+	qe_rename_start(e);
+}
+
+static int q_rename_all(phi_queue_id q, const char *pattern, uint flags)
+{
+	if (!q) q = qm_default();
+
+	q->rename_pattern = pattern;
+	q_rename_next(q);
+	return 0;
+}
+
 static void q_remove_multi(phi_queue_id q, uint flags)
 {
 	if (!q) q = qm_default();
@@ -743,6 +766,7 @@ const phi_queue_if phi_queueif = {
 	q_status,
 	q_sort,
 	q_read_meta,
+	q_rename_all,
 
 	q_clear,
 	q_remove_at,

src/exe/cmd.h

@@ -154,6 +154,9 @@ static int wildcard_expand(ffvec *input, ffstr s)
 
 static int cmd_input(ffvec *input, ffstr s)
 {
+	if (s.len && s.ptr[0] == '-')
+		return _ffargs_err(&x->cmd, 1, "unknown option '%S'. Use '-h' for usage info.", &s);
+
 	if (ffstr_eqz(&s, "@names"))
 		return cmd_input_names(input, ffstdin);
 
@@ -256,6 +259,7 @@ static int cmd_opus_mode(const char *s)
 #include <exe/play.h>
 #include <exe/record.h>
 #include <exe/remote.h>
+#include <exe/rename.h>
 #include <exe/server.h>
 #include <exe/tag.h>
 
@@ -281,6 +285,7 @@ Commands:\n\
   `play`      Play audio [Default command]\n\
   `record`    Record audio\n\
   `remote`    Send remote command\n\
+  `rename`    Auto-rename files\n\
   `server`    Start audio streaming server\n\
   `tag`       Edit file tags\n\
 \n\
@@ -470,6 +475,7 @@ static const struct ffarg cmd_root[] = {
 	{ "play",		'{',		cmd_play_init },
 	{ "record",		'{',		cmd_rec_init },
 	{ "remote",		'{',		cmd_remote_init },
+	{ "rename",		'{',		cmd_rename_init },
 	{ "server",		'{',		cmd_server_init },
 	{ "tag",		'{',		cmd_tag_init },
 	{ "\0\1",		'{',		cmd_play_init },

src/exe/convert.h

@@ -157,9 +157,6 @@ static int conv_tracks(struct cmd_conv *v, ffstr s) { return cmd_tracks(&v->trac
 
 static int conv_input(struct cmd_conv *v, ffstr s)
 {
-	if (s.len && s.ptr[0] == '-')
-		return _ffargs_err(&x->cmd, 1, "unknown option '%S'. Use '-h' for usage info.", &s);
-
 	x->stdin_busy = ffstr_eqz(&s, "@stdin");
 	return cmd_input(&v->input, s);
 }

src/exe/info.h

@@ -71,9 +71,6 @@ static int info_tracks(struct cmd_info *p, ffstr s) { return cmd_tracks(&p->trac
 
 static int info_input(struct cmd_info *p, ffstr s)
 {
-	if (s.len && s.ptr[0] == '-')
-		return _ffargs_err(&x->cmd, 1, "unknown option '%S'. Use '-h' for usage info.", &s);
-
 	x->stdin_busy = ffstr_eqz(&s, "@stdin");
 	return cmd_input(&p->input, s);
 }

src/exe/play.h

@@ -109,9 +109,6 @@ static int play_tracks(struct cmd_play *p, ffstr s) { return cmd_tracks(&p->trac
 
 static int play_input(struct cmd_play *p, ffstr s)
 {
-	if (s.len && s.ptr[0] == '-')
-		return _ffargs_err(&x->cmd, 1, "unknown option '%S'. Use '-h' for usage info.", &s);
-
 	x->stdin_busy = ffstr_eqz(&s, "@stdin");
 	return cmd_input(&p->input, s);
 }

src/exe/rename.h

@@ -0,0 +1,84 @@
+/** phiola: executor: 'rename' command
+2025, Simon Zolin */
+
+static int rename_help()
+{
+	help_info_write("\
+Auto-rename files:\n\
+    `phiola rename` INPUT... -o PATTERN\n\
+\n\
+INPUT                   File name, directory or URL\n\
+                          `@names`  Read file names from standard input\n\
+\n\
+Options:\n\
+  `-o` PATTERN            Target file name pattern (without file extension).\n\
+                        Supports runtime variable expansion:\n\
+                          @STRING    Expands to file meta data,\n\
+                                       e.g. `-o \"@tracknumber. @artist - @title\"`\n\
+");
+	x->exit_code = 0;
+	return 1;
+}
+
+struct cmd_rename {
+	phi_task task;
+	ffvec input; // ffstr[]
+	const char *output;
+};
+
+static int rename_action(struct cmd_rename *r)
+{
+	x->queue->on_change(q_on_change);
+
+	struct phi_queue_conf qc = {
+		.first_filter = &phi_guard,
+	};
+	x->queue->create(&qc);
+
+	ffstr *s;
+	FFSLICE_WALK(&r->input, s) {
+		struct phi_queue_entry qe = {
+			.url = s->ptr,
+		};
+		x->queue->add(NULL, &qe);
+	}
+	ffvec_free(&r->input);
+
+	x->queue->rename_all(NULL, r->output, 0);
+	return 0;
+}
+
+static int rename_input(struct cmd_rename *r, ffstr s)
+{
+	return cmd_input(&r->input, s);
+}
+
+static int rename_fin(struct cmd_rename *r)
+{
+	if (!r->input.len)
+		return _ffargs_err(&x->cmd, 1, "please specify input file");
+
+	if (!r->output)
+		return _ffargs_err(&x->cmd, 1, "please specify output file name pattern with '-o PATTERN'");
+
+	return 0;
+}
+
+#define O(m)  (void*)FF_OFF(struct cmd_rename, m)
+static const struct ffarg cmd_rename[] = {
+	{ "-help",		0,		rename_help },
+	{ "-o",			's',	O(output) },
+	{ "\0\1",		'S',	rename_input },
+	{ "",			0,		rename_fin },
+};
+#undef O
+
+static void cmd_rename_free(struct cmd_rename *r)
+{
+	ffmem_free(r);
+}
+
+struct ffarg_ctx cmd_rename_init(void *obj)
+{
+	return SUBCMD_INIT(ffmem_new(struct cmd_rename), cmd_rename_free, rename_action, cmd_rename);
+}

src/exe/server.h

@@ -57,9 +57,6 @@ static int srv_exclude(struct cmd_srv *s, ffstr ss)
 
 static int srv_input(struct cmd_srv *s, ffstr fn)
 {
-	if (fn.len && fn.ptr[0] == '-')
-		return _ffargs_err(&x->cmd, 1, "unknown option '%S'. Use '-h' for usage info.", &fn);
-
 	return cmd_input(&s->input, fn);
 }