globally change all use of "frame" to refer to audio into "sample".
[ardour.git] / libs / ardour / ardour / audio_track.h
1 /*
2     Copyright (C) 2002-2006 Paul Davis
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #ifndef __ardour_audio_track_h__
21 #define __ardour_audio_track_h__
22
23 #include "ardour/interthread_info.h"
24 #include "ardour/track.h"
25
26 namespace ARDOUR {
27
28 class Session;
29 class AudioDiskstream;
30 class AudioPlaylist;
31 class RouteGroup;
32 class AudioFileSource;
33
34 class LIBARDOUR_API AudioTrack : public Track
35 {
36   public:
37         AudioTrack (Session&, std::string name, TrackMode m = Normal);
38         ~AudioTrack ();
39
40         int roll (pframes_t nframes, samplepos_t start_sample, samplepos_t end_sample,
41                   int declick, bool& need_butler);
42
43         void freeze_me (InterThreadInfo&);
44         void unfreeze ();
45
46         bool bounceable (boost::shared_ptr<Processor>, bool include_endpoint) const;
47         boost::shared_ptr<Region> bounce (InterThreadInfo&);
48         boost::shared_ptr<Region> bounce_range (samplepos_t start, samplepos_t end, InterThreadInfo&,
49                                                 boost::shared_ptr<Processor> endpoint, bool include_endpoint);
50         int export_stuff (BufferSet& bufs, samplepos_t start_sample, samplecnt_t nframes,
51                           boost::shared_ptr<Processor> endpoint, bool include_endpoint, bool for_export, bool for_freeze);
52
53         int set_state (const XMLNode&, int version);
54
55         boost::shared_ptr<AudioFileSource> write_source (uint32_t n = 0);
56
57   protected:
58         XMLNode& state (bool full);
59
60   private:
61         int  deprecated_use_diskstream_connections ();
62         void set_state_part_two ();
63         void set_state_part_three ();
64 };
65
66 } // namespace ARDOUR
67
68 #endif /* __ardour_audio_track_h__ */