libs/ardour/session_click.cc

   1 /*
   2     Copyright (C) 2002 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 <list>
  21 #include <cerrno>
  22
  23 #include "ardour/amp.h"
  24 #include "ardour/audio_buffer.h"
  25 #include "ardour/buffer_set.h"
  26 #include "ardour/click.h"
  27 #include "ardour/io.h"
  28 #include "ardour/session.h"
  29 #include "ardour/tempo.h"
  30 #include "ardour/types.h"
  31
  32 #include <sndfile.h>
  33
  34 #include "pbd/i18n.h"
  35
  36 using namespace std;
  37 using namespace ARDOUR;
  38 using namespace PBD;
  39
  40 Pool Click::pool ("click", sizeof (Click), 1024);
  41
  42 void
  43 Session::add_click (framepos_t pos, bool emphasis)
  44 {
  45         if (emphasis) {
  46                 if (click_emphasis_data && Config->get_use_click_emphasis () == true) {
  47                         clicks.push_back (new Click (pos, click_emphasis_length, click_emphasis_data));
  48                 } else if (click_data && Config->get_use_click_emphasis () == false) {
  49                         clicks.push_back (new Click (pos, click_length, click_data));
  50                 }
  51         } else if (click_data) {
  52                 clicks.push_back (new Click (pos, click_length, click_data));
  53         }
  54 }
  55
  56 void
  57 Session::click (framepos_t start, framecnt_t nframes)
  58 {
  59         vector<TempoMap::BBTPoint> points;
  60         framecnt_t click_distance;
  61
  62         if (_click_io == 0) {
  63                 return;
  64         }
  65
  66         Glib::Threads::RWLock::WriterLock clickm (click_lock, Glib::Threads::TRY_LOCK);
  67
  68         /* how far have we moved since the last time the clicks got cleared
  69          */
  70
  71         click_distance = start - _clicks_cleared;
  72
  73         if (!clickm.locked() || !_clicking || click_data == 0 || ((click_distance + nframes) < _worst_track_latency)) {
  74                 _click_io->silence (nframes);
  75                 return;
  76         }
  77
  78         start -= _worst_track_latency;
  79         /* start could be negative at this point */
  80         const framepos_t end = start + nframes;
  81         /* correct start, potentially */
  82         start = max (start, (framepos_t) 0);
  83
  84         _tempo_map->get_grid (points, start, end);
  85
  86         if (distance (points.begin(), points.end()) == 0) {
  87                 goto run_clicks;
  88         }
  89
  90         for (vector<TempoMap::BBTPoint>::iterator i = points.begin(); i != points.end(); ++i) {
  91                 switch ((*i).beat) {
  92                 case 1:
  93                         add_click ((*i).frame, true);
  94                         break;
  95                 default:
  96                         if (click_emphasis_data == 0 || (Config->get_use_click_emphasis () == false) || (click_emphasis_data && (*i).beat != 1)) { // XXX why is this check needed ??
  97                                 add_click ((*i).frame, false);
  98                         }
  99                         break;
 100                 }
 101         }
 102
 103   run_clicks:
 104         clickm.release ();
 105         run_click (start, nframes);
 106 }
 107
 108 void
 109 Session::run_click (framepos_t start, framepos_t nframes)
 110 {
 111         Glib::Threads::RWLock::ReaderLock clickm (click_lock, Glib::Threads::TRY_LOCK);
 112
 113         if (!clickm.locked() || click_data == 0) {
 114                 _click_io->silence (nframes);
 115                 return;
 116         }
 117
 118         Sample *buf;
 119         BufferSet& bufs = get_scratch_buffers(ChanCount(DataType::AUDIO, 1));
 120         buf = bufs.get_audio(0).data();
 121         memset (buf, 0, sizeof (Sample) * nframes);
 122
 123         for (list<Click*>::iterator i = clicks.begin(); i != clicks.end(); ) {
 124
 125                 framecnt_t copy;
 126                 framecnt_t internal_offset;
 127                 Click *clk;
 128
 129                 clk = *i;
 130
 131                 if (clk->start < start) {
 132                         internal_offset = 0;
 133                 } else {
 134                         internal_offset = clk->start - start;
 135                 }
 136
 137                 if (nframes < internal_offset) {
 138                          /* we've just located or something..
 139                             effectively going backwards.
 140                             lets get the flock out of here */
 141                         break;
 142                 }
 143
 144                 copy = min (clk->duration - clk->offset, nframes - internal_offset);
 145
 146                 memcpy (buf + internal_offset, &clk->data[clk->offset], copy * sizeof (Sample));
 147
 148                 clk->offset += copy;
 149
 150                 if (clk->offset >= clk->duration) {
 151                         delete clk;
 152                         i = clicks.erase (i);
 153                 } else {
 154                         ++i;
 155                 }
 156         }
 157
 158         _click_gain->run (bufs, 0, 0, 1.0, nframes, false);
 159         _click_io->copy_to_outputs (bufs, DataType::AUDIO, nframes, 0);
 160 }
 161
 162 void
 163 Session::setup_click_sounds (Sample** data, Sample const * default_data, framecnt_t* length, framecnt_t default_length, string const & path)
 164 {
 165         if (*data != default_data) {
 166                 delete[] *data;
 167                 *data = 0;
 168         }
 169
 170         if (path.empty ()) {
 171
 172                 *data = const_cast<Sample*> (default_data);
 173                 *length = default_length;
 174
 175         } else {
 176
 177                 SF_INFO info;
 178                 SNDFILE* sndfile;
 179
 180                 info.format = 0;
 181                 if ((sndfile = sf_open (path.c_str(), SFM_READ, &info)) == 0) {
 182                         char errbuf[256];
 183                         sf_error_str (0, errbuf, sizeof (errbuf) - 1);
 184                         warning << string_compose (_("cannot open click soundfile %1 (%2)"), path, errbuf) << endmsg;
 185                         _clicking = false;
 186                         return;
 187                 }
 188
 189                 /* read the (possibly multi-channel) click data into a temporary buffer */
 190
 191                 sf_count_t const samples = info.frames * info.channels;
 192
 193                 Sample* tmp = new Sample[samples];
 194
 195                 if (sf_readf_float (sndfile, tmp, info.frames) != info.frames) {
 196
 197                         warning << _("cannot read data from click soundfile") << endmsg;
 198                         *data = 0;
 199                         _clicking = false;
 200
 201                 } else {
 202
 203                         *data = new Sample[info.frames];
 204                         *length = info.frames;
 205
 206                         /* mix down to mono */
 207
 208                         for (int i = 0; i < info.frames; ++i) {
 209                                 (*data)[i] = 0;
 210                                 for (int j = 0; j < info.channels; ++j) {
 211                                         (*data)[i] = tmp[i * info.channels + j];
 212                                 }
 213                                 (*data)[i] /= info.channels;
 214                         }
 215                 }
 216
 217                 delete[] tmp;
 218                 sf_close (sndfile);
 219         }
 220 }
 221
 222 void
 223 Session::setup_click_sounds (int which)
 224 {
 225         clear_clicks ();
 226
 227         if (which == 0 || which == 1) {
 228                 setup_click_sounds (
 229                         &click_data,
 230                         default_click,
 231                         &click_length,
 232                         default_click_length,
 233                         Config->get_click_sound ()
 234                         );
 235         }
 236
 237         if (which == 0 || which == -1) {
 238                 setup_click_sounds (
 239                         &click_emphasis_data,
 240                         default_click_emphasis,
 241                         &click_emphasis_length,
 242                         default_click_emphasis_length,
 243                         Config->get_click_emphasis_sound ()
 244                         );
 245         }
 246 }
 247
 248 void
 249 Session::clear_clicks ()
 250 {
 251         Glib::Threads::RWLock::WriterLock lm (click_lock);
 252
 253         for (Clicks::iterator i = clicks.begin(); i != clicks.end(); ++i) {
 254                 delete *i;
 255         }
 256
 257         clicks.clear ();
 258         _clicks_cleared = _transport_frame;
 259 }