GuitarInstructionGenerator.java

package com.PP.LunarTabsAndroid.InstructionGenerator;

import java.util.List;

import org.herac.tuxguitar.song.models.TGBeat;
import org.herac.tuxguitar.song.models.TGNote;

import android.content.Context;

import com.PP.LunarTabsAndroid.APIs.TuxGuitarUtil;
import com.PP.LunarTabsAndroid.InstrumentModels.ChordRecognizer;
import com.PP.LunarTabsAndroid.InstrumentModels.GuitarModel;
import com.PP.LunarTabsAndroid.UI.DataModel;
import com.PP.LunarTabsAndroid.UI.ResourceModel;
import com.example.lunartabsandroid.R;

public class GuitarInstructionGenerator extends InstructionGenerator {
	
	//constants
	public static String[] langMod;
	
	//singleton pattern
	private static GuitarInstructionGenerator instance;
	
	/**
	 * ctr
	 */
	protected GuitarInstructionGenerator(){
		langMod = ResourceModel.getInstance().langMod;
	}
		
	/**
	 * Singleton
	 * @return
	 */
	public static GuitarInstructionGenerator getInstance() {
		if(instance==null) {
			instance = new GuitarInstructionGenerator();
		}
		return instance;
	}
	
	
	/*
	 * Get play instruction
	 */
	@Override
	public String getPlayInstruction(TGBeat beat, int offset) {
		if(beat.isRestBeat()) {
			return getDurationInstruction(beat);
		}
		else {
			List<TGNote> notes = TuxGuitarUtil.getNotesForBeat(beat);		
			if(notes.size() > 1) {
				
				//correct notes for offset
				for(int x=0; x < notes.size(); x++) {
					TGNote note = notes.get(x);
					note.setValue(note.getValue()+offset);
				}
				
				//return chord instruction
				String CHORD = ResourceModel.getInstance().CHORD;
				String instruction = ChordRecognizer.getChordName(notes) + " "+CHORD+", " + getDurationInstruction(beat) + ". " + getNoteEffectInstruction(beat);
				instruction = instruction.trim();
				String lyricInstruction = this.getLyricInstruction(beat);
				if(lyricInstruction!=null) {
					instruction = instruction + "\n" + lyricInstruction;
				}
				return instruction.trim();
			}
			else {
				TGNote singleNote = notes.get(0);
				int string = singleNote.getString();
				int fret = singleNote.getValue()+offset+1; //correct for offset
				String SHARP = ResourceModel.getInstance().SHARP;
				String instruction= GuitarModel.getInstance().getNoteName(string, fret)[0].replaceAll("#", "-"+SHARP) + ", " + getDurationInstruction(beat) + ". " + getNoteEffectInstruction(beat);
				instruction = instruction.trim();				
				String lyricInstruction = this.getLyricInstruction(beat);
				if(lyricInstruction!=null) {
					instruction = instruction + "\n" + lyricInstruction;
				}
				return instruction.trim();
			}
		}
	}
	
	/*
	 * Generates instructions of the form (string, fret).
	 */
	public String getStringFretInstruction(TGBeat beat) {
		if(beat.isRestBeat()) {
			return getDurationInstruction(beat);
		}
		else {
		
			//loop for notes
			List<TGNote> notes = TuxGuitarUtil.getNotesForBeat(beat);
			String instruction = "";
			for(TGNote note : notes) {
				
				//get string, fret
				int string = note.getString();
				int fret = note.getValue();
				
				//keep from crashing if some crazy high note
				if(string >= langMod.length)
					string = langMod.length-1;
				if(fret >= langMod.length)
					fret = langMod.length - 1;
				
				//create instruction
				instruction = instruction + " " + langMod[string] + " " + ResourceModel.getInstance().GUITAR_INST_GEN_STRING+", " + langMod[fret] + " "+ResourceModel.getInstance().GUITAR_INST_GEN_FRET+". ";
			}
			
			//add duration
			instruction = instruction + getDurationInstruction(beat);
			
			//rtn
			return instruction;		
		}
	}
	
	/*
	 * Generates instructions using condensed form.
	 */
	public String getCondensedInstruction(TGBeat beat) {
		if(beat.isRestBeat()) {
			return getDurationInstruction(beat);
		}
		else {
			
			//init frets array
			int[] frets = new int[6];
			for(int x=0; x < 6; x++) {
				frets[x] = -1;
			}
			
			//loop for notes
			List<TGNote> notes = TuxGuitarUtil.getNotesForBeat(beat);
			for(TGNote note : notes) {
				
				//get string, fret
				int string = note.getString();
				int fret = note.getValue();
				
				//keep from crashing if some crazy high note
				if(string >= langMod.length)
					string = langMod.length-1;
				if(fret >= langMod.length)
					fret = langMod.length - 1;
				
				//store
				frets[string-1] = fret;				
			}
			
			String instruction="";
			for(int x=5; x >= 0; x--) {
				
				//display modifier
				if(frets[x]==-1) {
					instruction = instruction + "-";
				}
				else {
					instruction = instruction + frets[x];
				}
				
				if(x==0) {
					instruction = instruction + ". ";
				}
				else {
					instruction = instruction  + ",";
				}
			}
			
			//add duration
			instruction = instruction + getDurationInstruction(beat);
			
			//rtn
			return instruction;		
		}
	}
}