Add Media Explorer reascript functionality

[Mordi]

I'm currently cleaning up my audio library, renaming files and consolidating them from single one-off sounds into longer sequential files separated by cues.

It would be really handy if the Media Explorer exposed functions like these in Lua scripts:
- Get currently selected files
- Get current folder path
- Rename file (without opening dialog)
- Get/set metadata field
- Get Media Explorer time selection start/end

Implementing some or all of these would greatly enhance the usefulness of the Media Explorer.

[acendan]

+1 - Get/Set metadata would be a huge gamechanger. Especially for iXML.

[Phazma]

+1 - This would supercharge the media explorer and allow users to create scripts for it to turn it into a tool for not just browsing but also organizing big sound libraries. I imagine a sophisticated batch renaming utility that adds/removes certain characters to/from all selected file's names.

[sijam]

+1 I've been sitting on requesting something like this for a little while. Editing all the new available metadata fields would be ace, a set of scripts for batch editing would be huge!

[Buy One]

Even though native API is always welcome and preferable, this can be attempted with Julian Sader's API

Originally Posted by X-Raym

Do you think we can get selected media files from Media Explorer and start doing some Media Explorer script ? :P

Originally Posted by juliansader

As Edgemeal answered, yes you can! (I am actually using some myself.)

Three remarks:

* You can open the Media Explorer (and get its HWND) using reaper.OpenMediaExplorer("", false).

* You can run any action from the Actions list's Media Explorer context (or even any item from the ME's menu), using JS_Window_OnCommand.

* If you are publishing a script that searches for any of REAPER's standard windows, such as the Media Explorer, use JS_Localize to get the translated title.

Edgemeal's example 1
Edgemeal's example 2
.
.
.

[Mordi]

Thanks for the tip. That should work well as a plan B for media explorer scripts.

[airon]

Mass tagging BWF and iXML fields with wildcards would sell well amongst sound designers, if such scripts don’t already exist.

[Rodilab]

+1000 for Set metadata API
Get one already exist.

[tingshuo]

+1
I'm looking for a way for the 'Replace Source' command to respect the time selection start point on the file in Media Explorer. It seems this request would make what I need scriptable.

[BenjyO]

+1 for all of these but mostly for Set metadata and Get time selection

[FeedTheCat]

Originally Posted by BenjyO

+1 for all of these but mostly for Set metadata and Get time selection

Just FYI, reading out time selection is cumbersome, but possible with JS_ReaScriptAPI. I did it for my RS5K link script.



Big +1 on this FR though. A little bit of ReaScript access would go a long way here.

[BenjyO]

Originally Posted by FeedTheCat

Just FYI, reading out time selection is cumbersome, but possible with JS_ReaScriptAPI. I did it for my RS5K link script.

Big +1 on this FR though. A little bit of ReaScript access would go a long way here.

Oh I know about your script and I use it a lot along with the other MX scripts you wrote. Super useful! Thank you very much for sharing it with the community

Haven't looked at the code of your scripts yet but I think I know what you did since I already messed around with JS_ReaScriptAPI and the MX window's controls before and I hit a wall when I realized the mouse cursor needs to be in the waveform area. Your script is deferred but what I tried to do was a "one-shot" script which would be triggered by a hotkey after you've already made your time selection. Well .. you know what the issue is

[FeedTheCat]

Originally Posted by BenjyO

Oh I know about your script and I use it a lot along with the other MX scripts you wrote. Super useful! Thank you very much for sharing it with the community

Haven't looked at the code of your scripts yet but I think I know what you did since I already messed around with JS_ReaScriptAPI and the MX window's controls before and I hit a wall when I realized the mouse cursor needs to be in the waveform area. Your script is deferred but what I tried to do was a "one-shot" script which would be triggered by a hotkey after you've already made your time selection. Well .. you know what the issue is

Yeah... it's messy... you have to simulate a mouse event for the values to be shown. Here's the function MediaExplorer_GetTimeSelection (and a simple example) in case you still want it.

