Cwn_to_sig (BandM signal & music)

java.lang.Object
- eu.bandm.music.top.Cwn_to_sig

```
public class Cwn_to_sig
extends Object
```
Creates a simple sig output for one Score_cwn object. Given a file name stem like "XXX" it generates one binary file with name "XXX_VVV.sig" and one logically identical text file "XXX_VVV.sig.text" for each voice named "VVV". If there are more than one "PART" in the original file, the names will be "XXX_PPP_VVV.sig" and "XXX_PPP_VVV.sig.text".
The data is a table = a sequence of tuple, with the following format:
1. float duration, im msec
2. float freqency, in Hz
3. String pitch name
4. int trigger, CHANGES with each new event. A CHANGE in the value lets the ADSR start anew.
5. int gate for the ADSR, going to zero means starting a pause.
6. int metric weight (NOT YET SUPPORTED)
CURRENTLY the .sig file can be played by TestMonodic (cf Score_hkn_sig_v00)

Field Summary

Fields
Modifier and Type	Field and Description
`protected float`	`articulation_minpause_msec` Minimal pause in milliseconds between adjacent events with different pitch.
`protected float`	`articulation_minpause_percent` Minimal pause between adjacent events with different pitch, in percent of the duration of the earlier of both.
`(package private) float`	`currentFreq` Local register to let a PAUSE carry on the frequency of the preceding sound.
`static float`	`default_articulation_minpause_msec` Minimal pause in milliseconds between adjacent events with different pitch.
`static float`	`default_articulation_minpause_percent` Minimal pause between adjacent events with different pitch, in percent of the duration of the earlier of both.
`static float`	`default_repetition_articulation_minpause_msec` Minimal pause in milliseconds between adjacent events with the same pitch.
`static float`	`default_repetition_articulation_minpause_percent` Minimal pause between adjacent events with the same pitch, in percent of the duration of the earlier of both.
`protected int`	`eventNumber` The current event numberwhen the conversion process steps through the score.
`protected String`	`filenamestem` The prefix of the names of the generated files.
`static float`	`FINAL_SILENCE_MSEC` Length of a pause appended to each score.
`protected String`	`generationDate` Calendaric date of generation, to be integrated into comment.
`static float`	`HALFTONE` Frequency factor of a halftone in equal distance tempered tuning.
`protected BigDecimal`	`measureNumber` The current mesaure number when the conversion process steps through the score.
`static Tempo`	`mm60` Default tempo 1/4=60
`protected float`	`msec_per_whole` Gives the current tempo when the conversion process steps through the score.
`protected MessageReceiver<SimpleMessage<XMLDocumentIdentifier>>`	`msg` Drain of all generated messages.
`static String`	`NOTONE` Name printed for the pitch in table lines reralizing a pause = no sound.
`protected File`	`outDir` Where to put the result files.
`protected float`	`repetition_articulation_minpause_msec` Minimal pause in milliseconds between adjacent events with the same pitch.
`protected float`	`repetition_articulation_minpause_percent` Minimal pause between adjacent events with the same pitch, in percent of the duration of the earlier of both.
`protected Score_cwn`	`score` The score to convert.
`static String`	`sig_text_column_header` Comment in the first line of the text file, containing the column headerss.
`static String`	`sig_text_eof` Last line in the text file
`static String`	`sig_text_header` Initial comment for text file.

Constructor Summary

Constructors
Constructor and Description
`Cwn_to_sig(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg, Score_cwn score, String filenamestem, File outDir)` Convert one Score_cwn instance into a binray files to be played by a sig sequencer plus its text variant.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`convert()` Execute the conversion.
`(package private) void`	`convertOneVoice(Vox voice)` Create a new binary and a new text file and write to both the event data of the voice object.
`static void`	`main(String[] args)` Test method, translates input file "arg[0]" to sig output files in directory "arg[1"].
`protected float`	`note_duration_to_msec(RationalDuration.DottedBaseDuration db)` Convert a CWN duration to msecs, according to the current tempo.
`static float`	`pitch_to_sig(OctaveRegister oct, FunctionalPitchModOctave p)` Convert functional pitch into frequency value according to equal distance tempered tuning.
`static float`	`pitch_to_sig(PitchAndOctave<OctaveRegister,FunctionalPitchModOctave> ap)` Convert functional pitch into frequency value according to equal distance tempered tuning.
`protected float`	`rat_to_msec(Rational duration)` Convert a CWN duration to msecs, according to the current tempo.
`protected void`	`setMM(int mm)` Set the tempo as the count of CWN "1/4" note durations per physical/calendaric minute.
`protected void`	`setMM(Tempo tempo)` Set the tempo.
`(package private) void`	`writeEvent(Event e, float msec_start, @Opt Event next_e, float next_msec_start, int trigger, PrintWriter txt, DataOutputStream dos)` Write one event (sound or pause) to the two output files.
`(package private) void`	`writePause(float dura, int trigger, PrintWriter txt, DataOutputStream dos)` Write a pause which is characterized by a "gate==0".
`(package private) void`	`writeSound(float ontime, float offtime, String pitchname, int trigger, int intensity, PrintWriter txt, DataOutputStream dos)` Write a sounding event, with pitch, weight, etc.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - msg
```
protected final MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg
```
    Drain of all generated messages.
  - score
