---

qwavwaveviewinterface.h

/***************************************************************************
                          waveview.h  -  description
                             -------------------
    begin                : Mon Nov 18 2002
    copyright            : (C) 2002 by Peter Eschler
    email                : eschler@users.sourceforge.net
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef QwavWAVEVIEWINTERFACE_H
#define QwavWAVEVIEWINTERFACE_H


//---------------------------------------------------------------------------
// Includes: Qt
//---------------------------------------------------------------------------

#include <qwidget.h>

//---------------------------------------------------------------------------
// Includes: system
//---------------------------------------------------------------------------

#include <vector>
#include <iostream>
#include <string>

//---------------------------------------------------------------------------
// Includes: project
//---------------------------------------------------------------------------

#include "qwavdefines.h"
#include "qwavexceptions.h"
#include "qwavwavedatainterface.h"

using namespace std;

Qwav_BEGIN_NAMESPACE

//---------------------------------------------------------------------------
// Forward declarations
//---------------------------------------------------------------------------

class QwavViewLayer;
class QwavSelection;
//class QwavWaveDataInterface;
class QwavPeakInterpolator;

//---------------------------------------------------------------------------
// Class: QwavWaveViewInterface
//---------------------------------------------------------------------------

class QWAV_EXPORTIMPORT QwavWaveViewInterface 
{
//     Q_OBJECT
//     Q_PROPERTY( QColor bgColor   READ bgColor   WRITE setBgColor   )
//     Q_PROPERTY( QColor peakColor READ peakColor WRITE setPeakColor )    
//     Q_PROPERTY( QColor avgColor  READ avgColor  WRITE setAvgColor  )

    friend class QwavMonoWaveView;
    friend class QwavStereoWaveView;
    
public:
    enum State {
                 NORMAL,  
                 MOVING_SEL_BEGIN,
                 MOVING_SEL_END,
                 MOVING_MARKER
               };
               
    /*---------------------------------------------------------------------*/
    virtual int              addLayer       (QwavViewLayer* layer) =0;

    virtual QwavViewLayer*   getLayer       (const string& name)   =0;   
    
    virtual QwavViewLayer*   getLayer       (uint index)           =0;
    
    virtual uint             getNrOfLayers  (void)         const   =0;
    
    virtual QPixmap*         getBackbuf     (void)                 =0;

    /*---------------------------------------------------------------------*/
    virtual int          sample2Pixel   (long  sample) const = 0;
    
    
    virtual long         pixel2Sample   (int   pixel)  const = 0;

    virtual bool         isSampleVisible(long sample)  const = 0;

    inline const long   nrOfSamples    (void)         const;
    
    virtual const int    nrOfPixels     (void)         const = 0;


    virtual double       zoomFac        (void)         const = 0;
    
    virtual double       zoomYFac       (void)         const = 0;
    
    virtual double       maxZoomFac     (void)         const = 0;  

    virtual const unsigned long firstSample(void)      const = 0;
    
    virtual const long   lastSample     (void)         const = 0;    
    
    virtual const long   samplesVisible (void)         const = 0;
  
    inline QwavWaveDataInterface* waveData (void)      const;
    
    inline void setWaveData(QwavWaveDataInterface* wd);
    
    virtual void setPeakInterpolator(QwavPeakInterpolator* s)= 0;
    
    virtual QwavPeakInterpolator* peakInterpolator() const   = 0;
    
    inline void setBorderDist(uint topBorder, uint bottomBorder);
    inline const uint& topBorderDist() const;
    inline const uint& bottomBorderDist() const ;    
    
    /*---------------------------------------------------------------------*/
    virtual void   setPosition(const ulong sample) = 0;
    
    virtual const ulong& position() const          = 0;

    /*---------------------------------------------------------------------*/
    virtual uint           addSelection     (const QwavSelection& s)= 0;
    
    virtual uint           getNrOfSelections(void)         const = 0;
    
    virtual const QwavSelection& getSelection(uint index=0)const = 0;
    
    virtual QwavSelection& getSelection     (uint index=0)       = 0;
    
    virtual int            isSelectionBegin (int pixel )         = 0;
    
    virtual int            isSelectionEnd   (int pixel )         = 0;

    virtual int            activeSelection  (void)         const = 0;
        
    virtual void           clearSelections  (void)               = 0;

    virtual const State&   state            (void) const = 0;

//signals:
    /*---------------------------------------------------------------------*/
    virtual void           selBeginChanged(long sample)          = 0;     
    
    virtual void           selEndChanged  (long sample)          = 0;     
    
    virtual void           zoomFacChanged (double fac )          = 0;
    
    virtual void           positionChanged(ulong sample)         = 0;     

    virtual void           firstSampleChanged(ulong sample)      = 0;
    
//public slots:
    
    /*---------------------------------------------------------------------*/
    virtual void           setBgColor       (const QColor& c)    = 0;
    
    virtual const QColor&  bgColor          (void) const         = 0;

    virtual void           setPeakColor     (const QColor& c)    = 0;
    
    virtual const QColor&  peakColor        (void) const         = 0;

    virtual void           setAvgColor      (const QColor& c)    = 0;

    virtual const QColor&  avgColor         (void) const         = 0;
    
    /*---------------------------------------------------------------------*/
    virtual void           setSamplesVisible(const long& newVal) = 0;

    virtual void           setZoomFac       (double zoomFac)     = 0;
    
    virtual void           setZoomYFac      (double zoomYFac)    = 0;
    
    virtual void           setFirstSample   (ulong sample)       = 0;
    
    virtual void           setChannel       (uint channel=1)     = 0;
    virtual uint           channel          (void) const         = 0;
    virtual void           scrollBy         (int pixel)          = 0;
protected:    
    QwavWaveViewInterface() 
        : _waveData(0),_interpolator(0), 
          _topBorderDist(0), _bottomBorderDist(0)  {};
        
    QwavWaveViewInterface(QwavWaveDataInterface* wd) 
        : _waveData(wd),_interpolator(0), 
          _topBorderDist(0), _bottomBorderDist(0) {};
       
private:   
    QwavWaveDataInterface*  _waveData;  
    QwavPeakInterpolator*   _interpolator;
    uint                    _topBorderDist;
    uint                    _bottomBorderDist;
};

//---------------------------------------------------------------------------
// Method: waveData
//---------------------------------------------------------------------------

QwavWaveDataInterface* QwavWaveViewInterface::waveData(void) const
{
    return _waveData;
}

//---------------------------------------------------------------------------
// Method: setWaveData
//---------------------------------------------------------------------------

void QwavWaveViewInterface::setWaveData(QwavWaveDataInterface* wd)
{
    _waveData = wd;
}


//---------------------------------------------------------------------------
// Method: nrOfSamples
//---------------------------------------------------------------------------

const long QwavWaveViewInterface::nrOfSamples() const
{
    return waveData()->nrOfSamples();    
}

void QwavWaveViewInterface::setBorderDist(uint topBorder, uint bottomBorder)
{
    _topBorderDist = topBorder;
    _bottomBorderDist = bottomBorder;
}

const uint& QwavWaveViewInterface::topBorderDist() const
{
    return _topBorderDist;
}

const uint& QwavWaveViewInterface::bottomBorderDist() const
{
    return _bottomBorderDist;
}



Qwav_END_NAMESPACE

#endif // QwavWAVEVIEW_H

---