org/jsampler/CC.java

/*
 *   JSampler - a java front-end for LinuxSampler
 *
 *   Copyright (C) 2005-2007 Grigor Iliev <grigor@grigoriliev.com>
 *
 *   This file is part of JSampler.
 *
 *   JSampler is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License version 2
 *   as published by the Free Software Foundation.
 *
 *   JSampler 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 General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with JSampler; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *   MA  02111-1307  USA
 */

package org.jsampler;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.InputStream;

import java.util.Vector;

import java.util.logging.Handler;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.logging.SimpleFormatter;
import java.util.logging.StreamHandler;

import javax.swing.Timer;

import net.sf.juife.Task;
import net.sf.juife.TaskQueue;

import net.sf.juife.event.TaskEvent;
import net.sf.juife.event.TaskListener;
import net.sf.juife.event.TaskQueueEvent;
import net.sf.juife.event.TaskQueueListener;

import org.jsampler.event.ListEvent;
import org.jsampler.event.ListListener;
import org.jsampler.event.OrchestraEvent;
import org.jsampler.event.OrchestraListener;

import org.jsampler.task.*;

import org.jsampler.view.JSMainFrame;
import org.jsampler.view.JSProgress;
import org.jsampler.view.JSViewConfig;
import org.jsampler.view.InstrumentsDbTreeModel;

import org.linuxsampler.lscp.AudioOutputChannel;
import org.linuxsampler.lscp.AudioOutputDevice;
import org.linuxsampler.lscp.Client;
import org.linuxsampler.lscp.FxSend;
import org.linuxsampler.lscp.MidiInputDevice;
import org.linuxsampler.lscp.MidiPort;
import org.linuxsampler.lscp.Parameter;
import org.linuxsampler.lscp.SamplerChannel;

import org.linuxsampler.lscp.event.*;

import org.w3c.dom.Document;
import org.w3c.dom.Node;

import static org.jsampler.JSI18n.i18n;


/**
 * This class serves as a 'Control Center' of the application.
 * It also provides some fundamental routines and access to most used objects.
 * @author Grigor Iliev
 */
public class CC {
        private static Handler handler;
        private static FileOutputStream fos;
        
        private static JSViewConfig viewConfig = null;
        private static JSMainFrame mainFrame = null;
        private static JSProgress progress = null;
        
        private final static Client lsClient = new Client();
        
        private static String jSamplerHome = null;
        
        private final static TaskQueue taskQueue = new TaskQueue();
        private final static Timer timer = new Timer(2000, null);
        
        /** Forbits the instantiation of this class. */
        private
        CC() { }
        
        /**
         * Returns the logger to be used for logging events.
         * @return The logger to be used for logging events.
         */
        public static Logger
        getLogger() {
                return Logger.getLogger (
                        "org.jsampler",
                        "org.jsampler.langprops.LogsBundle"
                );
        }
        
        /**
         * Returns the task queue to be used for scheduling tasks
         * for execution out of the event-dispatching thread.
         * @return The task queue to be used for scheduling tasks
         * for execution out of the event-dispatching thread.
         */
        public static TaskQueue
        getTaskQueue() { return taskQueue; }
        
        /**
         * Adds the specified task to the task queue. All task in the
         * queue equal to the specified task are removed from the queue.
         */
        public static void
        scheduleTask(Task t) {
                while(getTaskQueue().removeTask(t)) { }
                
                if(getTaskQueue().getPendingTaskCount() == 0) {
                        if(t.equals(getTaskQueue().getRunningTask())) return;
                }
                
                getTaskQueue().add(t);
        }
        
        /**
         * Gets the configuration of the current view.
         */
        public static JSViewConfig
        getViewConfig() { return viewConfig; }
        
        /**
         * Sets the configuration of the current view.
         */
        public static void
        setViewConfig(JSViewConfig viewConfig) { CC.viewConfig = viewConfig; }
        
        /**
         * Returns the main window of this application.
         * @return The main window of this application.
         */
        public static JSMainFrame
        getMainFrame() { return mainFrame; }
        
        /**
         * Sets the main window of this application.
         * @param mainFrame The main window of this application.
         */
        public static void
        setMainFrame(JSMainFrame mainFrame) { CC.mainFrame = mainFrame; }
        
        /**
         * Gets the progress indicator of this application.
         * @return The progress indicator of this application.
         */
        public static JSProgress
        getProgressIndicator() { return progress; }
        
        /**
         * Sets the progress indicator to be used by this application.
         * @param progress The progress indicator to be used by this application.
         */
        public static void
        setProgressIndicator(JSProgress progress) { CC.progress = progress; }
        
        /**
         * Gets the absolute path to the JSampler's home location.
         * @return The absolute path to the JSampler's home location
         * or <code>null</code> if the JSampler's home location is not specified yet.
         */
        public static String
        getJSamplerHome() { return jSamplerHome; }
        
