libs/ardour/source_factory.cc

   1 /*
   2     Copyright (C) 2000-2006 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     $Id$
  19 */
  20
  21 #ifdef WAF_BUILD
  22 #include "libardour-config.h"
  23 #endif
  24
  25 #include "pbd/boost_debug.h"
  26 #include "pbd/error.h"
  27 #include "pbd/convert.h"
  28 #include "pbd/pthread_utils.h"
  29 #include "pbd/stacktrace.h"
  30
  31 #include "ardour/source_factory.h"
  32 #include "ardour/sndfilesource.h"
  33 #include "ardour/silentfilesource.h"
  34 #include "ardour/rc_configuration.h"
  35 #include "ardour/smf_source.h"
  36 #include "ardour/session.h"
  37
  38 #ifdef  HAVE_COREAUDIO
  39 #define USE_COREAUDIO_FOR_FILES
  40 #endif
  41
  42 #ifdef USE_COREAUDIO_FOR_FILES
  43 #include "ardour/coreaudiosource.h"
  44 #endif
  45
  46
  47 #include "i18n.h"
  48
  49 using namespace ARDOUR;
  50 using namespace std;
  51 using namespace PBD;
  52
  53 PBD::Signal1<void,boost::shared_ptr<Source> > SourceFactory::SourceCreated;
  54 Glib::Cond* SourceFactory::PeaksToBuild;
  55 Glib::StaticMutex SourceFactory::peak_building_lock = GLIBMM_STATIC_MUTEX_INIT;
  56 std::list<boost::weak_ptr<AudioSource> > SourceFactory::files_with_peaks;
  57
  58 static void
  59 peak_thread_work ()
  60 {
  61         SessionEvent::create_per_thread_pool (X_("PeakFile Builder "), 64);
  62
  63         while (true) {
  64
  65                 SourceFactory::peak_building_lock.lock ();
  66
  67           wait:
  68                 if (SourceFactory::files_with_peaks.empty()) {
  69                         SourceFactory::PeaksToBuild->wait (SourceFactory::peak_building_lock);
  70                 }
  71
  72                 if (SourceFactory::files_with_peaks.empty()) {
  73                         goto wait;
  74                 }
  75
  76                 boost::shared_ptr<AudioSource> as (SourceFactory::files_with_peaks.front().lock());
  77                 SourceFactory::files_with_peaks.pop_front ();
  78                 SourceFactory::peak_building_lock.unlock ();
  79
  80                 if (!as) {
  81                         continue;
  82                 }
  83
  84                 as->setup_peakfile ();
  85         }
  86 }
  87
  88 void
  89 SourceFactory::init ()
  90 {
  91         PeaksToBuild = new Glib::Cond();
  92
  93         for (int n = 0; n < 2; ++n) {
  94                 Glib::Thread::create (sigc::ptr_fun (::peak_thread_work), false);
  95         }
  96 }
  97
  98 int
  99 SourceFactory::setup_peakfile (boost::shared_ptr<Source> s, bool async)
 100 {
 101         boost::shared_ptr<AudioSource> as (boost::dynamic_pointer_cast<AudioSource> (s));
 102
 103         if (as) {
 104
 105                 if (async) {
 106
 107                         Glib::Mutex::Lock lm (peak_building_lock);
 108                         files_with_peaks.push_back (boost::weak_ptr<AudioSource> (as));
 109                         PeaksToBuild->broadcast ();
 110
 111                 } else {
 112
 113                         if (as->setup_peakfile ()) {
 114                                 error << string_compose("SourceFactory: could not set up peakfile for %1", as->name()) << endmsg;
 115                                 return -1;
 116                         }
 117                 }
 118         }
 119
 120         return 0;
 121 }
 122
 123 boost::shared_ptr<Source>
 124 SourceFactory::createSilent (Session& s, const XMLNode& node, framecnt_t nframes, float sr)
 125 {
 126         Source* src = new SilentFileSource (s, node, nframes, sr);
 127         // boost_debug_shared_ptr_mark_interesting (src, "Source");
 128         boost::shared_ptr<Source> ret (src);
 129         // no analysis data - the file is non-existent
 130         SourceCreated (ret);
 131         return ret;
 132 }
 133
 134 boost::shared_ptr<Source>
 135 SourceFactory::create (Session& s, const XMLNode& node, bool defer_peaks)
 136 {
 137         DataType type = DataType::AUDIO;
 138         const XMLProperty* prop = node.property("type");
 139
 140         if (prop) {
 141                 type = DataType (prop->value());
 142         }
 143
 144         if (type == DataType::AUDIO) {
 145
 146                 try {
 147                         Source* src = new SndFileSource (s, node);
 148                         // boost_debug_shared_ptr_mark_interesting (src, "Source");
 149                         boost::shared_ptr<Source> ret (src);
 150                         if (setup_peakfile (ret, defer_peaks)) {
 151                                 return boost::shared_ptr<Source>();
 152                         }
 153                         ret->check_for_analysis_data_on_disk ();
 154                         SourceCreated (ret);
 155                         return ret;
 156                 }
 157
 158                 catch (failed_constructor& err) {
 159
 160 #ifdef USE_COREAUDIO_FOR_FILES
 161
 162                         /* this is allowed to throw */
 163
 164                         Source *src = new CoreAudioSource (s, node);
 165                         // boost_debug_shared_ptr_mark_interesting (src, "Source");
 166                         boost::shared_ptr<Source> ret (src);
 167
 168                         if (setup_peakfile (ret, defer_peaks)) {
 169                                 return boost::shared_ptr<Source>();
 170                         }
 171
 172                         ret->check_for_analysis_data_on_disk ();
 173                         SourceCreated (ret);
 174                         return ret;
 175 #else
 176                         throw; // rethrow
 177 #endif
 178                 }
 179
 180         } else if (type == DataType::MIDI) {
 181                 Source* src = new SMFSource (s, node);
 182                 // boost_debug_shared_ptr_mark_interesting (src, "Source");
 183                 boost::shared_ptr<Source> ret (src);
 184                 ret->check_for_analysis_data_on_disk ();
 185                 SourceCreated (ret);
 186                 return ret;
 187         }
 188
 189         return boost::shared_ptr<Source>();
 190 }
 191
 192 boost::shared_ptr<Source>
 193 SourceFactory::createReadable (DataType type, Session& s, const string& path,
 194                                int chn, Source::Flag flags, bool announce, bool defer_peaks)
 195 {
 196         if (type == DataType::AUDIO) {
 197
 198                 if (!(flags & Destructive)) {
 199
 200                         try {
 201
 202                                 Source* src = new SndFileSource (s, path, chn, flags);
 203                                 // boost_debug_shared_ptr_mark_interesting (src, "Source");
 204                                 boost::shared_ptr<Source> ret (src);
 205
 206                                 if (setup_peakfile (ret, defer_peaks)) {
 207                                         return boost::shared_ptr<Source>();
 208                                 }
 209
 210                                 ret->check_for_analysis_data_on_disk ();
 211                                 if (announce) {
 212                                         SourceCreated (ret);
 213                                 }
 214                                 return ret;
 215                         }
 216
 217                         catch (failed_constructor& err) {
 218 #ifdef USE_COREAUDIO_FOR_FILES
 219
 220                                 Source* src = new CoreAudioSource (s, path, chn, flags);
 221                                 // boost_debug_shared_ptr_mark_interesting (src, "Source");
 222                                 boost::shared_ptr<Source> ret (src);
 223                                 if (setup_peakfile (ret, defer_peaks)) {
 224                                         return boost::shared_ptr<Source>();
 225                                 }
 226                                 ret->check_for_analysis_data_on_disk ();
 227                                 if (announce) {
 228                                         SourceCreated (ret);
 229                                 }
 230                                 return ret;
 231
 232 #else
 233                                 throw; // rethrow
 234 #endif
 235                         }
 236
 237                 } else {
 238                         // eh?
 239                 }
 240
 241         } else if (type == DataType::MIDI) {
 242
 243                 Source* src = new SMFSource (s, path, SMFSource::Flag(0));
 244                 // boost_debug_shared_ptr_mark_interesting (src, "Source");
 245                 boost::shared_ptr<Source> ret (src);
 246
 247                 if (announce) {
 248                         SourceCreated (ret);
 249                 }
 250
 251                 return ret;
 252
 253         }
 254
 255         return boost::shared_ptr<Source>();
 256 }
 257
 258 boost::shared_ptr<Source>
 259 SourceFactory::createWritable (DataType type, Session& s, const std::string& path,
 260                                bool destructive, nframes_t rate, bool announce, bool defer_peaks)
 261 {
 262         /* this might throw failed_constructor(), which is OK */
 263
 264         if (type == DataType::AUDIO) {
 265                 Source* src = new SndFileSource (s, path,
 266                                 s.config.get_native_file_data_format(),
 267                                 s.config.get_native_file_header_format(),
 268                                 rate,
 269                                 (destructive
 270                                         ? Source::Flag (SndFileSource::default_writable_flags | Source::Destructive)
 271                                  : SndFileSource::default_writable_flags));
 272                 // boost_debug_shared_ptr_mark_interesting (src, "Source");
 273                 boost::shared_ptr<Source> ret (src);
 274
 275                 if (setup_peakfile (ret, defer_peaks)) {
 276                         return boost::shared_ptr<Source>();
 277                 }
 278
 279                 // no analysis data - this is a new file
 280
 281                 if (announce) {
 282                         SourceCreated (ret);
 283                 }
 284                 return ret;
 285
 286         } else if (type == DataType::MIDI) {
 287                 // XXX writable flags should belong to MidiSource too
 288                 Source* src = new SMFSource (s, path, SndFileSource::default_writable_flags);
 289                 // boost_debug_shared_ptr_mark_interesting (src, "Source");
 290                 boost::shared_ptr<Source> ret (src);
 291
 292                 // no analysis data - this is a new file
 293
 294                 if (announce) {
 295                         SourceCreated (ret);
 296                 }
 297                 return ret;
 298
 299         }
 300
 301         return boost::shared_ptr<Source> ();
 302 }
 303