Waiting for the bounce dialog to complete/close

You asked for it...

There is a lot of stuff specific to my workflow and there's a lot that should be tightened up code-wise but it works! I have a variant of this that lets me specify a name and does it slightly differently for printing other types of mixes. Saving me so much time, and I can hit the button and walk away!

// This script prints the next reference mix for a session given some rather stringent parameters:
//  1) The Print Track has to be the bottom-most track in the session, including hidden tracks
//  2) There has to already be a playlist on the Print track that ends in a revision number that can be incremented.
//  3) There has to a clip on the print track that represents the bounce selection, and it has to be the first clip on the track
//          note: I satisfy 2 and 3 for the first ref by making a playlist whos name ends in "R0" that has a clip group for the desired bounce selection
//  4) I always want the mix bounced into the local Bounced Files directory
//  5) I always want to export a 44.1/16 bit copy to a folder called " Refs" one level above the session folder
//  6) I am always printing a bus called "Print"

// I'm sure there is a lot of this that should be separated into functions and made neater, but it does actually work and is pretty bullet proof.

sf.ui.proTools.appActivateMainWindow();

// Dialog to remind me which button I just hit on the Stream Deck
if (!confirm(`This Script will increment the Print Track playist, bounce and export a ref\nDo you want to continue?`))
    throw 0;


//Get and Increment Last Number - We'll use this for the new playlist name
function getAndIncrementLastNumber(str) {
    return str.replace(/\d+$/, function (s) {
        return ++s;
    });
}

// Set variables so Bounce directory can be set back to default if it has been changed
var sessionDir = sf.ui.proTools.mainWindow.sessionPath.split('/').slice(0, -1).join('/');
var bounceDir = `${sessionDir}/Bounced Files`;
//Make sure our new bounce dir exists
sf.system.exec({ commandLine: 'mkdir -p "' + bounceDir + '"' });

// Get name of last track (which has to be the print track)
var lastTrackName = sf.ui.proTools.trackNames.slice(-1)[0];

// Scroll the track into view
sf.ui.proTools.trackSelectByName({ deselectOthers: true, names: [lastTrackName] });
sf.ui.proTools.selectedTrack.trackScrollToView();

// Select the existing mix
if (sf.ui.proTools.getMenuItem('Options', 'Tab to Transient').isMenuChecked)
{
    //Tab to Transient is enabled - disable it
    sf.ui.proTools.menuClick({
    menuPath: ["Options","Tab to Transient"],
});
}
else 
{
    //Tab to Transient is not enabled - good!
};
// Select first clip on teh track
sf.keyboard.press({
    keys: "return, tab, shift+tab",
});

// Create name of playlist
var newPlaylistName = getAndIncrementLastNumber(lastTrackName);

//Duplicate the current playlist
sf.ui.proTools.selectedTrack.popupButtons.whoseTitle.is('Playlist selector').first.popupMenuSelect({
    menuPath: ["Duplicate..."],
});

//Wait for Duplicate Playlist window to appear
sf.ui.proTools.confirmationDialog.elementWaitFor({ waitType: "Appear", });

// Put in new playlist name
sf.ui.proTools.confirmationDialog.textFields.first.elementSetTextFieldWithAreaValue({ value: newPlaylistName });

//Click OK in Duplicate Playlist window
sf.ui.proTools.confirmationDialog.buttons.whoseTitle.is('OK').first.elementClick();

//Wait for Duplicate Playlist window to disappear
sf.ui.proTools.confirmationDialog.elementWaitFor({ waitType: "Disappear", });

// ------------- Get current session smaple rate -----------
// See if the Session Setup window is open and if not, open it
var sessionSetupWin = sf.ui.proTools.windows.whoseTitle.is('Session Setup');
if (sessionSetupWin && sessionSetupWin.exists) {
    //audio suite window is open
} else {
    sf.ui.proTools.menuClick({
    menuPath: ["Setup", "Session"],
});
var sessionSetupDlg = sf.ui.proTools.dialogWaitForManual({
    dialogTitle: 'Session Setup'
}).dialog;
};

// Get the current session sample rate
var currentSampleRate = sf.ui.proTools.windows.whoseTitle.is('Session Setup').first.groups.whoseTitle.is('Session Format').first.children.whoseRole.is("AXStaticText").allItems[2].value.value;

// Close the Session Setup window
sf.ui.proTools.menuClick({
    menuPath: ["Setup", "Session"],
})

