ScoreFrameLayouter.java

package com.xenoage.zong.musiclayout.layouter.scoreframelayout;

import com.xenoage.utils.kernel.Tuple2;
import com.xenoage.utils.kernel.Tuple3;
import com.xenoage.zong.core.Score;
import com.xenoage.zong.core.header.ScoreHeader;
import com.xenoage.zong.core.music.Part;
import com.xenoage.zong.core.music.StavesList;
import com.xenoage.zong.core.music.beam.Beam;
import com.xenoage.zong.core.music.group.BracketGroup;
import com.xenoage.zong.core.music.group.StavesRange;
import com.xenoage.zong.core.music.tuplet.Tuplet;
import com.xenoage.zong.core.text.FormattedTextElement;
import com.xenoage.zong.core.text.FormattedTextString;
import com.xenoage.zong.core.text.FormattedTextStyle;
import com.xenoage.zong.musiclayout.ScoreFrameLayout;
import com.xenoage.zong.musiclayout.continued.*;
import com.xenoage.zong.musiclayout.layouter.Context;
import com.xenoage.zong.musiclayout.layouter.cache.OpenLyricsCache;
import com.xenoage.zong.musiclayout.layouter.cache.OpenSlursCache;
import com.xenoage.zong.musiclayout.layouter.cache.OpenTupletsCache;
import com.xenoage.zong.musiclayout.layouter.cache.util.SlurCache;
import com.xenoage.zong.musiclayout.layouter.scoreframelayout.util.LastLyrics;
import com.xenoage.zong.musiclayout.layouter.scoreframelayout.util.StaffStampings;
import com.xenoage.zong.musiclayout.notation.Notations;
import com.xenoage.zong.musiclayout.spacing.*;
import com.xenoage.zong.musiclayout.stamper.PartNameStamper;
import com.xenoage.zong.musiclayout.stamper.StamperContext;
import com.xenoage.zong.musiclayout.stampings.*;
import com.xenoage.zong.symbols.SymbolPool;

import java.util.*;

import static com.xenoage.utils.collections.CollectionUtils.*;
import static com.xenoage.utils.kernel.Range.range;
import static com.xenoage.zong.musiclayout.layouter.scoreframelayout.LyricStamper.lyricStamper;
import static com.xenoage.zong.musiclayout.stamper.SlurStamper.slurStamper;
import static com.xenoage.zong.musiclayout.layouter.scoreframelayout.TupletStamper.tupletStamper;
import static com.xenoage.zong.musiclayout.stamper.BarlinesStamper.barlinesStamper;
import static com.xenoage.zong.musiclayout.stamper.DirectionStamper.directionStamper;
import static com.xenoage.zong.musiclayout.stamper.MeasureStamper.measureStamper;
import static com.xenoage.zong.musiclayout.stamper.PartNameStamper.partNameStamper;
import static com.xenoage.zong.musiclayout.stamper.StaffStamper.staffStamper;
import static com.xenoage.zong.musiclayout.stamper.VoiceStamper.voiceStamper;
import static com.xenoage.zong.musiclayout.stamper.VoltaStamper.voltaStamper;
import static com.xenoage.zong.musiclayout.stamper.WedgeStamper.wedgeStamper;

/**
 * This strategy creates the {@link ScoreFrameLayout}
 * for a given {@link FrameSpacing}.
 * 
 * TODO: TIDY or redesign. This is probably the ugliest
 * class in the whole project.
 * 
 * @author Andreas Wenger
 */
public class ScoreFrameLayouter {
	
	public static final ScoreFrameLayouter scoreFrameLayouter = new ScoreFrameLayouter();


