libs/ardour/playlist_source.cc

   1 /*
   2     Copyright (C) 2011 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 #ifdef WAF_BUILD
  20 #include "libardour-config.h"
  21 #endif
  22
  23 #include <vector>
  24 #include <cstdio>
  25
  26 #include <glibmm/fileutils.h>
  27 #include <glibmm/miscutils.h>
  28
  29 #include "pbd/error.h"
  30 #include "pbd/convert.h"
  31 #include "pbd/enumwriter.h"
  32
  33 #include "ardour/playlist.h"
  34 #include "ardour/playlist_source.h"
  35 #include "ardour/playlist_factory.h"
  36 #include "ardour/session.h"
  37 #include "ardour/session_playlists.h"
  38 #include "ardour/source_factory.h"
  39
  40 #include "i18n.h"
  41
  42 using namespace std;
  43 using namespace ARDOUR;
  44 using namespace PBD;
  45
  46 PlaylistSource::PlaylistSource (Session& s, const ID& orig, const std::string& name, boost::shared_ptr<Playlist> p, DataType type,
  47                                 frameoffset_t begin, framecnt_t len, Source::Flag flags)
  48         : Source (s, type, name)
  49         , _playlist (p)
  50         , _original (orig)
  51 {
  52         /* PlaylistSources are never writable, renameable, removable or destructive */
  53         _flags = Flag (_flags & ~(Writable|CanRename|Removable|RemovableIfEmpty|RemoveAtDestroy|Destructive));
  54
  55         _playlist = p;
  56         _playlist_offset = begin;
  57         _playlist_length = len;
  58
  59         _level = _playlist->max_source_level () + 1;
  60 }
  61
  62 PlaylistSource::PlaylistSource (Session& s, const XMLNode& node)
  63         : Source (s, DataType::AUDIO, "toBeRenamed")
  64 {
  65         /* PlaylistSources are never writable, renameable, removable or destructive */
  66         _flags = Flag (_flags & ~(Writable|CanRename|Removable|RemovableIfEmpty|RemoveAtDestroy|Destructive));
  67
  68
  69         if (set_state (node, Stateful::loading_state_version)) {
  70                 throw failed_constructor ();
  71         }
  72 }
  73
  74 PlaylistSource::~PlaylistSource ()
  75 {
  76 }
  77
  78 void
  79 PlaylistSource::add_state (XMLNode& node)
  80 {
  81         char buf[64];
  82
  83         _playlist->id().print (buf, sizeof (buf));
  84         node.add_property ("playlist", buf);
  85         snprintf (buf, sizeof (buf), "%" PRIi64, _playlist_offset);
  86         node.add_property ("offset", buf);
  87         snprintf (buf, sizeof (buf), "%" PRIu64, _playlist_length);
  88         node.add_property ("length", buf);
  89         node.add_property ("original", _id.to_s());
  90
  91         node.add_child_nocopy (_playlist->get_state());
  92 }
  93
  94 int
  95 PlaylistSource::set_state (const XMLNode& node, int version)
  96 {
  97         /* check that we have a playlist ID */
  98
  99         const XMLProperty *prop = node.property (X_("playlist"));
 100
 101         if (!prop) {
 102                 error << _("No playlist ID in PlaylistSource XML!") << endmsg;
 103                 throw failed_constructor ();
 104         }
 105
 106         /* create playlist from child node */
 107
 108         XMLNodeList nlist;
 109         XMLNodeConstIterator niter;
 110
 111         nlist = node.children();
 112
 113         for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
 114                 if ((*niter)->name() == "Playlist") {
 115                         _playlist = PlaylistFactory::create (_session, **niter, true, false);
 116                         break;
 117                 }
 118         }
 119
 120         if (!_playlist) {
 121                 error << _("Could not construct playlist for PlaylistSource from session data!") << endmsg;
 122                 throw failed_constructor ();
 123         }
 124
 125         /* other properties */
 126
 127         if ((prop = node.property (X_("name"))) == 0) {
 128                 throw failed_constructor ();
 129         }
 130
 131         set_name (prop->value());
 132
 133         if ((prop = node.property (X_("offset"))) == 0) {
 134                 throw failed_constructor ();
 135         }
 136         sscanf (prop->value().c_str(), "%" PRIi64, &_playlist_offset);
 137
 138         if ((prop = node.property (X_("length"))) == 0) {
 139                 throw failed_constructor ();
 140         }
 141
 142         sscanf (prop->value().c_str(), "%" PRIu64, &_playlist_length);
 143
 144         if ((prop = node.property (X_("original"))) == 0) {
 145                 throw failed_constructor ();
 146         }
 147
 148         _id = prop->value();
 149
 150         _level = _playlist->max_source_level () + 1;
 151
 152         return 0;
 153 }