probably fix cleanup issues, but testing required
[ardour.git] / libs / ardour / audioregion.cc
1 /*
2     Copyright (C) 2000-2001 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 #include <cmath>
21 #include <climits>
22 #include <cfloat>
23
24 #include <set>
25
26 #include <sigc++/bind.h>
27 #include <sigc++/class_slot.h>
28
29 #include <glibmm/thread.h>
30
31 #include <pbd/basename.h>
32 #include <pbd/xml++.h>
33 #include <pbd/stacktrace.h>
34 #include <pbd/enumwriter.h>
35
36 #include <ardour/audioregion.h>
37 #include <ardour/session.h>
38 #include <ardour/gain.h>
39 #include <ardour/dB.h>
40 #include <ardour/playlist.h>
41 #include <ardour/audiofilter.h>
42 #include <ardour/audiofilesource.h>
43 #include <ardour/region_factory.h>
44
45 #include "i18n.h"
46 #include <locale.h>
47
48 using namespace std;
49 using namespace ARDOUR;
50
51 /* a Session will reset these to its chosen defaults by calling AudioRegion::set_default_fade() */
52
53 Change AudioRegion::FadeInChanged         = ARDOUR::new_change();
54 Change AudioRegion::FadeOutChanged        = ARDOUR::new_change();
55 Change AudioRegion::FadeInActiveChanged   = ARDOUR::new_change();
56 Change AudioRegion::FadeOutActiveChanged  = ARDOUR::new_change();
57 Change AudioRegion::EnvelopeActiveChanged = ARDOUR::new_change();
58 Change AudioRegion::ScaleAmplitudeChanged = ARDOUR::new_change();
59 Change AudioRegion::EnvelopeChanged       = ARDOUR::new_change();
60
61 AudioRegion::AudioRegion (boost::shared_ptr<AudioSource> src, nframes_t start, nframes_t length)
62         : Region (start, length, PBD::basename_nosuffix(src->name()), 0,  Region::Flag(Region::DefaultFlags|Region::External)),
63           _fade_in (0.0, 2.0, 1.0, false),
64           _fade_out (0.0, 2.0, 1.0, false),
65           _envelope (0.0, 2.0, 1.0, false)
66 {
67         /* basic AudioRegion constructor */
68
69         sources.push_back (src);
70         master_sources.push_back (src);
71         src->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
72
73         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (src);
74         if (afs) {
75                 afs->HeaderPositionOffsetChanged.connect (mem_fun (*this, &AudioRegion::source_offset_changed));
76         }
77
78         _scale_amplitude = 1.0;
79
80         set_default_fades ();
81         set_default_envelope ();
82
83         listen_to_my_curves ();
84 }
85
86 AudioRegion::AudioRegion (boost::shared_ptr<AudioSource> src, nframes_t start, nframes_t length, const string& name, layer_t layer, Flag flags)
87         : Region (start, length, name, layer, flags),
88           _fade_in (0.0, 2.0, 1.0, false),
89           _fade_out (0.0, 2.0, 1.0, false),
90           _envelope (0.0, 2.0, 1.0, false)
91 {
92         /* basic AudioRegion constructor */
93
94         sources.push_back (src);
95         master_sources.push_back (src);
96         src->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
97
98         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (src);
99         if (afs) {
100                 afs->HeaderPositionOffsetChanged.connect (mem_fun (*this, &AudioRegion::source_offset_changed));
101         }
102
103         _scale_amplitude = 1.0;
104
105         set_default_fades ();
106         set_default_envelope ();
107
108         listen_to_my_curves ();
109 }
110
111 AudioRegion::AudioRegion (SourceList& srcs, nframes_t start, nframes_t length, const string& name, layer_t layer, Flag flags)
112         : Region (start, length, name, layer, flags),
113           _fade_in (0.0, 2.0, 1.0, false),
114           _fade_out (0.0, 2.0, 1.0, false),
115           _envelope (0.0, 2.0, 1.0, false)
116 {
117         /* basic AudioRegion constructor */
118
119         for (SourceList::iterator i=srcs.begin(); i != srcs.end(); ++i) {
120                 sources.push_back (*i);
121                 master_sources.push_back (*i);
122                 (*i)->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
123                 
124                 boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> ((*i));
125                 if (afs) {
126                         afs->HeaderPositionOffsetChanged.connect (mem_fun (*this, &AudioRegion::source_offset_changed));
127                 }
128         }
129
130         _scale_amplitude = 1.0;
131
132         set_default_fades ();
133         set_default_envelope ();
134
135         listen_to_my_curves ();
136 }
137
138
139 AudioRegion::AudioRegion (boost::shared_ptr<const AudioRegion> other, nframes_t offset, nframes_t length, const string& name, layer_t layer, Flag flags)
140         : Region (other, offset, length, name, layer, flags),
141           _fade_in (other->_fade_in),
142           _fade_out (other->_fade_out),
143           _envelope (other->_envelope, (double) offset, (double) offset + length) 
144 {
145         /* create a new AudioRegion, that is part of an existing one */
146         
147         set<boost::shared_ptr<AudioSource> > unique_srcs;
148
149         for (SourceList::const_iterator i= other->sources.begin(); i != other->sources.end(); ++i) {
150                 sources.push_back (*i);
151                 (*i)->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
152
153                 pair<set<boost::shared_ptr<AudioSource> >::iterator,bool> result;
154
155                 result = unique_srcs.insert (*i);
156
157                 if (result.second) {
158                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (*i);
159                         if (afs) {
160                                 afs->HeaderPositionOffsetChanged.connect (mem_fun (*this, &AudioRegion::source_offset_changed));
161                         }
162                 }
163         }
164
165         for (SourceList::const_iterator i = other->master_sources.begin(); i != other->master_sources.end(); ++i) {
166                 if (unique_srcs.find (*i) == unique_srcs.end()) {
167                         (*i)->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
168                 }
169                 master_sources.push_back (*i);
170         }
171
172         /* return to default fades if the existing ones are too long */
173         _fade_in_disabled = 0;
174         _fade_out_disabled = 0;
175
176
177         if (_flags & LeftOfSplit) {
178                 if (_fade_in.back()->when >= _length) {
179                         set_default_fade_in ();
180                 } else {
181                         _fade_in_disabled = other->_fade_in_disabled;
182                 }
183                 set_default_fade_out ();
184                 _flags = Flag (_flags & ~Region::LeftOfSplit);
185         }
186
187         if (_flags & RightOfSplit) {
188                 if (_fade_out.back()->when >= _length) {
189                         set_default_fade_out ();
190                 } else {
191                         _fade_out_disabled = other->_fade_out_disabled;
192                 }
193                 set_default_fade_in ();
194                 _flags = Flag (_flags & ~Region::RightOfSplit);
195         }
196
197         _scale_amplitude = other->_scale_amplitude;
198
199         listen_to_my_curves ();
200 }
201
202 AudioRegion::AudioRegion (boost::shared_ptr<const AudioRegion> other)
203         : Region (other),
204           _fade_in (other->_fade_in),
205           _fade_out (other->_fade_out),
206           _envelope (other->_envelope) 
207 {
208         /* Pure copy constructor */
209
210         set<boost::shared_ptr<AudioSource> > unique_srcs;
211
212         for (SourceList::const_iterator i = other->sources.begin(); i != other->sources.end(); ++i) {
213                 sources.push_back (*i);
214                 (*i)->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
215                 pair<set<boost::shared_ptr<AudioSource> >::iterator,bool> result;
216
217                 result = unique_srcs.insert (*i);
218
219                 if (result.second) {
220                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (*i);
221                         if (afs) {
222                                 afs->HeaderPositionOffsetChanged.connect (mem_fun (*this, &AudioRegion::source_offset_changed));
223                         }
224                 }
225         }
226
227         for (SourceList::const_iterator i = other->master_sources.begin(); i != other->master_sources.end(); ++i) {
228                 master_sources.push_back (*i);
229                 if (unique_srcs.find (*i) == unique_srcs.end()) {
230                         (*i)->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
231                 }
232         }
233
234         _scale_amplitude = other->_scale_amplitude;
235         _envelope = other->_envelope;
236
237         _fade_in_disabled = 0;
238         _fade_out_disabled = 0;
239         
240         listen_to_my_curves ();
241 }
242
243 AudioRegion::AudioRegion (boost::shared_ptr<AudioSource> src, const XMLNode& node)
244         : Region (node),
245           _fade_in (0.0, 2.0, 1.0, false),
246           _fade_out (0.0, 2.0, 1.0, false),
247           _envelope (0.0, 2.0, 1.0, false)
248 {
249         sources.push_back (src);
250         master_sources.push_back (src);
251         src->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
252
253         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (src);
254         if (afs) {
255                 afs->HeaderPositionOffsetChanged.connect (mem_fun (*this, &AudioRegion::source_offset_changed));
256         }
257
258         set_default_fades ();
259
260         if (set_state (node)) {
261                 throw failed_constructor();
262         }
263
264         listen_to_my_curves ();
265 }
266
267 AudioRegion::AudioRegion (SourceList& srcs, const XMLNode& node)
268         : Region (node),
269           _fade_in (0.0, 2.0, 1.0, false),
270           _fade_out (0.0, 2.0, 1.0, false),
271           _envelope (0.0, 2.0, 1.0, false)
272 {
273         set<boost::shared_ptr<AudioSource> > unique_srcs;
274
275         for (SourceList::iterator i=srcs.begin(); i != srcs.end(); ++i) {
276                 sources.push_back (*i);
277                 (*i)->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
278                 pair<set<boost::shared_ptr<AudioSource> >::iterator,bool> result;
279
280                 result = unique_srcs.insert (*i);
281
282                 if (result.second) {
283                         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource> (*i);
284                         if (afs) {
285                                 afs->HeaderPositionOffsetChanged.connect (mem_fun (*this, &AudioRegion::source_offset_changed));
286                         }
287                 }
288         }
289
290         for (SourceList::iterator i = srcs.begin(); i != srcs.end(); ++i) {
291                 master_sources.push_back (*i);
292                 if (unique_srcs.find (*i) == unique_srcs.end()) {
293                         (*i)->GoingAway.connect (mem_fun (*this, &AudioRegion::source_deleted));
294                 }
295         }
296
297         set_default_fades ();
298         _scale_amplitude = 1.0;
299
300         if (set_state (node)) {
301                 throw failed_constructor();
302         }
303
304         listen_to_my_curves ();
305 }
306
307 AudioRegion::~AudioRegion ()
308 {
309         boost::shared_ptr<Playlist> pl (playlist());
310
311         if (pl) {
312                 for (SourceList::const_iterator i = sources.begin(); i != sources.end(); ++i) {
313                         (*i)->remove_playlist (pl);
314                 }
315         }
316
317         notify_callbacks ();
318         GoingAway (); /* EMIT SIGNAL */
319 }
320
321 void
322 AudioRegion::listen_to_my_curves ()
323 {
324         _envelope.StateChanged.connect (mem_fun (*this, &AudioRegion::envelope_changed));
325         _fade_in.StateChanged.connect (mem_fun (*this, &AudioRegion::fade_in_changed));
326         _fade_out.StateChanged.connect (mem_fun (*this, &AudioRegion::fade_out_changed));
327 }
328
329 bool
330 AudioRegion::verify_length (nframes_t len)
331 {
332         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(source());
333
334         if (afs && afs->destructive()) {
335                 return true;
336         }
337
338         for (uint32_t n=0; n < sources.size(); ++n) {
339                 if (_start > sources[n]->length() - len) {
340                         return false;
341                 }
342         }
343         return true;
344 }
345
346 bool
347 AudioRegion::verify_start_and_length (nframes_t new_start, nframes_t new_length)
348 {
349         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(source());
350
351         if (afs && afs->destructive()) {
352                 return true;
353         }
354
355         for (uint32_t n=0; n < sources.size(); ++n) {
356                 if (new_length > sources[n]->length() - new_start) {
357                         return false;
358                 }
359         }
360         return true;
361 }
362 bool
363 AudioRegion::verify_start (nframes_t pos)
364 {
365         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(source());
366
367         if (afs && afs->destructive()) {
368                 return true;
369         }
370
371         for (uint32_t n=0; n < sources.size(); ++n) {
372                 if (pos > sources[n]->length() - _length) {
373                         return false;
374                 }
375         }
376         return true;
377 }
378
379 bool
380 AudioRegion::verify_start_mutable (nframes_t& new_start)
381 {
382         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(source());
383
384         if (afs && afs->destructive()) {
385                 return true;
386         }
387
388         for (uint32_t n=0; n < sources.size(); ++n) {
389                 if (new_start > sources[n]->length() - _length) {
390                         new_start = sources[n]->length() - _length;
391                 }
392         }
393         return true;
394 }
395 void
396 AudioRegion::set_envelope_active (bool yn)
397 {
398         if (envelope_active() != yn) {
399                 char buf[64];
400                 if (yn) {
401                         snprintf (buf, sizeof (buf), "envelope active");
402                         _flags = Flag (_flags|EnvelopeActive);
403                 } else {
404                         snprintf (buf, sizeof (buf), "envelope off");
405                         _flags = Flag (_flags & ~EnvelopeActive);
406                 }
407                 send_change (EnvelopeActiveChanged);
408         }
409 }
410
411 nframes_t
412 AudioRegion::read_peaks (PeakData *buf, nframes_t npeaks, nframes_t offset, nframes_t cnt, uint32_t chan_n, double samples_per_unit) const
413 {
414         if (chan_n >= sources.size()) {
415                 return 0; 
416         }
417
418         if (sources[chan_n]->read_peaks (buf, npeaks, offset, cnt, samples_per_unit)) {
419                 return 0;
420         } else {
421                 if (_scale_amplitude != 1.0) {
422                         for (nframes_t n = 0; n < npeaks; ++n) {
423                                 buf[n].max *= _scale_amplitude;
424                                 buf[n].min *= _scale_amplitude;
425                         }
426                 }
427                 return cnt;
428         }
429 }
430
431 nframes_t
432 AudioRegion::read_at (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nframes_t position, 
433                       nframes_t cnt, 
434                       uint32_t chan_n, nframes_t read_frames, nframes_t skip_frames) const
435 {
436         return _read_at (sources, buf, mixdown_buffer, gain_buffer, position, cnt, chan_n, read_frames, skip_frames);
437 }
438
439 nframes_t
440 AudioRegion::master_read_at (Sample *buf, Sample *mixdown_buffer, float *gain_buffer, nframes_t position, 
441                              nframes_t cnt, uint32_t chan_n) const
442 {
443         return _read_at (master_sources, buf, mixdown_buffer, gain_buffer, position, cnt, chan_n, 0, 0);
444 }
445
446 nframes_t
447 AudioRegion::_read_at (const SourceList& srcs, Sample *buf, Sample *mixdown_buffer, float *gain_buffer,
448                        nframes_t position, nframes_t cnt, 
449                        uint32_t chan_n, nframes_t read_frames, nframes_t skip_frames) const
450 {
451         nframes_t internal_offset;
452         nframes_t buf_offset;
453         nframes_t to_read;
454
455         /* precondition: caller has verified that we cover the desired section */
456
457         if (chan_n >= sources.size()) {
458                 return 0; /* read nothing */
459         }
460         
461         if (position < _position) {
462                 internal_offset = 0;
463                 buf_offset = _position - position;
464                 cnt -= buf_offset;
465         } else {
466                 internal_offset = position - _position;
467                 buf_offset = 0;
468         }
469
470         if (internal_offset >= _length) {
471                 return 0; /* read nothing */
472         }
473
474         if ((to_read = min (cnt, _length - internal_offset)) == 0) {
475                 return 0; /* read nothing */
476         }
477
478         if (opaque()) {
479                 /* overwrite whatever is there */
480                 mixdown_buffer = buf + buf_offset;
481         } else {
482                 mixdown_buffer += buf_offset;
483         }
484
485         if (muted()) {
486                 return 0; /* read nothing */
487         }
488
489         _read_data_count = 0;
490
491         if (srcs[chan_n]->read (mixdown_buffer, _start + internal_offset, to_read) != to_read) {
492                 return 0; /* "read nothing" */
493         }
494
495         _read_data_count += srcs[chan_n]->read_data_count();
496
497         /* fade in */
498
499         if (_flags & FadeIn) {
500
501                 nframes_t fade_in_length = (nframes_t) _fade_in.back()->when;
502                 
503                 /* see if this read is within the fade in */
504
505                 if (internal_offset < fade_in_length) {
506                         
507                         nframes_t limit;
508
509                         limit = min (to_read, fade_in_length - internal_offset);
510
511                         _fade_in.get_vector (internal_offset, internal_offset+limit, gain_buffer, limit);
512
513                         for (nframes_t n = 0; n < limit; ++n) {
514                                 mixdown_buffer[n] *= gain_buffer[n];
515                         }
516                 }
517         }
518         
519         /* fade out */
520
521         if (_flags & FadeOut) {
522         
523                 /* see if some part of this read is within the fade out */
524
525                 /* .................        >|            REGION
526                                             _length
527                                             
528                                  {           }            FADE
529                                              fade_out_length
530                                  ^                                           
531                                _length - fade_out_length
532                         |--------------|
533                         ^internal_offset
534                                        ^internal_offset + to_read
535
536                   we need the intersection of [internal_offset,internal_offset+to_read] with
537                   [_length - fade_out_length, _length]
538
539                 */
540
541         
542                 nframes_t fade_out_length = (nframes_t) _fade_out.back()->when;
543                 nframes_t fade_interval_start = max(internal_offset, _length-fade_out_length);
544                 nframes_t fade_interval_end   = min(internal_offset + to_read, _length);
545
546                 if (fade_interval_end > fade_interval_start) {
547                         /* (part of the) the fade out is  in this buffer */
548                         
549                         nframes_t limit = fade_interval_end - fade_interval_start;
550                         nframes_t curve_offset = fade_interval_start - (_length-fade_out_length);
551                         nframes_t fade_offset = fade_interval_start - internal_offset;
552                                                                        
553                         _fade_out.get_vector (curve_offset,curve_offset+limit, gain_buffer, limit);
554
555                         for (nframes_t n = 0, m = fade_offset; n < limit; ++n, ++m) {
556                                 mixdown_buffer[m] *= gain_buffer[n];
557                         }
558                 } 
559
560         }
561
562         /* Regular gain curves */
563
564         if (envelope_active())  {
565                 _envelope.get_vector (internal_offset, internal_offset + to_read, gain_buffer, to_read);
566                 
567                 if (_scale_amplitude != 1.0f) {
568                         for (nframes_t n = 0; n < to_read; ++n) {
569                                 mixdown_buffer[n] *= gain_buffer[n] * _scale_amplitude;
570                         }
571                 } else {
572                         for (nframes_t n = 0; n < to_read; ++n) {
573                                 mixdown_buffer[n] *= gain_buffer[n];
574                         }
575                 }
576         } else if (_scale_amplitude != 1.0f) {
577                 Session::apply_gain_to_buffer (mixdown_buffer, to_read, _scale_amplitude);
578         }
579
580         if (!opaque()) {
581
582                 /* gack. the things we do for users.
583                  */
584
585                 buf += buf_offset;
586
587                 for (nframes_t n = 0; n < to_read; ++n) {
588                         buf[n] += mixdown_buffer[n];
589                 }
590         } 
591         
592         return to_read;
593 }
594         
595 XMLNode&
596 AudioRegion::state (bool full)
597 {
598         XMLNode& node (Region::state (full));
599         XMLNode *child;
600         char buf[64];
601         char buf2[64];
602         LocaleGuard lg (X_("POSIX"));
603         
604         node.add_property ("flags", enum_2_string (_flags));
605
606         snprintf (buf, sizeof(buf), "%.12g", _scale_amplitude);
607         node.add_property ("scale-gain", buf);
608
609         for (uint32_t n=0; n < sources.size(); ++n) {
610                 snprintf (buf2, sizeof(buf2), "source-%d", n);
611                 sources[n]->id().print (buf, sizeof (buf));
612                 node.add_property (buf2, buf);
613         }
614
615         snprintf (buf, sizeof (buf), "%u", (uint32_t) sources.size());
616         node.add_property ("channels", buf);
617
618         if (full) {
619         
620                 child = node.add_child (X_("FadeIn"));
621                 
622                 if ((_flags & DefaultFadeIn)) {
623                         child->add_property (X_("default"), X_("yes"));
624                 } else {
625                         child->add_child_nocopy (_fade_in.get_state ());
626                 }
627
628                 child->add_property (X_("active"), _fade_in_disabled ? X_("no") : X_("yes"));
629                 
630                 child = node.add_child (X_("FadeOut"));
631                 
632                 if ((_flags & DefaultFadeOut)) {
633                         child->add_property (X_("default"), X_("yes"));
634                 } else {
635                         child->add_child_nocopy (_fade_out.get_state ());
636                 }
637                 
638                 child->add_property (X_("active"), _fade_out_disabled ? X_("no") : X_("yes"));
639         }
640         
641         child = node.add_child ("Envelope");
642
643         if (full) {
644                 bool default_env = false;
645                 
646                 // If there are only two points, the points are in the start of the region and the end of the region
647                 // so, if they are both at 1.0f, that means the default region.
648
649                 if (_envelope.size() == 2 &&
650                     _envelope.front()->value == 1.0f &&
651                     _envelope.back()->value==1.0f) {
652                         if (_envelope.front()->when == 0 && _envelope.back()->when == _length) {
653                                 default_env = true;
654                         }
655                 } 
656                 
657                 if (default_env) {
658                         child->add_property ("default", "yes");
659                 } else {
660                         child->add_child_nocopy (_envelope.get_state ());
661                 }
662
663         } else {
664                 child->add_property ("default", "yes");
665         }
666
667         if (full && _extra_xml) {
668                 node.add_child_copy (*_extra_xml);
669         }
670
671         return node;
672 }
673
674 int
675 AudioRegion::set_live_state (const XMLNode& node, Change& what_changed, bool send)
676 {
677         const XMLNodeList& nlist = node.children();
678         const XMLProperty *prop;
679         LocaleGuard lg (X_("POSIX"));
680
681         Region::set_live_state (node, what_changed, false);
682
683         uint32_t old_flags = _flags;
684                 
685         if ((prop = node.property ("flags")) != 0) {
686                 _flags = Flag (string_2_enum (prop->value(), _flags));
687
688                 //_flags = Flag (strtol (prop->value().c_str(), (char **) 0, 16));
689
690                 _flags = Flag (_flags & ~Region::LeftOfSplit);
691                 _flags = Flag (_flags & ~Region::RightOfSplit);
692         }
693
694         if ((old_flags ^ _flags) & Muted) {
695                 what_changed = Change (what_changed|MuteChanged);
696         }
697         if ((old_flags ^ _flags) & Opaque) {
698                 what_changed = Change (what_changed|OpacityChanged);
699         }
700         if ((old_flags ^ _flags) & Locked) {
701                 what_changed = Change (what_changed|LockChanged);
702         }
703
704         if ((prop = node.property ("scale-gain")) != 0) {
705                 _scale_amplitude = atof (prop->value().c_str());
706         } else {
707                 _scale_amplitude = 1.0;
708         }
709         
710         /* Now find envelope description and other misc child items */
711                                 
712         for (XMLNodeConstIterator niter = nlist.begin(); niter != nlist.end(); ++niter) {
713                 
714                 XMLNode *child;
715                 XMLProperty *prop;
716                 
717                 child = (*niter);
718                 
719                 if (child->name() == "Envelope") {
720                         
721                         _envelope.clear ();
722
723                         if ((prop = child->property ("default")) != 0 || _envelope.set_state (*child)) {
724                                 set_default_envelope ();
725                         }
726
727                         _envelope.set_max_xval (_length);
728                         _envelope.truncate_end (_length);
729
730                 } else if (child->name() == "FadeIn") {
731                         
732                         _fade_in.clear ();
733                         
734                         if ((prop = child->property ("default")) != 0 || (prop = child->property ("steepness")) != 0 || _fade_in.set_state (*child)) {
735                                 set_default_fade_in ();
736                         } 
737
738                 } else if (child->name() == "FadeOut") {
739                         
740                         _fade_out.clear ();
741
742                         if ((prop = child->property ("default")) != 0 || (prop = child->property ("steepness")) != 0 || _fade_out.set_state (*child)) {
743                                 set_default_fade_out ();
744                         } 
745                 } 
746         }
747
748         if (send) {
749                 send_change (what_changed);
750         }
751
752         return 0;
753 }
754
755 int
756 AudioRegion::set_state (const XMLNode& node)
757 {
758         /* Region::set_state() calls the virtual set_live_state(),
759            which will get us back to AudioRegion::set_live_state()
760            to handle the relevant stuff.
761         */
762
763         return Region::set_state (node);
764 }
765
766 void
767 AudioRegion::set_fade_in_shape (FadeShape shape)
768 {
769         set_fade_in (shape, (nframes_t) _fade_in.back()->when);
770 }
771
772 void
773 AudioRegion::set_fade_out_shape (FadeShape shape)
774 {
775         set_fade_out (shape, (nframes_t) _fade_out.back()->when);
776 }
777
778 void
779 AudioRegion::set_fade_in (FadeShape shape, nframes_t len)
780 {
781         _fade_in.freeze ();
782         _fade_in.clear ();
783
784         switch (shape) {
785         case Linear:
786                 _fade_in.fast_simple_add (0.0, 0.0);
787                 _fade_in.fast_simple_add (len, 1.0);
788                 break;
789
790         case Fast:
791                 _fade_in.fast_simple_add (0, 0);
792                 _fade_in.fast_simple_add (len * 0.389401, 0.0333333);
793                 _fade_in.fast_simple_add (len * 0.629032, 0.0861111);
794                 _fade_in.fast_simple_add (len * 0.829493, 0.233333);
795                 _fade_in.fast_simple_add (len * 0.9447, 0.483333);
796                 _fade_in.fast_simple_add (len * 0.976959, 0.697222);
797                 _fade_in.fast_simple_add (len, 1);
798                 break;
799
800         case Slow:
801                 _fade_in.fast_simple_add (0, 0);
802                 _fade_in.fast_simple_add (len * 0.0207373, 0.197222);
803                 _fade_in.fast_simple_add (len * 0.0645161, 0.525);
804                 _fade_in.fast_simple_add (len * 0.152074, 0.802778);
805                 _fade_in.fast_simple_add (len * 0.276498, 0.919444);
806                 _fade_in.fast_simple_add (len * 0.481567, 0.980556);
807                 _fade_in.fast_simple_add (len * 0.767281, 1);
808                 _fade_in.fast_simple_add (len, 1);
809                 break;
810
811         case LogA:
812                 _fade_in.fast_simple_add (0, 0);
813                 _fade_in.fast_simple_add (len * 0.0737327, 0.308333);
814                 _fade_in.fast_simple_add (len * 0.246544, 0.658333);
815                 _fade_in.fast_simple_add (len * 0.470046, 0.886111);
816                 _fade_in.fast_simple_add (len * 0.652074, 0.972222);
817                 _fade_in.fast_simple_add (len * 0.771889, 0.988889);
818                 _fade_in.fast_simple_add (len, 1);
819                 break;
820
821         case LogB:
822                 _fade_in.fast_simple_add (0, 0);
823                 _fade_in.fast_simple_add (len * 0.304147, 0.0694444);
824                 _fade_in.fast_simple_add (len * 0.529954, 0.152778);
825                 _fade_in.fast_simple_add (len * 0.725806, 0.333333);
826                 _fade_in.fast_simple_add (len * 0.847926, 0.558333);
827                 _fade_in.fast_simple_add (len * 0.919355, 0.730556);
828                 _fade_in.fast_simple_add (len, 1);
829                 break;
830         }
831
832         _fade_in.thaw ();
833         _fade_in_shape = shape;
834
835         send_change (FadeInChanged);
836 }
837
838 void
839 AudioRegion::set_fade_out (FadeShape shape, nframes_t len)
840 {
841         _fade_out.freeze ();
842         _fade_out.clear ();
843
844         switch (shape) {
845         case Fast:
846                 _fade_out.fast_simple_add (len * 0, 1);
847                 _fade_out.fast_simple_add (len * 0.023041, 0.697222);
848                 _fade_out.fast_simple_add (len * 0.0553,   0.483333);
849                 _fade_out.fast_simple_add (len * 0.170507, 0.233333);
850                 _fade_out.fast_simple_add (len * 0.370968, 0.0861111);
851                 _fade_out.fast_simple_add (len * 0.610599, 0.0333333);
852                 _fade_out.fast_simple_add (len * 1, 0);
853                 break;
854
855         case LogA:
856                 _fade_out.fast_simple_add (len * 0, 1);
857                 _fade_out.fast_simple_add (len * 0.228111, 0.988889);
858                 _fade_out.fast_simple_add (len * 0.347926, 0.972222);
859                 _fade_out.fast_simple_add (len * 0.529954, 0.886111);
860                 _fade_out.fast_simple_add (len * 0.753456, 0.658333);
861                 _fade_out.fast_simple_add (len * 0.9262673, 0.308333);
862                 _fade_out.fast_simple_add (len * 1, 0);
863                 break;
864
865         case Slow:
866                 _fade_out.fast_simple_add (len * 0, 1);
867                 _fade_out.fast_simple_add (len * 0.305556, 1);
868                 _fade_out.fast_simple_add (len * 0.548611, 0.991736);
869                 _fade_out.fast_simple_add (len * 0.759259, 0.931129);
870                 _fade_out.fast_simple_add (len * 0.918981, 0.68595);
871                 _fade_out.fast_simple_add (len * 0.976852, 0.22865);
872                 _fade_out.fast_simple_add (len * 1, 0);
873                 break;
874
875         case LogB:
876                 _fade_out.fast_simple_add (len * 0, 1);
877                 _fade_out.fast_simple_add (len * 0.080645, 0.730556);
878                 _fade_out.fast_simple_add (len * 0.277778, 0.289256);
879                 _fade_out.fast_simple_add (len * 0.470046, 0.152778);
880                 _fade_out.fast_simple_add (len * 0.695853, 0.0694444);
881                 _fade_out.fast_simple_add (len * 1, 0);
882                 break;
883
884         case Linear:
885                 _fade_out.fast_simple_add (len * 0, 1);
886                 _fade_out.fast_simple_add (len * 1, 0);
887                 break;
888         }
889
890         _fade_out.thaw ();
891         _fade_out_shape = shape;
892
893         send_change (FadeOutChanged);
894 }
895
896 void
897 AudioRegion::set_fade_in_length (nframes_t len)
898 {
899         bool changed = _fade_in.extend_to (len);
900
901         if (changed) {
902                 _flags = Flag (_flags & ~DefaultFadeIn);
903                 send_change (FadeInChanged);
904         }
905 }
906
907 void
908 AudioRegion::set_fade_out_length (nframes_t len)
909 {
910         bool changed =  _fade_out.extend_to (len);
911
912         if (changed) {
913                 _flags = Flag (_flags & ~DefaultFadeOut);
914         }
915
916         send_change (FadeOutChanged);
917 }
918
919 void
920 AudioRegion::set_fade_in_active (bool yn)
921 {
922         if (yn == (_flags & FadeIn)) {
923                 return;
924         }
925         if (yn) {
926                 _flags = Flag (_flags|FadeIn);
927         } else {
928                 _flags = Flag (_flags & ~FadeIn);
929         }
930
931         send_change (FadeInActiveChanged);
932 }
933
934 void
935 AudioRegion::set_fade_out_active (bool yn)
936 {
937         if (yn == (_flags & FadeOut)) {
938                 return;
939         }
940         if (yn) {
941                 _flags = Flag (_flags | FadeOut);
942         } else {
943                 _flags = Flag (_flags & ~FadeOut);
944         }
945
946         send_change (FadeOutActiveChanged);
947 }
948
949 void
950 AudioRegion::set_default_fade_in ()
951 {
952         set_fade_in (Linear, 64);
953 }
954
955 void
956 AudioRegion::set_default_fade_out ()
957 {
958         set_fade_out (Linear, 64);
959 }
960
961 void
962 AudioRegion::set_default_fades ()
963 {
964         _fade_in_disabled = 0;
965         _fade_out_disabled = 0;
966         set_default_fade_in ();
967         set_default_fade_out ();
968 }
969
970 void
971 AudioRegion::set_default_envelope ()
972 {
973         _envelope.freeze ();
974         _envelope.clear ();
975         _envelope.fast_simple_add (0, 1.0f);
976         _envelope.fast_simple_add (_length, 1.0f);
977         _envelope.thaw ();
978 }
979
980 void
981 AudioRegion::recompute_at_end ()
982 {
983         /* our length has changed. recompute a new final point by interpolating 
984            based on the the existing curve.
985         */
986         
987         _envelope.freeze ();
988         _envelope.truncate_end (_length);
989         _envelope.set_max_xval (_length);
990         _envelope.thaw ();
991
992         if (_fade_in.back()->when > _length) {
993                 _fade_in.extend_to (_length);
994                 send_change (FadeInChanged);
995         }
996
997         if (_fade_out.back()->when > _length) {
998                 _fade_out.extend_to (_length);
999                 send_change (FadeOutChanged);
1000         }
1001 }       
1002
1003 void
1004 AudioRegion::recompute_at_start ()
1005 {
1006         /* as above, but the shift was from the front */
1007
1008         _envelope.truncate_start (_length);
1009
1010         if (_fade_in.back()->when > _length) {
1011                 _fade_in.extend_to (_length);
1012                 send_change (FadeInChanged);
1013         }
1014
1015         if (_fade_out.back()->when > _length) {
1016                 _fade_out.extend_to (_length);
1017                 send_change (FadeOutChanged);
1018         }
1019 }
1020
1021 int
1022 AudioRegion::separate_by_channel (Session& session, vector<boost::shared_ptr<AudioRegion> >& v) const
1023 {
1024         SourceList srcs;
1025         string new_name;
1026         int n;
1027
1028         if (sources.size() < 2) {
1029                 return 0;
1030         }
1031
1032         n = 0;
1033
1034         for (SourceList::const_iterator i = sources.begin(); i != sources.end(); ++i) {
1035
1036                 srcs.clear ();
1037                 srcs.push_back (*i);
1038
1039                 new_name = _name;
1040
1041                 if (sources.size() == 2) {
1042                         if (n == 0) {
1043                                 new_name += "-L";
1044                         } else {
1045                                 new_name += "-R";
1046                         }
1047                 } else {
1048                         new_name += '-';
1049                         new_name += ('0' + n + 1);
1050                 }
1051
1052                 /* create a copy with just one source. prevent if from being thought of as "whole file" even if 
1053                    it covers the entire source file(s).
1054                  */
1055
1056                 Flag f = Flag (_flags & ~WholeFile);
1057
1058                 boost::shared_ptr<Region> r = RegionFactory::create (srcs, _start, _length, new_name, _layer, f);
1059                 boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion> (r);
1060
1061                 v.push_back (ar);
1062                 
1063                 ++n;
1064         }
1065
1066         return 0;
1067 }
1068
1069 void
1070 AudioRegion::source_deleted ()
1071 {
1072         sources.clear ();
1073         drop_references ();
1074 }
1075
1076 vector<string>
1077 AudioRegion::master_source_names ()
1078 {
1079         SourceList::iterator i;
1080
1081         vector<string> names;
1082         for (i = master_sources.begin(); i != master_sources.end(); ++i) {
1083                 names.push_back((*i)->name());
1084         }
1085
1086         return names;
1087 }
1088
1089 bool
1090 AudioRegion::source_equivalent (boost::shared_ptr<const Region> o) const
1091 {
1092         boost::shared_ptr<const AudioRegion> other = boost::dynamic_pointer_cast<const AudioRegion>(o);
1093
1094         if (!other)
1095                 return false;
1096
1097         SourceList::const_iterator i;
1098         SourceList::const_iterator io;
1099
1100         for (i = sources.begin(), io = other->sources.begin(); i != sources.end() && io != other->sources.end(); ++i, ++io) {
1101                 if ((*i)->id() != (*io)->id()) {
1102                         return false;
1103                 }
1104         }
1105
1106         for (i = master_sources.begin(), io = other->master_sources.begin(); i != master_sources.end() && io != other->master_sources.end(); ++i, ++io) {
1107                 if ((*i)->id() != (*io)->id()) {
1108                         return false;
1109                 }
1110         }
1111
1112         return true;
1113 }
1114
1115 int
1116 AudioRegion::apply (AudioFilter& filter)
1117 {
1118         boost::shared_ptr<AudioRegion> ar = boost::dynamic_pointer_cast<AudioRegion> (shared_from_this());
1119         return filter.run (ar);
1120 }
1121
1122 int
1123 AudioRegion::exportme (Session& session, AudioExportSpecification& spec)
1124 {
1125         const nframes_t blocksize = 4096;
1126         nframes_t to_read;
1127         int status = -1;
1128
1129         spec.channels = sources.size();
1130
1131         if (spec.prepare (blocksize, session.frame_rate())) {
1132                 goto out;
1133         }
1134
1135         spec.pos = 0;
1136         spec.total_frames = _length;
1137
1138         while (spec.pos < _length && !spec.stop) {
1139                 
1140                 
1141                 /* step 1: interleave */
1142                 
1143                 to_read = min (_length - spec.pos, blocksize);
1144                 
1145                 if (spec.channels == 1) {
1146
1147                         if (sources.front()->read (spec.dataF, _start + spec.pos, to_read) != to_read) {
1148                                 goto out;
1149                         }
1150
1151                 } else {
1152
1153                         Sample buf[blocksize];
1154
1155                         for (uint32_t chan = 0; chan < spec.channels; ++chan) {
1156                                 
1157                                 if (sources[chan]->read (buf, _start + spec.pos, to_read) != to_read) {
1158                                         goto out;
1159                                 }
1160                                 
1161                                 for (nframes_t x = 0; x < to_read; ++x) {
1162                                         spec.dataF[chan+(x*spec.channels)] = buf[x];
1163                                 }
1164                         }
1165                 }
1166                 
1167                 if (spec.process (to_read)) {
1168                         goto out;
1169                 }
1170                 
1171                 spec.pos += to_read;
1172                 spec.progress = (double) spec.pos /_length;
1173                 
1174         }
1175         
1176         status = 0;
1177
1178   out:  
1179         spec.running = false;
1180         spec.status = status;
1181         spec.clear();
1182         
1183         return status;
1184 }
1185
1186 boost::shared_ptr<Region>
1187 AudioRegion::get_parent() const
1188 {
1189         boost::shared_ptr<Playlist> pl (playlist());
1190
1191         if (pl) {
1192                 boost::shared_ptr<AudioRegion> ar;
1193                 boost::shared_ptr<AudioRegion const> grrr2 = boost::dynamic_pointer_cast<AudioRegion const> (shared_from_this());
1194                 
1195                 if (grrr2 && (ar = pl->session().find_whole_file_parent (grrr2))) {
1196                         return boost::static_pointer_cast<Region> (ar);
1197                 }
1198         }
1199         
1200         return boost::shared_ptr<Region>();
1201 }
1202
1203 void
1204 AudioRegion::set_scale_amplitude (gain_t g)
1205 {
1206         boost::shared_ptr<Playlist> pl (playlist());
1207
1208         _scale_amplitude = g;
1209
1210         /* tell the diskstream we're in */
1211         
1212         if (pl) {
1213                 pl->Modified();
1214         }
1215
1216         /* tell everybody else */
1217
1218         send_change (ScaleAmplitudeChanged);
1219 }
1220
1221 void
1222 AudioRegion::normalize_to (float target_dB)
1223 {
1224         const nframes_t blocksize = 64 * 1024;
1225         Sample buf[blocksize];
1226         nframes_t fpos;
1227         nframes_t fend;
1228         nframes_t to_read;
1229         double maxamp = 0;
1230         gain_t target = dB_to_coefficient (target_dB);
1231
1232         if (target == 1.0f) {
1233                 /* do not normalize to precisely 1.0 (0 dBFS), to avoid making it appear
1234                    that we may have clipped.
1235                 */
1236                 target -= FLT_EPSILON;
1237         }
1238
1239         fpos = _start;
1240         fend = _start + _length;
1241
1242         /* first pass: find max amplitude */
1243
1244         while (fpos < fend) {
1245
1246                 uint32_t n;
1247
1248                 to_read = min (fend - fpos, blocksize);
1249
1250                 for (n = 0; n < n_channels(); ++n) {
1251
1252                         /* read it in */
1253
1254                         if (source (n)->read (buf, fpos, to_read) != to_read) {
1255                                 return;
1256                         }
1257                         
1258                         maxamp = Session::compute_peak (buf, to_read, maxamp);
1259                 }
1260
1261                 fpos += to_read;
1262         };
1263
1264         if (maxamp == 0.0f) {
1265                 /* don't even try */
1266                 return;
1267         }
1268
1269         if (maxamp == target) {
1270                 /* we can't do anything useful */
1271                 return;
1272         }
1273
1274         /* compute scale factor */
1275
1276         _scale_amplitude = target/maxamp;
1277
1278         /* tell the diskstream we're in */
1279
1280         boost::shared_ptr<Playlist> pl (playlist());
1281
1282         if (pl) {
1283                 pl->Modified();
1284         }
1285
1286         /* tell everybody else */
1287
1288         send_change (ScaleAmplitudeChanged);
1289 }
1290
1291 void
1292 AudioRegion::fade_in_changed ()
1293 {
1294         send_change (FadeInChanged);
1295 }
1296
1297 void
1298 AudioRegion::fade_out_changed ()
1299 {
1300         send_change (FadeOutChanged);
1301 }
1302
1303 void
1304 AudioRegion::envelope_changed ()
1305 {
1306         send_change (EnvelopeChanged);
1307 }
1308
1309 void
1310 AudioRegion::suspend_fade_in ()
1311 {
1312         if (++_fade_in_disabled == 1) {
1313                 set_fade_in_active (false);
1314         }
1315 }
1316
1317 void
1318 AudioRegion::resume_fade_in ()
1319 {
1320         if (_fade_in_disabled && --_fade_in_disabled == 0) {
1321                 set_fade_in_active (true);
1322         }
1323 }
1324
1325 void
1326 AudioRegion::suspend_fade_out ()
1327 {
1328         if (++_fade_out_disabled == 1) {
1329                 set_fade_out_active (false);
1330         }
1331 }
1332
1333 void
1334 AudioRegion::resume_fade_out ()
1335 {
1336         if (_fade_out_disabled && --_fade_out_disabled == 0) {
1337                 set_fade_out_active (true);
1338         }
1339 }
1340
1341 bool
1342 AudioRegion::speed_mismatch (float sr) const
1343 {
1344         if (sources.empty()) {
1345                 /* impossible, but ... */
1346                 return false;
1347         }
1348
1349         float fsr = sources.front()->sample_rate();
1350
1351         return fsr != sr;
1352 }
1353
1354 void
1355 AudioRegion::source_offset_changed ()
1356 {
1357         boost::shared_ptr<AudioFileSource> afs = boost::dynamic_pointer_cast<AudioFileSource>(sources.front());
1358
1359         if (afs && afs->destructive()) {
1360                 // set_start (source()->natural_position(), this);
1361                 set_position (source()->natural_position(), this);
1362         } 
1363 }
1364
1365 void
1366 AudioRegion::set_playlist (boost::weak_ptr<Playlist> wpl)
1367 {
1368         boost::shared_ptr<Playlist> old_playlist = (_playlist.lock());
1369
1370         boost::shared_ptr<Playlist> pl (wpl.lock());
1371
1372         if (old_playlist == pl) {
1373                 return;
1374         }
1375
1376         Region::set_playlist (wpl);
1377
1378         if (pl) {
1379                 if (old_playlist) {
1380                         for (SourceList::const_iterator i = sources.begin(); i != sources.end(); ++i) {
1381                                 (*i)->remove_playlist (_playlist);      
1382                                 (*i)->add_playlist (pl);
1383                         }
1384                 } else {
1385                         for (SourceList::const_iterator i = sources.begin(); i != sources.end(); ++i) {
1386                                 (*i)->add_playlist (pl);
1387                         }
1388                 }
1389         } else {
1390                 if (old_playlist) {
1391                         for (SourceList::const_iterator i = sources.begin(); i != sources.end(); ++i) {
1392                                 (*i)->remove_playlist (old_playlist);
1393                         }
1394                 }
1395         }
1396 }
1397
1398 extern "C" {
1399
1400         int region_read_peaks_from_c (void *arg, uint32_t npeaks, uint32_t start, uint32_t cnt, intptr_t data, uint32_t n_chan, double samples_per_unit) 
1401 {
1402         return ((AudioRegion *) arg)->read_peaks ((PeakData *) data, (nframes_t) npeaks, (nframes_t) start, (nframes_t) cnt, n_chan,samples_per_unit);
1403 }
1404
1405 uint32_t region_length_from_c (void *arg)
1406 {
1407
1408         return ((AudioRegion *) arg)->length();
1409 }
1410
1411 uint32_t sourcefile_length_from_c (void *arg, double zoom_factor)
1412 {
1413         return ( (AudioRegion *) arg)->source()->available_peaks (zoom_factor) ;
1414 }
1415
1416 } /* extern "C" */