	/**
	 * Creates a {@link ScoreFrameLayout} from the given {@link FrameSpacing}.
	 * 
	 * @param unclosedElements  unclosed elements from the last frame, like slurs
	 *                          spanning over more than one frame
	 */
	public ScoreFrameLayout computeScoreFrameLayout(FrameSpacing frame, int frameIndex,
		Notations notations, List<ContinuedElement> unclosedElements, Context layouterContext,
		Map<Beam, BeamSpacing> beamsSpacing) {
		
		layouterContext.saveMp();
		
		Score score = layouterContext.score;
		SymbolPool symbols = layouterContext.symbols;
		
		StamperContext context = new StamperContext();
		context.layouter = layouterContext;
		context.notations = notations;
		
		ScoreHeader header = score.getHeader();
		int stavesCount = score.getStavesCount();
		StavesList stavesList = score.getStavesList();
		ArrayList<StaffStamping> staffStampsPool = alist();
		ArrayList<Stamping> otherStampsPool = alist();

		//default lyric style
		FormattedTextStyle defaultLyricStyle = new FormattedTextStyle(score.getFormat().getLyricFont());

		//caches
		OpenSlursCache openCurvedLinesCache = new OpenSlursCache();
		OpenWedges openWedges = new OpenWedges();
		OpenLyricsCache openLyricsCache = new OpenLyricsCache();
		LastLyrics lastLyrics = new LastLyrics();
		OpenTupletsCache openTupletsCache = new OpenTupletsCache();
		OpenVolta openVolta = new OpenVolta();

		//add continued elements
		for (ContinuedElement ce : unclosedElements) {
			if (ce instanceof ContinuedSlur) {
				openCurvedLinesCache.add(SlurCache.createContinued((ContinuedSlur) ce));
			}
			else if (ce instanceof ContinuedVolta) {
				openVolta.volta = (ContinuedVolta) ce;
			}
			else if (ce instanceof ContinuedWedge) {
				openWedges.wedges.add((ContinuedWedge) ce);
			}
		}

		//create staff stampings
		StaffStampings staffStampings = staffStamper.createStaffStampings(score, frame);
		staffStampings.addAllTo(staffStampsPool);
		context.staffStampings = staffStampings;

		//go through the systems
		for (int iSystem : range(frame.getSystems())) {
			context.systemIndex = iSystem;
			SystemSpacing system = frame.getSystems().get(iSystem);
			
			List<StaffStamping> systemStaves = staffStampings.getAllOfSystem(iSystem);
			StaffStamping systemFirstStaff = getFirst(systemStaves);
			
			//add the part names (first system) or part abbreviations (other systems)
			int iStaffInPart = 0;
			for (Part part : stavesList.getParts()) {
				PartNameStamper.Style style = (frameIndex == 0 && iSystem == 0 ?
					PartNameStamper.Style.Full : PartNameStamper.Style.Abbreviated);
				addNotNull(otherStampsPool, partNameStamper.stamp(part, iStaffInPart, systemStaves, style));
				iStaffInPart += part.getStavesCount();
			}

			//create the brackets at the beginning of the system
			for (BracketGroup bracketGroup : stavesList.getBracketGroups()) {
				StavesRange r = bracketGroup.getStaves();
				otherStampsPool.add(new BracketStamping(systemStaves.get(r.getStart()), systemStaves.get(r
					.getStop()), system.getMarginLeftMm() - 1.4f, bracketGroup.getStyle()));
			}

			//create the barlines and measure numbers
			otherStampsPool.addAll(barlinesStamper.stamp(system, systemStaves, score));

			//fill the staves
			for (int iStaff : range(stavesCount)) {
				layouterContext.mp = layouterContext.mp.withStaff(iStaff);
				context.staffIndex = iStaff;
				float xMm = context.getCurrentStaffStamping().positionMm.x;

				for (int iMeasure : range(system.columns)) {
					int globalMeasureIndex = system.getStartMeasure() + iMeasure;
					layouterContext.mp = layouterContext.mp.withMeasure(globalMeasureIndex);
					context.measureIndex = globalMeasureIndex;

					ColumnSpacing measureColumnSpacing = system.columns.get(iMeasure);
					MeasureSpacing measure = measureColumnSpacing.getMeasures().get(iStaff);

					//add leading spacing elements, if available
					otherStampsPool.addAll(measureStamper.stampLeading(measure, xMm, context));

					//add directions
					otherStampsPool.addAll(directionStamper.stamp(context));

					//add measure elements within this measure
					float voicesXMm = xMm + measureColumnSpacing.getLeadingWidthMm();
					otherStampsPool.addAll(measureStamper.stampMeasure(measure, voicesXMm, context));

					//add voice elements within this measure
					otherStampsPool.addAll(voiceStamper.stampVoices(measure, voicesXMm, staffStampings, context,
						defaultLyricStyle, beamsSpacing, openCurvedLinesCache, openLyricsCache, lastLyrics,
						openTupletsCache));
					
					xMm += measureColumnSpacing.getWidthMm();
				}

			}

			//create all voltas in this system, including open voltas from the last system
			otherStampsPool.addAll(voltaStamper.stampSystem(systemFirstStaff, openVolta,
				header, defaultLyricStyle));

			//create all wedges in this system
			otherStampsPool.addAll(wedgeStamper.stampSystem(system, score, staffStampings, openWedges));

		}

		//create the collected ties and slurs
		otherStampsPool.addAll(createTiesAndSlurs(openCurvedLinesCache, staffStampings, frame
			.getSystems().size()));

		//create the open lyric underscore lines
		for (Tuple3<StaffTextStamping, NoteheadStamping, Integer> openUnderscore : openLyricsCache
			.getUnderscores()) {
			//TODO: fetch style efficiently
			FormattedTextStyle style = defaultLyricStyle;
			FormattedTextElement firstElement = openUnderscore.get1().getText().getFirstParagraph().getElements().getFirst();
			if (firstElement instanceof FormattedTextString) {
				style = ((FormattedTextString) firstElement).getStyle();
			}
			otherStampsPool.addAll(lyricStamper.createUnderscoreStampings(openUnderscore.get1(),
				openUnderscore.get2(), style, staffStampings.getAllOfStaff(openUnderscore.get3())));
		}

		//create tuplet brackets/numbers
		for (Tuplet tuplet : openTupletsCache) {
			otherStampsPool.add(tupletStamper.createTupletStamping(tuplet, openTupletsCache,
				symbols));
		}

		//collect elements that have to be continued on the next frame
		ArrayList<ContinuedElement> continuedElements = alist();
		for (SlurCache clc : openCurvedLinesCache) {
			continuedElements.add(clc.getContinuedCurvedLine());
		}
		if (openVolta.volta != null)
			continuedElements.add(openVolta.volta);
		continuedElements.addAll(openWedges.wedges);

		layouterContext.restoreMp();
		return new ScoreFrameLayout(frame, staffStampsPool, otherStampsPool, continuedElements);
	}