        /**
         * Sets the location of the JSampler's home.
         * @param path The new absolute path to the JSampler's home location.
         */
        public static void
        setJSamplerHome(String path) {
                jSamplerHome = path;
                Prefs.setJSamplerHome(jSamplerHome);
        }
        
        /**
         * This method does the initial preparation of the application.
         */
        protected static void
        initJSampler() {
                fos = null;
                setJSamplerHome(Prefs.getJSamplerHome());
                String s = getJSamplerHome();
                try {
                        if(s != null) {
                                s += File.separator + "jsampler.log";
                                File f = new File(s);
                                if(f.isFile()) HF.createBackup("jsampler.log", "jsampler.log.0");
                                fos = new FileOutputStream(s);
                        }
                } catch(Exception x) { x.printStackTrace(); }
                
                if(fos == null) handler = new StreamHandler(System.out, new SimpleFormatter());
                else handler = new StreamHandler(fos, new SimpleFormatter());
                
                handler.setLevel(Level.FINE);
                getLogger().addHandler(handler);
                getLogger().setLevel(Level.FINE);
                Logger.getLogger("org.linuxsampler.lscp").setLevel(Level.FINE);
                Logger.getLogger("org.linuxsampler.lscp").addHandler(handler);
                
                // Flushing logs on every second
                new java.util.Timer().schedule(new java.util.TimerTask() {
                        public void
                        run() { if(handler != null) handler.flush(); }
                }, 1000, 1000);
                
                CC.getLogger().fine("CC.jsStarted");
                
                HF.setUIDefaultFont(Prefs.getInterfaceFont());
                
                getClient().setServerAddress(Prefs.getLSAddress());
                getClient().setServerPort(Prefs.getLSPort());
                
                timer.setRepeats(false);
                
                timer.addActionListener(new ActionListener() {
                        public void
                        actionPerformed(ActionEvent e) { CC.getProgressIndicator().start(); }
                });
                
                taskQueue.addTaskQueueListener(getHandler());
                
                taskQueue.start();
                
                getClient().removeChannelCountListener(getHandler());
                getClient().addChannelCountListener(getHandler());
                
                getClient().removeChannelInfoListener(getHandler());
                getClient().addChannelInfoListener(getHandler());
                
                getClient().removeFxSendCountListener(getHandler());
                getClient().addFxSendCountListener(getHandler());
                
                getClient().removeFxSendInfoListener(getHandler());
                getClient().addFxSendInfoListener(getHandler());
                
                getClient().removeStreamCountListener(getHandler());
                getClient().addStreamCountListener(getHandler());
                
                getClient().removeVoiceCountListener(getHandler());
                getClient().addVoiceCountListener(getHandler());
                
                getClient().removeTotalVoiceCountListener(getHandler());
                getClient().addTotalVoiceCountListener(getHandler());
                
                getClient().removeAudioDeviceCountListener(audioDeviceCountListener);
                getClient().addAudioDeviceCountListener(audioDeviceCountListener);
                
                getClient().removeAudioDeviceInfoListener(audioDeviceInfoListener);
                getClient().addAudioDeviceInfoListener(audioDeviceInfoListener);
                
                getClient().removeMidiDeviceCountListener(midiDeviceCountListener);
                getClient().addMidiDeviceCountListener(midiDeviceCountListener);
                
                getClient().removeMidiDeviceInfoListener(midiDeviceInfoListener);
                getClient().addMidiDeviceInfoListener(midiDeviceInfoListener);
                
                getClient().removeMidiInstrumentMapCountListener(midiInstrMapCountListener);
                getClient().addMidiInstrumentMapCountListener(midiInstrMapCountListener);
                
                getClient().removeMidiInstrumentMapInfoListener(midiInstrMapInfoListener);
                getClient().addMidiInstrumentMapInfoListener(midiInstrMapInfoListener);
                
                getClient().removeMidiInstrumentCountListener(getHandler());
                getClient().addMidiInstrumentCountListener(getHandler());
                
                getClient().removeMidiInstrumentInfoListener(getHandler());
                getClient().addMidiInstrumentInfoListener(getHandler());
                
                getClient().removeGlobalInfoListener(getHandler());
                getClient().addGlobalInfoListener(getHandler());
        }
        
        /**
         * Checks whether the JSampler home directory is specified and exist.
         * If the JSampler home directory is not specifed, or is specified
         * but doesn't exist, a procedure of specifying a JSampler home
         * directory is initiated.
         * @see org.jsampler.view.JSMainFrame#installJSamplerHome
         */
        public static void
        checkJSamplerHome() {
                if(getJSamplerHome() != null) {
                        File f = new File(getJSamplerHome());
                        if(f.exists() && f.isDirectory()) {
                                return;
                        }
                }
                
                CC.getMainFrame().installJSamplerHome();
        }
        
