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 #ifndef __ardour_element_importer_h__
22 #define __ardour_element_importer_h__
27 #include <sigc++/signal.h>
29 #include <ardour/types.h>
38 /// Virtual interface class for element importers
43 ElementImporter (XMLTree const & source, ARDOUR::Session & session);
44 virtual ~ElementImporter () {};
46 /** Returns the element name
47 * @return the name of the element
49 virtual string get_name () const { return name; };
51 /** Gets a textual representation of the element
52 * @return a textual representation on this specific element
54 virtual string get_info () const = 0;
56 /** Prepares to move element
57 * Should take care of all tasks that need to be done
58 * before moving the element. This includes prompting
59 * the user for more information if necessary.
61 * If the element can be moved, queued should be set to true.
63 * @return whther or not the element could be prepared for moving
65 virtual bool prepare_move () = 0;
67 /** Cancels moving of element
68 * If the element has been set to be moved, this cancels the move.
69 * queued should be set to false.
71 virtual void cancel_move () = 0;
73 /** Moves the element to the taget session
74 * In addition to actually adding the element to the session
75 * changing ids, renaming files etc. should be taken care of.
77 virtual void move () = 0;
79 /// Check if element is broken. Cannot be moved if broken.
80 bool broken () { return _broken; }
82 /// Signal that requests for anew name
83 static sigc::signal <std::pair<bool, string>, string, string> Rename;
85 /// Signal for ok/cancel prompting
86 static sigc::signal <bool, string> Prompt;
90 XMLTree const & source;
93 ARDOUR::Session & session;
95 /// Ture if the element has been prepared and queued for importing
101 /// The sample rate of the session from which we are importing
102 nframes_t sample_rate;
104 /// Converts smpte time to a string
105 string smpte_to_string(SMPTE::Time & time) const;
107 /// Converts samples so that times match the sessions sample rate
108 nframes_t rate_convert_samples (nframes_t samples) const;
110 /// Converts samples so that times match the sessions sample rate (for straight use in XML)
111 string rate_convert_samples (string const & samples) const;
113 /// Set element broken
114 void set_broken () { _broken = true; }
120 } // namespace ARDOUR