// qsamplerChannel.h
//
/****************************************************************************
   Copyright (C) 2003-2004, rncbc aka Rui Nuno Capela. All rights reserved.

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public License
   as published by the Free Software Foundation; either version 2
   of the License, or (at your option) any later version.

   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 General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

*****************************************************************************/

#ifndef __qsamplerChannel_h
#define __qsamplerChannel_h

#include <qobject.h>

#include <lscp/client.h>
#include <lscp/device.h>

#include "qsamplerOptions.h"

class qsamplerMainForm;


//-------------------------------------------------------------------------
// qsamplerChannel - Sampler channel structure.
//

class qsamplerChannel
{
public:

    // Constructor.
    qsamplerChannel(qsamplerMainForm *pMainForm, int iChannelID = -1);
    // Default destructor.
    ~qsamplerChannel();

    // Main application options accessor.
    qsamplerOptions *options();

    // LSCP client descriptor accessor.
    lscp_client_t * client();

    // Add/remove sampler channel methods.
    bool     addChannel();
    bool     removeChannel();

    // Sampler channel ID accessors.
    int      channelID();
    void     setChannelID(int iChannelID);
    
    // Readable channel name.
    QString  channelName();

    // Engine name property.
    QString& engineName();
    bool     loadEngine(const QString& sEngineName);
    
    // Instrument file and index.
    QString& instrumentFile();
    int      instrumentNr();
    int      instrumentStatus();
    bool     loadInstrument(const QString& sInstrumentFile, int iInstrumentNr);
    
    // MIDI input driver (DEPRECATED).
    QString& midiDriver();
    bool     setMidiDriver(const QString& sMidiDriver);
    
    // MIDI input device.
    int      midiDevice();
    bool     setMidiDevice(int iMidiDevice);
    
    // MIDI input port.
    int      midiPort();
    bool     setMidiPort(int iMidiPort);
    
    // MIDI input channel.
    int      midiChannel();
    bool     setMidiChannel(int iMidiChannel);
    
    // Audio output driver (DEPRECATED).
    QString& audioDriver();
    bool     setAudioDriver(const QString& sAudioDriver);

    // Audio output device.
    int      audioDevice();
    bool     setAudioDevice(int iAudioDevice);
    
    // Sampler channel volume.
    float    volume();
    bool     setVolume(float fVolume);

    // Channel info structure map executive.
    bool updateChannelInfo();

    // Reset channel method.
    bool resetChannel();

    // Message logging methods (brainlessly mapped to main form's).
    void appendMessages       (const QString & s);
    void appendMessagesColor  (const QString & s, const QString & c);
    void appendMessagesText   (const QString & s);
    void appendMessagesError  (const QString & s);
    void appendMessagesClient (const QString & s);

    // Retrieve the available instrument name(s) of an instrument file (.gig).
    static QString     getInstrumentName (const QString& sInstrumentFile, int iInstrumentNr);
    static QStringList getInstrumentList (const QString& sInstrumentFile);

private:

    // Main application form reference.
    qsamplerMainForm *m_pMainForm;

    // Unique channel identifier.
    int     m_iChannelID;

    // Sampler channel info map.
    QString m_sEngineName;
    QString m_sInstrumentFile;
    int     m_iInstrumentNr;
    int     m_iInstrumentStatus;
    QString m_sMidiDriver;          // DEPRECATED.
    int     m_iMidiDevice;
    int     m_iMidiPort;
    int     m_iMidiChannel;
    QString m_sAudioDriver;         // DEPRECATED.
    int     m_iAudioDevice;
    float   m_fVolume;
};

#endif  // __qsamplerChannel_h


// end of qsamplerChannel.h