Merge pull request #59 from bbc/filename_hint

Add hint about putting UUIDs in IMF filenames
bbc · Mar 1, 2024 · c6fed6e · c6fed6e
2 parents e182e6c + 60ce997
commit c6fed6e
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/apps/bmxtranswrap/bmxtranswrap.cpp b/apps/bmxtranswrap/bmxtranswrap.cpp
@@ -731,6 +731,8 @@ static void usage(const char *cmd)
     printf("                       - {fp_uuid}: The UUID material number in a file source package UMID\n");
     printf("                                    The clip writers will by default generate UMIDs with UUID material numbers\n");
     printf("                       - {fp_umid}: The file source package UMID\n");
+    printf("                     At least one letter in a variable name can also be in uppercase, which will result in\n");
+    printf("                     the corresponding substituted value being in uppercase.\n");
     printf(" - <umid> format is 64 hexadecimal characters and any '.' and '-' characters are ignored\n");
     printf(" - <uuid> format is 32 hexadecimal characters and any '.' and '-' characters are ignored\n");
     printf(" - <tstamp> format is YYYY-MM-DDThh:mm:ss:qm where qm is in units of 1/250th second\n");

diff --git a/apps/raw2bmx/raw2bmx.cpp b/apps/raw2bmx/raw2bmx.cpp
@@ -850,6 +850,8 @@ static void usage(const char *cmd)
     printf("                       - {fp_uuid}: The UUID material number in a file source package UMID\n");
     printf("                                    The clip writers will by default generate UMIDs with UUID material numbers\n");
     printf("                       - {fp_umid}: The file source package UMID\n");
+    printf("                     At least one letter in a variable name can also be in uppercase, which will result in\n");
+    printf("                     the corresponding substituted value being in uppercase.\n");
     printf(" - <umid> format is 64 hexadecimal characters and any '.' and '-' characters are ignored\n");
     printf(" - <uuid> format is 32 hexadecimal characters and any '.' and '-' characters are ignored\n");
     printf(" - <tstamp> format is YYYY-MM-DDThh:mm:ss:qm where qm is in units of 1/250th second\n");

diff --git a/docs/imf_track_files.md b/docs/imf_track_files.md
@@ -36,3 +36,5 @@ and [SMPTE ST 2067-21 - Application #2E](https://ieeexplore.ieee.org/document/90
 * Mastering Display White Point Chromaticity (`--display-white-point`)
 * Mastering Display Maximum Luminance (`--display-max-luma`)
 * Mastering Display Minimum Luminance (`--display-min-luma`)
+
+IMF Track File names conventionally include the UUID material number of the top-level file source package UMID. This can be accomplished automatically by supplying an output filename argument as a pattern, such as `-o {Type}_{fp_uuid}.mxf`. This example pattern results in a filename beginning with `VIDEO`, `AUDIO` or `DATA`, such as `VIDEO_a145db5d-4623-4233-913f-15e16980b840.mxf`, but can be tuned with the `--ess-type-names` parameter.