Published on: Last updated:

ReaScripts: BWF Metadata pack

Introduction

This scripts pack aims to bring some BWF processing and injection features to REAPER, thanks to BWF MetaEdit CLI open source software.

Pack Content

Screenshots

Note: to display items active take source file BWF metadata in REAPER, you can simply use the Item properties: Show media item source properties action.

Propagate first take BWF metadata to all takes in selected items with bwfmetaedit CLI

The render to new take and glue actions are very handy but they erase some valuable metadata infos. This scripts aim to correct that.

A efficient way to re-inject back lost metadata to new rendered items.

Add BWF metadata to selected media items

Add BWF metadata from REAPER. Data can be arbitrary or you can use wildcards. Here is the list:

  • $val (actual value, useful for adding prefix or suffix)
  • $name (item active take name)
  • $itemnumber (on track)
  • $track (item track name)
  • $parenttrack (parent track name of the item track)
  • $tracknumber (track idx)
  • $region (region at item pos)
  • $project (project name)
  • $possample (item pos in sample format for Timecode Reference metadata)
Add BWF metadata from REAPER, with wildcards.

Restore BWF metadata of selected media items from similarly-named XML backup files

Previous scripts don’t have CTRL+Z, as the modifications is made directly on files, using another software.

That’s why previous scripts automatically dump a backup of the metadata in a XML file next to their source. This script will re-inject the backup into their original source.

Add data, and restore from backup.

Propagate first half of selected takes BWF metadata to the other half with bwfmetaedit CLI

Useful if you use the Render -> Selected items and you want to preserve original items BWF. Just use the Import rendered items to new tracks setting and run the script.

Rename selected items based on BWF DESC metadata variables

This uses BWF desc variables as found in SoundDevise or Aaton Digital created files.

Avaibles wildcards are:

$NOTE $SCENE $SPEED $TAG $TAKE $TAPE $TRK $TRK# $iTRK $TYPE $UBITS

Some of these infos are redundant with iXML ones so this can be very handy.

You can also rename the track the item is on with SWS: Set track name from first selected item on track action. This will allow you to name a track based on a Tape name for eg.

Usage

BWF MetaEdit Installation

To Get and Set BWF metadata, these scripts use the great free and open source BWF MetaEdit software. You will need to download and install the CLI version to make them work.

CLI, for Command Line Interface, is a way to call a software without interface. In this case, it make it allows software to communicate between each others.

Version 1.3.6 or higher is required, cause I personally contributed to bug hunting and bug fixes of prior versions.

Windows

  1. Go to BWF MetaEdit Windows Download
  2. Download the CLI version according to your OS version (32bits, or 64 bits)
  3. Put the bwfmetaedit.exe file in the UserPlugins subfolder of your REAPER Resource directory (Options → Show REAPER resource path in explorer)

Mac

  1. Go to BWF MetaEdit MacOS Download
  2. Download the CLI version according to your OS version (32bits, or 64 bits)
  3. Put the bwfmetaedit file in the UserPlugins subfolder of your REAPER Resource directory (Options → Show REAPER resource path in explorer)

Processing

To process item source, all items with same source have to be set as Offline. Though, setting back to Online can take a bit of time if you have a lot of TakeFX.

Also, be sure to have write access to the chosen files. It shouldn’t be open by other software, or even in REAPER Media Explorer.

User Config Area

These files contains parameters which can be customized by the user. Here is the process:

  1. Create a file named exactly like the script file but with .ini extension.
  2. Edit the script from the action list or from a code editor
  3. Copy the USER CONFIG AREA code block at the top of the script to your.ini file
  4. Customize your value

You can also simply copy-rename the script, but you will have to re-do this process at every script update.

Here is an example of file you can create:

-- USER CONFIG AREA --------------------------------------------
-- To modify these values, instead of modding the script, you can simply create a .ini file with same name of the script in the same folder, and copy paste the code below. Then, edit to add you own defaults.

console = true -- true/false: display debug messages in the console
set_back_online = true -- true/false: set peaks offline. Else, wrap this action inside a custom action, between Set items offline / online.
prompt = true -- display the pop up input window

bwf_input = {}
bwf_input.Description = 'n'
bwf_input.Originator = 'n'
bwf_input.OriginatorReference = 'n'
bwf_input.OriginationDate = 'n'
bwf_input.OriginationTime = 'n'
-- bwf_input['TimeReference (translated)'] = 'n'
bwf_input.TimeReference = 'n'
bwf_input.BextVersion = 'n'
bwf_input.UMID = 'n'
bwf_input.LoudnessValue = 'n'
bwf_input.LoudnessRange = 'n'
bwf_input.MaxTruePeakLevel = 'n'
bwf_input.MaxMomentaryLoudness = 'n'
bwf_input.MaxShortTermLoudness = 'n'
bwf_input.CodingHistory = 'n'
bwf_input.IARL = 'n'
bwf_input.IART = 'n'
bwf_input.ICMS = 'n'
bwf_input.ICMT = 'n'
bwf_input.ICOP = 'n'
bwf_input.ICRD = 'n'
bwf_input.IENG = 'n'
bwf_input.IGNR = 'n'
bwf_input.IKEY = 'n'
bwf_input.IMED = 'n'
bwf_input.INAM = 'n'
bwf_input.IPRD = 'n'
bwf_input.ISBJ = 'n'
bwf_input.ISFT = 'n'
bwf_input.ISRC = 'n'
bwf_input.ISRF = 'n'
bwf_input.ITCH = 'n'
---------------------------------------- END OF USER CONFIG AREA

The set_offline here is particularly useful, if you want to chain this action with others actions which needs to process on offline items. It allows to save a lot of performance if you have a lot of items with take FX, as setting offline/online takes time. Here is an example of custom action:

Custom: Rename source and add BWF:

  1. Script: X-Raym_Rename selected takes source file name according to take name in the limit of 32 characters and with 001 counter.lua
  2. Script: X-Raym_Propagate first take BWF Description to all takes in selected items with bwfmetaedit CLI.lua

(The set items back online stage is handle here by the second script).

Known Limitations

Broken Header

BWF MetaEdit is very strict about metadata. If your file contains invalid file size metadata, as it seems to happen with some audio metadata/library softwares, BWFMetaEdit will not be able to process them. You can help sponsoring the dev of a fix header size feature right in BWF MetaEdit by making a donation to the project maintainers and sending them message about this particular issue.

No Markers/Cue point supports

For the moment, the script doesn’t support markers. This may be added in the future.

Installation

This pack can be installed and auto-updated with the free ReaPack REAPER extension with a custom link related to your licence, or via regular Zip download.
After purchase, detailed installation instructions will be provided here and on the dedicated Purchase Confirmation page.
License are valid lifetime. You will be able to enjoy updates and new scripts added to the pack.

Feature Requests

Miss a function? Let me know!

Notes

By buying this product, you are supporting my free scripting. Thanks!

Cockos Forum Threads:

Thanks to BWF MetaEdit team for providing their software free and open source. I invite you to make a donation to the project maintainers!

And thanks cfillion from Reapack for the help on the CLI commands! 😛

Purchase

  • Personnal use, you are an individual, a student, or a non-profit organization, and you will not use this pack on commercial projects.

  • Your work for a individual or small business company, you will work on commercial projects, and you want to share the pack to your team.

  • You are a big business company with a team of more than 5 people and this script will be part of your main workflow.

  • You helped developing these scripts. many thanks !