        /**
         * Changes the JSampler's home directory and moves all files from
         * the old JSampler's home directory to the new one. If all files are
         * moved succesfully, the old directory is deleted.
         * @param path The location of the new JSampler's home directory. If
         * the last directory in the path doesn't exist, it is created.
         */
        public static void
        changeJSamplerHome(String path) {
                File fNew = new File(path);
                if(fNew.exists() && fNew.isFile()) {
                        HF.showErrorMessage(i18n.getError("CC.JSamplerHomeIsNotDir!"));
                        return;
                }
                
                if(!fNew.exists()) {
                        if(!fNew.mkdir()) {
                                String s = fNew.getAbsolutePath();
                                HF.showErrorMessage(i18n.getError("CC.mkdirFailed", s));
                                return;
                        }
                }
                
                if(getJSamplerHome() == null || path.equals(getJSamplerHome())) {
                        setJSamplerHome(fNew.getAbsolutePath());
                        return;
                }
                
                File fOld = new File(getJSamplerHome());
                if(!fOld.exists() || !fOld.isDirectory()) {
                        setJSamplerHome(fNew.getAbsolutePath());
                        return;
                }
                
                File[] files = fOld.listFiles();
                boolean b = true;
                if(files != null) {
                        String s = fNew.getAbsolutePath() + File.separator;
                        for(File f : files) if(!f.renameTo(new File(s + f.getName()))) b = false;
                }
                
                if(b) fOld.delete();
                setJSamplerHome(fNew.getAbsolutePath());
        }
        
        private final static OrchestraListModel orchestras = new DefaultOrchestraListModel();
        
        /**
         * Returns a list containing all available orchestras.
         * @return A list containing all available orchestras.
         */
        public static OrchestraListModel
        getOrchestras() { return orchestras; }
        
        private static InstrumentsDbTreeModel instrumentsDbTreeModel = null;
        /**
         * Gets the tree model of the instruments database.
         * If the currently used view doesn't have instruments
         * database support the tree model is initialized on first use.
         * @return The tree model of the instruments database or
         * <code>null</code> if the backend doesn't have instruments database support.
         * @see org.jsampler.view.JSViewConfig#getInstrumentsDbSupport
         */
        public static InstrumentsDbTreeModel
        getInstrumentsDbTreeModel() {
                if(!CC.getSamplerModel().getServerInfo().hasInstrumentsDbSupport()) return null;
                
                if(instrumentsDbTreeModel == null) {
                        instrumentsDbTreeModel = new InstrumentsDbTreeModel();
                }
                
                return instrumentsDbTreeModel;
        }
        
        /**
         * Loads the orchestras described in <code>&lt;jsampler_home&gt;/orchestras.xml</code>.
         * If file with name <code>orchestras.xml.bkp</code> exist in the JSampler's home
         * directory, this means that the last save has failed. In that case a recovery file
         * <code>orchestras.xml.rec</code> is created and a recovery procedure
         * will be initiated.
         */
        public static void
        loadOrchestras() {
                if(getJSamplerHome() == null) return;
                
                try {
                        String s = getJSamplerHome();
                        if(s == null) return;
                        getOrchestras().addOrchestraListListener(getHandler());
                        
                        File f = new File(s + File.separator + "orchestras.xml.bkp");
                        if(f.isFile()) HF.createBackup("orchestras.xml.bkp", "orchestras.xml.rec");
                        
                        FileInputStream fis;
                        fis = new FileInputStream(s + File.separator + "orchestras.xml");
                        
                        loadOrchestras(fis);
                        fis.close();
                } catch(Exception x) {
                        getLogger().log(Level.INFO, HF.getErrorMessage(x), x);
                }
        }
        
        
        private static void
        loadOrchestras(InputStream in) {
                Document doc = DOMUtils.readObject(in);
                
                try { getOrchestras().readObject(doc.getDocumentElement()); }
                catch(Exception x) {
                        HF.showErrorMessage(x, "Loading orchestras: ");
                        return;
                }
                
                for(int i = 0; i < getOrchestras().getOrchestraCount(); i++) {
                        getOrchestras().getOrchestra(i).addOrchestraListener(getHandler());
                }
        }
        
        private static void
        saveOrchestras() {
                try {
                        String s = getJSamplerHome();
                        if(s == null) return;
                        
                        HF.createBackup("orchestras.xml", "orchestras.xml.bkp");
                        
                        FileOutputStream fos;
                        fos = new FileOutputStream(s + File.separator + "orchestras.xml", false);
                        
                        Document doc = DOMUtils.createEmptyDocument();
                
                        Node node = doc.createElement("temp");
                        doc.appendChild(node);
                        
                        getOrchestras().writeObject(doc, doc.getDocumentElement());
                        
                        doc.replaceChild(node.getFirstChild(), node);
                
                        DOMUtils.writeObject(doc, fos);
                        
                        fos.close();
                        
                        HF.deleteFile("orchestras.xml.bkp");
                } catch(Exception x) {
                        HF.showErrorMessage(x, "Saving orchestras: ");
                        return;
                }
        }
        
