Ultraschall-API 4.9 - 1663 Lua-Functions -"Razor Edit"

[X-Raym]

Nice for the uploading speed ! It was my main concern with using such big library :P (not for my personal scripts but for script I share at least).



So if it now only loads what is necessary... Seems as good as it can get !


Thx !

[Meo-Ada Mespotine]

I think, I can improve even further(I have...ideas*), but need some time to rest, after that much stuff I coded this year for the API


*that's how every evolutionary step or amargeddon starts

[Ivannn Bennnettt]

I'm waiting for an Armageddon

[Meo-Ada Mespotine]

Hotfix 1 now available.
5th of January 2020

Changes:
- EventManager: Eventmanager_RemoveEvent - didn't work with new speedup-improvements -> fixed(thanks to rstockm)
- EventManager: Eventmanager_RemoveAllEvents_Script - - didn't work with new speedup-improvements -> fixed
- Docs: had typo in the functionnames of Eventmanager_RemoveEvent and Eventmanager_RemoveAllEvents_Script -> fixed

Please update your ReaPacks.

[X-Raym]

Hi Mespotine,

boolean retval, optional string alteredStateChunk = ultraschall.SetFXStateChunk(string StateChunk, string FXStateChunk)

I tried to use it to insert FX chains file content, but it doesn't seems to work,
the validator functions tolds me that this file content isn't a valid FX state chunk (which I think it i supposed to be)



Is there a subtle differnece I missed between FX chains file content and FX state chunk ?


Thx for your assistance !

[X-Raym]

Ok I see,


regular take FXs have

 <TAKEFX
...
>

which isn't present in FX chains file content.


A funciton to support this would be very nice :P


----
Bug report:


Doc says that take ID is optionnal for GetFXStateChunk but it doesn't seems to be the case. I had to put '1' as ID.


Question, if optional, would it only consider active take right ?

[X-Raym]

I tried to add <Take FX > to my FX chain file content to see if it could works,


the FX chain is validated by ultrashall validator function but I get this error when trying to set the altered string to an item:

...i//Modules/ultraschall_functions_FXManagement_Module.lua:1726: bad argument #1 to 'gsub' (string expected, got nil)

      if ultraschall.IsValidFXStateChunk(FXStateChunk) then
        retval, StateChunk = reaper.GetItemStateChunk( item, '', false )
        retval, alteredStateChunk = ultraschall.SetFXStateChunk(StateChunk, FXStateChunk)
        reaper.SetItemStateChunk( item, alteredStateChunk, true)
      end

Do you see any error in this code ?

Can this because I didn't add propper indendation to every line of my FX chain chunk ?
(I suspect - cause the chunk is validated by your validator funciton) and hope that the set Chunk functions doesn't need propper indendations).

EDIT
I discover that we have to put take ids

      if ultraschall.IsValidFXStateChunk(FXStateChunk) then
        take_id = reaper.GetMediaItemInfo_Value( item, "I_CURTAKE" )
        retval, StateChunk = reaper.GetItemStateChunk( item, '', false )
        retval, alteredStateChunk = ultraschall.SetFXStateChunk(StateChunk, FXStateChunk)
        reaper.SetItemStateChunk( item, alteredStateChunk, true, take_id  )
      end

In this case, no crash, bu it still don't work.

[X-Raym]

boolean retval, optional string alteredStateChunk = ultraschall.SetFXStateChunk(string StateChunk, string FXStateChunk)

Just discover that this definition lacks the optional ID parameter :P

[Meo-Ada Mespotine]

Thanks, I'll look into it.

Looks like it's time for Hotfix 2

It's all probably oversights on my side, as fas as I see.

[X-Raym]

@mespotine
Ok many thanks !



I edit my post on https://forum.cockos.com/showpost.ph...&postcount=369


with code with and without take ID.


With take ID it doesnt break but it still don't work. The reutrned alteredStateChunk is nil.

[Meo-Ada Mespotine]

Yeah, it's time, I take on the take-management to take it to new heights.

[X-Raym]

Ok then I pause my script for now,


waiting for your magic :P


Good luck !

