midway snapshot of work done on managing Region & Source lifetimes correctly. may...
[ardour.git] / libs / ardour / midi_region.cc
1 /*
2     Copyright (C) 2000-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     $Id: midiregion.cc 746 2006-08-02 02:44:23Z drobilla $
19 */
20
21 #include <cmath>
22 #include <climits>
23 #include <cfloat>
24
25 #include <set>
26
27
28 #include <glibmm/thread.h>
29
30 #include "pbd/basename.h"
31 #include "pbd/xml++.h"
32 #include "pbd/enumwriter.h"
33
34 #include "ardour/midi_region.h"
35 #include "ardour/session.h"
36 #include "ardour/gain.h"
37 #include "ardour/dB.h"
38 #include "ardour/playlist.h"
39 #include "ardour/midi_source.h"
40 #include "ardour/region_factory.h"
41 #include "ardour/types.h"
42 #include "ardour/midi_ring_buffer.h"
43
44 #include "i18n.h"
45 #include <locale.h>
46
47 using namespace std;
48 using namespace ARDOUR;
49 using namespace PBD;
50
51 /* Basic MidiRegion constructor (many channels) */
52 MidiRegion::MidiRegion (const SourceList& srcs)
53         : Region (srcs)
54 {
55         midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
56         assert(_name.val().find("/") == string::npos);
57         assert(_type == DataType::MIDI);
58 }
59
60 /** Create a new MidiRegion, that is part of an existing one */
61 MidiRegion::MidiRegion (boost::shared_ptr<const MidiRegion> other, frameoffset_t offset, bool offset_relative)
62         : Region (other, offset, offset_relative)
63 {
64         assert(_name.val().find("/") == string::npos);
65         midi_source(0)->Switched.connect_same_thread (*this, boost::bind (&MidiRegion::switch_source, this, _1));
66 }
67
68 MidiRegion::~MidiRegion ()
69 {
70 }
71
72 /** Create a new MidiRegion that has its own version of some/all of the Source used by another. 
73  */
74 boost::shared_ptr<MidiRegion>
75 MidiRegion::clone ()
76 {
77         BeatsFramesConverter bfc (_session.tempo_map(), _position);
78         double bbegin = bfc.from (_position);
79         double bend = bfc.from (last_frame() + 1);
80
81         boost::shared_ptr<MidiSource> ms = midi_source(0)->clone (bbegin, bend);
82
83         PropertyList plist;
84
85         plist.add (Properties::name, ms->name());
86         plist.add (Properties::whole_file, true);
87         plist.add (Properties::start, 0);
88         plist.add (Properties::length, _length);
89         plist.add (Properties::layer, 0);
90
91         return boost::dynamic_pointer_cast<MidiRegion> (RegionFactory::create (ms, plist, true));
92 }
93
94 void
95 MidiRegion::set_position_internal (framepos_t pos, bool allow_bbt_recompute)
96 {
97         BeatsFramesConverter old_converter(_session.tempo_map(), _position - _start);
98         double length_beats = old_converter.from(_length);
99
100         Region::set_position_internal(pos, allow_bbt_recompute);
101
102         BeatsFramesConverter new_converter(_session.tempo_map(), pos - _start);
103
104         set_length(new_converter.to(length_beats), 0);
105 }
106
107 framecnt_t
108 MidiRegion::read_at (Evoral::EventSink<nframes_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode, MidiStateTracker* tracker) const
109 {
110         return _read_at (_sources, out, position, dur, chan_n, mode, tracker);
111 }
112
113 framecnt_t
114 MidiRegion::master_read_at (MidiRingBuffer<nframes_t>& out, framepos_t position, framecnt_t dur, uint32_t chan_n, NoteMode mode) const
115 {
116         return _read_at (_master_sources, out, position, dur, chan_n, mode); /* no tracker */
117 }
118
119 framecnt_t
120 MidiRegion::_read_at (const SourceList& /*srcs*/, Evoral::EventSink<nframes_t>& dst, framepos_t position, framecnt_t dur, uint32_t chan_n, 
121                       NoteMode mode, MidiStateTracker* tracker) const
122 {
123         frameoffset_t internal_offset = 0;
124         frameoffset_t src_offset      = 0;
125         framecnt_t to_read         = 0;
126
127         /* precondition: caller has verified that we cover the desired section */
128
129         assert(chan_n == 0);
130
131         if (muted()) {
132                 return 0; /* read nothing */
133         }
134
135         if (position < _position) {
136                 internal_offset = 0;
137                 src_offset = _position - position;
138                 dur -= src_offset;
139         } else {
140                 internal_offset = position - _position;
141                 src_offset = 0;
142         }
143
144         if (internal_offset >= _length) {
145                 return 0; /* read nothing */
146         }
147
148         if ((to_read = min (dur, _length - internal_offset)) == 0) {
149                 return 0; /* read nothing */
150         }
151
152         _read_data_count = 0;
153
154         boost::shared_ptr<MidiSource> src = midi_source(chan_n);
155         src->set_note_mode(mode);
156
157         framepos_t output_buffer_position = 0;
158         framepos_t negative_output_buffer_position = 0;
159         if (_position >= _start) {
160                 // handle resizing of beginnings of regions correctly
161                 output_buffer_position = _position - _start;
162         } else {
163                 // when _start is greater than _position, we have to subtract
164                 // _start from the note times in the midi source
165                 negative_output_buffer_position = _start;
166         }
167
168         /*cerr << "MR read @ " << position << " * " << to_read
169                 << " _position = " << _position
170             << " _start = " << _start
171             << " offset = " << output_buffer_position
172             << " negoffset = " << negative_output_buffer_position
173             << " intoffset = " << internal_offset
174             << endl;*/
175
176         if (src->midi_read (
177                         dst, // destination buffer
178                         _position - _start, // start position of the source in this read context
179                         _start + internal_offset, // where to start reading in the source
180                         to_read, // read duration in frames
181                         output_buffer_position, // the offset in the output buffer
182                         negative_output_buffer_position, // amount to substract from note times
183                         tracker
184                     ) != to_read) {
185                 return 0; /* "read nothing" */
186         }
187
188         _read_data_count += src->read_data_count();
189
190         return to_read;
191 }
192
193 XMLNode&
194 MidiRegion::state (bool full)
195 {
196         return Region::state (full);
197 }
198
199 int
200 MidiRegion::set_state (const XMLNode& node, int version)
201 {
202         return Region::set_state (node, version);
203 }
204
205 void
206 MidiRegion::recompute_at_end ()
207 {
208         /* our length has changed
209          * so what? stuck notes are dealt with via a note state tracker
210          */
211 }
212
213 void
214 MidiRegion::recompute_at_start ()
215 {
216         /* as above, but the shift was from the front
217          * maybe bump currently active note's note-ons up so they sound here?
218          * that could be undesireable in certain situations though.. maybe
219          * remove the note entirely, including it's note off?  something needs to
220          * be done to keep the played MIDI sane to avoid messing up voices of
221          * polyhonic things etc........
222          */
223 }
224
225 int
226 MidiRegion::separate_by_channel (ARDOUR::Session&, vector< boost::shared_ptr<Region> >&) const
227 {
228         // TODO
229         return -1;
230 }
231
232 int
233 MidiRegion::exportme (ARDOUR::Session&, ARDOUR::ExportSpecification&)
234 {
235         return -1;
236 }
237
238 boost::shared_ptr<MidiSource>
239 MidiRegion::midi_source (uint32_t n) const
240 {
241         // Guaranteed to succeed (use a static cast?)
242         return boost::dynamic_pointer_cast<MidiSource>(source(n));
243 }
244
245
246 void
247 MidiRegion::switch_source(boost::shared_ptr<Source> src)
248 {
249         boost::shared_ptr<MidiSource> msrc = boost::dynamic_pointer_cast<MidiSource>(src);
250         if (!msrc)
251                 return;
252
253         // MIDI regions have only one source
254         _sources.clear();
255         _sources.push_back(msrc);
256
257         set_name(msrc->name());
258 }
259