        /**
         * The exit point of the application which ensures clean exit with default exit status 0.
         *  @see #cleanExit(int i)
         */
        public static void
        cleanExit() { cleanExit(0); }
        
        /**
         * The exit point of the application which ensures clean exit.
         * @param i The exit status.
         */
        public static void
        cleanExit(int i) {
                CC.getLogger().fine("CC.jsEnded");
                System.exit(i);
        }
        
        /**
         * Gets the <code>Client</code> object that is used to communicate with the backend.
         * @return The <code>Client</code> object that is used to communicate with the backend.
         */
        public static Client
        getClient() { return lsClient; }
        
        private static final Vector<ActionListener> listeners = new Vector<ActionListener>();
        
        /**
         * Registers the specified listener to be notified when reconnecting to LinuxSampler.
         * @param l The <code>ActionListener</code> to register.
         */
        public static void
        addReconnectListener(ActionListener l) { listeners.add(l); }
        
        /**
         * Removes the specified listener.
         * @param l The <code>ActionListener</code> to remove.
         */
        public static void
        removeReconnectListener(ActionListener l) { listeners.remove(l); }
        
        private static void
        fireReconnectEvent() {
                ActionEvent e = new ActionEvent(CC.class, ActionEvent.ACTION_PERFORMED, null);
                for(ActionListener l : listeners) l.actionPerformed(e);
        }
        
        private static final SamplerModel samplerModel = new DefaultSamplerModel();
        
        /**
         * Gets the sampler model.
         * @return The sampler model.
         */
        public static SamplerModel
        getSamplerModel() { return samplerModel; }
        
        /**
         * Reconnects to LinuxSampler.
         */
        public static void
        reconnect() {
                initSamplerModel();
                fireReconnectEvent();
        }
        
        /**
         * This method updates the information about the backend state.
         */
        public static void
        initSamplerModel() {
                final DefaultSamplerModel model = (DefaultSamplerModel)getSamplerModel();
                
                final Global.GetServerInfo gsi = new Global.GetServerInfo();
                gsi.addTaskListener(new TaskListener() {
                        public void
                        taskPerformed(TaskEvent e) {
                                if(gsi.doneWithErrors()) return;
                                
                                model.setServerInfo(gsi.getResult());
                                
                                if(CC.getViewConfig().getInstrumentsDbSupport()) {
                                        getInstrumentsDbTreeModel();
                                }
                        }
                });
                
                final Audio.GetDrivers gaod = new Audio.GetDrivers();
                gaod.addTaskListener(new TaskListener() {
                        public void
                        taskPerformed(TaskEvent e) {
                                if(!gaod.doneWithErrors())
                                        model.setAudioOutputDrivers(gaod.getResult());
                        }
                });
                
                final GetEngines ge = new GetEngines();
                ge.addTaskListener(new TaskListener() {
                        public void
                        taskPerformed(TaskEvent e) {
                                if(!ge.doneWithErrors()) model.setEngines(ge.getResult());
                        }
                });
                
                final Midi.GetDrivers gmid = new Midi.GetDrivers();
                gmid.addTaskListener(new TaskListener() {
                        public void
                        taskPerformed(TaskEvent e) {
                                if(!gmid.doneWithErrors())
                                        model.setMidiInputDrivers(gmid.getResult());
                        }
                });
                
                final Global.GetVolume gv = new Global.GetVolume();
                gv.addTaskListener(new TaskListener() {
                        public void
                        taskPerformed(TaskEvent e) {
                                if(!gv.doneWithErrors())
                                        model.setVolume(gv.getResult());
                        }
                });
                
                final Midi.GetInstrumentMaps mgim = new Midi.GetInstrumentMaps();
                mgim.addTaskListener(new TaskListener() {
                        public void
                        taskPerformed(TaskEvent e) {
                                if(mgim.doneWithErrors()) return;
                                model.removeAllMidiInstrumentMaps();
                                
                                for(MidiInstrumentMap map : mgim.getResult()) {
                                        model.addMidiInstrumentMap(map);
                                }
                        }
                });
                
                final UpdateChannels uc = new UpdateChannels();
                uc.addTaskListener(new TaskListener() {
                        public void
                        taskPerformed(TaskEvent e) {
                                for(SamplerChannelModel c : model.getChannels()) {
                                        if(c.getChannelInfo().getEngine() == null) continue;
                                        
                                        Channel.GetFxSends gfs = new Channel.GetFxSends();
                                        gfs.setChannel(c.getChannelId());
                                        gfs.addTaskListener(new GetFxSendsListener());
                                        getTaskQueue().add(gfs);
                                }
                        }
                });
                
                
                final Connect cnt = new Connect();
                cnt.addTaskListener(new TaskListener() {
                        public void
                        taskPerformed(TaskEvent e) {
                                if(cnt.doneWithErrors()) return;
                                
                                getTaskQueue().add(gsi);
                                getTaskQueue().add(gaod);
                                getTaskQueue().add(gmid);
                                getTaskQueue().add(ge);
                                getTaskQueue().add(gv);
                                getTaskQueue().add(mgim);
                                getTaskQueue().add(new Midi.UpdateDevices());
                                getTaskQueue().add(new Audio.UpdateDevices());
                                getTaskQueue().add(uc);
                        }
                });
                getTaskQueue().add(cnt);
        }
        