[Meo-Ada Mespotine]

Thank you for your detailed bugreports. This may help me getting my head around that more quickly, especially with my limited time right now(we're working on our next Ultraschall4-Extension release so API-development is very limited currently).

[Meo-Ada Mespotine]

@XRaym

I fixed all the bugs for the next version of the API, but I couldn't really get the problem you have with FXStateChunks.
Can you give me two FXStateChunks, the original one and the one after insertion of the new FX?
With thatm I could work with the actual material for debugging.

One more thing: Currently there's no function for inserting, removing and counting FX in FXStateChunks, so SetFXStateChunk only supports setting already existing FXses.
Maybe this is the confusion(and I reworked the docs to clear up this confusion a bit).

Also means: I'll add the missing functions in the next update.


BTW: Did I understand correctly, that you're working on the first official US-API-requiring script?

[X-Raym]

@mespotine
Thx for your work !

Can you give me two FXStateChunks, the original one and the one after insertion of the new FX?

FX chunk are just one coming from FXchain file. No matter which one. You can try with any of your

[X-Raym]

BTW: Did I understand correctly, that you're working on the first official US-API-requiring script?

What do you mean ? There are various scripts which uses ultraschall API already !

[Meo-Ada Mespotine]

Oh, didn't know that
How can I find them. Via ReaPack?
One thing still missing, that I should write a small code-snippet for insertion into such a script, that gives feedback to the user, if Ultraschall-API is not installed.
ToDoList.



In regards of FXStateChunk, I need yours, as mine may not have the problems yours have, so I may not be able to reproduce the buggy behavior.
At least, I tried yesterday to no avail.

[Lokasenna]

Originally Posted by mespotine

Oh, didn't know that
How can I find them. Via ReaPack?
One thing still missing, that I should write a small code-snippet for insertion into such a script, that gives feedback to the user, if Ultraschall-API is not installed.

Try:

local UltraSchall, err = loadfile(reaper.GetResourcePath().."/UserPlugins/ultraschall_api.lua")
if err then reaper.MB("Couldn't load Ultraschall:\n\n"..err, 0); return; end
UltraSchall()

For performance you'd be better off having US return itself so it can be stored in a local variable rather than a global. The difference can be significant for scripts accessing it frequently.

[Meo-Ada Mespotine]

Thanks, will try that.

Everything that makes the stuff faster is appreciated

[X-Raym]

this how I put the dependency in my scripts

dofile(reaper.GetResourcePath().."/UserPlugins/ultraschall_api.lua")

if not (ultraschall and ultraschall.CopyMediaItemToDestinationTrack and ultraschall.AddItemSpectralEdit) then
  reaper.ShowConsoleMsg("Please Install Ultraschall API via Reapack\nhttps://raw.githubusercontent.com/Ultraschall/ultraschall-lua-api-for-reaper/master/ultraschall_api_index.xml")
  return false
end

Advantages :

• Users have full detailed about the missing stuffs and how to install them
• it is in console so they can copy the link easily
• it does check for the necessary functions used in the script

I'll have to compare with lokasenna method though for the "local" improvements.

---
Not all ultraschall scripts are shared publicly, especially because it allows complex functions so it is used for very specific workflow which are not always shared, but for those which are just CTRL+SHIFT+F in a code editor (usually, search in content of all files) in the REAPER / Scripts folder and search for ultraschall. You will have all scripts with used it :P


But I have to admit that I have more ultraschall scripts in my private repo and test files than shared publicly !


Anyway, your API is useful ! I'm not the only one who have commented this thread so far :P There is various things for which having to code solutions from scratch would have been very tedious (like spectrogram edit).


EDIT: GetProject_Extensions also very useful.

[Meo-Ada Mespotine]

I have noticed, that the Render-preset-functions quit working, due some changes in the way, render-presets are stored since Reaper 6.

I'm on my way of fixing(or better reimplementing) them, but that also means, that the next update will require Reaper 6.02 and later.

So be prepared for that.

[X-Raym]

So be prepared for that.

I was born ready !

[Meo-Ada Mespotine]

4.00 Beta 2.80: - "Starsailor - Four to the Floor"

Note: Ultraschall-API needs now Reaper 6.02 or higher. Please update to Reaper 6. It's worth it!

Has now 1079 functions, with 20 new ones and 23 deprecated ones removed

new in this release:

• Improved Defer Management
  Ultraschall.Defer allows you now to set and get the timer-settings of a given ultraschall.Defer-cycle.
  You can even do this from the outside of the deferred script!
  You can also protect now ultraschall.Defer-cycles from being stopped from the outside.
• Rendering functions
  The RenderPreset-functions do work again, after some changes in the way Reaper stores render-presets since Reaper 6.02.
  They also allow you to use: preset-names with spaces. (I know, this should have been in there from the beginning... )
• GetItem_ClickState
  Is now fully functional. That means, if you call this function in every defer-cycle of a script, you can actually monitor clicked and dragged MediaItems.
  This will open up new ways of editing and item-manipulation, like RippleDrag, etc.
• FXStateChunk
  They can now be counted, added, removed and gotten. Means: I added the missing functions for working with them, so you can fully work with FXStateChunks now.
  XRaym will love that
• GetProjectLength
  unlike Reaper's own API-function GetProjectLength, this one returns the end of the last itemedge, the last regionedge, marker and time-sigmarker
• Easy Clipboarding
  FromClip and ToClip allow you now to get/put strings from/to the clipboard without having to type gazillions of characters.
• GetProject and GetTrackState-functions
  I completely reworked most of them, so they will now return all values, even those, which I haven't put into the docs yet.
  That means, if the devs add new values, you can retrieve them right away, without being dependent on me to add them.
  Will do the same with the Set-functions in the future.

New features in 4.00beta2.80

• Helper functions: FloatCompare - compares two float-numbers, with the a chance to set a precision to compare against(thanks to fernsehmuell)
• Helper functions: FromClip - gets a string from the clipboard
• Helper functions: ToClip - puts a string into the clipboard
• DeferManagement: GetDeferCycleSettings - allows getting mode and timer-settings of running ultraschall.Defer-cycles at runtime and even from the outside of the deferred script
• DeferManagement: SetDeferCycleSettings - allows setting mode and timer-settings of running ultraschall.Defer-cycles at runtime and even from the outside of the deferred script
• FXManagement: CountFXStateChunksInStateChunk - counts the FXStateChunks within a Project-/Track-/ItemStateChunk(requested by XRaym)
• FXManagement: RemoveFXStateChunkFromTrackStateChunk - removes a FXStateChunk from a TrackStateChunk(requested by XRaym)
• FXManagement: RemoveFXStateChunkFromItemStateChunk - removes a certain FXStateChunk from an ItemStateChunk(requested by XRaym)
• MediaItems: GetEndOfItem - returns the endposition of a MediaItem(thanks to fernsehmuell)
• MediaItems: GetAllMediaItemAttributes_Table - returns all attributes of a MediaItem as a handy table(requested by fernsehmuell)
• MediaItems: GetAllSelectedMediaItemsBetween - returns all selected MediaItems between start- and endposition within certain tracks of your choice(requested by fernsehmuell)
• MediaItems: SetAllMediaItemAttributes_Table - sets all attributes of a MediaItems using an attributes table, like the one returned by GetAllMediaItemAttributes_Table(requested by fernsehmuell)
• Reaper Internals: Jumping_FX_Button_in_TCP-demo.zip - demoes, how Set/GetLayout-functions work; includes a demo theme and a script, that influences it, including comments
• Reaper Internals: RenderPreset-Configfile.txt - documentation of the Render-Presets of Reaper
• Reaper Internals: Reaper-ProjectDefault-ConfigSettings.txt - documents all reaper.ini-entries, responsible for default project settings
• Reaper Internals: Reaper-StuffMidiMessage-Codes(engl_shortlist).txt - holds all messages and their meaning for StuffMIDIMessage
• Reaper Internals: StuffMidiMessage-docs.txt - describes the usage of the StuffMIDIMessage-function
• Render Management: GetRender_EmbedStretchMarkers - gets the current state of the "Embed stretch markers/transient guides"-checkbox from the Render to File dialog
• Render Management: SetRender_EmbedStretchMarkers - sets the current state of the "Embed stretch markers/transient guides"-checkbox from the Render to File dialog
• ProjectManagement: GetProjectState_NumbersOnly - returns all numerical values, associated with a certain state
• ProjectManagement: GetProject_PooledEnvAttach - gets the pooled-envattach-state
• ProjectManagement: GetProjectLength - gets the length of the current active project, as well as the position of the last itemedge, regionend, marker, time-sig-marker(requested by rstockm)
• TrackManagement: GetTrackState_NumbersOnly - returns all numerical values, associated with a certain state

Changes from Beta 2.79 to Beta 2.80

• API: deprecated - allows showing a warning message, if a script uses a deprecated function in a script; will be shown only once until Reaper restarts, so scripts are stil useable
• Defer Management: GetDeferIdentifier - removed
• Defer Management: GetDeferRunState - removed Defer01-Defer20 management; threw Lua-error, when passing nonstring as identifier -> fixed
• Defer Management: Defer1 through Defer20 - removed
• Defer Management: Defer - mode and timer can also be set now from the outside of the defer-cycle; can now be protected from stopping it from the outside; couldn't be stopped from the outside when mode~=2 -> fixed
• Defer Management: GetDeferRunState - was missing parameters in the docs due typo -> fixed
• Defer Management: StopDeferCycle - didn't work, when mode=2 of a ultraschall.Defer-cycle -> fixed
• Docs: DeferScripts_004_Working_with_Defer_Identifiers - removed
• Docs: Defer - reworked docs and removed all references to Defer1 through Defer20
• Docs: JS-Extension - updated to 0.998
• Docs: Reaper - updated to Reaper 6.03
• Docs: render-codes-decoded-base64-strings.txt - removed last 00-byte in every string(except DDP), as it was wrongly there
• Event Manager: Eventmanager_RemoveEvent - couldn't be found due typo in new module-loader -> fixed (thanks to rstockm)
• Event Manager: EventManager_RemoveAllEvents_Script - couldn't be found due typo in new module-loader -> fixed
• Helper functions: Base64_Decoder - removed small bug, which added a nullbyte at end of strings
• MediaItems: GetSelectedMediaItemsAtPosition - sped up a little; returns now a MediaItemStateChunkArray as well
• ProjectManagement: GetProject_AddMediaToProjectAfterRender - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_AutoCrossFade - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_CursorPos - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_DefPitchMode - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_EnvAttach - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_Feedback - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_GlobalAuto - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_Grid - simplified implementation, future values added by Reaper-devs will now be returned properly

[Meo-Ada Mespotine]

• ProjectManagement: GetProject_GroupDisabled - simplified implementation, future values added by Reaper-devs will now be returned properly; didn't return anything, when no groups were disabled -> fixed
• ProjectManagement: GetProject_GroupOverride - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_HorizontalZoom - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_ItemMixBehavior - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_Lock - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_Loop - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_LoopGran - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterAutomode - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterFXByp - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterMuteSolo - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterNChans - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterPanMode - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterSel - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterTrackColor - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterTrackHeight - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterTrackView - didn't return the new values added in recent Reaper-versions -> fixed and stabilized
• ProjectManagement: GetProject_MasterTrackView - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterVolume - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MasterWidth - simplified implementation, future values added by Reaper-devs will now be returned properly; didn't return 1 in case of +100 width -> fixed
• ProjectManagement: GetProject_MaxProjectLength - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_MixerUIFlags - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_PanLaw - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_PanMode - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_PeakGain - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_Playrate - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_ProjOffsets - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_RecMode - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_RenderDitherState - simplified implementation, future values added by Reaper-devs will now be returned properly; updated docs with new options like embed stretch markers
• ProjectManagement: GetProject_RenderFreqNChans - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_RenderRange - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_RenderResample - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_RenderSpeed - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_RenderStems - simplified implementation, future values added by Reaper-devs will now be returned properly; updated docs with new rendering selected tracks/media through master-options
• ProjectManagement: GetProject_RippleState - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_SMPTESync - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_SampleRate - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_Selection - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_TakeLane - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_Tempo - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_TempoTimeSignature - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_TimeBase - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_Timemode - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_TrackMixingDepth - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_UseRecConfig - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_VerticalZoom - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: GetProject_VideoConfig - simplified implementation, future values added by Reaper-devs will now be returned properly
• ProjectManagement: SetProject_RenderDitherState - updated docs with new options like embed stretch markers
• ProjectManagement: SetProject_RenderStems - updated docs with new rendering selected tracks/media through master-options
• Reaper Internals: render-codes-decoded-base64-strings.txt - added new settings for AIFF
• Render Management: AddRenderPreset - supports now embed stretch markers-checkbox; works only with render-presets as of Reaper 6; supports now presetnames with spaces in it
• Render Management: ApplyRenderTable_Project - supports now embed stretch markers-checkbox as of Reaper 6
• Render Management: ApplyRenderTable_ProjectFile - supports now embed stretch markers-checkbox as of Reaper 6
• Render Management: CreateRenderCFG_AIFF - added Embed Beat Length-checkbox, as included with Reaper 6
• Render Management: CreateNewRenderTable - added new "Embed stretch markers/transient guides"-settings as of Reaper 6; CloseAfterRender wasn't accepted as boolean -> fixed
• Render Management: GetRenderCFG_Settings_AIFF - returns Embed Beat Length-checkbox, as included with Reaper 6
• Render Management: GetRenderPreset_Names - reimplemented; supports now presetnames with spaces in them as well
• Render Management: GetRenderTable_Project - supports now "Embed stretch markers/transient guides"-settings as of Reaper 6
• Render Management: GetRenderTable_ProjectFile - supports now "Embed stretch markers/transient guides"-settings as of Reaper 6
• Render Management: GetRenderPreset_RenderTable - reimplemented due changed reaper-render.ini-format in Reaper 6, should be more stable now; backwards compatible to old Reaper 5 presets
• Render Management: DeleteRenderPreset_Bounds - supports now presetnames with spaces in it
• Render Management: DeleteRenderPreset_FormatOptions - supports now presetnames with spaces in it
• Render Management: IsValidRenderTable - checks now as well new "Embed stretch markers/transient guides"-settings as of Reaper 6
• Render Management: RenderProject_RenderTable - supports now new Embed stretch markers/transient guides-checkbox as of Reaper 6
• Render Management: SetRenderPreset - supports now new Embed stretch markers/transient guides-checkbox as of Reaper 6; supports now spaces in preset-names as well
• TakeManagement: GetFXStateChunk - parameter TakeFXChain_id wasn't optional due typo -> fixed(thanks to XRaym)
• TakeManagement: SetFXStateChunk - docs were unclear, that only setting NOT inserting is possible; could crash, if no FXStateChunk for setting could be found -> fixed(thanks to XRaym)

[Meo-Ada Mespotine]

• TrackManagement: GetTrackPeakColorState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackBeatState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackAutoRecArmState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackMuteSoloState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackIPhaseState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackIsBusState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackBusCompState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackShowInMixState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackFreeModeState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackRecState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackVUState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackHeightState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackINQState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackNChansState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackBypFXState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackPerfState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackMIDIOutState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackMainSendState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackLockState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackAutomodeState - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackMidiCTL - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackWidth - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackPanMode - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackScore - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• TrackManagement: GetTrackVolPan - improved implementation, it returns now new values as well, who are added by the Reaper-devs and aren't documented yet
• User Interface: GetReaperWindowPosition_Left - removed
• User Interface: GetReaperWindowPosition_Right - removed
• User Interface: GetItem_ClickState - remembers now the dragged item+take, even if mouse-cursor is not above it anymore

Please update your ReaPacks: https://github.com/Ultraschall/ultra..._api_index.xml

[Meo-Ada Mespotine]

Please test the new Render-Preset-functions. I had to completely reimplement them, as Reaper 6 changed the way the reaper-render.ini works.

I did as good as I could, and I tried to make GetRenderPreset_RenderTable backwards compatible, so you can still read the render-presets stored with Reaper 5.
https://mespotin.uber.space/Ultrasch...et_RenderTable

I hope I managed to pull it off, but I fear, I missed some edge-cases as they were quite complicated to rewrite.
So if you could test them and find all bugs I missed, it would be awesome.

[X-Raym]

• XRaym will love that

Indeed ! Thx


Small question though,


do I need to take care of every line indentation or is your function agnostic to this ?


Cause I want to use FXchain file, and I want and to know if I have to indent every line when parsing the file.


(I notice that I also have to add

FXStateChunk = "<TAKEFX\n" .. FXStateChunk .. ">"

so fxchainf ile content pass

 ultraschall.IsValidFXStateChunk(FXStateChunk)

• GetProjectLength
  unlike Reaper's own API-function GetProjectLength, this one returns the end of the last itemedge, the last regionedge, marker and time-sigmarker

I don't need it right now, but just to be sure, have you take care of last envelope points ? :P
Also, what about =START =END marker ? Is it taken into account, as it would be expcted ?


Thanks for your support !

[X-Raym]

I don't succeed to use the Set FX chain chunk function, even with plain strings;


Can you show an exemple of the format expected by this function ?


Thx :P

[X-Raym]

      FXStateChunk = "<TAKEFX\n" .. FXStateChunk .. ">"
      if ultraschall.IsValidFXStateChunk(FXStateChunk) then
        Msg("FX Valid")
        retval, StateChunk = reaper.GetItemStateChunk( item, '', false )
        Msg(StateChunk)
        --retval = xpcall(  ultraschall.SetFXStateChunk, Msg, StateChunk, FXStateChunk )
        --Msg(retval)
        take_id = reaper.GetMediaItemInfo_Value( item, "I_CURTAKE" )
        retval, alteredStateChunk = ultraschall.SetFXStateChunk(StateChunk, FXStateChunk, take_id)
        Msg(retval)
        reaper.SetItemStateChunk( item, alteredStateChunk, true )
      end
    end

Here is my code (I use the function with Take FX)

[Meo-Ada Mespotine]

1) You get the MediaItemStateChunk
2) You get the right FXStateChunk(every take has its own FXStateChunk) from that MediaItemStateChunk
3) You modify that FXStateChunk
4) You set THE SAME FXStateChunk into the same Take, by using the same take_id you used in step 2
5) You set the MediaItemStateChunk to the MediaItem.

