X32 Scene Parser
https://sourceforge.net/projects/x32sceneparser/?source=navbar
User Manual
Copyright (C) 2014
Paul Vannatto
Document Version 1.0
December 2014
License
This program is free software: you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
more details.
You should have received a copy of the GNU General Public License along with this
program. If not, see http://www.gnu.org/licenses/
Acknowledgments
Many thanks to the following:
The Behringer Forum members for their many suggestions and encouragement.
It was because of the numerous discussions on the forum that this X32 offline
tool was created and developed.
Patrick-Gilles Maillot for his enormous effort in updating the OSC Remote
Protocol document. Without this document, this app probably would not have
begun.
Music Group for creating the X32 eco-system and opening up the X32 specific
OSC command language so that developers could provide enhancements beyond
the standard capabilities of the X32.
Page 1
X32 Scene Parser User Manual
Purpose
The X32 Scene Parser was designed to use an OSC type (scene, snippet or preset) file
created by the X32, one of its apps, or other tools as a starting point to create a snippet
(or preset) file that makes specific changes to the X32 - no more, no less. This is
accomplished using various filters, text editing functions, and specialized tools
provided by the Scene Parser. It was intended as an offline enhancement tool for the
X32 eco-system, with a specific focus of providing a mechanism to produce fine-tuned
snippets.
WorkFlow
On the Parse screen, an OSC based file (scene, snippet, preset) is selected, filters are
chosen, and import type (Parse, Input, List) selected. The file is then imported and
processed using the selected parameters.
The results are added to the text editor on the Results page. These results can then be
modified/manipulated using standard text editor functions (cut, copy, paste, search,
replace, etc) to fine tune the functionality of the snippet. Other Scene Parser specific
functions, such as macro functions (range replace, copy, delete) can also be used to
further refine the snippet.
As an added bonus, specialized processes (Copy EQ, DCA or Mute Group analysis,
scripting of commands, etc.) have been provided. Other specialized processes will be
added as requested or required.
The final results can then be saved as a snippet or preset files that can then be loaded
into the X32. The resulting X32 change will be what is desired/required - no more, no
less.
Page 2
X32 Scene Parser User Manual
Quick Start
Parsing a file
Import a scene file by either entering the path/filename in the Input File editbox or
click on the file icon (to the right of the editbox) to launch the Open File dialog.
Select the required filters of items that are to be parsed (extracted). For example, if
all channel info for channels 1-16 and the headamps are required, check Ch 1-8, Ch
9-16, Headamps.
Click on the Parse button. This will parse (or extract) the OSC command lines from
the input file and add the results to the editor on the Results screen.
The resulting text are a number of lines of OSC commands, each with various
parameters. These can be modified using standard text editing techniques (cut, copy,
paste, delete, etc.) as well with the Range set of editing features.
The snippet header line (first line in the text) can be changed (such as the title)
When all modifications are complete, the resulting text can be saved as a snippet file,
by entering the Output file path/filename or click on the file icon to launch the Save
File dialog.
Finally, click on the Output button to save the file.
Inputting a file
Import a scene file by either entering the path/filename in the Input File editbox or
click on the file icon (to the right of the editbox) to launch the Open File dialog.
Select Input (to the left of the Parse button). This will tell the Scene Parser to input
the file in its entirety to the editor on the Results screen.
Click on the Input button.
The resulting text are a number of lines of OSC commands, each with various
parameters. These can be modified using standard text editing techniques (cut, copy,
paste, delete, etc.) as well with the Range set of editing features.
The snippet header line (first line in the text) can be changed (such as the title)
When all modifications are complete, the resulting text can be saved as a snippet file,
by entering the Output file path/filename or click on the file icon to launch the Save
File dialog.
Finally, click on the Output button to save the file
Create a I/O list
Import a scene file by either entering the path/filename in the Input File editbox or
click on the file icon (to the right of the editbox) to launch the Open File dialog.
Select List (to the left of the Parse button). This will tell the Scene Parser to create a
list in the editor on the Results screen.
Select the desired I/O filters from the surface inputs and/or Routing sections.
Click on the List button.
The resulting text will be a list of the filters selected
This list can be saved as a text file by entering the Output file path/filename or click
on the file icon to launch the Save File dialog.
Finally, click on the Output button to save the file.
Page 3
X32 Scene Parser User Manual
Copy EQ
Import a scene file by either entering the path/filename in the Input File editbox or
click on the file icon (to the right of the editbox) to launch the Open File dialog.
Click on the Copy EQ button.
Scene Parser will analyze the the scene file and populate the Copy EQ screen with
details of which slot has which graphics EQ.
Choose which slot (and side) to copy values from, then choose which slot (and side)
to copy those values to.
Click on the Transfer button to transfer the values.
Click on the Done button to generate the OSC command lines for the snippet
Entering the Output file path/filename or click on the file icon to launch the Save File
dialog.
Finally, click on the Output button to save the file.
Analyze DCA’s
Import a scene file by either entering the path/filename in the Input File editbox or
click on the file icon (to the right of the editbox) to launch the Open File dialog.
Click on the DCA’s button.
Scene Parser will analyze the the scene file and populate the DCA screen with the
current status of the DCA’s.
The DCA screen displays the current DCA status in a matrix of checkboxes of DCA
and channels. The channels are in 4 banks, similar to the X32.
These assignments can be changed by simply changing the check status. Once all
changes are made, the title determined, which parts to include, a snippet of the
changes can then be created by clicking the Generate OSC.
Analyze Mute Groups
Import a scene file by either entering the path/filename in the Input File editbox or
click on the file icon (to the right of the editbox) to launch the Open File dialog.
Click on the Mute Groups button.
Scene Parser will analyze the the scene file and populate the Mutes screen with the
current status of the Mute Groups.
The Mutes screen displays the current Mute Group status in a matrix of checkboxes
of Mute Groups and channels. The channels are in 4 banks, similar to the X32.
These assignments can be changed by simply changing the check status. Once all
changes are made, the title determined, which parts to include, a snippet of the
changes can then be created by clicking the Generate OSC.
Page 4
X32 Scene Parser User Manual
Range Functions
Once a basic snippet is created in the editor, the resulting OSC commands can then
be fine tuned using standard editor functions (cut, copy, paste, delete, etc.).
It can also be fine tuned using macro functions, such as range replace, copy and
delete (on the Range screen).
For example, changing all channels 3-7 OSC commands to channels 4-7, select the
range replace with the following parameters
- Find Prefix: /ch/
- From: 3
- To: 7
- Suffix: /
- Replace Prefix: /ch/
- Replace From: 4
- Reverse order: checked (since the find and replace ranges overlap)
Click on the Replace button.
Range Scripts
Range functions are a very powerful method of changing snippets on a macro level.
But sometimes certain changes require multiple range changes. Scripts can be created
to automate these range changes.
For example, if channel 17 needs to be moved to channel 5 and all other channels
shifted appropriately, that would require a number of range changes. This would
include:
- Replace /ch/17 to /ch/33 (temp assignment)
- Replace /ch/5 to 16, to /ch/6 (shifting ch 5-16 over one)
- Replace /ch/33 to /ch/5 (moving ch 33 (formerly ch 17) to ch 5)
- SortAll (sort the results)
To make it easier to create script lines, fill in the various range edit values, then click
on the CBE (create by example). Then repeat for each step of the script.
Filter Values
The X32 snippet GUI includes a filter matrix. This is used to create the desired
snippet. Unfortunately, this GUI is limited in scope to what it can create. This is why
the Scene Parser was created.
This filter GUI also provides an indication of what that snippet actually does.
Unfortunately, these filter values are in the form of bitmaps and must be calculated
and the resulting values inserted into the snippet header (first line).
The Filter Values screen provides this functionality. Once the snippet is completed,
the filter values reflecting the functionality of the snippet can be calculated and
inserted into the snippet header. Simply select the various sections that applies to this
snippet, click on the update, review the resulting filte values, then finally click on the
Transfer button to insert these values into the snippet header.
Page 5
X32 Scene Parser User Manual
Screens
Parsing Screen
On the Parse screen, an OSC based file (scene, snippet, preset) is selected, filters are
chosen, and import type (Parse, Input, List) selected. The file is then processed using
these parameters.
Input File: An OSC type file (scene, snippet, preset, etc.) can be selected to be
imported as a starting point of the snippet to be created. The path\filename can be
typed in the editbox or can be selected using the file icon (to the right). This icon
will launch the File Open dialog. Goto the location and select the desired file. If
the file is not a scene file (*.scn), select the file type. Then click on Open.
Select/Clear: This provides the ability of clearing groups of checkboxes.
Input Type: There are 3 types of inputting that can be accomplished
- Parsing analyses the complete input file for items according to the selected filters.
The results are OSC multi-variable commands that are added to the Results editor.
- Input imports the complete file with no parsing done. This can be used with existing
snippet files that simply need some adjustments.
- List limits the parsing to Surface Inputs and Routing and produces a list of these
inputs/outputs in a different form that snippets.
Filter Groups: There are 5 filter groups that are grouped by functionality. They can be
disabled by unchecking the appropriate group header (eg. System Config).
Transfer Header: This should be checked if the input file type is the same as the
output (eg. Snippet). If they are not the same (eg. scene input, snippet output), the
header will be different and should not be transferred.
Page 6
X32 Scene Parser User Manual
Results Screen
The Results screen receives the processing results of other screens (Parse, Range, Copy
EQ, Filter Values, DCA, Mutes). In essence, this is the heart of the Scene Parser.
Toolbar: The standard editor functions (find, replace, cut, copy, paste, select all, undo)
are conveniently located on the toolbar. Standard keyboard shortcuts can also be
used. As well as with the right click popup menu.
- Find/Replace: The Find and Replace editboxes must be completed for this function to
work. Find simply finds the first occurrence from the cursor (or from the beginning
if that is checked) and highlights the results. Replace replaces the first occurrence
found (unless Replace All is checked). There will not be any prompting during the
process. If the results are not as expected, simply undo and try again.
- Range: This simply provides a link to the Range screen, where further processing on a
macro level can be accomplished.
- Clear All: This clears the editor. It can be used if the results are not as expected, some
of the processing resulted in a mess, or a completely different snippet is to be
created.
- Sort All: This sorts the results in the editor in alphabetical order (A - Z).
Title: The snippet title can be changed in the editbox, which automatically changes it on
the header (first line in the editor).
Clear Suffix: This deletes the section to the right of the title in the header.
Output File: The path\filename can be typed in the editbox or can be selected using the
file icon (to the right). This icon will launch the File Save dialog. Nothing is actually
saved until the Output button is selected.
Page 7
X32 Scene Parser User Manual
Range Screen
The Range screen provides functional tools on a macro level. It also provides scripting of
multiple range commands to produce editing results that would normally require multiple
steps.
Reset: This resets the Range Processing section to the default.
Replace/Copy/Delete: This determines the type of range processing.
- Replace: This changes the existing OSC command line found with the Find values to
the Replace values. The Find To and From values determines the range for both Find
and Replace. For example, if the find is from 3-6 and the Replace begins with 5, it
will process through to 8. Leading zero’s will be added when required.
- Copy: This creates a copy of the existings OSC command line found with the Find
values, with the Replace values. The copied lines are added to the end of the editor.
- Delete: This uses the Find values and deletes the found OSC command line(s).
Process in Reverse: If the Find and Replace ranges overlaps, they need to be processed
in reverse. For example if the Find range is 3-6 and Replace range is 5-8, 6 needs to
be replaced (or copied) to 8 first, then 5 to 7, etc. If not all lines will end up with 8.
CBE: Create By Example. Once a range processing values have been verified, they can
be added to the script editor (below). This way a script file can be created to provide
a multiple range process script.
Page 8
X32 Scene Parser User Manual
Range Scripts
Scripts combine numerous range processes in order to process complex changes to the
snippet. Examples are provided in the default.sps file as well as a separate download
(https://sourceforge.net/projects/x32sceneparser/files/?source=navbar).
The easiest way to create script lines is to setup a range process above, then click on CBE
(create by example). This will add the script line with the appropriate parameters.
Script Parameters: Each range process includes various parameters and are identical to
the interface above.
- Replace/Copy: These require 9 parameters identical to the above interface.
- Delete: This requires 5 parameters
- SortAll: This requires no parameters, but is simply a command to resort the results
editor after the script has completed all the changes.
- # (pound): Comments begin with the #.
- * (asterix) can be used as a placeholder, using the appropriate parameter of the previous
script line.
- ! (exclamation) can be used to substitute for a space, since the space is also a separation
character.
- Process in Reverse can be False/True or 0/1
Run Script: This processes the script file and applies the changes to the OSC command
lines in the Results editor.
Load Script: This loads a previously save script file
Save Script: This saves the current script to a file
Clear Script: This clears the script editor
Page 9
X32 Scene Parser User Manual
Copy EQ Screen
The Copy EQ screen provides the ability to copy graphics EQ values from one slot or
side to another. The initial values are populated by clicking on the Copy EQ button on the
Parse screen.
From EQ: Select the slot of the EQ that contains the EQ values that is to be copied. This
will change the side, type and values appropriately. Select the side is there is more
than one.
To EQ: Select the slot of the EQ that the values are to be copied to. This will change the
side, type and values appropriately. Select the side is there is more than one.
Transfer: This will simply transfer the values From EQ -> To EQ.
Done: When everything is as expected, the Done button will create the OSC command
lines with the EQ values and add them to the Results editor.
Page 10
X32 Scene Parser User Manual
Filter Values Screen
The Filter Values screen provides the ability to calculate the filter values indicating the
functionality of the snippet in the X32 snippet GUI. Unfortunately, some snippets created
by the Scene Parser does not have appropriate filter values.
Update: Once the appropriate filters are selected, the Update will update the Snippet
Filter Value. This comprises of 5 numbers of bitmap equivalent of the 4 sections of
the filters. The Parametric, Effects and Console comprise the first section. The last
number is always 1 (not sure why).
Transfer: This transfers the Snippet Filter Values to the Results editor header, to the right
of the title.
Page 11
X32 Scene Parser User Manual
DCA Screen
The DCA screen provides the ability to analyze the DCA assignments and make any
necessary or desired changes. The initial values are populated by clicking on the DCA’s
button on the Parse screen.
DCA/Channel matrix: This provides the ability to analyze the DCA assignments. The
matrix is divided in 4 layers, similar to the X32 left bank of faders. Changes can be
made by checking/unchecking the various checkboxes. As these change, the actual
value will be shown to the right of the Layer radiogroup.
Snippet Title: This provides the ability to change the snippet title.
Include: This provides the ability to choose the sections included in the resulting OSC
commands generated when the Generate OSC button is clicked.
Clear Memo: This clears the Results editor before the OSC command lines are added.
Generate OSC: This generates the OSC command lines with the changes made to the
DCA/Channel matrix and adds the results to the Results editor.
Page 12
X32 Scene Parser User Manual
Mute Group Screen
The Mute Group screen is identical in functionality to the DCA screen. It provides the
ability to analyze the mute group assignments and make any necessary or desired changes.
The initial values are populated by clicking on the Mute Groups button on the Parse
screen.
Mute Group/Channel matrix: This provides the ability to analyze the Mute Group
assignments. The matrix is divided in 4 layers, similar to the X32 left bank of faders.
Changes can be made by checking/unchecking the various checkboxes. As these
change, the actual value will be shown to the right of the Layer radiogroup.
Snippet Title: This provides the ability to change the snippet title.
Include: This provides the ability to choose the sections included in the resulting OSC
commands generated when the Generate OSC button is clicked.
Clear Memo: This clears the Results editor before the OSC command lines are added.
Generate OSC: This generates the OSC command lines with the changes made to the
Mute Group/Channel matrix and adds the results to the Results editor.
Page 13
X32 Scene Parser User Manual
Setup Screen
The Setup screen allows the user to set various defaults.
Directory defaults: The path can be typed in the editbox or can be selected using the file
icon (to the right). This icon will launch the Folder dialog. Select the location and
click on OK.
Script File default: The path\filename can be typed in the editbox or can be selected
using the file icon (to the right). This icon will launch the File Open dialog. Goto the
location and select the desired script file. Then click on Open.
Include in Channel List: This determines what parameters are included in the
channel/output list.
Color buttons: These will launch the color dialog in order to choose the background and
font colors of the various edit fields.
Editor Font Size: The size of the editor text can be established by entering or
increasing/decreasing the value.
Save Defaults: All items on this screen will be saved to the SceneParser.ini file in the
same directory as the app. These values will be loaded on startup.
Reset: This sets all default values back to original values (set by me).
Page 14
X32 Scene Parser User Manual
Glossary
Scenes: a compilation of OSC commands in ASCII format (text file) that captures
almost all functionality of the X32 digital console.
Snippets: a compilation of specific OSC commands in ASCII format that provides
specific functional changes to the X32.
The documentation of this section will be completed shortly.
Page 15
">