        private static class GetFxSendsListener implements TaskListener {
                public void
                taskPerformed(TaskEvent e) {
                        Channel.GetFxSends gfs = (Channel.GetFxSends)e.getSource();
                        if(gfs.doneWithErrors()) return;
                        SamplerChannelModel m = getSamplerModel().getChannelById(gfs.getChannel());
                        m.removeAllFxSends();
                        
                        for(FxSend fxs : gfs.getResult()) m.addFxSend(fxs);
                }
        }
        
        public static String
        exportInstrMapsToLscpScript() {
                StringBuffer sb = new StringBuffer("# Exported by: ");
                sb.append("JSampler - a java front-end for LinuxSampler\r\n# Version: ");
                sb.append(JSampler.VERSION).append("\r\n");
                sb.append("# Date: ").append(new java.util.Date().toString()).append("\r\n\r\n");
                
                Client lscpClient = new Client(true);
                ByteArrayOutputStream out = new ByteArrayOutputStream();
                lscpClient.setPrintOnlyModeOutputStream(out);
                
                exportInstrMapsToLscpScript(lscpClient);
                sb.append(out.toString());
                out.reset();
                
                return sb.toString();
        }
        
        private static void
        exportInstrMapsToLscpScript(Client lscpClient) {
                try {
                        lscpClient.removeAllMidiInstrumentMaps();
                        MidiInstrumentMap[] maps = CC.getSamplerModel().getMidiInstrumentMaps();
                        for(int i = 0; i < maps.length; i++) {
                                lscpClient.addMidiInstrumentMap(maps[i].getName());
                                exportInstrumentsToLscpScript(i, maps[i], lscpClient);
                        }
                } catch(Exception e) {
                        CC.getLogger().log(Level.FINE, HF.getErrorMessage(e), e);
                        HF.showErrorMessage(e);
                }
        }
        
        private static void
        exportInstrumentsToLscpScript(int mapId, MidiInstrumentMap map, Client lscpClient)
                                                                                throws Exception {
        
                for(MidiInstrument i : map.getAllMidiInstruments()) {
                        lscpClient.mapMidiInstrument(mapId, i.getInfo().getEntry(), i.getInfo());
                }
        }
        
        public static String
        exportSessionToLscpScript() {
                StringBuffer sb = new StringBuffer("# Exported by: ");
                sb.append("JSampler - a java front-end for LinuxSampler\r\n# Version: ");
                sb.append(JSampler.VERSION).append("\r\n");
                sb.append("# Date: ").append(new java.util.Date().toString()).append("\r\n\r\n");
                
                Client lscpClient = new Client(true);
                ByteArrayOutputStream out = new ByteArrayOutputStream();
                lscpClient.setPrintOnlyModeOutputStream(out);
                
                try {
                        lscpClient.resetSampler();
                        sb.append(out.toString());
                        out.reset();
                        sb.append("\r\n");
                        lscpClient.setVolume(CC.getSamplerModel().getVolume());
                        sb.append(out.toString());
                        out.reset();
                        sb.append("\r\n");
                } catch(Exception e) { CC.getLogger().log(Level.FINE, HF.getErrorMessage(e), e); }
                                
                MidiDeviceModel[] mDevs = getSamplerModel().getMidiDevices();
                for(int i = 0; i < mDevs.length; i++) {
                        exportMidiDeviceToLscpScript(mDevs[i].getDeviceInfo(), i, lscpClient);
                        sb.append(out.toString());
                        out.reset();
                        sb.append("\r\n");
                }
                
                AudioDeviceModel[] aDevs = getSamplerModel().getAudioDevices();
                for(int i = 0; i < aDevs.length; i++) {
                        exportAudioDeviceToLscpScript(aDevs[i].getDeviceInfo(), i, lscpClient);
                        sb.append(out.toString());
                        out.reset();
                        sb.append("\r\n");
                }
                
                SamplerChannelModel[] channels = getSamplerModel().getChannels();
                
                for(int i = 0; i < channels.length; i++) {
                        SamplerChannelModel scm = channels[i];
                        exportChannelToLscpScript(scm.getChannelInfo(), i, lscpClient);
                        sb.append(out.toString());
                        out.reset();
                        
                        sb.append("\r\n");
                        
                        exportFxSendsToLscpScript(scm, i, lscpClient);
                        sb.append(out.toString());
                        out.reset();
                        
                        sb.append("\r\n");
                }
                
                exportInstrMapsToLscpScript(lscpClient);
                sb.append(out.toString());
                out.reset();
                
                return sb.toString();
        }
        
