Cwn_to_lilypond (BandM signal & music)

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

```
public class Cwn_to_lilypond
extends Object
```
Creates a simple lilypond output for one or more Score_cwn object/s. These are combined in one ".ly" file, in different "score{..}" blocks.

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`compoundMeter` Whether for "irregular" meters not only the overall duration shall be printed, but the first generation child nodes, as in "`3/8+2/8`" instead of simply "`5/8`".
`protected @Opt String`	`const_layout` An additional lilypond "`paper{...}`" text block entered into the generated source format.
`protected @Opt String`	`const_paper` An additional lilypond "`layout{...}`" text block entered into the generated source format.
`static String`	`default_includefile` Name of the lilypond include file for language selection.
`static String`	`default_language` Default language to use for pitch class names etc.
`protected Map<Vox,String>`	`firstLabels` Maps of the labels which shall be printed before the very first staff for this voice.
`static Format`	`format_lilypond_cautionary` Evident.
`static Format`	`format_lilypond_forceAccidental` Evident.
`static Format`	`format_lilypond_measure_pause` Evident.
`static Format`	`format_lilypond_pause` Evident.
`static Format`	`format_lilypond_setMetrum` Evident.
`static Format`	`format_lilypond_tie` Evident.
`protected String`	`includefile` Name of the lilypond include file for language selection.
`protected String`	`language` Language to use for pitch class names etc.
`static String`	`lily_generation_comment` Template for the generation comment added into the generated source file format.
`static String`	`lily_header` Template for the global include command added into the generated source file format.
`static String`	`lilypond_comment_leadin` Evident.
`protected Map<MTreeSpec,MSplitter>`	`metricSplitters` Local cache of one metric splitter each (with its internal cache) per metric tree specifications.
`protected MessageReceiver<SimpleMessage<?>>`	`msg` Evident
`protected boolean`	`numericTimeSignature` Whether "4/4" shall be printed instead of "C", etc.
`protected MCover.Parameters_approximate`	`parameters_approximate` Parameter collection controlling metric split approximation by binary division.
`protected MTree.Parameters`	`parameters_beams` Parameter collection controlling metric split beams.
`protected MCover.Parameters_divide`	`parameters_divide` Parameter collection controlling metric split approximation by synthesis of new divisions.
`protected MSplitter.Parameters`	`parameters_splitter` Parameter collection controlling metric split dotting, sibling merge, syncopes, etc.
`protected Score_cwn`	`score` The currently processed score input.
`protected List<Score_cwn>`	`scores` All scores which shall be printed by this instance.
`protected boolean`	`shareDenominator` Whether compound meters shall be printed with a common denominator.
`protected Map<Vox,String>`	`shortLabels` Maps of the labels which shall be printed before the subsequent (non-first) staves for this voice.
`protected Map<Vox,FunctionalInterval>`	`transpositions` Maps of transpostions to be applied to the score data before writing out.
`protected boolean`	`wholeMeasurePauses` Whether a pause covering a whole measure shall be printed in a special way, namely always with the duration "1/1" and in the geometric middle between the bars.

Constructor Summary

