include/sample_play_handle.h

   1 /*
   2  * sample_play_handle.h - play-handle for playing a sample
   3  *
   4  * Copyright (c) 2005-2008 Tobias Doerffel <tobydox/at/users.sourceforge.net>
   5  *
   6  * This file is part of Linux MultiMedia Studio - http://lmms.sourceforge.net
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public
  19  * License along with this program (see COPYING); if not, write to the
  20  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21  * Boston, MA 02110-1301 USA.
  22  *
  23  */
  24
  25
  26 #ifndef _SAMPLE_PLAY_HANDLE_H
  27 #define _SAMPLE_PLAY_HANDLE_H
  28
  29 #include "mixer.h"
  30 #include "sample_buffer.h"
  31 #include "AutomatableModel.h"
  32
  33 class bbTrack;
  34 class pattern;
  35 class sampleTCO;
  36 class track;
  37 class AudioPort;
  38
  39
  40 class samplePlayHandle : public playHandle
  41 {
  42 public:
  43         samplePlayHandle( const QString & _sample_file );
  44         samplePlayHandle( sampleBuffer * _sample_buffer );
  45         samplePlayHandle( sampleTCO * _tco );
  46         samplePlayHandle( pattern * _pattern );
  47         virtual ~samplePlayHandle();
  48
  49         virtual inline bool affinityMatters() const
  50         {
  51                 return true;
  52         }
  53
  54
  55         virtual void play( sampleFrame * _working_buffer );
  56         virtual bool done() const;
  57
  58         virtual bool isFromTrack( const track * _track ) const;
  59
  60         f_cnt_t totalFrames() const;
  61         inline f_cnt_t framesDone() const
  62         {
  63                 return( m_frame );
  64         }
  65         void setDoneMayReturnTrue( bool _enable )
  66         {
  67                 m_doneMayReturnTrue = _enable;
  68         }
  69
  70         void setBBTrack( bbTrack * _bb_track )
  71         {
  72                 m_bbTrack = _bb_track;
  73         }
  74
  75         void setVolumeModel( FloatModel * _model )
  76         {
  77                 m_volumeModel = _model;
  78         }
  79
  80
  81 private:
  82         sampleBuffer * m_sampleBuffer;
  83         bool m_doneMayReturnTrue;
  84
  85         f_cnt_t m_frame;
  86         sampleBuffer::handleState m_state;
  87
  88         AudioPort * m_audioPort;
  89         const bool m_ownAudioPort;
  90
  91         FloatModel m_defaultVolumeModel;
  92         FloatModel * m_volumeModel;
  93         track * m_track;
  94
  95         bbTrack * m_bbTrack;
  96
  97 } ;
  98
  99
 100 #endif