2 Copyright (C) 2008 Paul Davis
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.
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.
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.
21 #include "ardour/audio_playlist_importer.h"
25 #include "pbd/failed_constructor.h"
26 #include "pbd/compose.h"
27 #include "pbd/error.h"
29 #include "ardour/audio_region_importer.h"
30 #include "ardour/session.h"
31 #include "ardour/playlist_factory.h"
32 #include "ardour/session_playlists.h"
38 using namespace ARDOUR;
41 AudioPlaylistImportHandler::AudioPlaylistImportHandler (XMLTree const & source, Session & session, AudioRegionImportHandler & region_handler, const char * nodename) :
42 ElementImportHandler (source, session),
43 region_handler (region_handler)
45 XMLNode const * root = source.root();
46 XMLNode const * playlists;
48 if (!(playlists = root->child (nodename))) {
49 throw failed_constructor();
52 XMLNodeList const & pl_children = playlists->children();
53 for (XMLNodeList::const_iterator it = pl_children.begin(); it != pl_children.end(); ++it) {
54 XMLProperty const * type = (*it)->property("type");
55 if ( !type || type->value() == "audio" ) {
57 elements.push_back (ElementPtr ( new AudioPlaylistImporter (source, session, *this, **it)));
58 } catch (failed_constructor const&) {
66 AudioPlaylistImportHandler::get_info () const
68 return _("Audio Playlists");
72 AudioPlaylistImportHandler::get_regions (XMLNode const & node, ElementList & list) const
74 region_handler.create_regions_from_children (node, list);
78 AudioPlaylistImportHandler::update_region_id (XMLProperty * id_prop)
80 PBD::ID old_id (id_prop->value());
81 PBD::ID new_id (region_handler.get_new_id (old_id));
82 id_prop->set_value (new_id.to_s());
86 AudioPlaylistImportHandler::playlists_by_diskstream (PBD::ID const & id, PlaylistList & list) const
88 for (ElementList::const_iterator it = elements.begin(); it != elements.end(); ++it) {
89 boost::shared_ptr<AudioPlaylistImporter> pl = boost::dynamic_pointer_cast<AudioPlaylistImporter> (*it);
90 if (pl && pl->orig_diskstream() == id) {
91 list.push_back (PlaylistPtr (new AudioPlaylistImporter (*pl)));
96 /*** AudioPlaylistImporter ***/
97 AudioPlaylistImporter::AudioPlaylistImporter (XMLTree const & source, Session & session, AudioPlaylistImportHandler & handler, XMLNode const & node) :
98 ElementImporter (source, session),
106 populate_region_list ();
109 XMLPropertyList const & props = xml_playlist.properties();
110 for (XMLPropertyList::const_iterator it = props.begin(); it != props.end(); ++it) {
111 string prop = (*it)->name();
112 if (!prop.compare("type") || !prop.compare("frozen")) {
114 } else if (!prop.compare("name")) {
115 name = (*it)->value();
116 } else if (!prop.compare("orig-diskstream-id")) {
117 orig_diskstream_id = (*it)->value();
120 std::cerr << string_compose (X_("AudioPlaylistImporter did not recognise XML-property \"%1\""), prop) << endmsg;
125 error << string_compose (X_("AudioPlaylistImporter (%1): did not find XML-property \"orig_diskstream_id\" which is mandatory"), name) << endmsg;
126 throw failed_constructor();
130 AudioPlaylistImporter::AudioPlaylistImporter (AudioPlaylistImporter const & other) :
131 ElementImporter (other.source, other.session),
132 handler (other.handler),
133 orig_node (other.orig_node),
134 xml_playlist (other.xml_playlist),
135 orig_diskstream_id (other.orig_diskstream_id)
137 populate_region_list ();
140 AudioPlaylistImporter::~AudioPlaylistImporter ()
146 AudioPlaylistImporter::get_info () const
148 XMLNodeList children = xml_playlist.children();
149 unsigned int regions = 0;
150 std::ostringstream oss;
152 for (XMLNodeIterator it = children.begin(); it != children.end(); it++) {
153 if ((*it)->name() == "Region") {
158 oss << regions << " ";
170 AudioPlaylistImporter::_prepare_move ()
173 while (session.playlists->by_name (name) || !handler.check_name (name)) {
174 std::pair<bool, string> rename_pair = *Rename (_("A playlist with this name already exists, please rename it."), name);
175 if (!rename_pair.first) {
178 name = rename_pair.second;
181 XMLProperty * p = xml_playlist.property ("name");
183 error << _("badly-formed XML in imported playlist") << endmsg;
188 handler.add_name (name);
194 AudioPlaylistImporter::_cancel_move ()
196 handler.remove_name (name);
200 AudioPlaylistImporter::_move ()
202 boost::shared_ptr<Playlist> playlist;
204 // Update diskstream id
205 xml_playlist.property ("orig-diskstream-id")->set_value (diskstream_id.to_s());
207 // Update region XML in playlist and prepare sources
208 xml_playlist.remove_nodes("Region");
209 for (RegionList::iterator it = regions.begin(); it != regions.end(); ++it) {
210 xml_playlist.add_child_copy ((*it)->get_xml());
211 (*it)->add_sources_to_session();
212 if ((*it)->broken()) {
215 return; // TODO clean up?
219 // Update region ids in crossfades
220 XMLNodeList crossfades = xml_playlist.children("Crossfade");
221 for (XMLNodeIterator it = crossfades.begin(); it != crossfades.end(); ++it) {
222 XMLProperty * in = (*it)->property("in");
223 XMLProperty * out = (*it)->property("out");
225 error << string_compose (X_("AudioPlaylistImporter (%1): did not find the \"in\" or \"out\" property from a crossfade"), name) << endmsg;
226 continue; // or fatal?
229 handler.update_region_id (in);
230 handler.update_region_id (out);
232 // rate convert length and position
233 XMLProperty * length = (*it)->property("length");
235 length->set_value (rate_convert_samples (length->value()));
238 XMLProperty * position = (*it)->property("position");
240 position->set_value (rate_convert_samples (position->value()));
245 playlist = PlaylistFactory::create (session, xml_playlist, false, true);
249 AudioPlaylistImporter::set_diskstream (PBD::ID const & id)
255 AudioPlaylistImporter::populate_region_list ()
257 ElementImportHandler::ElementList elements;
258 handler.get_regions (orig_node, elements);
259 for (ElementImportHandler::ElementList::iterator it = elements.begin(); it != elements.end(); ++it) {
260 regions.push_back (boost::dynamic_pointer_cast<AudioRegionImporter> (*it));
265 UnusedAudioPlaylistImportHandler::get_info () const
267 return _("Audio Playlists (unused)");