libs/ardour/audio_playlist_importer.cc

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Sakari Bergen
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #include <ardour/audio_playlist_importer.h>
  22
  23 #include <sstream>
  24
  25 #include <pbd/failed_constructor.h>
  26 #include <pbd/compose.h>
  27 #include <pbd/error.h>
  28
  29 #include <ardour/audio_region_importer.h>
  30 #include <ardour/session.h>
  31 #include <ardour/playlist.h>
  32 #include <ardour/playlist_factory.h>
  33
  34 using namespace PBD;
  35 using namespace ARDOUR;
  36
  37 /**** Handler ***/
  38 AudioPlaylistImportHandler::AudioPlaylistImportHandler (XMLTree const & source, Session & session, AudioRegionImportHandler & region_handler, const char * nodename) :
  39   ElementImportHandler (source, session),
  40   region_handler (region_handler)
  41 {
  42         XMLNode const * root = source.root();
  43         XMLNode const * playlists;
  44
  45         if (!(playlists = root->child (nodename))) {
  46                 throw failed_constructor();
  47         }
  48
  49         XMLNodeList const & pl_children = playlists->children();
  50         for (XMLNodeList::const_iterator it = pl_children.begin(); it != pl_children.end(); ++it) {
  51                 const XMLProperty* type = (*it)->property("type");
  52                 if ( !type || type->value() == "audio" ) {
  53                         try {
  54                                 elements.push_back (ElementPtr ( new AudioPlaylistImporter (source, session, *this, **it)));
  55                         } catch (failed_constructor err) {
  56                                 set_dirty();
  57                         }
  58                 }
  59         }
  60 }
  61
  62 string
  63 AudioPlaylistImportHandler::get_info () const
  64 {
  65         return _("Audio Playlists");
  66 }
  67
  68 void
  69 AudioPlaylistImportHandler::get_regions (XMLNode const & node, ElementList & list)
  70 {
  71         region_handler.create_regions_from_children (node, list);
  72 }
  73
  74 void
  75 AudioPlaylistImportHandler::update_region_id (XMLProperty* id_prop)
  76 {
  77         PBD::ID old_id (id_prop->value());
  78         PBD::ID new_id (region_handler.get_new_id (old_id));
  79         id_prop->set_value (new_id.to_s());
  80 }
  81
  82 /*** AudioPlaylistImporter ***/
  83 AudioPlaylistImporter::AudioPlaylistImporter (XMLTree const & source, Session & session, AudioPlaylistImportHandler & handler, XMLNode const & node) :
  84   ElementImporter (source, session),
  85   handler (handler),
  86   xml_playlist (node),
  87   diskstream_id ("0")
  88 {
  89         bool ds_ok = false;
  90
  91         // Populate region list
  92         ElementImportHandler::ElementList elements;
  93         handler.get_regions (node, elements);
  94         for (ElementImportHandler::ElementList::iterator it = elements.begin(); it != elements.end(); ++it) {
  95                 regions.push_back (boost::dynamic_pointer_cast<AudioRegionImporter> (*it));
  96         }
  97
  98         // Parse XML
  99         XMLPropertyList const & props = xml_playlist.properties();
 100         for (XMLPropertyList::const_iterator it = props.begin(); it != props.end(); ++it) {
 101                 string prop = (*it)->name();
 102                 if (!prop.compare("type") || !prop.compare("frozen")) {
 103                         // All ok
 104                 } else if (!prop.compare("name")) {
 105                         name = (*it)->value();
 106                 } else if (!prop.compare("orig-diskstream-id")) {
 107                         ds_ok = true;
 108                 } else {
 109                         std::cerr << string_compose (X_("AudioPlaylistImporter did not recognise XML-property \"%1\""), prop) << endmsg;
 110                 }
 111         }
 112
 113         if (!ds_ok) {
 114                 error << string_compose (X_("AudioPlaylistImporter (%1): did not find XML-property \"orig_diskstream_id\" which is mandatory"), name) << endmsg;
 115                 throw failed_constructor();
 116         }
 117 }
 118
 119 string
 120 AudioPlaylistImporter::get_info () const
 121 {
 122         XMLNodeList children = xml_playlist.children();
 123         unsigned int regions = 0;
 124         std::ostringstream oss;
 125
 126         for (XMLNodeIterator it = children.begin(); it != children.end(); it++) {
 127                 if ((*it)->name() == "Region") {
 128                         ++regions;
 129                 }
 130         }
 131
 132         oss << regions << " ";
 133
 134         if (regions == 1) {
 135                 oss << _("region");
 136         } else {
 137                 oss << _("regions");
 138         }
 139
 140         return oss.str();
 141 }
 142
 143 bool
 144 AudioPlaylistImporter::prepare_move ()
 145 {
 146         // Rename
 147         while (session.playlist_by_name (name) || !handler.check_name (name)) {
 148                 std::pair<bool, string> rename_pair = Rename (_("A playlist with this name already exists, please rename it."), name);
 149                 if (!rename_pair.first) {
 150                         return false;
 151                 }
 152                 name = rename_pair.second;
 153         }
 154         xml_playlist.property ("name")->set_value (name);
 155         handler.add_name (name);
 156
 157         queued = true;
 158         return true;
 159 }
 160
 161 void
 162 AudioPlaylistImporter::cancel_move ()
 163 {
 164         handler.remove_name (name);
 165         queued = false;
 166 }
 167
 168 void
 169 AudioPlaylistImporter::move ()
 170 {
 171         boost::shared_ptr<Playlist> playlist;
 172
 173         // Update diskstream id
 174         xml_playlist.property ("orig-diskstream-id")->set_value (diskstream_id.to_s());
 175
 176         // Update region XML in playlist and prepare sources
 177         xml_playlist.remove_nodes("Region");
 178         for (RegionList::iterator it = regions.begin(); it != regions.end(); ++it) {
 179                 xml_playlist.add_child_copy ((*it)->get_xml());
 180                 (*it)->add_sources_to_session();
 181                 if ((*it)->broken()) {
 182                         handler.set_dirty();
 183                         set_broken();
 184                         return; // TODO clean up?
 185                 }
 186         }
 187
 188         // Update region ids in crossfades
 189         XMLNodeList crossfades = xml_playlist.children("Crossfade");
 190         for (XMLNodeIterator it = crossfades.begin(); it != crossfades.end(); ++it) {
 191                 XMLProperty* in = (*it)->property("in");
 192                 XMLProperty* out = (*it)->property("out");
 193                 if (!in || !out) {
 194                         error << string_compose (X_("AudioPlaylistImporter (%1): did not find the \"in\" or \"out\" property from a crossfade"), name) << endmsg;
 195                 }
 196
 197                 handler.update_region_id (in);
 198                 handler.update_region_id (out);
 199
 200                 // rate convert length and position
 201                 XMLProperty* length = (*it)->property("length");
 202                 if (length) {
 203                         length->set_value (rate_convert_samples (length->value()));
 204                 }
 205
 206                 XMLProperty* position = (*it)->property("position");
 207                 if (position) {
 208                         position->set_value (rate_convert_samples (position->value()));
 209                 }
 210         }
 211
 212         // Create playlist
 213         playlist = PlaylistFactory::create (session, xml_playlist, false, true);
 214 }
 215
 216 void
 217 AudioPlaylistImporter::set_diskstream (PBD::ID const & id)
 218 {
 219         diskstream_id = id;
 220 }
 221