Help with Script to Extract and Rename Drum Rack Chains in Ableton 12 Using Soundflow

Hi @Jake_Morton!

Excellent work all around. I'm so impressed you could brute force a workable version of this workflow so quickly!

We are still in the early stages of exploring Ableton's possibilities with SoundFlow. Still, the doors have opened up a bit now that Ableton has implemented some accessibility features in version 12. I'm so glad you dug in and made it work for you!

I made a version of this script to see if I could refactor your code and get it to behave more like the scripts we write for our Pro Tools and Logic Pro packages. I'm still relying on some keyboard/mouse simulation, but this version should be more stable overall.

I also handled adding a timestamp (although it could be prettier), ensuring that you don't have to have the drum rack first in the session, and forcing the return tracks to be visible.

I hope this script helps you as you tinker with Ableton. I tried to leave thorough notes as comments.

If you are up for it, I'd also love to hop on a quick Zoom call and chat about using SoundFlow with Ableton. Feel free to contact support@soundflow.org if you'd like to set that up!

if (!sf.ui.abletonLive.isRunning) throw `Ableton is not running`;

// Activate Ableton
sf.ui.abletonLive.appActivateMainWindow();

// Invalidate the UI Cache
sf.ui.abletonLive.mainWindow.invalidate();

// Fucntion to Select Track by Name
function selectTrackbyName(trackName) {
    // Store the state of the Arrangement vs Session Window.
    let isArrangementFocused = sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Arrangement").first.isEnabled
    
    // If Arrangement window is not focused, then focus it. 
    if (!isArrangementFocused) {
        // Navigate to Arrangement View
        sf.ui.abletonLive.menuClick({
            menuPath: ["Navigate", "Arrangement View"],
        });
    }

    // Select the track using the "AXShowMenu" command.
    sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Arrangement").first.children.whoseRole.is("AXOutline").whoseDescription.is("Track Headers").first.children.whoseRole.is("AXRow").whoseTitle.startsWith(trackName).first.textFields.whoseDescription.is("Track Title Bar").first.elementClick({ actionName: "AXShowMenu", })
    
    // Quickly escape since the previous call opens a context menu.
    sf.keyboard.press({ keys: 'escape', repetitions: 2, fast: true })
    
    // If Session view was focused previously, restore it. 
    if (!isArrangementFocused) {
        sf.ui.abletonLive.menuClick({
            menuPath: ["Navigate", "Session View"],
        });
    }
}