local mx = reaper.OpenMediaExplorer('', false)

function MediaExplorer_GetTimeSelection(force_readout)
    if force_readout then
        -- Simulate mouse event on waveform to read out time selection
        local wave_hwnd = reaper.JS_Window_FindChildByID(mx, 1046)
        local x, y = reaper.GetMousePosition()
        local c_x, c_y = reaper.JS_Window_ScreenToClient(wave_hwnd, x, y)
        reaper.JS_WindowMessage_Send(wave_hwnd, 'WM_MOUSEFIRST', c_y, 0, c_x, 0)
    end

    -- If a time selection exists, it will be shown in the wave info window
    local wave_info_hwnd = reaper.JS_Window_FindChildByID(mx, 1014)
    local wave_info = reaper.JS_Window_GetTitle(wave_info_hwnd)
    local pattern = ': ([^%s]+) .-: ([^%s]+)'
    local start_timecode, end_timecode = wave_info:match(pattern)

    if not start_timecode then return false end

    -- Convert timecode to seconds
    local start_mins, start_secs = start_timecode:match('^(.-):(.-)$')
    start_secs = tonumber(start_secs) + tonumber(start_mins) * 60

    local end_mins, end_secs = end_timecode:match('^(.-):(.-)$')
    end_secs = tonumber(end_secs) + tonumber(end_mins) * 60

    -- Note: When no media file is loaded, start and end are both 0
    return start_secs ~= end_secs, start_secs, end_secs
end

ret, start_pos, end_pos = MediaExplorer_GetTimeSelection(true)

[BenjyO]

Originally Posted by FeedTheCat

Yeah... it's messy... you have to simulate a mouse event for the values to be shown. Here's the function MediaExplorer_GetTimeSelection (and a simple example) in case you still want it.

local mx = reaper.OpenMediaExplorer('', false)

function MediaExplorer_GetTimeSelection(force_readout)
    if force_readout then
        -- Simulate mouse event on waveform to read out time selection
        local wave_hwnd = reaper.JS_Window_FindChildByID(mx, 1046)
        local x, y = reaper.GetMousePosition()
        local c_x, c_y = reaper.JS_Window_ScreenToClient(wave_hwnd, x, y)
        reaper.JS_WindowMessage_Send(wave_hwnd, 'WM_MOUSEFIRST', c_y, 0, c_x, 0)
    end

    -- If a time selection exists, it will be shown in the wave info window
    local wave_info_hwnd = reaper.JS_Window_FindChildByID(mx, 1014)
    local wave_info = reaper.JS_Window_GetTitle(wave_info_hwnd)
    local pattern = ': ([^%s]+) .-: ([^%s]+)'
    local start_timecode, end_timecode = wave_info:match(pattern)

    if not start_timecode then return false end

    -- Convert timecode to seconds
    local start_mins, start_secs = start_timecode:match('^(.-):(.-)$')
    start_secs = tonumber(start_secs) + tonumber(start_mins) * 60

    local end_mins, end_secs = end_timecode:match('^(.-):(.-)$')
    end_secs = tonumber(end_secs) + tonumber(end_mins) * 60

    -- Note: When no media file is loaded, start and end are both 0
    return start_secs ~= end_secs, start_secs, end_secs
end

ret, start_pos, end_pos = MediaExplorer_GetTimeSelection(true)

Thanks!

[wastee]

+1 Happy to see if there's native API in ME.

[grandfougue]

So good But how did you manage to put your toolbar at the bottom of the media explorer?

[FeedTheCat]

Originally Posted by grandfougue

So good But how did you manage to put your toolbar at the bottom of the media explorer?

I have it docked in the toolbar docker, not the media explorer itself. (It's just 2 docked windows, ctrl-drag the tabs to position them).

Btw, just saw this in prerelease:

Originally Posted by matt_t

+ ReaScript: support GetMediaFileMetadata(src, "Generic:BPM") to get any BPM metadata

Really nice to see, let's hope that they also add SetMediaFileMetadata at some point.