Constructors
Constructor and Description
`Cwn_to_lilypond(MessageReceiver<SimpleMessage<?>> msg, List<Score_cwn> scores, MTree.Parameters parameters_beams, MCover.Parameters_approximate parameters_approximate, MCover.Parameters_divide parameters_divide, MSplitter.Parameters parameters_splitter, boolean wholeMeasurePauses)` Only constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Format`	`barnum2format(BigDecimal barnum)` Generate a lilypond comment format indicating the bar number / measure number-
`Format`	`convertOneVoice(Vox voice, boolean includeMetric, @Opt List<Format> formatsLyrics)` Generate a format for one certain voice (possibly including metric info) which can be read by Lilypond.
`Format`	`convertVoices(String sourcename)` Generate the format of a lilypond source file, for all Score_cwn instances in `scores`.
`Format`	`convertVoices(String sourcename, Part part, List<Vox> voices)` Generate a format representing Lilypond source text, for one tscore soure "PART" and the given list of voices.
`static Format`	`formatValueOf(Rational rat)` Translate the rational value into a literal format.
`protected MSplitter`	`getMetricSplitter(MTreeSpec mt)` Get a metric splitter (with its internal cache) for the given metric tree specifications, or construct a new one.
`static void`	`main(String[] args)` Stand-alone application, translates input file "arg[0]" to lilypond output file "arg[1]".
`static String`	`meterName(MTree_<?> meter, boolean useCompoundFormat, boolean compress)` Generate a meter name based only on duration, or on an "addition" of the first generation child nodes.
`Cwn_to_lilypond`	`putLabels(Vox voice, String firstLabel, String shortLabel)` Set the initial=long and subsequent=short labels to be printed before the staff of a voice.
`Cwn_to_lilypond`	`putTransposition(Vox voice, FunctionalInterval ival)` Set a transposition to be applied to the voice before generating the lilypond source.
`Cwn_to_lilypond`	`set_const_layout(String s)` Set `const_layout`.
`Cwn_to_lilypond`	`set_const_paper(String s)` Set `const_paper`.
`Cwn_to_lilypond`	`set_meter_names(boolean numericTimeSignature, boolean compoundMeter, boolean shareDenominator)` Sets parameters how to render meter names.
`static void`	`toLilyPond_clefSelect(List<Format> formats, ClefUsage cu)` Generate a format for changing the clef.
`void`	`toLilyPond_clefSelect(List<Format> formats, Event event)` Generate a format for changing the clef, iff event carries such a command.
`static String`	`toLilyPond_duration(RationalDuration.DottedBaseDuration db)` Translate duration information into lilypond format.
`void`	`toLilyPond_key(List<Format> formats, Event event)` Emit a lilypond diatonic key change, if the Event carries such a command.
`protected void`	`toLilyPond_key(@Opt Vox voice, List<Format> formats, Event event)` Emit a lilypond diatonic key change, if the Event carries such a command.
`void`	`toLilyPond_metrics(List<Format> formats, BigDecimal barnum)` Generate a format for the start text for the measure with the given barnum, indicating its meter, (and its duration, if it is partial).
`static String`	`toLilyPond_pitch(PitchAndOctave<OctaveRegister,FunctionalPitchModOctave> ap)` Translate pitch information into lilypond format.
`protected FunctionalPitchModOctave`	`transpose(@Opt Vox v, FunctionalPitchModOctave p)` Deliver the pitch transposed UP by the interval which is assigned to the voice in `transpositions`, if any.
`protected PitchAndOctave<OctaveRegister,FunctionalPitchModOctave>`	`transpose(@Opt Vox v, PitchAndOctave<OctaveRegister,FunctionalPitchModOctave> p)` Deliver the pitch transposed UP by the interval which is assigned to the voice in `transpositions`, if any.

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<?>> msg
```
    Evident
  - scores
```
protected final List<Score_cwn> scores
```
    All scores which shall be printed by this instance. All data goes together into one single disk-file, but with a new lilypond "score{}" block for each.
  - score
```
protected Score_cwn score
```
    The currently processed score input.
  - parameters_beams
```
protected final MTree.Parameters parameters_beams
```
    Parameter collection controlling metric split beams. Configuration parameter, set once when constructing.
  - parameters_approximate
```
@Opt
protected final MCover.Parameters_approximate parameters_approximate
```
    Parameter collection controlling metric split approximation by binary division. Iff == null, the binary division will not be applied. Configuration parameter, set once when constructing.
  - parameters_divide
```
@Opt
protected final MCover.Parameters_divide parameters_divide
```
    Parameter collection controlling metric split approximation by synthesis of new divisions. Iff == null, this method will not be applied. Configuration parameter, set once when constructing.
  - parameters_splitter
```
protected final MSplitter.Parameters parameters_splitter
```
    Parameter collection controlling metric split dotting, sibling merge, syncopes, etc. Configuration parameter, set once when constructing.
  - wholeMeasurePauses
