/***************************************************************************
 *   Copyright (C) 2013-2014 by Tomasz Bojczuk                             *
 *   tomaszbojczuk@gmail.com                                               *
 *                                                                         *
 *   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 3 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, see <http://www.gnu.org/licenses/>.  *
 ***************************************************************************/


#ifndef TABSTRACTPLAYER_H
#define TABSTRACTPLAYER_H

#include <QObject>
#include <nootkasoundglobal.h>

class QTimer;


/** 
 * Base abstract class for sound output (playing scale). 
 */
class NOOTKASOUND_EXPORT TabstractPlayer : public QObject
{

  Q_OBJECT
  
public:
    TabstractPlayer(QObject *parent = 0);
    
    bool isPlayable() { return playable; }
    
        /** Starts playing given note and then returns true, otherwise gets false. */
    virtual bool play(int noteNr);
    virtual void stop(); /** Immediately stops playing. Emits nothing */
    virtual void deleteMidi(); /**Does nothing in audio player subclass. */
    virtual void setMidiParams();
    
    enum EplayerType { e_audio, e_midi };
    
    EplayerType type() { return playerType; }
    
signals:
  void noteFinished(); /** This signal is emitted when playing of a note is finished. */
    
  
protected:
    void setType(EplayerType type) { playerType = type; }
    bool          playable;
		
        /** Determines whether noteFinished() signal is emited in offTimer timeOut() slot.
         * Slot is also called by stop() method and then signal can't be emited. */
    bool          doEmit;
    QTimer        *offTimer;
    EplayerType   playerType;
    
};

#endif // TABSTRACTPLAYER_H
