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 #include <ctime>
  24 #include <string>
  25 #include <set>
  26
  27 #include "pbd/error.h"
  28 #include "pbd/pthread_utils.h"
  29 #include "pbd/memento_command.h"
  30 #include "pbd/stateful_diff_command.h"
  31
  32 #include "ardour/audioregion.h"
  33 #include "ardour/midi_stretch.h"
  34 #include "ardour/pitch.h"
  35 #include "ardour/region.h"
  36 #include "ardour/session.h"
  37 #include "ardour/stretch.h"
  38
  39 #include <gtkmm2ext/utils.h>
  40
  41 #include "audio_region_view.h"
  42 #include "audio_time_axis.h"
  43 #include "editor.h"
  44 #include "region_selection.h"
  45 #include "time_fx_dialog.h"
  46
  47 #ifdef USE_RUBBERBAND
  48 #include <rubberband/RubberBandStretcher.h>
  49 using namespace RubberBand;
  50 #endif
  51
  52 #include "pbd/i18n.h"
  53
  54 using namespace std;
  55 using namespace ARDOUR;
  56 using namespace PBD;
  57 using namespace Gtk;
  58 using namespace Gtkmm2ext;
  59
  60 /** @return -1 in case of error, 1 if operation was cancelled by the user, 0 if everything went ok */
  61 int
  62 Editor::time_stretch (RegionSelection& regions, float fraction)
  63 {
  64         RegionList audio;
  65         RegionList midi;
  66         int aret;
  67
  68         begin_reversible_command (_("stretch/shrink"));
  69
  70         for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
  71                 if  ((*i)->region()->data_type() == DataType::AUDIO) {
  72                         audio.push_back ((*i)->region());
  73                 } else if  ((*i)->region()->data_type() == DataType::MIDI) {
  74                         midi.push_back ((*i)->region());
  75                 }
  76         }
  77
  78         if ((aret = time_fx (audio, fraction, false)) != 0) {
  79                 commit_reversible_command ();
  80                 return aret;
  81         }
  82
  83         set<boost::shared_ptr<Playlist> > midi_playlists_affected;
  84
  85         for (RegionList::iterator i = midi.begin(); i != midi.end(); ++i) {
  86                 boost::shared_ptr<Playlist> playlist = (*i)->playlist();
  87
  88                 if (playlist) {
  89                         playlist->clear_changes ();
  90                 }
  91
  92         }
  93
  94         ARDOUR::TimeFXRequest request;
  95         request.time_fraction = fraction;
  96
  97         for (RegionList::iterator i = midi.begin(); i != midi.end(); ++i) {
  98                 boost::shared_ptr<Playlist> playlist = (*i)->playlist();
  99
 100                 if (!playlist) {
 101                         continue;
 102                 }
 103
 104                 MidiStretch stretch (*_session, request);
 105                 stretch.run (*i);
 106
 107                 playlist->replace_region (regions.front()->region(), stretch.results[0],
 108                                           regions.front()->region()->position());
 109                 midi_playlists_affected.insert (playlist);
 110         }
 111
 112         for (set<boost::shared_ptr<Playlist> >::iterator p = midi_playlists_affected.begin(); p != midi_playlists_affected.end(); ++p) {
 113                 _session->add_command (new StatefulDiffCommand (*p));
 114         }
 115
 116         commit_reversible_command ();
 117
 118         return 0;
 119 }
 120
 121 int
 122 Editor::pitch_shift (RegionSelection& regions, float fraction)
 123 {
 124         RegionList rl;
 125
 126         for (RegionSelection::iterator i = regions.begin(); i != regions.end(); ++i) {
 127                 rl.push_back ((*i)->region());
 128         }
 129
 130         begin_reversible_command (_("pitch shift"));
 131
 132         int ret = time_fx (rl, fraction, true);
 133
 134         if (ret == 0) {
 135                 commit_reversible_command ();
 136         } else {
 137                 abort_reversible_command ();
 138         }
 139
 140         return ret;
 141 }
 142
 143 /** @param val Percentage to time stretch by; ignored if pitch-shifting.
 144  *  @param pitching true to pitch shift, false to time stretch.
 145  *  @return -1 in case of error, 1 if operation was cancelled by the user, 0 if everything went ok */
 146 int
 147 Editor::time_fx (RegionList& regions, float val, bool pitching)
 148 {
 149         if (regions.empty()) {
 150                 return 0;
 151         }
 152
 153         const framecnt_t oldlen = (framecnt_t) (regions.front()->length());
 154         const framecnt_t newlen = (framecnt_t) (regions.front()->length() * val);
 155         const framecnt_t pos = regions.front()->position ();
 156
 157         delete current_timefx;
 158         current_timefx = new TimeFXDialog (*this, pitching, oldlen, newlen, pos);
 159         current_timefx->regions = regions;
 160
 161         switch (current_timefx->run ()) {
 162         case RESPONSE_ACCEPT:
 163                 break;
 164         default:
 165                 current_timefx->hide ();
 166                 return 1;
 167         }
 168
 169         current_timefx->status = 0;
 170         current_timefx->request.time_fraction = current_timefx->get_time_fraction ();
 171         current_timefx->request.pitch_fraction = current_timefx->get_pitch_fraction ();
 172
 173         if (current_timefx->request.time_fraction == 1.0 &&
 174             current_timefx->request.pitch_fraction == 1.0) {
 175                 /* nothing to do */
 176                 current_timefx->hide ();
 177                 return 0;
 178         }
 179
 180 #ifdef USE_RUBBERBAND
 181         /* parse options */
 182
 183         RubberBandStretcher::Options options = 0;
 184
 185         bool realtime = false;
 186         bool precise = false;
 187         bool peaklock = true;
 188         bool longwin = false;
 189         bool shortwin = false;
 190         bool preserve_formants = false;
 191         string txt;
 192
 193         enum {
 194                 NoTransients,
 195                 BandLimitedTransients,
 196                 Transients
 197         } transients = Transients;
 198
 199         precise = current_timefx->precise_button.get_active();
 200         preserve_formants = current_timefx->preserve_formants_button.get_active();
 201
 202         txt = current_timefx->stretch_opts_selector.get_active_text ();
 203
 204         for (int i = 0; i <= 6; i++) {
 205                 if (txt == rb_opt_strings[i]) {
 206                         rb_current_opt = i;
 207                         break;
 208                 }
 209         }
 210
 211         switch (rb_current_opt) {
 212                 case 0:
 213                         transients = NoTransients; peaklock = false; longwin = true; shortwin = false;
 214                         break;
 215                 case 1:
 216                         transients = NoTransients; peaklock = false; longwin = false; shortwin = false;
 217                         break;
 218                 case 2:
 219                         transients = NoTransients; peaklock = true; longwin = false; shortwin = false;
 220                         break;
 221                 case 3:
 222                         transients = BandLimitedTransients; peaklock = true; longwin = false; shortwin = false;
 223                         break;
 224                 case 5:
 225                         transients = Transients; peaklock = false; longwin = false; shortwin = true;
 226                         break;
 227                 case 6:
 228                         transients = NoTransients;
 229                         precise = true;
 230                         preserve_formants = false;
 231                         current_timefx->request.pitch_fraction = 1/val;
 232                         shortwin = true;
 233                         // peaklock = false;
 234                         break;
 235                 default:
 236                         /* default/4 */
 237                         transients = Transients; peaklock = true; longwin = false; shortwin = false;
 238                         break;
 239         };
 240
 241         if (realtime)          options |= RubberBandStretcher::OptionProcessRealTime;
 242         if (precise)           options |= RubberBandStretcher::OptionStretchPrecise;
 243         if (preserve_formants) options |= RubberBandStretcher::OptionFormantPreserved;
 244         if (!peaklock)         options |= RubberBandStretcher::OptionPhaseIndependent;
 245         if (longwin)           options |= RubberBandStretcher::OptionWindowLong;
 246         if (shortwin)          options |= RubberBandStretcher::OptionWindowShort;
 247
 248         switch (transients) {
 249         case NoTransients:
 250                 options |= RubberBandStretcher::OptionTransientsSmooth;
 251                 break;
 252         case BandLimitedTransients:
 253                 options |= RubberBandStretcher::OptionTransientsMixed;
 254                 break;
 255         case Transients:
 256                 options |= RubberBandStretcher::OptionTransientsCrisp;
 257                 break;
 258         }
 259
 260         current_timefx->request.opts = (int) options;
 261 #else
 262         current_timefx->request.quick_seek = current_timefx->quick_button.get_active();
 263         current_timefx->request.antialias = !current_timefx->antialias_button.get_active();
 264 #endif
 265         current_timefx->request.done = false;
 266         current_timefx->request.cancel = false;
 267
 268         /* re-connect the cancel button and delete events */
 269
 270         current_timefx->first_cancel.disconnect();
 271         current_timefx->first_delete.disconnect();
 272
 273         current_timefx->first_cancel = current_timefx->cancel_button->signal_clicked().connect
 274                 (sigc::mem_fun (current_timefx, &TimeFXDialog::cancel_in_progress));
 275         current_timefx->first_delete = current_timefx->signal_delete_event().connect
 276                 (sigc::mem_fun (current_timefx, &TimeFXDialog::delete_in_progress));
 277
 278         current_timefx->start_updates ();
 279
 280         if (pthread_create_and_store ("timefx", &current_timefx->request.thread, timefx_thread, current_timefx)) {
 281                 current_timefx->hide ();
 282                 error << _("timefx cannot be started - thread creation error") << endmsg;
 283                 return -1;
 284         }
 285
 286         pthread_detach (current_timefx->request.thread);
 287
 288         while (!current_timefx->request.done && !current_timefx->request.cancel) {
 289                 gtk_main_iteration ();
 290         }
 291
 292         pthread_join (current_timefx->request.thread, 0);
 293
 294         current_timefx->hide ();
 295         return current_timefx->status;
 296 }
 297
 298 void
 299 Editor::do_timefx ()
 300 {
 301         boost::shared_ptr<Playlist> playlist;
 302         boost::shared_ptr<Region>   new_region;
 303         set<boost::shared_ptr<Playlist> > playlists_affected;
 304
 305         uint32_t const N = current_timefx->regions.size ();
 306
 307         for (RegionList::iterator i = current_timefx->regions.begin(); i != current_timefx->regions.end(); ++i) {
 308                 boost::shared_ptr<Playlist> playlist = (*i)->playlist();
 309
 310                 if (playlist) {
 311                         playlist->clear_changes ();
 312                 }
 313         }
 314
 315         for (RegionList::iterator i = current_timefx->regions.begin(); i != current_timefx->regions.end(); ++i) {
 316
 317                 boost::shared_ptr<AudioRegion> region = boost::dynamic_pointer_cast<AudioRegion> (*i);
 318
 319                 if (!region || (playlist = region->playlist()) == 0) {
 320                         continue;
 321                 }
 322
 323                 if (current_timefx->request.cancel) {
 324                         /* we were cancelled */
 325                         /* XXX what to do about playlists already affected ? */
 326                         current_timefx->status = 1;
 327                         return;
 328                 }
 329
 330                 Filter* fx;
 331
 332                 if (current_timefx->pitching) {
 333                         fx = new Pitch (*_session, current_timefx->request);
 334                 } else {
 335 #ifdef USE_RUBBERBAND
 336                         fx = new RBStretch (*_session, current_timefx->request);
 337 #else
 338                         fx = new STStretch (*_session, current_timefx->request);
 339 #endif
 340                 }
 341
 342                 current_timefx->descend (1.0 / N);
 343
 344                 if (fx->run (region, current_timefx)) {
 345                         current_timefx->status = -1;
 346                         current_timefx->request.done = true;
 347                         delete fx;
 348                         return;
 349                 }
 350
 351                 if (!fx->results.empty()) {
 352                         new_region = fx->results.front();
 353
 354                         playlist->replace_region (region, new_region, region->position());
 355                         playlists_affected.insert (playlist);
 356                 }
 357
 358                 current_timefx->ascend ();
 359                 delete fx;
 360         }
 361
 362         for (set<boost::shared_ptr<Playlist> >::iterator p = playlists_affected.begin(); p != playlists_affected.end(); ++p) {
 363                 _session->add_command (new StatefulDiffCommand (*p));
 364         }
 365
 366         current_timefx->status = 0;
 367         current_timefx->request.done = true;
 368 }
 369
 370 void*
 371 Editor::timefx_thread (void *arg)
 372 {
 373         SessionEvent::create_per_thread_pool ("timefx events", 64);
 374
 375         TimeFXDialog* tsd = static_cast<TimeFXDialog*>(arg);
 376
 377         pthread_setcanceltype (PTHREAD_CANCEL_ASYNCHRONOUS, 0);
 378
 379         tsd->editor.do_timefx ();
 380
 381         /* GACK! HACK! sleep for a bit so that our request buffer for the GUI
 382            event loop doesn't die before any changes we made are processed
 383            by the GUI ...
 384         */
 385
 386 #ifdef PLATFORM_WINDOWS
 387         Glib::usleep(2 * G_USEC_PER_SEC);
 388 #else
 389         struct timespec t = { 2, 0 };
 390         nanosleep (&t, 0);
 391 #endif
 392         return 0;
 393 }