mozaic_tips_and_tricks

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
mozaic_tips_and_tricks [2020/01/12 21:16] – [Store two positive Values into a single Variable] Fixed typo _kimozaic_tips_and_tricks [2024/04/23 19:07] (current) – Fixed depricated html snippets into WRAP _ki
Line 1: Line 1:
 ====== Mozaic: Scripting Tips & Tricks ====== ====== Mozaic: Scripting Tips & Tricks ======
 +~~NOTOC~~ {{tag>Mozaic midi_scripting tips_and_tricks}}
  
 This wiki page contains programming tips & tricks for [[mozaic_plugin_engine|Mozaic]] This wiki page contains programming tips & tricks for [[mozaic_plugin_engine|Mozaic]]
  
 +  * [[#NoteOn Velocity 0 Special Case]]
 +  * [[#Two dimensional Arrays]]
 +  * [[#Multi dimensional Arrays]]
 +  * [[#Store two positive Values into a single Variable]]
 +  * [[#Store three unsigned Bytes into a single Variable]]
 +  * [[#Output Fixed Point Values in Labels]]
 +  * [[#Some Best Practice Tips]]
 +  * [[#About State-Saving]]
 +  * [[#Detect Long or Short Pad Taps]]
 +  * [[#Detect Long or Short SHIFT Button Taps]]
 +  * [[#Multi-Line Pad Labels]]
 +  * [[#Dynamic Letters for Labeling]]
 +  * [[#Use the SHIFT Button to toggle to HELP View]]
 +  * [[#Use a Knob to toggle 16 Pads View to HELP View]]
 +  * [[#Knob double-tap Support]]
 +  * [[#Remove or add an entry inside an array]]
 +  * [[#Using Logic Operators in Expressions instead of IF cases]]
 +  * [[#Using Inc and Dec in Expressions]]
 +  * [[#Calculate Standard Chords from a Root Note]]
 +  * [[#Include Snippets]]
 +
 +===== NoteOn Velocity 0 Special Case=====
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP>
 +
 +The Midi Spec allows to use a NoteOn command with velocity zero instead of a NoteOff command. If this combination is received by Mozaic, this midi command is automatically converted to 
NoteOff vel 0 - even for the @OnMidiInput event and when checking MidiByte1. 
 +
 +Therefore scripts don‘t need to check for this ‚NoteOn Vel 0‘ case, as that special case is handled by Mozaic. Even when using MidiThrough, an incomming ‚NoteOn Vel 0‘ command will be converted to ‚NoteOff Vel 0‘
  
-  * [[mozaic_tips_and_tricks#Two dimensional Arrays]] 
-  * [[mozaic_tips_and_tricks#Multi dimensional Arrays]] 
-  * [[mozaic_tips_and_tricks#Store two positive Values into a single Variable]] 
-  * [[mozaic_tips_and_tricks#Store three unsigned Bytes into a single Variable]] 
-  * [[mozaic_tips_and_tricks#Some Best Practice Tips]] 
-  * [[mozaic_tips_and_tricks#Multi-Line Pad Labels]] 
-  * [[mozaic_tips_and_tricks#Use the SHIFT Button to toggle to HELP View]] 
-  * [[mozaic_tips_and_tricks#Use a Knob to toggle 16 Pads View to HELP View]] 
  
 ===== Two dimensional Arrays ===== ===== Two dimensional Arrays =====
-<html><p align = "right"><small><i>From -ki</i></small></p></html>+<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 Each variable in Mozaic is in fact an array with a maximum of 1024 elements. Scripting often needs two dimensional arrays, but the variables only offer one dimensional access. Each variable in Mozaic is in fact an array with a maximum of 1024 elements. Scripting often needs two dimensional arrays, but the variables only offer one dimensional access.
  
Line 54: Line 75:
  
 ===== Multi dimensional Arrays ===== ===== Multi dimensional Arrays =====
-<html><p align = "right"><small><i>From -ki</i></small></p></html>+<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP>
  
 The above folding can be expanded to multiple dimension, here an example for a 3 dimensional array folded into one dimensions: The above folding can be expanded to multiple dimension, here an example for a 3 dimensional array folded into one dimensions:
Line 65: Line 86:
  
 ===== Store two positive Values into a single Variable ===== ===== Store two positive Values into a single Variable =====
-<html><p align = "right"><small><i>From -ki</i></small></p></html>+<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 It is possible to store two positive values in a single variable if their product is less than 16.777.216 It is possible to store two positive values in a single variable if their product is less than 16.777.216
 and they both have a known maximum value. and they both have a known maximum value.
  
 <code> <code>
-  maxB = 1000  // Maximum value for B plus one +  maxA = 1000  // Maximum value for A plus one 
-  valA = 723   // allowed range 0 .. ~16000 +  valA = 723   // allowed range 0 .. 999 
-  varB = 124   // allowed range 0 .. 999+  varB = 124   // allowed range 0 .. ~16000
      
-  combinedValue = valA * maxB + valB+  combinedValue = valA + (valB * maxA) 
 </code>  </code> 
 +
 +For single-byte MIDI values, use 128 for maxA
  
 To later extract the values from their packed format use To later extract the values from their packed format use
 <code> <code>
-  valA = RoundDown combinedValue / maxB +  valA = combinedValue % maxA 
-  valB = combinedValue % maxB+  valB = Div combinedValue, maxA
 </code> </code>
 \\  \\ 
  
 ===== Store three unsigned Bytes into a single Variable ===== ===== Store three unsigned Bytes into a single Variable =====
-<html><p align = "right"><small><i>From <a href="https://forum.audiob.us/discussion/comment/724913/#Comment_724913">espiegel123 @ Audiobus Forum </a></i></small></p></html>+<WRAP group><WRAP right><sup> From [[https://forum.audiob.us/discussion/comment/724913/#Comment_724913| 
 +Comment of espiegel123 @ Audiobus Forum]]</sup></WRAP></WRAP>
  
 Storing of 3 unsigned bytes (J,K & L, each with the range of 0-255) into a single 24bit integer can be done by using the packing formular: Storing of 3 unsigned bytes (J,K & L, each with the range of 0-255) into a single 24bit integer can be done by using the packing formular:
Line 110: Line 135:
 </code> </code>
  
 +
 +\\ 
 +===== Output Fixed Point Values in Labels =====
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP>
 +
 +When outputting floating point values into labels (knobs, pads, titles) Moazic generates either a 4 digit fraction string 
 +like 42.5000 (if a remainder present) or an integer value without fraction.
 +
 +\\ 
 +To always output a positive float with two digits (even when integer), one needs to split the input value and output the computed integer parts individually:
 +<code>
 +  n = Round value * 100
 +  f = Div n, 100
 +  d = n-f*100
 +  r1 = Div d, 10
 +  r2 = d % 10
 +  LabelKnob 0, {B:},f,{.},r1,r2
 +</code>
 +
 +\\ 
 +To always output a negative and positive float with a single digit, the split needs to work on the absolute value
 +and a conditional statement is used to output both variants:
 +<code>
 +  n = Round Abs(value * 10)
 +  f = Div n, 10
 +  r = (n-f*10) % 10
 +  if value >=0
 +    LabelKnob 1, {N: +},f,{.},r
 +  else
 +    LabelKnob 1, {N: },f,{.},r
 +  endif
 +</code>
  
 \\  \\ 
 ===== Some Best Practice Tips ===== ===== Some Best Practice Tips =====
-<html><p align = "right"><small><i>From -ki</i></small></p></html>+<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
   * Its helpfull to add the version number right into the title label. \\ And also add this version number to the script title and patchname if uploaded / updated on [[https://patchstorage.com/platform/mozaic/|PatchStorage]] so that script-users can notice the version change.   * Its helpfull to add the version number right into the title label. \\ And also add this version number to the script title and patchname if uploaded / updated on [[https://patchstorage.com/platform/mozaic/|PatchStorage]] so that script-users can notice the version change.
   * Add a short name to set the icon name. This helps when a project contains multiple Mozaic instances with different scripts   * Add a short name to set the icon name. This helps when a project contains multiple Mozaic instances with different scripts
Line 137: Line 195:
 @End @End
 </code> </code>
 +
 +\\ 
 +===== About State-Saving =====
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP>
 +
 +All assigned variables of a script are automatically included in a saved preset and restored when reloading. To not overwrite them, use the 
 +<code>
 +  if Unassigned channel
 +    channel = 10
 +    bank = 1
 +    ....
 +  endif
 +</code>
 +construct in the scripts **OnLoad** that only set the default value if a script is freshly run using ‚Upload‘. If reloaded (and therefor some value is already assigned to ‚channel‘ ) the initialization block is skipped.
 +
 +
 +Mozaic stores some more more information in the presets/session and restores them when reloading:
 +  * Layout
 +  * Pad labels, color, latch-state
 +  * Knob labels and position
 +  * XY position
 +  * Title label above pads, knobs, XY
 +  * Rootnote and scale
 +
 +Things **not** restored during session reload:
 +  * ShortName
 +  * Timer state and settings
 +  * LFO settings
  
 +
 +\\ 
 +===== Detect Long or Short Pad Taps =====
 +<WRAP group><WRAP right><sup>From wim</sup></WRAP></WRAP>
 +
 +<code>
 +@OnLoad
 +  FillArray downStart,0,16
 +  pressTime = 250
 +@End
 +
 +@OnPadDown
 +  downStart[LastPad] = SystemTime
 +@End
 +
 +@OnPadUp
 +  pad = LastPad
 +  if SystemTime - downStart[pad] < pressTime
 +    Log {Short tap pad }, pad
 +  else
 +    Log {Long tap pad }, pad
 +  endif
 +@End
 +</code>
 +
 +\\ 
 +
 +===== Detect Long or Short SHIFT Button Taps =====
 +<WRAP group><WRAP right><sup>From wim</sup></WRAP></WRAP>
 +
 +<code>
 +@OnLoad
 +  shiftStart = 0
 +  pressTime  = 250
 +@End
 +
 +@OnShiftDown
 +  shiftStart = SystemTime
 +@End
 +
 +@OnShiftUp
 +  if SystemTime - shiftStart < pressTime
 +    Log {Short tap SHIFT}
 +  else
 +    Log {Long  tap SHIFT}
 +  endif
 +@End
 +</code>
  
 \\  \\ 
 ===== Multi-Line Pad Labels ===== ===== Multi-Line Pad Labels =====
-<html><p align = "right"><small><i>From -ki</i></small></p></html>+<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 You can force multiline pad labels by adding space-filled substrings.  You can force multiline pad labels by adding space-filled substrings. 
   * There must be enough spaces to fill the rest of the current line   * There must be enough spaces to fill the rest of the current line
Line 151: Line 286:
   LabelPad 0,{Line 1},{                     },{Line 2}   LabelPad 0,{Line 1},{                     },{Line 2}
   LabelPad 1,{Upper},{ -------------- },{Lower}   LabelPad 1,{Upper},{ -------------- },{Lower}
 +@End
 +</code>
 +
 +\\ 
 +===== Dynamic Letters for Labeling =====
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP>
 +
 +The NoteName function of Moazic can be used to dynamically output the letters A-G inside the label string definitions of Knobs, Pads or Logs. This allows to construct labels like ‚Bank A‘ to ‚Bank D‘, or ‚Preset A-1‘ to ‚Preset F-8‘.
 +
 +<code>
 +@OnLoad
 +  ShowLayout 2
 +  ABCDEFG   = [9,11,0,2,4,5,7]
 +
 +  for i = 0 to 15
 +    row = 1 + (i>7)
 +    id  = i%8
 +    if (id < 7)
 +      LabelPad i, {Pad },(NoteName ABCDEFG[id],NO),{     },{Row },row
 +    endif
 +  endfor
 @End @End
 </code> </code>
Line 156: Line 312:
 \\  \\ 
 ===== Use the SHIFT Button to toggle to HELP View ===== ===== Use the SHIFT Button to toggle to HELP View =====
-<html><p align = "right"><small><i>From -ki</i></small></p></html>+<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 <code> <code>
 @Description @Description
Line 190: Line 347:
 \\  \\ 
 ===== Use a Knob to toggle 16 Pads View to HELP View =====  ===== Use a Knob to toggle 16 Pads View to HELP View ===== 
-<html><p align = "right"><small><i>From -ki</i></small></p></html>+<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP>
  
 This script snippet is only applicable for the 16 pads layout (2) as this the only layout where the knobs 0-3 are at the same screen position as on the HELP page. This script snippet is only applicable for the 16 pads layout (2) as this the only layout where the knobs 0-3 are at the same screen position as on the HELP page.
Line 212: Line 369:
 @End @End
 </code> </code>
-{{tag>Mozaic midi_scripting}}+ 
 +\\  
 +===== Knob double-tap Support =====  
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 + 
 +The value returned from //**GetKnobValue**// is a floating point number, usually it will contain non-zero decimal places when the knob is turned manually. If double tapped the knob-value is set to 64 exactly.  
 +This tip exploits the fact, that is very unlikely to manually dial in exactly 64.0000 - if such a knob value is returned, then the knob has probably been double-tapped. 
 + 
 + 
 +If a knob is only used to toggle between two states like a switch (like the variable //isOn// in the example), the code for double-tap detection would look like: 
 +<code> 
 +@OnKnobChange 
 +  _knob = LastKnob 
 +  _val  = GetKnobValue _knob 
 +   
 +  if _knob = TOGGLE_KNOB 
 +    if _val = 64 
 +      isOn = not isOn 
 +      SetKnobValue TOGGLE_KNOB,48 + 32*isOn 
 +    else 
 +      isOn = _val > 64   
 +    endif 
 +     
 +    if isOn 
 +      LabelKnob TOGGLE_KNOB,  {ON} 
 +    else 
 +      LabelKnob TOGGLE_KNOB,  {OFF} 
 +    endif 
 +  endif 
 +@End 
 + 
 +@OnLoad 
 +  ShowLayout 2 
 +  LabelPads {Knob Double-Tap Demo } 
 +  LabelKnobs {Toggle with Double-Tap} 
 +  for _knob = 0 to 3 
 +    SetKnobValue _knob,0 
 +    LabelKnob _knob,  { } 
 +  endfor 
 +   
 +  if Unassigned isOn 
 +    isOn = NO   
 +  endif 
 +   
 +  TOGGLE_KNOB = 1 
 +   
 +  SetKnobValue TOGGLE_KNOB,48 + 32*isOn 
 +  if isOn 
 +    LabelKnob TOGGLE_KNOB,  {ON} 
 +  else 
 +    LabelKnob TOGGLE_KNOB,  {OFF} 
 +  endif 
 +@End 
 +</code> 
 +The script snippet also features 
 +  * State saving of the toggle variable isOn 
 +  * Conditional expressions:  
 +    * //48 + 32*isOn// is either 48 or 80 depending on the state of //isOn// 
 +    * //isOn = _val > 64// assigns either 0 or 1 to //isOn// depending on _val 
 + 
 + 
 +\\  
 +=====  Remove or add an entry inside an array =====  
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 + 
 +Instead of running through an array with a FOR loop to shift entries to either insert or remove an  intermedeate enry, it is way faster to use the CopyArray Mozaic function: 
 + 
 +<code> CopyArray source, dest, size</code> 
 + 
 +\\  
 +=== Remove an entry of an array (shift left) === 
 + 
 +<code> 
 +@OnLoad 
 +  for i=0 to 6 
 +    a[i] = i 
 +  endfor 
 +  Log {Before },a[0],{ },a[1],{ },a[2],{ },a[3],{ },a[4],{ },a[5],{ },a[6] 
 + 
 +  // Remove entry a[2] by left shift of the following entries 
 +  CopyArray a[3], a[2], 6 
 +   
 +  Log {After  },a[0],{ },a[1],{ },a[2],{ },a[3],{ },a[4],{ },a[5],{ },a[6] 
 +@End 
 +</code> 
 + 
 +\\  
 +=== Insert an entry into array (shift right) === 
 + 
 +Due to the inner working of CopyArray, the above trick doesn‘t work for right shifts - but one can use a temporary array to be more efficient than iterating over the array: 
 + 
 +<code> 
 +@OnLoad 
 +  for i=0 to 6 
 +    a[i] = i 
 +  endfor 
 +  Log {Before  },a[0],{ },a[1],{ },a[2],{ },a[3],{ },a[4],{ },a[5],{ },a[6] 
 + 
 +  // Insert a new a[2] 
 +  CopyArray a[2], _tmp, 6 
 +  CopyArray _tmp, a[3], 6   
 +  a[2] = 9 
 +   
 +  Log {After   },a[0],{ },a[1],{ },a[2],{ },a[3],{ },a[4],{ },a[5],{ },a[6] 
 +@End 
 +</code> 
 +=====  Using Logic Operators in Expressions instead of IF cases =====  
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 + 
 +Boolean expressions compute to either 1 or 0, which are the internal values for TRUE/FALSE or YES/NO. 
 +Using this behavior in expressions allows to get rid of some IFs, but on the other hand makes the script a bit more complicated to read and understand for novices. 
 + 
 +Instead of the lengthy 
 +<code> 
 +  // showHelp  is a boolean with the values YES/NO or TRUE/FALSE 
 + 
 +  If showHelp 
 +    ShowLayout 4 
 +  Else 
 +    ShowLayout 2 
 +  Endif 
 +</code> 
 + 
 +On can write  
 +<code> 
 +  ShowLayout 2 + 2*showHelp 
 +</code> 
 + 
 +. 
 + 
 +Here second example where in the 22 knob layout the left most 8 knobs of both rows are used as channel knobs for channels 1 to 16. Since there are 11 knobs per row, the channel computed for the lower row needs to be adjusted: 
 +<code> 
 +  chan = LastKnob + 1 
 +  If LastKnob >= 8 
 +    chan = chan - 3 
 +  Endif 
 +</code> 
 + 
 +This can be written shorter as: 
 +<code> 
 +  chan = LastKnob +1 - 3*(LastKnob>=8) 
 +</code> 
 + 
 +\\  
 +===== Using Inc and Dec in Expressions =====  
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 + 
 +TheOriginalPaulB discovered that Inc and Dec are working as functions. Both Inc and Dec are ‚pre-increment‘ operations like ++var  in C, as the function returns the already incremented value. This allows for several interesting language constructs: 
 + 
 +In case of a ring buffer index, one could use 
 +<code> 
 +  index = (Inc index) % 64 
 +</code> 
 +instead of the longer construct 
 + 
 +<code> 
 +  Inc index 
 +  index = index % 64 
 +</code> 
 + 
 +\\  
 +Sometimes this trick is also applicable in array initialization, but one has to compensate for the pre-increment. 
 +<code> 
 +  idx = -1 
 +  for i = 10 to 19 
 +    array[Inc idx] = 2*i 
 +  endfor 
 +</code> 
 +The example fills array[0] to array[9] with the values 20 to 38. To compensate for pre-increment, idx needs to start at -1 since it will be incremented to zero on first usage 
 + 
 +\\  
 +It is also possible to construct a post-increment operation by using the inc in the expression itself, but discarding it using multiplication with 0: 
 + 
 +<code> 
 +  idx = 0 
 +  for i = 10 to 19 
 +    array[idx] = 2*i  + 0*(Inc idx) 
 +  endfor 
 +</code> 
 + 
 +\\  
 +===== Calculate Standard Chords from a Root Note ==== 
 +<WRAP group><WRAP right><sup>From wim</sup></WRAP></WRAP> 
 + 
 +This is a compact way to build standard chords from just a root note. It turns out that for standard western scales such as Major, Minor, Dorian, Phrygian, etc, normal chord notes can be found by starting at the root and counting up in steps of three semitones then quantizing up to the next scale tone. Repeat this for the number of notes you want in the chord (triad (3), seventh (4), ninth (5), eleventh (6), 13th (7). 
 + 
 +Here’s a code snippet that efficiently creates a chord of “notes” degree from an incoming MIDI Note. Code to do something with that array would obviously have to be added. 
 + 
 +<code> 
 +@OnMIDINote 
 +  //set “notes” to the number of notes wanted in the chord before this event triggers! 
 +  chordNotes[0] = ScaleQuantize MIDINote 
 +  for i = 1 to (notes - 1) 
 +    chordNotes[i] = ScaleQuantize chordNotes[i-1] + 3 
 +  endfor 
 +@End 
 +</code> 
 + 
 + 
 +\\  
 +===== Include Snippets ===== 
 +<WRAP group><WRAP right><sup>From -ki</sup></WRAP></WRAP> 
 + 
 +On PatchStorage you can find several 'Include Snippets' that cover specific programming problems and that are intended to be appended your own scipt code. 
 + 
 +The snippets can be seen as 'well tested library functions'. For the current available include snippets, you copy their main code to the end of you script and call one or two initialization event functions in your @OnLoad.  
 +The snippet in turn will later call event that you need to define in your code (callbacks).  
 +All of the current available snippets need a timer event to do their work, the snippets are coded in a way that allows to also to work with a timer event that you defined in your script.  
 + 
 +I tried to make them as 'developer-friendly' as possible and also did extensive testing on each of them. The documentation wiki pages show the snippets source at the bottom since its easier to read on the wiki than inside Mozaic. 
 + 
 +^PatchStorage  ^Wiki ^OnLoad ^Other ^Callbacks ^Info ^ 
 +| [[https://patchstorage.com/pad-manager-include/|Pad & Shift Manager]] | [[mozaic_include_pad_and_shift_manager|Documentation]]| optional vars \\ one call| - | 2 | Detect single-/double-/triple-tap and hold interactions for pads or shift| 
 +| [[https://patchstorage.com/active-notes-tracker/|Active Notes Tracker]] | [[mozaic_include_active_notes_tracker|Documentation]] | optional var \\ one call | note-on / note-off \\ events | - | Manages a list of active notes, velocities and durations for each channel | 
 +| [[https://patchstorage.com/migration-manager-include/|Migration Manager]] | [[mozaic_include_migration_mananger|Documentation]] | two calls| - | 4 | Migrate script parameters between different script versions |
  • mozaic_tips_and_tricks.1578824212.txt.gz
  • Last modified: 2020/01/12 21:16
  • by _ki