Skip to content
TheChatArchiveThe Chat Archive
gpt-4o-2024-05-13· OpenAIAi2 WildChat-4.8M (AI2)

-- Rykord - ImGui Media Explorer -- folders are represented as tree nodes -- items are…

  1. User

    -- Rykord - ImGui Media Explorer

    -- folders are represented as tree nodes -- items are selectables -- play functionality with volume knob and autoplay -- drag and drop functionalities -- drop to the arrange view (priority) -- drop to the media explorer -- search bar functionality

    -- Store the reference to the currently playing preview local current_preview = nil

    -- Variables for search functionality local search_query = "" local last_search_query = "" local search_cache = {} local debounce_timer = 0

    -- Function to check if a directory contains any matching files function directory_contains_matching_files(path) if search_cache[path] ~= nil then return search_cache[path] end

    local idx = 0
    local contains_matches = false
    while true do
        local file = reaper.EnumerateFiles(path, idx)
        if not file then break end
    
        -- Ignore hidden files and directories
        if not file:match("^%.") then
            -- Check if the file matches the search query
            if (file:match("%.wav$") and (search_query == "" or file:lower():find(search_query:lower(), 1, true)) then
                contains_matches = true
                break
            end
        end
    
        idx = idx + 1
    end
    
    if not contains_matches then
        idx = 0
        while true do
            local subdir = reaper.EnumerateSubdirectories(path, idx)
            if not subdir then break end
    
            -- Ignore hidden files and directories
            if not subdir:match("^%.") then
                local full_path = path .. "/" .. subdir
                if directory_contains_matching_files(full_path) then
                    contains_matches = true
                    break
                end
            end
    
            idx = idx + 1
        end
    end
    
    search_cache[path] = contains_matches
    return contains_matches
    

    end

    -- Function to create a directory tree and search for files recursively function create_directory_tree(path, depth) if depth > 5 then return end -- Limit search depth

    -- Enumerate subdirectories
    local idx = 0
    while true do
        local subdir = reaper.EnumerateSubdirectories(path, idx)
        if not subdir then break end
    
        -- Ignore hidden files and directories
        if not subdir:match("^%.") then
            local full_path = path .. "/" .. subdir
    
            -- Check if the subdir contains matching files
            if directory_contains_matching_files(full_path) then
                if reaper.ImGui_TreeNode(ctx, subdir) then
                    create_directory_tree(full_path, depth + 1)
                    reaper.ImGui_TreePop(ctx)
                end
            end
        end
    
        idx = idx + 1
    end
    
    -- Enumerate files
    idx = 0
    while true do
        local file = reaper.EnumerateFiles(path, idx)
        if not file then break end
    
        -- Ignore hidden files and directories
        if not file:match("^%.") then
            -- Check if the file matches the search query
            if (file:match("%.wav$") and (search_query == "" or file:lower():find(search_query:lower(), 1, true)) then
                if reaper.ImGui_Selectable(ctx, file) then
                    -- Preview the selected file
                    preview_file(path .. "/" .. file)
                end
            end
        end
    
        idx = idx + 1
    end
    

    end

    -- Function to preview a selected file within Reaper function preview_file(file) -- Stop any currently playing preview if current_preview then reaper.CF_Preview_StopAll() current_preview = nil end

    -- Create a PCM_Source from the file
    local source = reaper.PCM_Source_CreateFromFile(file)
    
    -- Create a preview object
    current_preview = reaper.CF_CreatePreview(source)
    
    -- Start the preview
    local play_success = reaper.CF_Preview_Play(current_preview)
    if not play_success then
        reaper.ShowMessageBox("Failed to play preview: " .. file, "Error", 0)
    end
    

    end

    function main() reaper.ImGui_SetNextWindowDockID(ctx, -7) local retval, is_open = reaper.ImGui_Begin(ctx, "Media Explorer", true)

    if is_open then
        -- Search input box
        local changed, text = reaper.ImGui_InputText(ctx, "Search", search_query, 256)
        if changed then
            search_query = text
            debounce_timer = reaper.time_precise() + 0.3  -- 300 ms debounce
        end
    
        if reaper.time_precise() > debounce_timer then
            if search_query ~= last_search_query then
                search_cache = {}  -- Clear cache when the search query changes
                last_search_query = search_query
            end
    
            -- Call the function to create the directory tree and search for files
            create_directory_tree("E:\\Sample Packs\\COLLECTION", 0)
        end
    
        reaper.defer(main)
    end
    
    reaper.ImGui_End(ctx)
    

    end

    ctx = reaper.ImGui_CreateContext("ctx") main()

  2. Assistant

    Let's break down the Lua script you posted and summarize how it works, focusing on the integration with ImGui for creating a media explorer with search functionality and preview capabilities:

    Key Functionalities

    1. Directory and File Search:

      • The script recursively traverses directories, looking for .wav files that match the search query.
      • It uses caching (search_cache) to store and quickly reference previously searched directories, thereby improving performance.
    2. ImGui Interface Elements:

      • Tree Nodes: Directories are represented with tree nodes which can be expanded or collapsed.
      • Selectables: Individual media files (specifically .wav files) are displayed as selectable items.
      • Search Bar: A text input field allows users to search for specific files within the media explorer.
    3. Debouncing:

      • A debounce timer delays the search execution, ensuring that the search mechanism isn't overwhelmed by rapid successive keystrokes.
    4. Preview Functionality:

      • When a media file is selected, it is previewed using Reaper’s preview playback capabilities (reaper.CF_Preview_Play()).
    5. Recursive Directory Traversal:

      • The function create_directory_tree recursively visits subdirectories and files, ensuring all potential matches are found up to a specified depth (5 in this case).

    Explained Code

    1. Global Variables:
    local current_preview = nil
    local search_query = ""
    local last_search_query = ""
    local search_cache = {}
    local debounce_timer = 0
    
    1. Checking Directories for Matching Files:
    function directory_contains_matching_files(path)
        if search_cache[path] ~= nil then
            return search_cache[path]
        end
    
        local idx = 0
        local contains_matches = false
        while true do
            local file = reaper.EnumerateFiles(path, idx)
            if not file then break end
    
            if not file:match("^%.") then
                if (file:match("%.wav$") and (search_query == "" or file:lower():find(search_query:lower(), 1, true)) then
                    contains_matches = true
                    break
                end
            end
            idx += 1
        end
    
        if not contains_matches then
            idx = 0
            while true do
                local subdir = reaper.EnumerateSubdirectories(path, idx)
                if not subdir then break end
    
                if not subdir:match("^%.") then
                    local full_path = path .. "/" .. subdir
                    if directory_contains_matching_files(full_path) then
                        contains_matches = true
                        break
                    end
                end
                idx += 1
            end
        end
    
        search_cache[path] = contains_matches
        return contains_matches
    end
    
    1. Creating Directory Tree:
    function create_directory_tree(path, depth)
        if depth > 5 then return end
    
        local idx = 0
        while true do
            local subdir = reaper.EnumerateSubdirectories(path, idx)
            if not subdir then break end
    
            if not subdir:match("^%.") then
                local full_path = path .. "/" .. subdir
    
                if directory_contains_matching_files(full_path) then
                    if reaper.ImGui_TreeNode(ctx, subdir) then
                        create_directory_tree(full_path, depth + 1)
                        reaper.ImGui_TreePop(ctx)
                    end
                end
            end
            idx += 1
        end
    
        idx = 0
        while true do
            local file = reaper.EnumerateFiles(path, idx)
            if not file then break end
    
            if not file:match("^%.") then
                if (file:match("%.wav$") and (search_query == "" or file:lower():find(search_query:lower(), 1, true)) then
                    if reaper.ImGui_Selectable(ctx, file) then
                        preview_file(path .. "/" .. file)
                    end
                end
            end
            idx += 1
        end
    end
    
    1. File Preview:
    function preview_file(file)
        if current_preview then
            reaper.CF_Preview_StopAll()
            current_preview = nil
        end
    
        local source = reaper.PCM_Source_CreateFromFile(file)
        current_preview = reaper.CF_CreatePreview(source)
    
        local play_success = reaper.CF_Preview_Play(current_preview)
        if not play_success then
            reaper.ShowMessageBox("Failed to play preview: " .. file, "Error", 0)
        end
    end
    
    1. Main Function and UI Loop:
    function main()
        reaper.ImGui_SetNextWindowDockID(ctx, -7)
        local retval, is_open = reaper.ImGui_Begin(ctx, "Media Explorer", true)
    
        if is_open then
            local changed, text = reaper.ImGui_InputText(ctx, "Search", search_query, 256)
            if changed then
                search_query = text
                debounce_timer = reaper.time_precise() + 0.3
            end
    
            if reaper.time_precise() > debounce_timer then
                if search_query ~= last_search_query then
                    search_cache = {}
                    last_search_query = search_query
                end
    
                create_directory_tree("E:\\Sample Packs\\COLLECTION", 0)
            end
    
            reaper.defer(main)
        end
    
        reaper.ImGui_End(ctx)
    end
    
    ctx = reaper.ImGui_CreateContext("ctx")
    main()
    

    This script integrates well with Reaper using Rykord to create a media explorer with a functional search, tree representation for folders, selectable items, and file preview capabilities. The debounce mechanism avoids performance issues during rapid text input for searches.