```
protected final boolean wholeMeasurePauses
```
    Whether a pause covering a whole measure shall be printed in a special way, namely always with the duration "1/1" and in the geometric middle between the bars. Configuration parameter, set once when constructing.
  - default_includefile
```
public static final String default_includefile
```
    Name of the lilypond include file for language selection. Must be in sync with default_language.
    
    See Also:
    
    Constant Field Values
  - default_language
```
public static final String default_language
```
    Default language to use for pitch class names etc. Must be in sync with default_includefile.
    
    See Also:
    
    Constant Field Values
  - includefile
```
protected String includefile
```
    Name of the lilypond include file for language selection. Default can be overrriden in the timeless prefix of the tscore by getTimeless("lilypond.language"). Must be in sync with language.
  - language
```
protected String language
```
    Language to use for pitch class names etc. Default can be overrriden in the timeless prefix of the tscore by getTimeless("lilypond.includefile"). Must be in sync with includefile.
  - metricSplitters
```
protected final Map<MTreeSpec,MSplitter> metricSplitters
```
    Local cache of one metric splitter each (with its internal cache) per metric tree specifications.
  - transpositions
```
protected Map<Vox,FunctionalInterval> transpositions
```
    Maps of transpostions to be applied to the score data before writing out. The Score_cwn data will be transposed by this interval upward before translating it into lilypond source text. Can be set by putTransposition(Vox,FunctionalInterval).
  - firstLabels
