Cascade Audio In Mastering Application

Prepping mastering sessions in Pro Tools is quite frankly, annoying. After seeing the potential in the SDK from using it yesterday, I was wondering why this functionality isn't already built in. The screen recording makes it pretty apparent what it's doing but essentially it's allowing each song to be proceeded by the next song with markers. This makes printing masters incredibly easy and navigating the mastering session equally so. I was imagining it would look something like this:

sf.app.proTools.cascadeTracks({
    numberTracks: true, // Adds numbering to track names
    gaplessTransitions: false,
    startPadding: 80ms,
    endPadding: 120ms,
    startMarker: trackName, // Accounts for padding
    endMarker: clipName, // Accounts for padding
});

Below is the script I wrote and the screen recording, let me know your thoughts!

function returnToZero() {
    const trasnport = sf.ui.proTools.mainWindow.transportViewCluster.groups.whoseTitle.is("Normal Transport Buttons");

    trasnport.first.buttons.whoseTitle.is("Return to Zero").first.elementClick();
}

////////////////////////////////////////////////////////////////////////////////////////////////////

function getOriginalCounter() {
    let originalCounter;

    if (sf.ui.proTools.getMenuItem('View', 'Main Counter', 'Bars|Beats').isMenuChecked) {
        originalCounter = ['View', 'Main Counter', 'Bars|Beats'];
    }

    if (sf.ui.proTools.getMenuItem('View', 'Main Counter', 'Min:Secs').isMenuChecked) {
        originalCounter = ['View', 'Main Counter', 'Min:Secs'];
    }

    if (sf.ui.proTools.getMenuItem('View', 'Main Counter', 'Timecode').isMenuChecked) {
        originalCounter = ['View', 'Main Counter', 'Timecode'];
    }

    if (sf.ui.proTools.getMenuItem('View', 'Main Counter', 'Feet+Frames').isMenuChecked) {
        originalCounter = ['View', 'Main Counter', 'Feet+Frames'];
    }

    if (sf.ui.proTools.getMenuItem('View', 'Main Counter', 'Samples').isMenuChecked) {
        originalCounter = ['View', 'Main Counter', 'Samples'];
    }

    return originalCounter;
}

////////////////////////////////////////////////////////////////////////////////////////////////////

function getOriginalEditMode() {
    let editMode;

    const slipModeButton = sf.ui.proTools.mainWindow.editModeCluster.buttons.whoseTitle.is("EditModeSlip").first;
    const gridModeButton = sf.ui.proTools.mainWindow.editModeCluster.buttons.whoseTitle.is("Absolute Grid mode").first;
    const shuffleModeButton = sf.ui.proTools.mainWindow.editModeCluster.buttons.whoseTitle.is("EditModeShuffle").first;
    const spotModeButton = sf.ui.proTools.mainWindow.editModeCluster.buttons.whoseTitle.is("EditModeSpot").first;

    if (slipModeButton.value.invalidate().value === 'Selected') {
        editMode = 'Slip';
    }

    if (gridModeButton.value.invalidate().value === 'Selected') {
        editMode = 'Grid';
    }

    if (shuffleModeButton.value.invalidate().value === 'Selected') {
        editMode = 'Shuffle';
    }

    if (spotModeButton.value.invalidate().value === 'Selected') {
        editMode = 'Spot';
    }

    return editMode;
}

////////////////////////////////////////////////////////////////////////////////////////////////////

function batchRename() {
    sf.ui.proTools.selectedTrack.titleButton.popupMenuSelect({
        isRightClick: true,
        relativePosition: { x: 5, y: 5 },
        menuPath: ['Batch Rename...']
    });

    const batchRenameWin = sf.ui.proTools.windows.whoseTitle.is('Batch Track Rename').first;

    batchRenameWin.elementWaitFor();

    batchRenameWin.checkBoxes.whoseTitle.is('Replace').first.checkboxSet({
        targetValue: 'Disable',
    });

    batchRenameWin.checkBoxes.whoseTitle.is('Trim').first.checkboxSet({
        targetValue: 'Disable',
    });

    batchRenameWin.checkBoxes.whoseTitle.is('Add').first.checkboxSet({
        targetValue: 'Disable',
    });

    batchRenameWin.checkBoxes.whoseTitle.is('Numbering').first.checkboxSet({
        targetValue: 'Enable',
    });

    batchRenameWin.popupButtons.first.popupMenuSelect({
        menuPath: ['Beginning'],
    });

    // Starting Number
    batchRenameWin.textFields.allItems[11].elementSetTextFieldWithAreaValue({
        useMouseKeyboard: true,
        value: '1'
    });

    // Number of Places
    batchRenameWin.textFields.allItems[12].elementSetTextFieldWithAreaValue({
        useMouseKeyboard: true,
        value: '1'
    });

    // Increment
    batchRenameWin.textFields.allItems[13].elementSetTextFieldWithAreaValue({
        useMouseKeyboard: true,
        value: '1'
    });

    batchRenameWin.checkBoxes.whoseTitle.is('Separate With:').first.checkboxSet({
        targetValue: 'Enable',
    });

    batchRenameWin.buttons.whoseTitle.is('OK').first.elementClick();

}