Be aware, that set does not add FXStateChunks, so you may need to insert one first.
Don't remember right now, but I think, that Takes may have no FXStateChunk at all, if it hasn't been added yet.


And while I was writing this, I think, I should doublecheck exactly that, so I can don't just return all existing FXStateChunk, but also, if a certain take hasn't got one.
Otherwise, take_id would not be take_id but rather FXStateChunk_id, which would be confusing.



GetProjectLength doesn't(yet) take envelope-points into account. I may add that at a later date, but I need to find a way to make that efficient.

[Meo-Ada Mespotine]

Can you post me, how you get the contents of the variable FXStateChunk in your examplecode?

[Meo-Ada Mespotine]

Hotfix1 - 23rd of January 2020

Changes:
- FXManagement: GetFXStateChunk - counted FXStateChunks, not Takes by parameter TakeFXChain_id -> fixed(thanks to XRaym)
- FXManagement: RemoveFXStateChunkFromItemStateChunk - counted FXStateChunks, not Takes by parameter take_id -> fixed(thanks to XRaym)
- FXManagement: SetFXStateChunk - counted FXStateChunks, not Takes by parameter TakeFXChain_id -> fixed(thanks to XRaym)

Please update your ReaPacks.

[Meo-Ada Mespotine]

@XRaym