        private static void
        exportMidiDeviceToLscpScript(MidiInputDevice mid, int devId, Client lscpCLient) {
                try {
                        String s = mid.getDriverName();
                        lscpCLient.createMidiInputDevice(s, mid.getAdditionalParameters());
                        
                        MidiPort[] mPorts = mid.getMidiPorts();
                        int l = mPorts.length;
                        if(l != 1) lscpCLient.setMidiInputPortCount(devId, l);
                        
                        for(int i = 0; i < l; i++) {
                                Parameter[] prms = mPorts[i].getAllParameters();
                                for(Parameter p : prms) {
                                        if(!p.isFixed() && p.getStringValue().length() > 0)
                                                lscpCLient.setMidiInputPortParameter(devId, i, p);
                                }
                        }
                } catch(Exception e) {
                        CC.getLogger().log(Level.FINE, HF.getErrorMessage(e), e);
                }
        }
        
        private static void
        exportAudioDeviceToLscpScript(AudioOutputDevice aod, int devId, Client lscpCLient) {
                try {
                        String s = aod.getDriverName();
                        lscpCLient.createAudioOutputDevice(s, aod.getAllParameters());
                        
                        AudioOutputChannel[] chns = aod.getAudioChannels();
                        
                        for(int i = 0; i < chns.length; i++) {
                                Parameter[] prms = chns[i].getAllParameters();
                                for(Parameter p : prms) {
                                        if(p.isFixed() || p.getStringValue().length() == 0);
                                        else lscpCLient.setAudioOutputChannelParameter(devId, i, p);
                                }
                        }
                } catch(Exception e) {
                        CC.getLogger().log(Level.FINE, HF.getErrorMessage(e), e);
                }
        }
        
        private static void
        exportChannelToLscpScript(SamplerChannel chn, int chnId, Client lscpCLient) {
                try {
                        lscpCLient.addSamplerChannel();
                        
                        SamplerModel sm = CC.getSamplerModel();
                        int id = chn.getMidiInputDevice();
                        if(id != -1) {
                                for(int i = 0; i < sm.getMidiDeviceCount(); i++) {
                                        if(sm.getMidiDevice(i).getDeviceId() == id) {
                                                lscpCLient.setChannelMidiInputDevice(chnId, i);
                                                break;
                                        }
                                }
                        }
                        lscpCLient.setChannelMidiInputPort(chnId, chn.getMidiInputPort());
                        lscpCLient.setChannelMidiInputChannel(chnId, chn.getMidiInputChannel());
                        
                        id = chn.getAudioOutputDevice();
                        if(id != -1) {
                                for(int i = 0; i < sm.getAudioDeviceCount(); i++) {
                                        if(sm.getAudioDevice(i).getDeviceId() == id) {
                                                lscpCLient.setChannelAudioOutputDevice(chnId, i);
                                                break;
                                        }
                                }
                                
                                Integer[] routing = chn.getAudioOutputRouting();
                                
                                for(int j = 0; j < routing.length; j++) {
                                        int k = routing[j];
                                        if(k == j) continue;
                                        
                                        lscpCLient.setChannelAudioOutputChannel(chnId, j, k);
                                }
                        }
                        
                        if(chn.getEngine() != null) {
                                lscpCLient.loadSamplerEngine(chn.getEngine().getName(), chnId);
                                lscpCLient.setChannelVolume(chnId, chn.getVolume());
                        }
                        
                        String s = chn.getInstrumentFile();
                        int i = chn.getInstrumentIndex();
                        if(s != null) lscpCLient.loadInstrument(s, i, chnId, true);
                        
                        if(chn.isMuted()) lscpCLient.setChannelMute(chnId, true);
                        if(chn.isSoloChannel()) lscpCLient.setChannelSolo(chnId, true);
                } catch(Exception e) {
                        CC.getLogger().log(Level.FINE, HF.getErrorMessage(e), e);
                }
        }
        
        private static void
        exportFxSendsToLscpScript(SamplerChannelModel scm, int chnId, Client lscpClient) {
                try {
                        FxSend[] fxSends = scm.getFxSends();
                        
                        for(int i = 0; i < fxSends.length; i++) {
                                FxSend f = fxSends[i];
                                lscpClient.createFxSend(chnId, f.getMidiController(), f.getName());
                                
                                Integer[] r = f.getAudioOutputRouting();
                                for(int j = 0; j < r.length; j++) {
                                        lscpClient.setFxSendAudioOutputChannel(chnId, i, j, r[j]);
                                }
                        }
                } catch(Exception e) {
                        CC.getLogger().log(Level.FINE, HF.getErrorMessage(e), e);
                }
        }
        
        
        private final static EventHandler eventHandler = new EventHandler();
        
