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 "pbd/signals.h"
28 #include "ardour/libardour_visibility.h"
29 #include "ardour/types.h"
37 /// Virtual interface class for element importers
38 class LIBARDOUR_API ElementImporter
42 ElementImporter (XMLTree const & source, ARDOUR::Session & session);
43 virtual ~ElementImporter ();
45 /** Returns the element name
46 * @return the name of the element
48 virtual std::string get_name () const { return name; };
50 /** Gets a textual representation of the element
51 * @return a textual representation on this specific element
53 virtual std::string get_info () const = 0;
55 /** Gets import status, if applicable. */
56 virtual ImportStatus * get_import_status () { return 0; }
58 /** Prepares to move element
60 * @return whther or not the element could be prepared for moving
64 /** Cancels moving of element
65 * If the element has been set to be moved, this cancels the move.
69 /// Moves the element to the taget session
72 /// Check if element is broken. Cannot be moved if broken.
73 bool broken () { return _broken; }
75 /// Signal that requests for anew name
76 static PBD::Signal2<std::pair<bool, std::string>,std::string, std::string> Rename;
78 /// Signal for ok/cancel prompting
79 static PBD::Signal1<bool,std::string> Prompt;
83 /** Moves the element to the taget session
84 * In addition to actually adding the element to the session
85 * changing ids, renaming files etc. should be taken care of.
87 virtual void _move () = 0;
89 /** Should take care of all tasks that need to be done
90 * before moving the element. This includes prompting
91 * the user for more information if necessary.
93 * @return whether or not the element can be moved
95 virtual bool _prepare_move () = 0;
98 virtual void _cancel_move () = 0;
101 XMLTree const & source;
104 ARDOUR::Session & session;
106 /// Ture if the element has been prepared and queued for importing
107 bool queued () { return _queued; }
112 /// The sample rate of the session from which we are importing
113 framecnt_t sample_rate;
115 /// Converts timecode time to a string
116 std::string timecode_to_string (Timecode::Time & time) const;
118 /// Converts samples so that times match the sessions sample rate
119 framecnt_t rate_convert_samples (framecnt_t samples) const;
121 /// Converts samples so that times match the sessions sample rate (for straight use in XML)
122 std::string rate_convert_samples (std::string const & samples) const;
124 /// Set element broken
125 void set_broken () { _broken = true; }
132 } // namespace ARDOUR