Octave.java

/**
 *  Catroid: An on-device visual programming system for Android devices
 *  Copyright (C) 2010-2013 The Catrobat Team
 *  (<http://developer.catrobat.org/credits>)
 *
 *  This program is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU Affero General Public License as
 *  published by the Free Software Foundation, either version 3 of the
 *  License, or (at your option) any later version.
 *
 *  An additional term exception under section 7 of the GNU Affero
 *  General Public License, version 3, is available at
 *  http://developer.catrobat.org/license_additional_term
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 *  GNU Affero General Public License for more details.
 *
 *  You should have received a copy of the GNU Affero General Public License
 *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.catrobat.musicdroid.note;

import java.util.Arrays;

public final class Octave {

	public static final int NUMBER_OF_HALF_TONE_STEPS_PER_OCTAVE = 12;
	public static final int NUMBER_OF_UNSIGNED_HALF_TONE_STEPS_PER_OCTAVE = 7;

	private NoteName[] noteNames;

	private Octave(NoteName[] noteNames) {
		this.noteNames = noteNames;
	}

	public static Octave createSubContraOctave() {
		return new Octave(new NoteName[] { NoteName.A0, NoteName.A0S, NoteName.B0 });
	}

	public static Octave createContraOctave() {
		return new Octave(new NoteName[] { NoteName.C1, NoteName.C1S, NoteName.D1, NoteName.D1S, NoteName.E1,
				NoteName.F1, NoteName.F1S, NoteName.G1, NoteName.G1S, NoteName.A1, NoteName.A1S, NoteName.B1 });
	}

	public static Octave createGreatOctave() {
		return new Octave(new NoteName[] { NoteName.C2, NoteName.C2S, NoteName.D2, NoteName.D2S, NoteName.E2,
				NoteName.F2, NoteName.F2S, NoteName.G2, NoteName.G2S, NoteName.A2, NoteName.A2S, NoteName.B2 });
	}

	public static Octave createSmallOctave() {
		return new Octave(new NoteName[] { NoteName.C3, NoteName.C3S, NoteName.D3, NoteName.D3S, NoteName.E3,
				NoteName.F3, NoteName.F3S, NoteName.G3, NoteName.G3S, NoteName.A3, NoteName.A3S, NoteName.B3 });
	}

	public static Octave createOneLineOctave() {
		return new Octave(new NoteName[] { NoteName.C4, NoteName.C4S, NoteName.D4, NoteName.D4S, NoteName.E4,
				NoteName.F4, NoteName.F4S, NoteName.G4, NoteName.G4S, NoteName.A4, NoteName.A4S, NoteName.B4 });
	}

	public static Octave createTwoLineOctave() {
		return new Octave(new NoteName[] { NoteName.C5, NoteName.C5S, NoteName.D5, NoteName.D5S, NoteName.E5,
				NoteName.F5, NoteName.F5S, NoteName.G5, NoteName.G5S, NoteName.A5, NoteName.A5S, NoteName.B5 });
	}

	public static Octave createThreeLineOctave() {
		return new Octave(new NoteName[] { NoteName.C6, NoteName.C6S, NoteName.D6, NoteName.D6S, NoteName.E6,
				NoteName.F6, NoteName.F6S, NoteName.G6, NoteName.G6S, NoteName.A6, NoteName.A6S, NoteName.B6 });
	}

	public static Octave createFourLineOctave() {
		return new Octave(new NoteName[] { NoteName.C7, NoteName.C7S, NoteName.D7, NoteName.D7S, NoteName.E7,
				NoteName.F7, NoteName.F7S, NoteName.G7, NoteName.G7S, NoteName.A7, NoteName.A7S, NoteName.B7 });
	}

	public static Octave createFiveLineOctave() {
		return new Octave(new NoteName[] { NoteName.C8 });
	}

	public static Octave createCustomOctave(NoteName startNoteName) {
		NoteName currentNoteName = startNoteName;
		NoteName[] noteNames = new NoteName[NUMBER_OF_HALF_TONE_STEPS_PER_OCTAVE];

		for (int i = 0; i < noteNames.length; i++) {
			noteNames[i] = currentNoteName;

			if (currentNoteName == currentNoteName.next()) {
				return new Octave(Arrays.copyOf(noteNames, i + 1));
			}

			currentNoteName = currentNoteName.next();
		}

		return new Octave(noteNames);
	}

	public NoteName[] getNoteNames() {
		return noteNames;
	}
}