        private static EventHandler
        getHandler() { return eventHandler; }
        
        private static class EventHandler implements ChannelCountListener, ChannelInfoListener,
                FxSendCountListener, FxSendInfoListener, StreamCountListener, VoiceCountListener,
                TotalVoiceCountListener, TaskQueueListener, OrchestraListener,
                ListListener<OrchestraModel>, MidiInstrumentCountListener,
                MidiInstrumentInfoListener, GlobalInfoListener {
                
                /** Invoked when the number of channels has changed. */
                public void
                channelCountChanged( ChannelCountEvent e) {
                        getTaskQueue().add(new UpdateChannels());
                }
                
                /** Invoked when changes to the sampler channel has occured. */
                public void
                channelInfoChanged(ChannelInfoEvent e) {
                        /*
                         * Because of the rapid notification flow when instrument is loaded
                         * we need to do some optimization to decrease the traffic.
                         */
                        boolean b = true;
                        Task[] tS = getTaskQueue().getPendingTasks();
                        
                        for(int i = tS.length - 1; i >= 0; i--) {
                                Task t = tS[i];
                                
                                if(t instanceof Channel.UpdateInfo) {
                                        Channel.UpdateInfo cui = (Channel.UpdateInfo)t;
                                        if(cui.getChannelId() == e.getSamplerChannel()) return;
                                } else {
                                        b = false;
                                        break;
                                }
                        }
                        
                        if(b) {
                                Task t = getTaskQueue().getRunningTask();
                                if(t instanceof Channel.UpdateInfo) {
                                        Channel.UpdateInfo cui = (Channel.UpdateInfo)t;
                                        if(cui.getChannelId() == e.getSamplerChannel()) return;
                                }
                        }
                        
                        
                        getTaskQueue().add(new Channel.UpdateInfo(e.getSamplerChannel()));
                }
                
                /**
                 * Invoked when the number of effect sends
                 * on a particular sampler channel has changed.
                 */
                public void
                fxSendCountChanged(FxSendCountEvent e) {
                        getTaskQueue().add(new Channel.UpdateFxSends(e.getChannel()));
                }
                
                /**
                 * Invoked when the settings of an effect sends are changed.
                 */
                public void
                fxSendInfoChanged(FxSendInfoEvent e) {
                        Task t = new Channel.UpdateFxSendInfo(e.getChannel(), e.getFxSend());
                        getTaskQueue().add(t);
                }
                
                /**
                 * Invoked when the number of active disk
                 * streams in a specific sampler channel has changed.
                 */
                public void
                streamCountChanged(StreamCountEvent e) {
                        SamplerChannelModel scm = 
                                getSamplerModel().getChannelById(e.getSamplerChannel());
                        
                        if(scm == null) {
                                CC.getLogger().log (
                                        Level.WARNING,
                                        "CC.unknownChannel!",
                                        e.getSamplerChannel()
                                );
                                
                                return;
                        }
                        
                        scm.setStreamCount(e.getStreamCount());
                }
                
                /**
                 * Invoked when the number of active voices
                 * in a specific sampler channel has changed.
                 */
                public void
                voiceCountChanged(VoiceCountEvent e) {
                        SamplerChannelModel scm = 
                                getSamplerModel().getChannelById(e.getSamplerChannel());
                        
                        if(scm == null) {
                                CC.getLogger().log (
                                        Level.WARNING,
                                        "CC.unknownChannel!",
                                        e.getSamplerChannel()
                                );
                                
                                return;
                        }
                        
                        scm.setVoiceCount(e.getVoiceCount());
                }
                
                /** Invoked when the total number of active voices has changed. */
                public void
                totalVoiceCountChanged(TotalVoiceCountEvent e) {
                        getTaskQueue().add(new UpdateTotalVoiceCount());
                }
                
                /** Invoked when the number of MIDI instruments in a MIDI instrument map is changed. */
                public void
                instrumentCountChanged(MidiInstrumentCountEvent e) {
                        getTaskQueue().add(new Midi.UpdateInstruments(e.getMapId()));
                }
                
                /** Invoked when a MIDI instrument in a MIDI instrument map is changed. */
                public void
                instrumentInfoChanged(MidiInstrumentInfoEvent e) {
                        Task t = new Midi.UpdateInstrumentInfo (
                                e.getMapId(), e.getMidiBank(), e.getMidiProgram()
                        ); 
                        getTaskQueue().add(t);
                                
                }
                
                /** Invoked when the global volume of the sampler is changed. */
                public void
                volumeChanged(GlobalInfoEvent e) {
                        getSamplerModel().setVolume(e.getVolume());
                }
                
                /**
                 * Invoked to indicate that the state of a task queue is changed.
                 * This method is invoked only from the event-dispatching thread.
                 */
                public void
                stateChanged(TaskQueueEvent e) {
                        switch(e.getEventID()) {
                        case TASK_FETCHED:
                                getProgressIndicator().setString (
                                        ((Task)e.getSource()).getDescription()
                                );
                                break;
                        case TASK_DONE:
                                EnhancedTask t = (EnhancedTask)e.getSource();
                                if(t.doneWithErrors() && !t.isStopped()) {
                                        showError(t);
                                }
                                break;
                        case NOT_IDLE:
                                timer.start();
                                break;
                        case IDLE:
                                timer.stop();
                                getProgressIndicator().stop();
                                break;
                        }
                }
                
                private void
                showError(final Task t) {
                        javax.swing.SwingUtilities.invokeLater(new Runnable() {
                                public void
                                run() {
                                        if(t.getErrorDetails() == null) {
                                                HF.showErrorMessage(t.getErrorMessage());
                                        } else {
                                                getMainFrame().showDetailedErrorMessage (
                                                        getMainFrame(),
                                                        t.getErrorMessage(),
                                                        t.getErrorDetails()
                                                );
                                        }
                                }
                        });
                }
                
                /** Invoked when the name of orchestra is changed. */
                public void
                nameChanged(OrchestraEvent e) { saveOrchestras(); }
        
                /** Invoked when the description of orchestra is changed. */
                public void
                descriptionChanged(OrchestraEvent e) { saveOrchestras(); }
        
                /** Invoked when an instrument is added to the orchestra. */
                public void
                instrumentAdded(OrchestraEvent e) { saveOrchestras(); }
        
                /** Invoked when an instrument is removed from the orchestra. */
                public void
                instrumentRemoved(OrchestraEvent e) { saveOrchestras(); }
        
                /** Invoked when the settings of an instrument are changed. */
                public void
                instrumentChanged(OrchestraEvent e) { saveOrchestras(); }
                
                /** Invoked when an orchestra is added to the orchestra list. */
                public void
                entryAdded(ListEvent<OrchestraModel> e) {
                        e.getEntry().addOrchestraListener(getHandler());
                        saveOrchestras();
                }
        
                /** Invoked when an orchestra is removed from the orchestra list. */
                public void
                entryRemoved(ListEvent<OrchestraModel> e) {
                        e.getEntry().removeOrchestraListener(getHandler());
                        saveOrchestras();
                }
        }
        