```
protected final Score_cwn score
```
    The score to convert. Constant and set once when constructing.
  - filenamestem
```
protected final String filenamestem
```
    The prefix of the names of the generated files. This normally contains the name of the original tscore input file and that of the PART, if more than one.
  - outDir
```
protected final File outDir
```
    Where to put the result files.
  - generationDate
```
protected String generationDate
```
    Calendaric date of generation, to be integrated into comment.
  - msec_per_whole
```
protected float msec_per_whole
```
    Gives the current tempo when the conversion process steps through the score.
  - default_articulation_minpause_msec
```
public static final float default_articulation_minpause_msec
```
    Minimal pause in milliseconds between adjacent events with different pitch.
    
    See Also:
    
    Constant Field Values
  - default_articulation_minpause_percent
```
public static final float default_articulation_minpause_percent
```
    Minimal pause between adjacent events with different pitch, in percent of the duration of the earlier of both.
    
    See Also:
    
    Constant Field Values
  - articulation_minpause_msec
```
protected float articulation_minpause_msec
```
    Minimal pause in milliseconds between adjacent events with different pitch.
  - articulation_minpause_percent
```
protected float articulation_minpause_percent
```
    Minimal pause between adjacent events with different pitch, in percent of the duration of the earlier of both.
  - default_repetition_articulation_minpause_msec
```
public static final float default_repetition_articulation_minpause_msec
```
    Minimal pause in milliseconds between adjacent events with the same pitch.
    
    See Also:
    
    Constant Field Values
  - default_repetition_articulation_minpause_percent
```
public static final float default_repetition_articulation_minpause_percent
```
    Minimal pause between adjacent events with the same pitch, in percent of the duration of the earlier of both.
    
    See Also:
    
    Constant Field Values
  - repetition_articulation_minpause_msec
```
protected float repetition_articulation_minpause_msec
```
    Minimal pause in milliseconds between adjacent events with the same pitch.
  - repetition_articulation_minpause_percent
```
protected float repetition_articulation_minpause_percent
```
    Minimal pause between adjacent events with the same pitch, in percent of the duration of the earlier of both.
  - measureNumber
```
protected BigDecimal measureNumber
```
    The current mesaure number when the conversion process steps through the score.
  - eventNumber
