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/ardour.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
  31 #include <sndfile.h>
  32
  33 #include "i18n.h"
  34
  35 using namespace std;
  36 using namespace ARDOUR;
  37 using namespace PBD;
  38
  39 Pool Click::pool ("click", sizeof (Click), 128);
  40
  41 void
  42 Session::click (framepos_t start, framecnt_t nframes)
  43 {
  44         TempoMap::BBTPointList::const_iterator points_begin;
  45         TempoMap::BBTPointList::const_iterator points_end;
  46         Sample *buf;
  47
  48         if (_click_io == 0) {
  49                 return;
  50         }
  51
  52         Glib::RWLock::WriterLock clickm (click_lock, Glib::TRY_LOCK);
  53
  54         if (!clickm.locked() || _transport_speed != 1.0 || !_clicking || click_data == 0) {
  55                 _click_io->silence (nframes);
  56                 return;
  57         }
  58
  59         const framepos_t end = start + nframes;
  60
  61         BufferSet& bufs = get_scratch_buffers(ChanCount(DataType::AUDIO, 1));
  62         buf = bufs.get_audio(0).data();
  63         _tempo_map->get_grid (points_begin, points_end, start, end);
  64
  65         if (distance (points_begin, points_end) == 0) {
  66                 goto run_clicks;
  67         }
  68
  69         for (TempoMap::BBTPointList::const_iterator i = points_begin; i != points_end; ++i) {
  70                 switch ((*i).beat) {
  71                 case 1:
  72                         if (click_emphasis_data) {
  73                                 clicks.push_back (new Click ((*i).frame, click_emphasis_length, click_emphasis_data));
  74                         }
  75                         break;
  76
  77                 default:
  78                         if (click_emphasis_data == 0 || (click_emphasis_data && (*i).beat != 1)) {
  79                                 clicks.push_back (new Click ((*i).frame, click_length, click_data));
  80                         }
  81                         break;
  82                 }
  83
  84         }
  85
  86   run_clicks:
  87         memset (buf, 0, sizeof (Sample) * nframes);
  88
  89         for (list<Click*>::iterator i = clicks.begin(); i != clicks.end(); ) {
  90
  91                 framecnt_t copy;
  92                 framecnt_t internal_offset;
  93                 Click *clk;
  94                 list<Click*>::iterator next;
  95
  96                 clk = *i;
  97                 next = i;
  98                 ++next;
  99
 100                 if (clk->start < start) {
 101                         internal_offset = 0;
 102                 } else {
 103                         internal_offset = clk->start - start;
 104                 }
 105
 106                 if (nframes < internal_offset) {
 107                          /* we've just located or something..
 108                             effectively going backwards.
 109                             lets get the flock out of here */
 110                         break;
 111                 }
 112
 113                 copy = min (clk->duration - clk->offset, nframes - internal_offset);
 114
 115                 memcpy (buf + internal_offset, &clk->data[clk->offset], copy * sizeof (Sample));
 116
 117                 clk->offset += copy;
 118
 119                 if (clk->offset >= clk->duration) {
 120                         delete clk;
 121                         clicks.erase (i);
 122                 }
 123
 124
 125                 i = next;
 126         }
 127
 128         _click_io->copy_to_outputs (bufs, DataType::AUDIO, nframes, 0);
 129 }
 130
 131 void
 132 Session::setup_click_sounds (Sample** data, Sample const * default_data, framecnt_t* length, framecnt_t default_length, string const & path)
 133 {
 134         if (*data != default_data) {
 135                 delete[] *data;
 136                 *data = 0;
 137         }
 138
 139         if (path.empty ()) {
 140
 141                 *data = const_cast<Sample*> (default_data);
 142                 *length = default_length;
 143
 144         } else {
 145
 146                 SF_INFO info;
 147                 SNDFILE* sndfile;
 148
 149                 info.format = 0;
 150                 if ((sndfile = sf_open (path.c_str(), SFM_READ, &info)) == 0) {
 151                         char errbuf[256];
 152                         sf_error_str (0, errbuf, sizeof (errbuf) - 1);
 153                         warning << string_compose (_("cannot open click soundfile %1 (%2)"), path, errbuf) << endmsg;
 154                         _clicking = false;
 155                         return;
 156                 }
 157
 158                 /* read the (possibly multi-channel) click data into a temporary buffer */
 159
 160                 sf_count_t const samples = info.frames * info.channels;
 161
 162                 Sample* tmp = new Sample[samples];
 163
 164                 if (sf_readf_float (sndfile, tmp, info.frames) != info.frames) {
 165
 166                         warning << _("cannot read data from click soundfile") << endmsg;
 167                         *data = 0;
 168                         _clicking = false;
 169
 170                 } else {
 171
 172                         *data = new Sample[info.frames];
 173                         *length = info.frames;
 174
 175                         /* mix down to mono */
 176
 177                         for (int i = 0; i < info.frames; ++i) {
 178                                 (*data)[i] = 0;
 179                                 for (int j = 0; j < info.channels; ++j) {
 180                                         (*data)[i] = tmp[i * info.channels + j];
 181                                 }
 182                                 (*data)[i] /= info.channels;
 183                         }
 184                 }
 185
 186                 delete[] tmp;
 187                 sf_close (sndfile);
 188         }
 189 }
 190
 191 void
 192 Session::setup_click_sounds (int which)
 193 {
 194         clear_clicks ();
 195
 196         if (which == 0 || which == 1) {
 197                 setup_click_sounds (
 198                         &click_data,
 199                         default_click,
 200                         &click_length,
 201                         default_click_length,
 202                         Config->get_click_sound ()
 203                         );
 204         }
 205
 206         if (which == 0 || which == -1) {
 207                 setup_click_sounds (
 208                         &click_emphasis_data,
 209                         default_click_emphasis,
 210                         &click_emphasis_length,
 211                         default_click_emphasis_length,
 212                         Config->get_click_emphasis_sound ()
 213                         );
 214         }
 215 }
 216
 217 void
 218 Session::clear_clicks ()
 219 {
 220         Glib::RWLock::WriterLock lm (click_lock);
 221
 222         for (Clicks::iterator i = clicks.begin(); i != clicks.end(); ++i) {
 223                 delete *i;
 224         }
 225
 226         clicks.clear ();
 227 }