Module xNoteColumn
A virtual representation of renoise.NoteColumn.
Unlike the renoise.NoteColumn, this one can be freely defined, without the need to have the line present somewhere in an actual song
You create an instance by feeding it a descriptive table in the constructor. All string-based values are automatically converted into their numeric counterparts.
Functions
| __init (args) | [Constructor] Accepts a table with properties as argument |
| get_note_value () | Get/set methods |
| note_string_to_value (str_val) | Converter methods (static implementation) |
| instr_string_to_value (str) | |
| delay_string_to_value (str) | |
| delay_value_to_string (val) | |
| column_string_to_value (str_val) | convert vol/panning into a numeric value (everything above 0x80 is interpreted as an fx command) |
| column_value_to_string (val) | convert instr/vol/panning into a numeric value |
| convert_fx_to_value (str_val) | convert two-character effect string into a numeric value |
| convert_fx_to_string (val) | convert a numeric value into a two-character effect string |
| do_read (note_col, tokens) | Read method (static implementation) |
| do_write (note_col, tokens, clear_undefined) | Write methods |
Tables
| tokens | table, list of available note-column properties |
| output_tokens | table, properties that can be used when writing to pattern |
| NOTE_ARRAY | table, list of note-names (without the octave part) |
Fields
| EMPTY_NOTE_VALUE | number, representing an empty note |
| EMPTY_NOTE_STRING | string, representing an empty note |
| NOTE_OFF_VALUE | number, representing a note-off |
| NOTE_OFF_STRING | string, representing a note-off |
| EMPTY_VOLUME_VALUE | number, representing an empty column |
| EMPTY_COLUMN_STRING | string, representing an empty column |
| self.instrument_value | instrument_value [number, 0-254, 255==Empty] |
| self.instrument_string | instrument_string [string, '00'-'FE' or '..'] |
| self.volume_value |
volume_value [number, 0-127, 255==Empty when column value is <= 0x80 or is 0xFF, |
| self.volume_string | volume string [string, '00'-'ZF' or '..'] |
| self.panning_value |
panning_value [number, 0-127, 255==Empty when column value is <= 0x80 or is 0xFF, |
| self.panning_string | panning_string [string, '00'-'ZF' or '..'] |
| self.delay_value | delay_value [number, 0-255] |
| self.delay_string | delay_string [string, '00'-'FF' or '..'] |
| self.effect_number_value | effectnumbervalue [number, 0-255] |
| self.effect_number_string | effectnumberstring [string, '00'-'FF' or '..'] |
| self.effect_amount_value | effectamountvalue [number, 0-255] |
| self.effect_amount_string | effectamountstring [string, '00'-'FF' or '..'] |
Functions
- __init (args)
-
[Constructor] Accepts a table with properties as argument
Parameters:
- args (table), descriptor
- get_note_value ()
- Get/set methods
- note_string_to_value (str_val)
-
Converter methods (static implementation) convert note_string into a numeric value
Parameters:
- str_val (string), for example "C#4" or "---"
Returns:
- int (value, xNoteColumn.EMPTYNOTEVALUE when not matched)
- int (key) or nil
- int (octave) or nil
- int (0-255)
- instr_string_to_value (str)
-
Parameters:
- str (string), e.g. ".." or "1F"
Returns:
- int (0-255)
- int (0-255)
- delay_string_to_value (str)
-
Parameters:
- str (string), e.g. ".." or "1F"
Returns:
- int (0-255)
- string
- delay_value_to_string (val)
-
Parameters:
- val (int), between 0-255
Returns:
-
string
- column_string_to_value (str_val)
-
convert vol/panning into a numeric value
(everything above 0x80 is interpreted as an fx command)
Parameters:
- str_val (string), for example "40", "G5" or ".."
Returns:
-
int
- column_value_to_string (val)
-
convert instr/vol/panning into a numeric value
Parameters:
- val (int), 0-127, 255==Empty or 0-65535 when value is > 0x80
Returns:
-
value
- convert_fx_to_value (str_val)
-
convert two-character effect string into a numeric value
Parameters:
- str_val (string), for example "G5"
Returns:
-
value or nil
- convert_fx_to_string (val)
-
convert a numeric value into a two-character effect string
Parameters:
- val (int), for example 4615 ("I7") or 0x80
Returns:
-
string
- do_read (note_col, tokens)
-
Read method (static implementation)
Parameters:
- note_col (renoise.NoteColumn)
- tokens (table), xStreamModel.tokens
Returns:
-
table
- do_write (note_col, tokens, clear_undefined)
-
Write methods
Parameters:
- note_col (renoise.NoteColumn),
- tokens (table), xStreamModel.output_tokens
- clear_undefined (bool) clear existing data when ours is nil
Tables
- tokens
-
table, list of available note-column properties
Fields:
- note_value
- note_string
- instrument_value
- instrument_string
- volume_value
- volume_string
- panning_value
- panning_string
- delay_value
- delay_string
- effect_number_value
- effect_number_string
- effect_amount_value
- effect_amount_string
- output_tokens
-
table, properties that can be used when writing to pattern
Fields:
- note_value
- instrument_value
- volume_value
- panning_value
- delay_value
- effect_number_value
- effect_amount_value
- NOTE_ARRAY
-
table, list of note-names (without the octave part)
Fields:
- C-
- C#
- D-
- D#
- E-
- F-
- F#
- G-
- G#
- A-
- A#
- B-
Fields
- EMPTY_NOTE_VALUE
- number, representing an empty note
- EMPTY_NOTE_STRING
- string, representing an empty note
- NOTE_OFF_VALUE
- number, representing a note-off
- NOTE_OFF_STRING
- string, representing a note-off
- EMPTY_VOLUME_VALUE
- number, representing an empty column
- EMPTY_COLUMN_STRING
- string, representing an empty column
- self.instrument_value
- instrument_value [number, 0-254, 255==Empty]
- self.instrument_string
- instrument_string [string, '00'-'FE' or '..']
- self.volume_value
-
volume_value [number, 0-127, 255==Empty when column value is <= 0x80 or is 0xFF,
i.e. is used to specify volume][number, 0-65535 in the form 0x0000xxyy where
xx=effect char 1 and yy=effect char 2, when column value is > 0x80, is used to specify an effect] - self.volume_string
- volume string [string, '00'-'ZF' or '..']
- self.panning_value
-
panning_value [number, 0-127, 255==Empty when column value is <= 0x80 or is 0xFF,
i.e. is used to specify pan][number, 0-65535 in the form 0x0000xxyy where
xx=effect char 1 and yy=effect char 2, when column value is > 0x80, i.e. is used to specify an effect] - self.panning_string
- panning_string [string, '00'-'ZF' or '..']
- self.delay_value
- delay_value [number, 0-255]
- self.delay_string
- delay_string [string, '00'-'FF' or '..']
- self.effect_number_value
- effectnumbervalue [number, 0-255]
- self.effect_number_string
- effectnumberstring [string, '00'-'FF' or '..']
- self.effect_amount_value
- effectamountvalue [number, 0-255]
- self.effect_amount_string
- effectamountstring [string, '00'-'FF' or '..']