I've debugged the functions one more time. However, I think, that the script you've sent me has issues on the general understanding of how FXChains work, as one loop expects FXChains in its condition, though you get the FXChain within that loop, not before.

Long story short, I wrote a basic demo-script, on how to work with them, so you can get a better idea on that:

dofile(reaper.GetResourcePath().."/UserPlugins/ultraschall_api.lua")

-- Examplecode on how to toggle bypass with FXStateChunks in TakeFX by Meo Mespotine 23rd of January 2020
    bypasstoggle=1 -- set it to 1 to bypass, set it to 0 to unbypass FX of Takes


-- the following order is essential. If you leave out one of them or mix them up...you're out of luck

-- first, you need get the StateChunk
    MediaItem          = reaper.GetMediaItem(0, 0)
    B0, ItemStateChunk = reaper.GetItemStateChunk(MediaItem, "", false)

-- get the FXStateChunk. Before that, you cannot do anything with the FXStateChunks!
    FXStateChunk       = ultraschall.GetFXStateChunk(ItemStateChunk, 1)

-- let's manipulate it to make all FX bypassed
    FXStateChunk       = string.gsub(FXStateChunk, "BYPASS.-\n", "BYPASS "..bypasstoggle.." 0 0\n")

-- after the FXStateChunk is manipulated, you can set it back into the ItemStateChunk
    C, ItemStateChunk  = ultraschall.SetFXStateChunk(ItemStateChunk, FXStateChunk, 1)

