process_irs: write data file metadata

bear/process_irs/Snakefile

@@ -38,6 +38,21 @@ rule find_global_delays:
     shell:
         "python -m bear.process_irs.find_global_delays {params.args} --tf-in {input[0]} {params.in_delays} --out {output}"
 
+def get_meta_args(wildcards):
+    metadata = config["params"][wildcards.params].get("metadata", {}).get(wildcards.sofa, {})
+    label = metadata.get("label", wildcards.sofa)
+    description = metadata.get("description")
+
+    args = ["--label", label]
+
+    if description is not None:
+        args.extend(["--description", description])
+
+    if metadata.get("released", False):
+        args.append("--released")
+
+    return args
+
 rule finalise:
     input:
         "irs/{params}/{sofa}.tf",
@@ -49,9 +64,10 @@ rule finalise:
         "bear_data/{params}/{sofa}.tf",
         "finalise_extra/{params}/{sofa}.tf",
     params:
-        args=lambda w: config["params"][w.params].get("finalise_args", "")
+        args=lambda w: config["params"][w.params].get("finalise_args", ""),
+        meta_args=get_meta_args,
     shell:
-        "python -m bear.process_irs.finalise {params.args} --tf-in {input[0]} --delays {input[1]} --tf-out {output[0]} --hoa-decoder {input[2]} --extra-out {output[1]}"
+        "python -m bear.process_irs.finalise {params.args} {params.meta_args:q} --tf-in {input[0]} --delays {input[1]} --tf-out {output[0]} --hoa-decoder {input[2]} --extra-out {output[1]}"
 
 rule report:
     input:

bear/process_irs/finalise.py

@@ -46,6 +46,10 @@ def parse_args():
                         help="enable gain normalisation factors",
     )
 
+    parser.add_argument('--label', help="label for metadata", required=True)
+    parser.add_argument('--description', help="description for metadata")
+    parser.add_argument('--released', help=argparse.SUPPRESS, action="store_true")
+
     return parser.parse_args()
 
 
@@ -381,8 +385,16 @@ def main(args):
     # select front loudspeaker idx
     front_loudspeaker = np.argmin(np.linalg.norm(positions - [0, 1, 0], axis=1))
 
+    metadata = dict(
+        label=args.label,
+        released=args.released,
+    )
+    if args.description is not None:
+        metadata["description"] = args.description
+
     output = dict(
         bear_data_version=0,
+        metadata=metadata,
         views=views.astype(np.float32),
         # shape (view, loudspeaker, ear, sample)
         brirs=irs.astype(np.float32),

doc/ir_processing.md

@@ -113,7 +113,7 @@ final data file.
 
 For BRIRs:
 
-    python -m bear.process_irs.finalise --tf-in irs.tf --delays global_delays.npy --tf-out bear_data.tf --hoa-decoder bear/process_irs/data/AmbiHOA3_magLS.sofa --extra-out finalise_extra.tf
+    python -m bear.process_irs.finalise --label "example v1" --tf-in irs.tf --delays global_delays.npy --tf-out bear_data.tf --hoa-decoder bear/process_irs/data/AmbiHOA3_magLS.sofa --extra-out finalise_extra.tf
 
 For HRIRs, add "--window none" to disable windowing.