Tooldev: renoise.song() triggers error when executed during renoise startup

OopsIFly · August 10, 2021, 7:26pm

It seems that renoise does not have the renoise.song() function/object ready at startup, while tools that could access it are already being loaded. Executing that function before the startup/template song is loaded results in an error.

If a tool uses the function in it’s startup code the tool will fail loading, breaking the tool. However once renoise has successfully loaded, and tools are reloaded manually, the function works as expected, even when used in the startup code of the tool.

Expected behavior: either tools to be loaded once the renoise.song() function is ready for use, or the function passing a value like nil to indicate that the system is not ready yet.

I have created a little testing tool to demonstrate the error. Install the xrnx - it will print a message dialog stating success while being installed. Now shut down renoise. Start renoise again - the tool will execute renoise.song() and trigger the error message, the tool will not be loaded. Reloading the tools once renoise has finished startup will not trigger the error, but successfully load the tool and print the success message.

Tested with Renoise 3.3.2 on Linux.

song_object_bug.xrnx (602 Bytes)

OopsIFly · August 10, 2021, 11:35pm

Other (GUI) functionality seems to crap out as well when starting stuff directly when the tool loads.

Reason why I am doing it - I trigger the main function right at the end of the main.lua. So while I am developing, I can just fire up renoise and play around with the tool right away. Have to currently reload the tool for things to work properly.

Jek · August 11, 2021, 3:48am

May be possible to ‘wrap’ your ‘call’ to the ‘renoise.song()’ method;
thus ‘catching’ then ‘handling’ the failure in your own function.

taktik · August 16, 2021, 9:04am

I know this is not very convenient, but if you’re tool depends on the Renoise song, you anyway will need to listen for song instance changes via renoise.tool().app_new_document_observable

github.com

renoise/xrnx/blob/1112604a9c656f42c57b109eb227b4a551bf2766/Documentation/Renoise.ScriptingTool.API.lua#L338

    
      
          -- last time renoise.song() still points to the old song before a new one arrives.
          -- You can explicitly release notifiers to the old document here, or do your own
          -- housekeeping. Also called right before the application exits.
          renoise.tool().app_release_document_observable
            -> [renoise.Document.Observable object]
          
          
-- Invoked each time a new document (song) is created or loaded. In other words:
          -- each time the result of renoise.song() is changed. Also called when the script
          -- gets reloaded (only happens with the auto_reload debugging tools), in order
          -- to connect the new script instance to the already running document.
          renoise.tool().app_new_document_observable
            -> [renoise.Document.Observable object]
          
          
-- invoked each time the app's document (song) is successfully saved.
          -- renoise.song().file_name will point to the filename that it was saved to.
          renoise.tool().app_saved_document_observable
            -> [renoise.Document.Observable object]
          
          

          
--[[

So you should avoid using Lua main and hook into either app_new_document_observable or renoise.tool().tool_finished_loading_observable depending on if your tool is working on the app itself only or on the app’s song document.

system · August 20, 2021, 2:49am

This topic was automatically closed 2 days after the last reply. New replies are no longer allowed.