//Wait for 'Session Setup' window to disappear
sf.ui.proTools.windows.whoseTitle.is('Session Setup').first.elementWaitFor({
    waitType: "Disappear",
});


//----------------------------------------------------------|
//                  Set up bounce!                          |
//----------------------------------------------------------|


// Open bounce to disk dialog
sf.ui.proTools.menuClick({
    menuPath: ["File", "Bounce to", "Disk..."],
    looseMatch: true,
});

//Wait for the 'Bounce' dialog to appear and assign it to the bounceDlg variable
var bounceDlg = sf.ui.proTools.dialogWaitForManual({
    dialogTitle: 'Bounce'
}).dialog;

// The next bit is stolen and adapted from Marco, thanks Marco!
//Special code for now (this will change and be made easier)
//What this does is get the Children of the bounceDialog, filter them so we only get the popupbuttons,
//and then slice the resulting array so the we only get the last 5.
//This is needed since there are no names/titles/labels on the 4 buttons used to set up file type, format, bit depth and samplerate
//and you don't know how many bounce sources there might be when you open the dialog

var popupButtons = bounceDlg.getElements("AXChildren").filter(function (e) { return e.fullRole == "AXPopUpButton" }).slice(-5);

//Assign the five buttons coming out of the previous instruction to individual variables
var bounceSource = popupButtons[0];
var fileTypeBtn = popupButtons[1];
var formatBtn = popupButtons[2];
var bitDepthBtn = popupButtons[3];
var sampleRateBtn = popupButtons[4];
var deliverFormat = popupButtons[5];

//If the source is not already Print, use the popupMenuSelect action to select it
if (bounceSource.value.value != 'Print (Stereo)')
    sf.ui.proTools.windows.whoseTitle.is('Bounce').first.popupButtons.first.popupMenuSelect({
        menuPath: ["bus", "Print*"],
        useWildcards: true,
    });

// Set the resot of the bounce parameters
if (fileTypeBtn.value.value != 'WAV')
    fileTypeBtn.popupMenuSelect({ menuPath: ['WAV'] });

if (sampleRateBtn.value.value != currentSampleRate)
    sampleRateBtn.popupMenuSelect({ menuPath: [currentSampleRate] });

if (formatBtn.value.value != 'Interleaved')
    formatBtn.popupMenuSelect({ menuPath: ['Interleaved'] });

if (bitDepthBtn.value.value != '24 Bit')
    bitDepthBtn.popupMenuSelect({ menuPath: ['24 Bit'] });

//Make sure offline and import after bounce are selected
sf.ui.proTools.windows.whoseTitle.is('Bounce').first.checkBoxes.whoseTitle.is('Import After Bounce').first.checkboxSet({
    targetValue: "Enable",
});
sf.ui.proTools.windows.whoseTitle.is('Bounce').first.checkBoxes.whoseTitle.is('Offline').first.checkboxSet({
    targetValue: "Enable",
});

//--------------------------------------- Set the path to default----------------------------
// again, stolen code, I think from Fokke, thanks!

function navigateToInDialog(win, path) {
    //Open the Go to... sheet
    sf.keyboard.type({ text: '/' });

    //Wait for the sheet to appear
    var sheet = win.sheets.first.elementWaitFor({ timeout: 500 }, 'Could not find "Go to" sheet in the Save/Open dialog').element;

    //Set the value of the combo box
    sheet.comboBoxes.first.value.value = path;

    //Press OK
    sheet.buttons.whoseTitle.is('Go').first.elementClick({}, 'Could not click "Go"');

    //Wait for sheet to close
    win.sheets.first.elementWaitFor({ waitForNoElement: true, timeout: 500 }, '"Go to" sheet didn\'t close in time');
}


function openDialogFolder(folder) {
    var openDlg = sf.ui.proTools.windows.whoseTitle.is('Open').first;

    navigateToInDialog(openDlg, folder);

    //Click OK
    openDlg.buttons.whoseTitle.is('Open').first.elementClick();

    //Wait for the Open dialog to close
    openDlg.elementWaitFor({ waitForNoElement: true });
}

//Set the bounce directory if necessary

var existingDirectory = sf.ui.proTools.windows.whoseTitle.is('Bounce').first.children.whoseRole.is("AXStaticText").allItems[6].value.value;
if (existingDirectory !== bounceDir + "/") {
    sf.ui.proTools.windows.whoseTitle.is('Bounce').first.buttons.whoseTitle.is('Choose...').first.elementClick();

    openDialogFolder(bounceDir);

}
//----------------------------------------------------------------------------