////////////////////////////////////////////////////////////////////////////////////////////////////

function randomTrackColor() {
    const color = ((Math.random() * 22) + 1).toFixed(0);

    const brightnessList = ['Light', 'Medium', 'Dark'];

    const brightness = brightnessList[(Math.random() * 2).toFixed(0)];

    sf.ui.proTools.colorsSelect({
        colorTarget: 'Tracks',
        colorNumber: Number(color),
        colorBrightness: brightness
    });
}

////////////////////////////////////////////////////////////////////////////////////////////////////

function spotClip(start) {
    const spotModeButton = sf.ui.proTools.mainWindow.editModeCluster.buttons.whoseTitle.is("EditModeSpot").first;

    if (!spotModeButton.isFocused) {
        sf.ui.proTools.editModeSet({
            mode: 'Spot'
        });
    }

    returnToZero();

    // Move Edit Selection to Next Clip
    sf.keyboard.press({
        keys: 'control+tab'
    });

    // Zoom to Fit Horizontal Selection
    sf.keyboard.press({
        keys: 'control+alt+f'
    });

    sf.ui.proTools.toolsSelect({
        tool: "Grabber",
    });

    const selectedTrack = sf.ui.proTools.selectedTrack.frame;

    sf.mouse.setPosition({
        position: { x: selectedTrack.x + 600, y: selectedTrack.y + (selectedTrack.h / 2) }
    });

    sf.mouse.click({
        position: { x: selectedTrack.x + 600, y: selectedTrack.y + (selectedTrack.h / 2) }
    });

    const spotDialog = sf.ui.proTools.clipSpotDialog;

    spotDialog.elementWaitFor();

    spotDialog.textFields.first.elementSetTextFieldWithAreaValue({
        useMouseKeyboard: true,
        value: `${start}`
    });

    spotDialog.buttons.whoseTitle.is('OK').first.elementClick();
}

////////////////////////////////////////////////////////////////////////////////////////////////////

function createMarker(selectedTrackName) {

    const match = selectedTrackName.match(/^(\d+)[\s_](.+)$/);

    const markerName = match[2];

    const markerNumber = Number(match[1]);

    sf.ui.proTools.memoryLocationsCreate({
        name: markerName,
        memoryLocationNumber: markerNumber,
    });
}

////////////////////////////////////////////////////////////////////////////////////////////////////

function getPreviousTrackEnd() {
    returnToZero();

    sf.ui.proTools.menuClick({
        menuPath: ['Edit', 'Selection', 'Extend Edit Up']
    });

    sf.ui.proTools.menuClick({
        menuPath: ['Edit', 'Selection', 'Remove Edit from Bottom']
    });

    // Move Edit Selection to Next Clip
    sf.keyboard.press({
        keys: 'control+tab'
    });

    const previousTrackEnd = sf.ui.proTools.selectionGetInSamples().selectionEnd;

    return previousTrackEnd
}

////////////////////////////////////////////////////////////////////////////////////////////////////

function restore(originalCounter, editMode) {
    sf.ui.proTools.menuClick({
        menuPath: ['Edit', 'Select All']
    });

    // Zoom to Fit Horizontal Selection
    sf.keyboard.press({
        keys: 'control+alt+f'
    });

    sf.ui.proTools.trackDeselectAll();

    returnToZero();

    sf.ui.proTools.toolsSelect({
        tool: "Smart",
    });

    sf.ui.proTools.menuClick({
        menuPath: originalCounter
    });

    sf.ui.proTools.editModeSet({
        mode: editMode
    });
}

////////////////////////////////////////////////////////////////////////////////////////////////////

function main() {
    sf.ui.proTools.appActivateMainWindow();
    sf.ui.proTools.mainWindow.invalidate();

    const originalCounter = getOriginalCounter();

    const editMode = getOriginalEditMode();

    if (!sf.ui.proTools.getMenuItem('View', 'Main Counter', 'Samples').isMenuChecked) {
        sf.ui.proTools.menuClick({
            menuPath: ['View', 'Main Counter', 'Samples']
        });
    }

    batchRename();

    sf.ui.proTools.selectedTrackNames.forEach((trackName, trackNameIndex) => {

        sf.ui.proTools.trackSelectByName({ names: [trackName]});

        sf.ui.proTools.selectedTrack.trackScrollToView();

        randomTrackColor();

        // IF FIRST TRACK JUST CREATE MARKER
        if (trackNameIndex === 0) {
            createMarker(trackName);
            return
        } else {
            let previousTrackEnd = getPreviousTrackEnd();

            sf.ui.proTools.trackSelectByName({
                names: [trackName]
            });

            spotClip(previousTrackEnd);

            createMarker(trackName);

            returnToZero();
        }
    });

    restore(originalCounter, editMode);
}

main();