```
protected int eventNumber
```
    The current event numberwhen the conversion process steps through the score. Is used to generate "trigger" information, thus defines "event identity". May possibly run modulo, i.e. step from {Integer#MAX_VALUE} to {Integer#MIN_VALUE}.
  - FINAL_SILENCE_MSEC
```
public static float FINAL_SILENCE_MSEC
```
    Length of a pause appended to each score.
  - sig_text_header
```
public static final String sig_text_header
```
    Initial comment for text file. Incorporates original source file name, voice name and calendaric date. ATTENTION, the original source file name MAY be related to a disk file, MAY include the name of the part (in case of a tscore multiple PART input), or MAY be completely synthetic.
    
    See Also:
    
    Constant Field Values
  - sig_text_column_header
```
public static final String sig_text_column_header
```
    Comment in the first line of the text file, containing the column headerss.
    
    See Also:
    
    Constant Field Values
  - sig_text_eof
```
public static final String sig_text_eof
```
    Last line in the text file
    
    See Also:
    
    Constant Field Values
  - mm60
```
public static Tempo mm60
```
    Default tempo 1/4=60
  - HALFTONE
```
public static final float HALFTONE
```
    Frequency factor of a halftone in equal distance tempered tuning.
  - NOTONE
```
public static final String NOTONE
```
    Name printed for the pitch in table lines reralizing a pause = no sound.
    
    See Also:
    
    Constant Field Values
  - currentFreq
```
float currentFreq
```
    Local register to let a PAUSE carry on the frequency of the preceding sound.
- Constructor Detail
  - Cwn_to_sig
```
public Cwn_to_sig(MessageReceiver<SimpleMessage<XMLDocumentIdentifier>> msg,
                  Score_cwn score,
                  String filenamestem,
                  File outDir)
```
    Convert one Score_cwn instance into a binray files to be played by a sig sequencer plus its text variant.
    
    Parameters:
    
    msg - drain of all messages
    
    score - the data to convert
    
    filenamestem - the stem to generate the names of the output files
    
    outDir - where to generate the output files
- Method Detail
  - setMM
```
protected void setMM(int mm)
```
    Set the tempo as the count of CWN "1/4" note durations per physical/calendaric minute.
  - setMM
```
protected void setMM(Tempo tempo)
```
    Set the tempo.
  - note_duration_to_msec
```
protected float note_duration_to_msec(RationalDuration.DottedBaseDuration db)
```
    Convert a CWN duration to msecs, according to the current tempo.
  - rat_to_msec
```
protected float rat_to_msec(Rational duration)
```
    Convert a CWN duration to msecs, according to the current tempo.
  - pitch_to_sig
```
public static float pitch_to_sig(PitchAndOctave<OctaveRegister,FunctionalPitchModOctave> ap)
```
    Convert functional pitch into frequency value according to equal distance tempered tuning.
    PROVISIONAL, -- should be contained in a tuning system.
  - pitch_to_sig
```
public static float pitch_to_sig(OctaveRegister oct,
                                 FunctionalPitchModOctave p)
```
    Convert functional pitch into frequency value according to equal distance tempered tuning.
    PROVISIONAL, -- should be contained in a tuning system.
  - convert
```
public void convert()
```
    Execute the conversion. Call convertOneVoice(Vox) for every voice contained in the Score_cwn. (For the one and only metric voice this will do nothing.) If the score data does not contain tempo information,mm60 will be used.
  - writePause
```
void writePause(float dura,
                int trigger,
                PrintWriter txt,
                DataOutputStream dos)
         throws IOException
```
    Write a pause which is characterized by a "gate==0". This lets e.g. a traditinal simple ADSR go into the "R" phase.
    NB: the pitch of the last preceding sound is repeated because sound synthesis must not end abruptly.
    
    Throws:
    
    IOException
  - writeSound
```
void writeSound(float ontime,
                float offtime,
                String pitchname,
                int trigger,
                int intensity,
                PrintWriter txt,
                DataOutputStream dos)
         throws IOException
```
    Write a sounding event, with pitch, weight, etc. Counting up the event number has the effect of a trigger to the standard ADSR (Waiting for the "first derivative", i.e. for a change of the signal value)
    
    Throws:
    
    IOException
  - writeEvent
```
void writeEvent(Event e,
                float msec_start,
                @Opt
                @Opt Event next_e,
                float next_msec_start,
                int trigger,
                PrintWriter txt,
                DataOutputStream dos)
         throws IOException
```
    Write one event (sound or pause) to the two output files. In case of sound, applies articulation factor to the duration and possibly writes TWO lines to the files, for the sound and the articulation pause.
    
    Throws:
    
    IOException
  - convertOneVoice
```
void convertOneVoice(Vox voice)
```
    Create a new binary and a new text file and write to both the event data of the voice object.
  - main
```
public static void main(String[] args)
```
    Test method, translates input file "arg[0]" to sig output files in directory "arg[1"].

Class Cwn_to_sig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

msg

score

filenamestem

outDir

generationDate

msec_per_whole

default_articulation_minpause_msec

default_articulation_minpause_percent

articulation_minpause_msec

articulation_minpause_percent

default_repetition_articulation_minpause_msec

default_repetition_articulation_minpause_percent

repetition_articulation_minpause_msec

repetition_articulation_minpause_percent

measureNumber

eventNumber

FINAL_SILENCE_MSEC

sig_text_header

sig_text_column_header

sig_text_eof

mm60

HALFTONE

NOTONE

currentFreq

Constructor Detail

Cwn_to_sig

Method Detail

setMM

setMM

note_duration_to_msec

rat_to_msec

pitch_to_sig

pitch_to_sig

convert

writePause

writeSound

writeEvent

convertOneVoice

main