```
protected Map<Vox,String> firstLabels
```
    Maps of the labels which shall be printed before the very first staff for this voice. Must be set by {@link putLabels(Vox,String,String).
  - shortLabels
```
protected Map<Vox,String> shortLabels
```
    Maps of the labels which shall be printed before the subsequent (non-first) staves for this voice. Must be set by putLabels(Vox,String,String).
  - const_paper
```
@Opt
protected @Opt String const_paper
```
    An additional lilypond "layout{...}" text block entered into the generated source format. Can be set by set_const_paper(String).
  - const_layout
```
@Opt
protected @Opt String const_layout
```
    An additional lilypond "paper{...}" text block entered into the generated source format. Can be set by set_const_paper(String).
  - numericTimeSignature
```
protected boolean numericTimeSignature
```
    Whether "4/4" shall be printed instead of "C", etc. Is set by set_meter_names(boolean,boolean,boolean).
  - compoundMeter
```
protected boolean compoundMeter
```
    Whether for "irregular" meters not only the overall duration shall be printed, but the first generation child nodes, as in "3/8+2/8" instead of simply "5/8". Is set by set_meter_names(boolean,boolean,boolean).
  - shareDenominator
```
protected boolean shareDenominator
```
    Whether compound meters shall be printed with a common denominator. E.g. "3+2/8" instead of "3/8+2/8". Is set by set_meter_names(boolean,boolean,boolean).
  - lily_generation_comment
```
public static final String lily_generation_comment
```
    Template for the generation comment added into the generated source file format.
    
    See Also:
    
    Constant Field Values
  - lily_header
```
public static final String lily_header
```
    Template for the global include command added into the generated source file format.
    
    See Also:
    
    Constant Field Values
  - lilypond_comment_leadin
```
public static final String lilypond_comment_leadin
```
    Evident.
    
    See Also:
    
    Constant Field Values
  - format_lilypond_tie
```
public static final Format format_lilypond_tie
```
    Evident.
  - format_lilypond_pause
```
public static final Format format_lilypond_pause
```
    Evident.
  - format_lilypond_measure_pause
```
public static final Format format_lilypond_measure_pause
```
    Evident.
  - format_lilypond_cautionary
```
public static final Format format_lilypond_cautionary
```
    Evident.
  - format_lilypond_forceAccidental
```
public static final Format format_lilypond_forceAccidental
```
    Evident.
  - format_lilypond_setMetrum
```
public static final Format format_lilypond_setMetrum
```
    Evident.
- Constructor Detail
  - Cwn_to_lilypond
```
public Cwn_to_lilypond(MessageReceiver<SimpleMessage<?>> msg,
                       List<Score_cwn> scores,
                       @Opt
                       MTree.Parameters parameters_beams,
                       @Opt
                       MCover.Parameters_approximate parameters_approximate,
                       @Opt
                       MCover.Parameters_divide parameters_divide,
                       @Opt
                       MSplitter.Parameters parameters_splitter,
                       boolean wholeMeasurePauses)
```
    Only constructor. Gets the final values of many configuration parameters and all scores which shall be translated. Usage: construct an instance and then call convertVoices(String) or sim.
- Method Detail
  - getMetricSplitter
```
protected MSplitter getMetricSplitter(MTreeSpec mt)
```
    Get a metric splitter (with its internal cache) for the given metric tree specifications, or construct a new one.
  - putTransposition
```
public Cwn_to_lilypond putTransposition(Vox voice,
                                        FunctionalInterval ival)
```
    Set a transposition to be applied to the voice before generating the lilypond source. The Score_cwn data will be transposed by this interval upward before translating it into lilypond source text.
  - putLabels
```
public Cwn_to_lilypond putLabels(Vox voice,
                                 String firstLabel,
                                 String shortLabel)
```
    Set the initial=long and subsequent=short labels to be printed before the staff of a voice.
  - set_const_paper
```
public Cwn_to_lilypond set_const_paper(String s)
```
    Set const_paper.
  - set_const_layout
```
public Cwn_to_lilypond set_const_layout(String s)
```
    Set const_layout.
  - set_meter_names
```
public Cwn_to_lilypond set_meter_names(boolean numericTimeSignature,
                                       boolean compoundMeter,
                                       boolean shareDenominator)
```
    Sets parameters how to render meter names. See numericTimeSignature, compoundMeter, and shareDenominator.
  - toLilyPond_duration
```
public static String toLilyPond_duration(RationalDuration.DottedBaseDuration db)
```
    Translate duration information into lilypond format. (Apply this only after all containing brackets have been generated and their factor thus removed from the duration argument.) Works for all Rationals which have a power-of-two denominator and are e-writeable. Possibly DISLOC to "RationalDuration.lilypondString()" ?? FIXME
  - toLilyPond_pitch
```
public static String toLilyPond_pitch(PitchAndOctave<OctaveRegister,FunctionalPitchModOctave> ap)
```
    Translate pitch information into lilypond format. Lilypond syntax for a single pitch event is :
```
    pitchClass Octave Accidental  Duration
  
```
  - meterName
```
public static String meterName(MTree_<?> meter,
                               boolean useCompoundFormat,
                               boolean compress)
```
    Generate a meter name based only on duration, or on an "addition" of the first generation child nodes.
    FIXME CHECK whether lilypond copes with "6/6" etc. !?!?!
    FIXME GEHEN NICHT ALLE siehe sig/examples/msplit/nichtUebersetzbar.ly !!!
    
    Parameters:
    
    compress - whether to put on ONE fractional line: "1+2+3/8" instead of "1/8+2/8+3/8".
  - toLilyPond_metrics
```
public void toLilyPond_metrics(List<Format> formats,
                               BigDecimal barnum)
```
    Generate a format for the start text for the measure with the given barnum, indicating its meter, (and its duration, if it is partial). Do this only if these values change w.r.t. its predecessor. Currently: encode metrics only as a measure DURATION, no influence on beams and grouping, etc. MISSING FIXME
    
    Parameters:
    
    formats - where to append the generated command
  - transpose
```
protected PitchAndOctave<OctaveRegister,FunctionalPitchModOctave> transpose(@Opt
                                                                            @Opt Vox v,
                                                                            PitchAndOctave<OctaveRegister,FunctionalPitchModOctave> p)
```
    Deliver the pitch transposed UP by the interval which is assigned to the voice in transpositions, if any.
  - transpose
```
protected FunctionalPitchModOctave transpose(@Opt
                                             @Opt Vox v,
                                             FunctionalPitchModOctave p)
```
    Deliver the pitch transposed UP by the interval which is assigned to the voice in transpositions, if any.
  - toLilyPond_key
```
public void toLilyPond_key(List<Format> formats,
                           Event event)
```
    Emit a lilypond diatonic key change, if the Event carries such a command. No voice is defined so not transposition is applied.
    
    Parameters:
    
    formats - where to append the generated command
  - toLilyPond_key
```
protected void toLilyPond_key(@Opt
                              @Opt Vox voice,
                              List<Format> formats,
                              Event event)
```
    Emit a lilypond diatonic key change, if the Event carries such a command. Transposition according to transpositions is applied.
    
    Parameters:
    
    formats - where to append the generated command
  - toLilyPond_clefSelect
```
public void toLilyPond_clefSelect(List<Format> formats,
                                  Event event)
```
    Generate a format for changing the clef, iff event carries such a command.
    
    Parameters:
    
    formats - where to append the generated command
  - toLilyPond_clefSelect
```
public static void toLilyPond_clefSelect(List<Format> formats,
                                         ClefUsage cu)
```
    Generate a format for changing the clef.
    
    Parameters:
    
    format - where output is appended.
  - barnum2format
```
public static Format barnum2format(BigDecimal barnum)
```
    Generate a lilypond comment format indicating the bar number / measure number-
  - convertOneVoice
```
public Format convertOneVoice(Vox voice,
                              boolean includeMetric,
                              @Opt
                              @Opt List<Format> formatsLyrics)
```
    Generate a format for one certain voice (possibly including metric info) which can be read by Lilypond. Assume all input data (semantic maps in Score_cwn) are valid. Esp. it requires ...
    - that the metric voice has a metric indication at the very first timepoint,
    - + that all voices start at the first TopTp
    - that the very first event in every voice carries a clef selection
    Parameters:
    
    includeMetric - In lilypond, changes of metrum and duration of all measures are global and valid for all voices simultaneously. They thus need to appear only in one voice. This parameter says whether metrum information shall be included in the currently generated lilypond voice.
  - formatValueOf
```
public static Format formatValueOf(Rational rat)
```
    Translate the rational value into a literal format.
  - convertVoices
```
public Format convertVoices(String sourcename)
```
    Generate the format of a lilypond source file, for all Score_cwn instances in scores. Each such is contained in one lilypond "Score{..}" block.
  - convertVoices
```
public Format convertVoices(String sourcename,
                            Part part,
                            List<Vox> voices)
```
    Generate a format representing Lilypond source text, for one tscore soure "PART" and the given list of voices.
    
    Returns:
    
    a format object corresponding to a complete lilypond source file, representing all contents in the given tscore PART.
  - main
```
public static void main(String[] args)
```
    Stand-alone application, translates input file "arg[0]" to lilypond output file "arg[1]".

Class Cwn_to_lilypond

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

msg

scores

score

parameters_beams

parameters_approximate

parameters_divide

parameters_splitter

wholeMeasurePauses

default_includefile

default_language

includefile

language

metricSplitters

transpositions

firstLabels

shortLabels

const_paper

const_layout

numericTimeSignature

compoundMeter

shareDenominator

lily_generation_comment

lily_header

lilypond_comment_leadin

format_lilypond_tie

format_lilypond_pause

format_lilypond_measure_pause

format_lilypond_cautionary

format_lilypond_forceAccidental

format_lilypond_setMetrum

Constructor Detail

Cwn_to_lilypond

Method Detail

getMetricSplitter

putTransposition

putLabels

set_const_paper

set_const_layout

set_meter_names

toLilyPond_duration

toLilyPond_pitch

meterName

toLilyPond_metrics

transpose

transpose

toLilyPond_key

toLilyPond_key

toLilyPond_clefSelect

toLilyPond_clefSelect

barnum2format

convertOneVoice

formatValueOf

convertVoices

convertVoices

main