Patch from colinf to add tape-style region stretching via rubberband. Fixes #3075.
[ardour.git] / gtk2_ardour / editor_timefx.cc
1 /*
2     Copyright (C) 2000 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 <iostream>
21 #include <cstdlib>
22 #include <cmath>
23
24 #include <string>
25
26 #include "pbd/error.h"
27 #include "pbd/pthread_utils.h"
28 #include "pbd/memento_command.h"
29 #include "pbd/stateful_diff_command.h"
30
31 #include <gtkmm2ext/utils.h>
32
33 #include "audio_region_view.h"
34 #include "audio_time_axis.h"
35 #include "editor.h"
36 #include "region_selection.h"
37 #include "time_fx_dialog.h"
38
39 #include "ardour/session.h"
40 #include "ardour/region.h"
41 #include "ardour/audioplaylist.h"
42 #include "ardour/audio_track.h"
43 #include "ardour/audioregion.h"
44 #include "ardour/stretch.h"
45 #include "ardour/midi_stretch.h"
46 #include "ardour/pitch.h"
47
48 #ifdef USE_RUBBERBAND
49 #include "rubberband/RubberBandStretcher.h"
50 using namespace RubberBand;
51 #endif
52
53 #include "i18n.h"
54
55 using namespace std;
56 using namespace ARDOUR;
57 using namespace PBD;
58 using namespace Gtk;
59 using namespace Gtkmm2ext;
60
61 /** @return -1 in case of error, 1 if operation was cancelled by the user, 0 if everything went ok */
62 int
63 Editor::time_stretch (RegionSelection& regions, float fraction)
64 {
65         // FIXME: kludge, implement stretching of selection of both types
66
67         if (regions.front()->region()->data_type() == DataType::AUDIO) {
68                 // Audio, pop up timefx dialog
69                 return time_fx (regions, fraction, false);
70         } else {
71                 // MIDI, just stretch
72                 RouteTimeAxisView* rtv = dynamic_cast<RouteTimeAxisView*> (&regions.front()->get_time_axis_view());
73                 if (!rtv)
74                         return -1;
75
76                 boost::shared_ptr<Playlist> playlist
77                         = rtv->track()->playlist();
78
79             ARDOUR::TimeFXRequest request;
80                 request.time_fraction = fraction;
81                 MidiStretch stretch(*_session, request);
82                 begin_reversible_command ("midi stretch");
83                 stretch.run(regions.front()->region());
84                 playlist->clear_history ();
85                 playlist->replace_region (regions.front()->region(), stretch.results[0],
86                                 regions.front()->region()->position());
87                 _session->add_command (new StatefulDiffCommand (playlist));
88                 commit_reversible_command ();
89         }
90
91         return 0;
92 }
93
94 int
95 Editor::pitch_shift (RegionSelection& regions, float fraction)
96 {
97         return time_fx (regions, fraction, true);
98 }
99
100 /** @return -1 in case of error, 1 if operation was cancelled by the user, 0 if everything went ok */
101 int
102 Editor::time_fx (RegionSelection& regions, float val, bool pitching)
103 {
104         delete current_timefx;
105
106         current_timefx = new TimeFXDialog (*this, pitching);
107
108         current_timefx->progress_bar.set_fraction (0.0f);
109
110         switch (current_timefx->run ()) {
111         case RESPONSE_ACCEPT:
112                 break;
113         default:
114                 current_timefx->hide ();
115                 return 1;
116         }
117
118         current_timefx->status = 0;
119         current_timefx->regions = regions;
120
121         if (pitching) {
122
123                 float cents = current_timefx->pitch_octave_adjustment.get_value() * 1200.0;
124                 float pitch_fraction;
125                 cents += current_timefx->pitch_semitone_adjustment.get_value() * 100.0;
126                 cents += current_timefx->pitch_cent_adjustment.get_value();
127
128                 if (cents == 0.0) {
129                         // user didn't change anything
130                         current_timefx->hide ();
131                         return 0;
132                 }
133
134                 // one octave == 1200 cents
135                 // adding one octave doubles the frequency
136                 // ratio is 2^^octaves
137
138                 pitch_fraction = pow(2, cents/1200);
139
140                 current_timefx->request.time_fraction = 1.0;
141                 current_timefx->request.pitch_fraction = pitch_fraction;
142
143         } else {
144
145                 current_timefx->request.time_fraction = val;
146                 current_timefx->request.pitch_fraction = 1.0;
147
148         }
149
150 #ifdef USE_RUBBERBAND
151         /* parse options */
152
153         RubberBandStretcher::Options options = 0;
154
155         bool realtime = false;
156         bool precise = false;
157         bool peaklock = true;
158         bool longwin = false;
159         bool shortwin = false;
160         bool preserve_formants = false;
161         string txt;
162
163         enum {
164                 NoTransients,
165                 BandLimitedTransients,
166                 Transients
167         } transients = Transients;
168
169         precise = current_timefx->precise_button.get_active();
170         preserve_formants = current_timefx->preserve_formants_button.get_active();
171
172         txt = current_timefx->stretch_opts_selector.get_active_text ();
173
174         for (int i = 0; i <= 6; i++) {
175                 if (txt == rb_opt_strings[i]) {
176                         rb_current_opt = i;
177                         break;
178                 }
179         }
180         
181         switch (rb_current_opt) {
182                 case 0:
183                         transients = NoTransients; peaklock = false; longwin = true; shortwin = false; 
184                         break;
185                 case 1:
186                         transients = NoTransients; peaklock = false; longwin = false; shortwin = false; 
187                         break;
188                 case 2:
189                         transients = NoTransients; peaklock = true; longwin = false; shortwin = false; 
190                         break;
191                 case 3:
192                         transients = BandLimitedTransients; peaklock = true; longwin = false; shortwin = false; 
193                         break;
194                 case 5:
195                         transients = Transients; peaklock = false; longwin = false; shortwin = true; 
196                         break;
197                 case 6:
198                         transients = NoTransients;
199                         precise = true;
200                         preserve_formants = false;
201                         current_timefx->request.pitch_fraction = 1/val;
202                         shortwin = true;
203                         // peaklock = false;
204                         break;
205                 default:
206                         /* default/4 */ 
207                         transients = Transients; peaklock = true; longwin = false; shortwin = false; 
208                         break;
209         };
210
211         if (realtime)          options |= RubberBandStretcher::OptionProcessRealTime;
212         if (precise)           options |= RubberBandStretcher::OptionStretchPrecise;
213         if (preserve_formants) options |= RubberBandStretcher::OptionFormantPreserved;
214         if (!peaklock)         options |= RubberBandStretcher::OptionPhaseIndependent;
215         if (longwin)           options |= RubberBandStretcher::OptionWindowLong;
216         if (shortwin)          options |= RubberBandStretcher::OptionWindowShort;
217
218         switch (transients) {
219         case NoTransients:
220                 options |= RubberBandStretcher::OptionTransientsSmooth;
221                 break;
222         case BandLimitedTransients:
223                 options |= RubberBandStretcher::OptionTransientsMixed;
224                 break;
225         case Transients:
226                 options |= RubberBandStretcher::OptionTransientsCrisp;
227                 break;
228         }
229
230         current_timefx->request.opts = (int) options;
231 #else
232         current_timefx->request.quick_seek = current_timefx->quick_button.get_active();
233         current_timefx->request.antialias = !current_timefx->antialias_button.get_active();
234 #endif
235         current_timefx->request.progress = 0.0f;
236         current_timefx->request.done = false;
237         current_timefx->request.cancel = false;
238
239         /* re-connect the cancel button and delete events */
240
241         current_timefx->first_cancel.disconnect();
242         current_timefx->first_delete.disconnect();
243
244         current_timefx->first_cancel = current_timefx->cancel_button->signal_clicked().connect
245                 (sigc::mem_fun (current_timefx, &TimeFXDialog::cancel_in_progress));
246         current_timefx->first_delete = current_timefx->signal_delete_event().connect
247                 (sigc::mem_fun (current_timefx, &TimeFXDialog::delete_in_progress));
248
249         if (pthread_create_and_store ("timefx", &current_timefx->request.thread, timefx_thread, current_timefx)) {
250                 current_timefx->hide ();
251                 error << _("timefx cannot be started - thread creation error") << endmsg;
252                 return -1;
253         }
254
255         pthread_detach (current_timefx->request.thread);
256
257         sigc::connection c = Glib::signal_timeout().connect (sigc::mem_fun (current_timefx, &TimeFXDialog::update_progress), 100);
258
259         while (!current_timefx->request.done && !current_timefx->request.cancel) {
260                 gtk_main_iteration ();
261         }
262
263         c.disconnect ();
264
265         current_timefx->hide ();
266         return current_timefx->status;
267 }
268
269 void
270 Editor::do_timefx (TimeFXDialog& dialog)
271 {
272         Track*    t;
273         boost::shared_ptr<Playlist> playlist;
274         boost::shared_ptr<Region>   new_region;
275         bool in_command = false;
276
277         for (RegionSelection::iterator i = dialog.regions.begin(); i != dialog.regions.end(); ) {
278                 AudioRegionView* arv = dynamic_cast<AudioRegionView*>(*i);
279
280                 if (!arv) {
281                         continue;
282                 }
283
284                 boost::shared_ptr<AudioRegion> region (arv->audio_region());
285                 TimeAxisView* tv = &(arv->get_time_axis_view());
286                 RouteTimeAxisView* rtv;
287                 RegionSelection::iterator tmp;
288
289                 tmp = i;
290                 ++tmp;
291
292                 if ((rtv = dynamic_cast<RouteTimeAxisView*> (tv)) == 0) {
293                         i = tmp;
294                         continue;
295                 }
296
297                 if ((t = dynamic_cast<Track*> (rtv->route().get())) == 0) {
298                         i = tmp;
299                         continue;
300                 }
301
302                 if ((playlist = t->playlist()) == 0) {
303                         i = tmp;
304                         continue;
305                 }
306
307                 if (dialog.request.cancel) {
308                         /* we were cancelled */
309                         dialog.status = 1;
310                         return;
311                 }
312
313                 Filter* fx;
314
315                 if (dialog.pitching) {
316                         fx = new Pitch (*_session, dialog.request);
317                 } else {
318 #ifdef USE_RUBBERBAND
319                         fx = new RBStretch (*_session, dialog.request);
320 #else
321                         fx = new STStretch (*_session, dialog.request);
322 #endif
323                 }
324
325                 if (fx->run (region)) {
326                         dialog.status = -1;
327                         dialog.request.done = true;
328                         delete fx;
329                         return;
330                 }
331
332                 if (!fx->results.empty()) {
333                         new_region = fx->results.front();
334
335                         if (!in_command) {
336                                 _session->begin_reversible_command (dialog.pitching ? _("pitch shift") : _("time stretch"));
337                                 in_command = true;
338                         }
339
340                         playlist->clear_history ();
341                         playlist->replace_region (region, new_region, region->position());
342                         _session->add_command (new StatefulDiffCommand (playlist));
343                 }
344
345                 i = tmp;
346                 delete fx;
347         }
348
349         if (in_command) {
350                 _session->commit_reversible_command ();
351         }
352
353         dialog.status = 0;
354         dialog.request.done = true;
355 }
356
357 void*
358 Editor::timefx_thread (void *arg)
359 {
360         SessionEvent::create_per_thread_pool ("timefx events", 64);
361
362         TimeFXDialog* tsd = static_cast<TimeFXDialog*>(arg);
363
364         pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
365
366         tsd->editor.do_timefx (*tsd);
367
368         return 0;
369 }
370