-- now you can set the statechunk into the MediaItem again
    Result             = reaper.SetItemStateChunk(MediaItem, ItemStateChunk, false)


-- update Arrangeview, so any changes in MediaItem-takes are shown
    reaper.UpdateArrange()

This should help you getting your script right, I hope.

[X-Raym]

@mespotine
Thanks for your investigation !


Though, I don't see any difference with my code (a part that my FX chain is made in a diff

I'm sorry but I'm surely missing something obvious I just don't get it.


If you can try to see on my script directly this would help a lot. :S


I checked the version with the GetApiVersion function and it is the last one. (4.00Beta 2.80 - "Starsailor - Four to the Floor")

[Meo-Ada Mespotine]

Look at line 78, which is the line that I don't get.

To me, this looks like you try to get the FXStateChunk in it BUT the earliest is the commented line 80, which would return the FXStateChunk into the variable retval, not the variable FXStateChunk.

That means, whatever you have in the variable FXStateChunk within that loop, it's not a FXStateChunk in the first place.
That's why adding "<TAKEFX\n" is making it somewhat valid. You try to make something, that isn't a FXStateChunk into one by patching it together with that string.

It's like writing Bible on the cover of the telephone-book. It may look like a bible but is still a telephone-book instead.

This is maybe the bug in there, maybe not.