// Use our new playlist name for the file name
sf.ui.proTools.windows.whoseTitle.is('Bounce').first.textFields.whoseTitle.is('').first.elementSetTextFieldWithAreaValue({
    value: newPlaylistName,
});

//Start bounce
sf.ui.proTools.windows.whoseTitle.is('Bounce').first.buttons.whoseTitle.is('Bounce').first.elementClick();
sf.ui.proTools.windows.whoseTitle.is('Bounce').first.elementWaitFor({
    waitType: "Disappear",
    timeout: 10000, //This can take a while to start sometimes
});
//Wait for bounce to finish (Wait for bounce dialog to appear, then to disappear)
sf.ui.proTools.confirmationDialog.elementWaitFor({ timeout: 10000 });
sf.ui.proTools.confirmationDialog.elementWaitFor({ waitType: 'Disappear', timeout: -1 }); //-1 is endless timeout (cancel by Ctrl+Shift+Esc)

// See if bounce completed normally or was cancelled by checking for the existence of the bounced file
//Check to see if the file with variable "newPlaylistName" exists
var file = sf.file.exists({path: bounceDir+"/"+newPlaylistName+".wav"});
if(!file.exists){
    log("File does not exist, bounce cancelled!");
    throw(0);
};

// Import mix to session in Clip list

var win = sf.ui.proTools.windows.whoseTitle.is('Audio Import Options').first;
win.radioButtons.whoseTitle.startsWith('Clip List').first.elementClick();
sf.ui.proTools.windows.whoseTitle.is('Audio Import Options').first.buttons.whoseTitle.is('OK').first.elementClick();
sf.ui.proTools.windows.whoseTitle.is('Audio Import Options').first.elementWaitFor({
    waitType: "Disappear",
});

//----------------------------------------------------------|
//                  Bounce Finished!                        |
//   Export ref and get bounced Mix onto Print Track        |
//----------------------------------------------------------|

//Make sure clip list is showing
sf.ui.proTools.menuClick({
    menuPath: ["View", "Other Displays", "Clip List"],
    targetValue: 'Enable'  //or 'Enable' or 'Toggle'
});


//----------------------------------------------------------|
//                     Export Mix                           |
//----------------------------------------------------------|

//Reselect mix on Print Track
//There was code here to re-select it but it never gets deselected in this order of operations...

sf.ui.proTools.mainWindow.popupButtons.whoseTitle.is('Clip List').first.popupMenuSelect({
    menuPath: ["Export Clips as Files..."],
});


var exportDlg = sf.ui.proTools.dialogWaitForManual({
    dialogTitle: "Export Selected"
}).dialog;

//Get the Children of the Export Selected dialog, filter them so we only get the popupbuttons,

var popupButtons = exportDlg.getElements("AXChildren").filter(function (e) { return e.fullRole == "AXPopUpButton" });

//Assign thefourthree buttons coming out of the previous instruction to individual variables
var sampleRate = popupButtons[0];
var bitDepth = popupButtons[1];
var fileFormat = popupButtons[2];
var fileTypeBtn = popupButtons[3];

//Change any options that aren't right
if (fileTypeBtn.value.value != 'WAV')
    fileTypeBtn.popupMenuSelect({ menuPath: ['WAV'] });

if (fileFormat.value.value != 'Interleaved')
    fileFormat.popupMenuSelect({ menuPath: ['Interleaved'] });

if (bitDepth.value.value != '16 Bit')
    bitDepth.popupMenuSelect({ menuPath: ['16 Bit'] });

if (sampleRate.value.value != '44.1 kHz')
    sampleRate.popupMenuSelect({ menuPath: ['44.1 kHz'] });

//--------------------------------
// Set the export directory to the refs folder - I probably didn't need to copy these and rename them but I haven't gone back to see if anything changed so better safe than sorry
//--------------------------------

function navigateToInDialog2(win, path) {
    //Open the Go to... sheet
    sf.keyboard.type({ text: '/' });

    //Wait for the sheet to appear
    var sheet = win.sheets.first.elementWaitFor({ timeout: 500 }, 'Could not find "Go to" sheet in the Save/Open dialog').element;

    //Set the value of the combo box
    sheet.comboBoxes.first.value.value = path;

    //Press OK
    sheet.buttons.whoseTitle.is('Go').first.elementClick({}, 'Could not click "Go"');

    //Wait for sheet to close
    win.sheets.first.elementWaitFor({ waitForNoElement: true, timeout: 500 }, '"Go to" sheet didn\'t close in time');
}