// Generic Function to navigate to a path in a save or open dialog window
function navigateTo(path) {
    //Get a reference to the focused window in the frontmost app:
    var win = sf.ui.frontmostApp.focusedWindow;

    //Sanity check - make sure window is either Save or Open dialog
    if (!(win.title.value.indexOf('Save') >= 0 || win.title.value.indexOf('Open') >= 0 || win.title.value.indexOf('Save As') >= 0))
        throw 'Focused window is not an Open or Save dialog. Title: ' + win.title.value;

    // Open the Go to... sheet
    sf.keyboard.type({ text: '/' });

    // Wait for the sheet to appear
    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
    sf.keyboard.type({
        text: path,
    }, 'Could not paste the path');

    // Press return
    sf.keyboard.press({
        keys: "return",
    }, "Could not hit return");

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

// Function to extract chains from a track 
function extractChains(chosenTrack, subtrackNames) {

    // Act on each subtrack
    subtrackNames.forEach((subtrack) => {
        try {
            // Select the track using the "AXShowMenu" command.
            sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Session").first.children.whoseRole.is("AXOutline").whoseDescription.is("Track Headers")
                .first.children.whoseRole.is("AXRow").whoseTitle.is(chosenTrack).first.children.whoseRole.is("AXStaticText").whoseValue.endsWith(subtrack.name).first.elementClick({ actionName: "AXShowMenu" }, `Could Not Click Show Menu`);
            
            // Quickly escape since the previous call opens a context menu.
            sf.keyboard.press({ keys: 'escape', repetitions: 2, fast: true }, `Could Not Press Keys`);

            // Initiate a Variable to store the new name.
            let newName;

            // Wait for "Create" > "Extract Chains" or "Create" > "Extract Return Chains" to be available in the menu
            while (!sf.ui.abletonLive.getMenuItem('Create', 'Extract Chains').isEnabled &&
                !sf.ui.abletonLive.invalidate().getMenuItem('Create', 'Extract Return Chains').isEnabled) {
                sf.wait({ intervalMs: 200 });
                sf.ui.abletonLive.invalidate();
            }

            // If the "Create" > "Extract Chains" menu item is available , click "Create" > "Extract Chains"
            if (sf.ui.abletonLive.getMenuItem('Create', 'Extract Chains').isEnabled) {
                sf.ui.abletonLive.menuClick({ menuPath: ['Create', 'Extract Chains'] }, `Could Not Click "Extract Chains"`);
                
                // A bit of a hack for now. The menu path doesn't seem to update right away.
                if (subtrack.name.endsWith('Mix Bus')) {
                    // store the name as 'Mix Bus'
                    newName = `${subtrack.name}`;
                } else {
                    // Store new name with a # in front to make sure it's a unique name in ableton
                    newName = `# ${subtrack.name}`;
                }
            // If the "Create" > "Extract Return Chains" menu item is available , click "Create" > "Extract Return Chains"
            } else if (sf.ui.abletonLive.invalidate().getMenuItem('Create', 'Extract Return Chains').isEnabled) {
                sf.ui.abletonLive.menuClick({ menuPath: ['Create', 'Extract Return Chains'] }, `Could Not Click "Extract Return Chains"`);
                
                // Store the new name as the name alone. Prefixed by the letter of the return automatically.
                newName = `${subtrack.name}`;
            } else {
                throw `Could Not Extract Chain for ${subtrack.name}`
            }

            // Menu Click to Rename the Extracted Track
            sf.ui.abletonLive.menuClick({ menuPath: ['Edit', 'Rename'] });

            // Currently Using Keyboard Simulation here, it'd be better to use ui automation to set the text field eventually. However, I'm not sure how we can tell which track is selected. 
            sf.keyboard.type({ text: `${newName}` });
            sf.keyboard.press({ keys: 'enter' });

            // Currently waiting an arbitrary amount of time, but this could eventually be removed.
            sf.wait({ intervalMs: 500 });
        } catch (err) {
            throw err;
        }
    })
}

function main() {
    // Store the state of Arrangement vs Session View. 
    let isArrangementFocused = sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Arrangement").first.isEnabled
    
    // If Arrangement View is not focused
    if (!isArrangementFocused) {
        // Navigate to Arrangement View
        sf.ui.abletonLive.menuClick({
            menuPath: ["Navigate", "Arrangement View"],
        });
    }
    // Return a List of All Track Names in Ableton
    let allTracks = sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Arrangement").first.children.whoseRole.is("AXOutline").whoseDescription.is("Track Headers").first.children.whoseRole.is("AXRow").allItems.map(function (x) { return { name: x.title.value } });

    // Search for a track
    var chosenTrack = sf.interaction.popupSearch({
        items: allTracks,
        title: 'Select a Track'
    }).item.name;

    // Select the Track
    selectTrackbyName(chosenTrack);

    // Navigate to Session View for Extracting
        sf.ui.abletonLive.menuClick({
            menuPath: ["Navigate", "Session View"],
            targetValue:"Enable"
        });

    // Show Return Tracks if Hidden
    sf.ui.abletonLive.menuClick({
        menuPath: ["View", "Mixer Controls", "Return Tracks"],
        targetValue: "Enable",
    });

    // Expand Drum Chains for Drum Rack
    if (sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Session").first.children.whoseRole.is("AXOutline").whoseDescription.is("Track Headers")
        .first.children.whoseRole.is("AXRow").whoseTitle.is(chosenTrack).first.checkBoxes.whoseDescription.is("Chain Mixer Fold Button").allItems.length == 1) {
        sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Session").first.children.whoseRole.is("AXOutline").whoseDescription.is("Track Headers")
            .first.children.whoseRole.is("AXRow").whoseTitle.is(chosenTrack).first.checkBoxes.whoseDescription.is("Chain Mixer Fold Button").first.checkboxSet({ targetValue: "Enable" });
    }

    // Hide All Chains Within the The Drum Rack
    sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Session").first.children.whoseRole.is("AXOutline").whoseDescription.is("Track Headers").first.children.whoseRole.is("AXRow").whoseTitle.is("2-707 Core Kit, Armed")
        .first.checkBoxes.whoseDescription.is("Chain Mixer Fold Button").allItems.map(
            (x, i, arr) => {
                if (i < arr.length - 1) {
                    x.checkboxSet({ targetValue: "Disable" })
                }
            })

    // Get the Names of All the Tracks in the Sub Stack 
    let currentSubtracks = sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Session").first.children.whoseRole.is("AXOutline").whoseDescription.is("Track Headers")
        .first.children.whoseRole.is("AXRow").whoseTitle.is(chosenTrack).first.children.whoseRole.is("AXStaticText").map(x => x.value.value)
        .map(function (x) {
            if (x.match(/^(\w\s)/gm)) {
                x = x.split(/^(\w\s)/gm)[2]
                return { name: x, trackType: 'Return Track' }
            }
            return { name: x, trackType: 'MIDI Track' };
        });

    // Run "extractChains" on all of the sub tracks.
    extractChains(chosenTrack, currentSubtracks);

    // PT 2 EXPORTING 
    
    // Grab the Session Name from the top of the session
    let sessionName = sf.ui.abletonLive.mainWindow.getElement("AXTitleUIElement").value.value

    // Open the Browser. Would be good to close this again if it wasn't open to start.
    sf.ui.abletonLive.menuClick({
        menuPath: ["Navigate", "Browser"],
        targetValue: "Enable",
    });

    // Wait for the "Browser Sidebar" element
    sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Browser").first.children.whoseRole.is("AXOutline").whoseDescription.is("Browser Sidebar").first.elementWaitFor();

    // Click on Current Project in this Sidebar. Currently uses mouse simulation. 
    sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Browser").first.children.whoseRole.is("AXOutline").whoseDescription.is("Browser Sidebar").first.children
        .whoseRole.is("AXRow").whoseTitle.is("Current Project").first.children.whoseRole.is("AXCell").whoseTitle.is("Current Project").first.children.whoseRole.is("AXStaticText").whoseValue.is("Current Project").first.mouseClickElement();

    // Select the Current Session in the Browser
    sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Browser").first.children.whoseRole.is("AXOutline").whoseDescription.startsWith("Current Project List").first
        .children.whoseRole.is("AXRow").whoseTitle.startsWith(sessionName).first.children.whoseRole.is("AXCell").whoseTitle.startsWith(sessionName).first.children.whoseRole.is("AXStaticText")
        .first.mouseClickElement({ isRightClick: true });

    // Right Click and Select "Show In Finder" in the context menu. 
    sf.ui.abletonLive.windows.whoseTitle.is('').first.groups.first.groups.whoseTitle.is('Context').first.children.whoseTitle.is('Show in Finder').first.elementClick();

    // Store the file path from Finder
    let selectedPath = sf.ui.finder.selectedPaths[0];

    // Trim the file path so that it points to the parent folder
    let parentFolderPath = selectedPath.split('/').slice(0, -1).join('/') + `/`;

    // Activate Ableton
    sf.ui.abletonLive.appActivateMainWindow();

    // Temporarily Hide Return Tracks
    sf.ui.abletonLive.menuClick({
        menuPath: ["View", "Mixer Controls", "Return Tracks"],
        targetValue: "Disable"
    });

    // Select the tracks
    // Select the Main Output Track
    sf.ui.abletonLive.mainWindow.groups.first.groups.whoseTitle.is("Session").first.children.whoseRole.is("AXOutline").whoseDescription.is("Track Headers")
        .first.children.whoseRole.is("AXRow").whoseTitle.is("Main").first.textFields.whoseDescription.is("Main Track Title Bar").first.mouseClickElement();

    // Get the number of tracks to select based on the track types.
    let currentSubtracksLength = currentSubtracks.map(x => x.trackType).filter(x => x == 'MIDI Track').length;

    // Using Keyboard Simulation until we have a better method to select multiple tracks.
    sf.keyboard.press({ keys: 'left' })
    sf.keyboard.press({ keys: 'shift+left', repetitions: currentSubtracksLength - 1 })

    // Show Return Tracks Again
    sf.ui.abletonLive.menuClick({
        menuPath: ["View", "Mixer Controls", "Return Tracks"],
        targetValue: "Enable",
    });

    // Click Menu Item Export Audio/Video...
    sf.ui.abletonLive.menuClick({
        menuPath: ["File", "Export Audio/Video..."],
    });

    // Wait for Export Window
    sf.ui.abletonLive.mainWindow.groups.first.buttons.whoseDescription.is("Export").first.elementWaitFor();

    // Choose "Selected Tracks Only"
    if (sf.ui.abletonLive.mainWindow.groups.first.popupButtons.whoseDescription.is("Rendered Track Chooser").first.value.value !== 'Selected Tracks Only') {
        sf.ui.abletonLive.mainWindow.groups.first.popupButtons.whoseDescription.is("Rendered Track Chooser").first.elementClick();
        sf.ui.abletonLive.windows.whoseTitle.is('').first.groups.first.groups.first.children.whoseTitle.is('Selected Tracks Only').first.elementClick();
    }

    // Choose "Include Return and Main Effects"
    if (sf.ui.abletonLive.mainWindow.groups.first.buttons.whoseDescription.is("Include Return and Main Effects").first.value.value !== 'On') {
        sf.ui.abletonLive.mainWindow.groups.first.buttons.whoseDescription.is("Include Return and Main Effects").first.elementClick();
    }

    // Choose "Encode PCM"
    if (sf.ui.abletonLive.mainWindow.groups.first.buttons.whoseDescription.is("Encode PCM").first.value.value !== 'On') {
        sf.ui.abletonLive.mainWindow.groups.first.buttons.whoseDescription.is("Encode PCM").first.elementClick();
    }

    // Click "Export"
    sf.ui.abletonLive.mainWindow.groups.first.buttons.whoseDescription.is("Export").first.elementClick({ asyncSwallow: true });

    // Clear the Text Field Values
    sf.ui.abletonLive.windows.whoseTitle.is("Save").first.textFields.first.elementSetTextFieldWithAreaValue({ value: '' })

    // Navigate to the Parent Folder
    navigateTo(parentFolderPath);

    // Wait for "New Folder" button to be active
    while (!sf.ui.abletonLive.windows.whoseTitle.is("Save").first.buttons.whoseTitle.is("New Folder").first.isEnabled) {
        sf.wait({ intervalMs: 200 });
    }

    // Click "New Folder" button
    sf.ui.abletonLive.windows.whoseTitle.is("Save").first.buttons.whoseTitle.is("New Folder").first.elementClick({asyncSwallow:true});

    // Get Current Date
    const today = new Date();

    // Format the date (e.g., MM/DD/YYYY) + Time
    const formattedDate = today.toLocaleDateString('en-US') + ' ' + today.toTimeString();

    // Create the Text With the Date Suffix
    const textWithDate = `Drum Rack Extract Chains Stems ${formattedDate}`;

     // Wait for the Untitled Folder Text Field
    while(!sf.ui.abletonLive.windows.whoseTitle.is("Save").first.sheets.first.textFields.whoseValue.is("untitled folder").first.exists){
        sf.wait({ intervalMs: 200 });
    }
    
    // Set the text in the text field
    sf.ui.abletonLive.windows.whoseTitle.is("Save").first.sheets.first.textFields.first.elementSetTextFieldWithAreaValue({ value:textWithDate })

    // Click the Default Button to Save the New Folder
    sf.ui.abletonLive.windows.whoseTitle.is("Save").first.sheets.first.getElement("AXDefaultButton").elementClick();

    // Wait for Save Window to Be Enabled Again
    while (!sf.ui.abletonLive.windows.whoseTitle.is("Save").first.buttons.whoseTitle.is("New Folder").first.isEnabled) {
        sf.wait({ intervalMs: 200 });
    }

    // Placeholder text, it won't start without any text. 
    sf.keyboard.type({ text:'stems-' })

    // Launch the rocket
    sf.ui.abletonLive.windows.whoseTitle.is("Save").first.buttons.whoseTitle.is("Save").first.elementClick();
}

main();