With my testproject, I didn't have anything in FXStateChunk at all, but I could have used the script wrong.

[X-Raym]

That means, whatever you have in the variable FXStateChunk within that loop, it's not a FXStateChunk in the first place.

In is indeed not a FXStateChunk... it is a FXChain file content... which are somehow dumped files of FxStateChunk (without first line of chunk), so I expect it to work :P


To continue your metaphor, it is like my telephone book is in fact the bible in the inside, not random phone numbers.



Have you tried with FXChain Files content ?

[Meo-Ada Mespotine]

No, I haven't yet.

How can I create one? Just exporting an FXChain in the FXChain-dialog? Never used that feature before...

[X-Raym]

There is many of them avaible for free on stash :P https://stash.reaper.fm/v/35108/TiltEQtest.RfxChain


To create them manually, just right click on FX chain of the track and item > FX CHAIN and then SAVE. it will be saved in user resource / FXchains file with .fxchain extension (if I'm correct).

[Meo-Ada Mespotine]

Ok, I'll look at it and hope, it's not yet another way of storing FXStateChunks that I have to take care of... :/

[Meo-Ada Mespotine]

@XRaym
Ok, the next version of the API will feature functions to read RFXChain-files and return their contents as Track-FXStateChunk or Take-FXStateChunk.
You will also be able to save FXChains as RFXChain-files so exporting the stuff will be possible as well.

RFXChain-files are basically the contents of a FXStateChunk but do not contain the beginning <TRACKFX or <FXCHAIN Tags and the >-endtag.

There seem to be some more minor details, but I think, this makes no difference in the end.