function openDialogFolder2(folder) {
    var openDlg = sf.ui.proTools.windows.whoseTitle.is('Open').first;

    navigateToInDialog2(openDlg, folder);

    //Click OK
    openDlg.buttons.whoseTitle.is('Open').first.elementClick();

    //Wait for the Open dialog to close
    openDlg.elementWaitFor({ waitForNoElement: true });
};

// Set a variable to the desired refs directory in the sessions parent folder
var exportDirectory = sf.ui.proTools.mainWindow.sessionPath.split('/').slice(0, -2).join('/') + "/ Refs";

//Make sure our desired export dir exists
sf.system.exec({ commandLine: 'mkdir -p "' + exportDirectory + '"' });

//Get the current export directory - I'm sure this can all be done one line but, well, newbie
var existingDirectory = sf.ui.proTools.windows.whoseTitle.is('Export Selected').first.children.whoseRole.is("AXStaticText").allItems[5].value.value;
var modifiedDirectory = "/"+ existingDirectory.substring(0, existingDirectory.length - 1).split(":").slice (1).join('/');

if (modifiedDirectory !== exportDirectory) { 
    sf.ui.proTools.windows.whoseTitle.is('Export Selected').first.buttons.whoseTitle.is('Choose...').first.elementClick();

    openDialogFolder2(exportDirectory);
}

// Start the Export
sf.ui.proTools.windows.whoseTitle.is('Export Selected').first.buttons.whoseTitle.is('Export...').first.elementClick();

sf.ui.proTools.windows.whoseTitle.is('Export Selected').first.elementWaitFor({
    waitType: "Disappear",
});

//Wait for export to finish (Wait for progress dialog to appear, then to disappear)
sf.ui.proTools.confirmationDialog.elementWaitFor({ timeout: 10000 });
sf.ui.proTools.confirmationDialog.elementWaitFor({ waitType: 'Disappear', timeout: -1 }); //-1 is endless timeout (cancel by Ctrl+Shift+Esc)
// No need to check if I cancelled or not, it's just an external file that nothing else relies on

// Get the bounced mix onto the Print track
// Use the clip list search function to make it the only displayed clip so we know where it is
sf.ui.proTools.mainWindow.popupButtons.whoseTitle.is('Clip List').first.popupMenuSelect({
    menuPath: ["Find..."],
});
sf.ui.proTools.windows.whoseTitle.is('Find Clips').first.elementWaitFor({
    waitType: "Appear",
});

sf.ui.proTools.windows.whoseTitle.is('Find Clips').first.textFields.whoseTitle.is('').first.elementSetTextFieldWithAreaValue({
    value: newPlaylistName,
});

sf.ui.proTools.windows.whoseTitle.is('Find Clips').first.buttons.whoseTitle.is('OK').first.elementClick();

sf.ui.proTools.windows.whoseTitle.is('Find Clips').first.elementWaitFor({
    waitType: "Disappear",
});

// Place clip on the print track

// Open Replace Clip dialog for first clip

sf.ui.proTools.mainWindow.tables.whoseTitle.is('CLIPS').first.children.whoseRole.is("AXRow").whoseValue.is('').allItems[0].children.whoseRole.is("AXCell").allItems[1].children.whoseRole.is("AXStaticText").first.popupMenuSelect({
    isRightClick: true,
    menuPath: ["Replace Clip..."],
});

sf.ui.proTools.replaceClipDialog.elementWaitFor({
    waitType: "Appear",
});

// Make sure we're only replacing the previous mix
sf.ui.proTools.replaceClipDialog.radioButtons.whoseTitle.is('original clip only').first.elementClick();
sf.ui.proTools.replaceClipDialog.radioButtons.whoseTitle.is('replacement clip length').first.elementClick();

// Do it
sf.ui.proTools.replaceClipDialog.buttons.whoseTitle.is('OK').first.elementClick();
sf.ui.proTools.replaceClipDialog.elementWaitFor({
    waitType: "Disappear",
});
// Clear the Find in the clip bin
sf.ui.proTools.mainWindow.popupButtons.whoseTitle.is('Clip List').first.popupMenuSelect({
    menuPath: ["Clear Find"],
});
// That's it!