	/**
	 * Creates the ties and slurs collected in the given {@link OpenSlursCache}.
	 * All closed slurs are removed from the cache. The unclosed slurs (which have to
	 * be continued on the next frame) remain in the cache.
	 */
	private List<SlurStamping> createTiesAndSlurs(OpenSlursCache openCurvedLinesCache,
		StaffStampings staffStampings, int systemsCount) {
		LinkedList<SlurStamping> ret = new LinkedList<>();
		for (Iterator<SlurCache> itSlurCache = openCurvedLinesCache.iterator(); itSlurCache.hasNext();) {
			boolean simpleLine = false; //current curved line simple (within one system)?
			SlurCache slurCache = itSlurCache.next();
			int middleSlurStartIndex = 0;
			//if the start is known, begin (and if possible end) the slur in its staff
			if (slurCache.isStartKnown()) {
				Tuple2<SlurStamping, Boolean> startCLS = slurStamper.createSlurStampingStart(slurCache);
				ret.add(startCLS.get1());
				if (startCLS.get2() == false) {
					//curved line is finished, remove cache
					simpleLine = true;
					itSlurCache.remove();
				}
				else {
					//curved lines is continued in next system
					middleSlurStartIndex = slurCache.getStartSystem() + 1;
				}
			}
			//if not a simple line, compute and stamp middle slurs and end slur
			if (!simpleLine) {
				//if the stop notehead is known, compute the system up zo where middle staff slurs (if any)
				//have to be stamped and stamp them
				int middleSlurStopIndex = systemsCount - 1;
				if (slurCache.isStopKnown()) {
					middleSlurStopIndex = slurCache.getStopSystem() - 1;
				}
				for (int iSystem = middleSlurStartIndex; iSystem <= middleSlurStopIndex; iSystem++) {
					SlurStamping cls = slurStamper.createSlurStampingMiddle(slurCache.getContinuedCurvedLine());
					if (cls != null)
						ret.add(cls);
				}
				//create stop slur (if any)
				if (!simpleLine && slurCache.isStopKnown()) {
					ret.add(slurStamper.createStopForLastSystem(slurCache));
					//curved line is finished, remove cache
					itSlurCache.remove();
				}
			}
		}
		return ret;
	}



	

}