829N/A/*
6321N/A * Copyright (c) 2007, 2013, Oracle and/or its affiliates. All rights reserved.
829N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
829N/A *
829N/A * This code is free software; you can redistribute it and/or modify it
829N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
829N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
829N/A *
829N/A * This code is distributed in the hope that it will be useful, but WITHOUT
829N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
829N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
829N/A * version 2 for more details (a copy is included in the LICENSE file that
829N/A * accompanied this code).
829N/A *
829N/A * You should have received a copy of the GNU General Public License version
829N/A * 2 along with this work; if not, write to the Free Software Foundation,
829N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
829N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
829N/A */
829N/Apackage com.sun.media.sound;
829N/A
829N/Aimport javax.sound.midi.Instrument;
829N/Aimport javax.sound.midi.MidiChannel;
829N/Aimport javax.sound.midi.Patch;
829N/Aimport javax.sound.midi.Soundbank;
829N/Aimport javax.sound.sampled.AudioFormat;
829N/A
829N/A/**
829N/A * The model instrument class.
829N/A *
829N/A * <p>The main methods to override are:<br>
829N/A * getPerformer, getDirector, getChannelMixer.
829N/A *
829N/A * <p>Performers are used to define what voices which will
829N/A * playback when using the instrument.<br>
829N/A *
829N/A * ChannelMixer is used to add channel-wide processing
829N/A * on voices output or to define non-voice oriented instruments.<br>
829N/A *
829N/A * Director is used to change how the synthesizer
829N/A * chooses what performers to play on midi events.
829N/A *
829N/A * @author Karl Helgason
829N/A */
829N/Apublic abstract class ModelInstrument extends Instrument {
829N/A
829N/A protected ModelInstrument(Soundbank soundbank, Patch patch, String name,
829N/A Class<?> dataClass) {
829N/A super(soundbank, patch, name, dataClass);
829N/A }
829N/A
829N/A public ModelDirector getDirector(ModelPerformer[] performers,
829N/A MidiChannel channel, ModelDirectedPlayer player) {
2713N/A return new ModelStandardIndexedDirector(performers, player);
829N/A }
829N/A
829N/A public ModelPerformer[] getPerformers() {
829N/A return new ModelPerformer[0];
829N/A }
829N/A
829N/A public ModelChannelMixer getChannelMixer(MidiChannel channel,
829N/A AudioFormat format) {
829N/A return null;
829N/A }
829N/A
829N/A // Get General MIDI 2 Alias patch for this instrument.
6321N/A public final Patch getPatchAlias() {
829N/A Patch patch = getPatch();
829N/A int program = patch.getProgram();
829N/A int bank = patch.getBank();
829N/A if (bank != 0)
829N/A return patch;
829N/A boolean percussion = false;
829N/A if (getPatch() instanceof ModelPatch)
829N/A percussion = ((ModelPatch)getPatch()).isPercussion();
829N/A if (percussion)
829N/A return new Patch(0x78 << 7, program);
829N/A else
829N/A return new Patch(0x79 << 7, program);
829N/A }
829N/A
829N/A // Return name of all the keys.
829N/A // This information is generated from ModelPerformer.getName()
829N/A // returned from getPerformers().
6321N/A public final String[] getKeys() {
829N/A String[] keys = new String[128];
829N/A for (ModelPerformer performer : getPerformers()) {
829N/A for (int k = performer.getKeyFrom(); k <= performer.getKeyTo(); k++) {
829N/A if (k >= 0 && k < 128 && keys[k] == null) {
829N/A String name = performer.getName();
829N/A if (name == null)
829N/A name = "untitled";
829N/A keys[k] = name;
829N/A }
829N/A }
829N/A }
829N/A return keys;
829N/A }
829N/A
829N/A // Return what channels this instrument will probably response
829N/A // on General MIDI synthesizer.
6321N/A public final boolean[] getChannels() {
829N/A boolean percussion = false;
829N/A if (getPatch() instanceof ModelPatch)
829N/A percussion = ((ModelPatch)getPatch()).isPercussion();
829N/A
829N/A // Check if instrument is percussion.
829N/A if (percussion) {
829N/A boolean[] ch = new boolean[16];
829N/A for (int i = 0; i < ch.length; i++)
829N/A ch[i] = false;
829N/A ch[9] = true;
829N/A return ch;
829N/A }
829N/A
829N/A // Check if instrument uses General MIDI 2 default banks.
829N/A int bank = getPatch().getBank();
829N/A if (bank >> 7 == 0x78 || bank >> 7 == 0x79) {
829N/A boolean[] ch = new boolean[16];
829N/A for (int i = 0; i < ch.length; i++)
829N/A ch[i] = true;
829N/A return ch;
829N/A }
829N/A
829N/A boolean[] ch = new boolean[16];
829N/A for (int i = 0; i < ch.length; i++)
829N/A ch[i] = true;
829N/A ch[9] = false;
829N/A return ch;
829N/A }
829N/A}