        private static final AudioDeviceCountListener audioDeviceCountListener = 
                new AudioDeviceCountListener();
        
        private static class AudioDeviceCountListener implements ItemCountListener {
                /** Invoked when the number of audio output devices has changed. */
                public void
                itemCountChanged(ItemCountEvent e) {
                        getTaskQueue().add(new Audio.UpdateDevices());
                }
        }
        
        private static final AudioDeviceInfoListener audioDeviceInfoListener = 
                new AudioDeviceInfoListener();
        
        private static class AudioDeviceInfoListener implements ItemInfoListener {
                /** Invoked when the audio output device's settings are changed. */
                public void
                itemInfoChanged(ItemInfoEvent e) {
                        getTaskQueue().add(new Audio.UpdateDeviceInfo(e.getItemID()));
                }
        }
        
        private static final MidiDeviceCountListener midiDeviceCountListener = 
                new MidiDeviceCountListener();
        
        private static class MidiDeviceCountListener implements ItemCountListener {
                /** Invoked when the number of MIDI input devices has changed. */
                public void
                itemCountChanged(ItemCountEvent e) {
                        getTaskQueue().add(new Midi.UpdateDevices());
                }
        }
        
        private static final MidiDeviceInfoListener midiDeviceInfoListener = 
                new MidiDeviceInfoListener();
        
        private static class MidiDeviceInfoListener implements ItemInfoListener {
                /** Invoked when the MIDI input device's settings are changed. */
                public void
                itemInfoChanged(ItemInfoEvent e) {
                        getTaskQueue().add(new Midi.UpdateDeviceInfo(e.getItemID()));
                }
        }
        
        private static final MidiInstrMapCountListener midiInstrMapCountListener = 
                new MidiInstrMapCountListener();
        
        private static class MidiInstrMapCountListener implements ItemCountListener {
                /** Invoked when the number of MIDI instrument maps is changed. */
                public void
                itemCountChanged(ItemCountEvent e) {
                        getTaskQueue().add(new Midi.UpdateInstrumentMaps());
                }
        }
        
        private static final MidiInstrMapInfoListener midiInstrMapInfoListener = 
                new MidiInstrMapInfoListener();
        
        private static class MidiInstrMapInfoListener implements ItemInfoListener {
                /** Invoked when the MIDI instrument map's settings are changed. */
                public void
                itemInfoChanged(ItemInfoEvent e) {
                        getTaskQueue().add(new Midi.UpdateInstrumentMapInfo(e.getItemID()));
                }
        }
}