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"
30 #include "ardour/session.h"
35 /// Virtual interface class for element importers
40 ElementImporter (XMLTree const & source, ARDOUR::Session & session);
41 virtual ~ElementImporter ();
43 /** Returns the element name
44 * @return the name of the element
46 virtual std::string get_name () const { return name; };
48 /** Gets a textual representation of the element
49 * @return a textual representation on this specific element
51 virtual std::string get_info () const = 0;
53 /** Gets import status, if applicable. */
54 virtual Session::ImportStatus * get_import_status () { return 0; }
56 /** Prepares to move element
58 * @return whther or not the element could be prepared for moving
62 /** Cancels moving of element
63 * If the element has been set to be moved, this cancels the move.
67 /// Moves the element to the taget session
70 /// Check if element is broken. Cannot be moved if broken.
71 bool broken () { return _broken; }
73 /// Signal that requests for anew name
74 static sigc::signal <std::pair<bool, std::string>, std::string, std::string> Rename;
76 /// Signal for ok/cancel prompting
77 static sigc::signal <bool, std::string> Prompt;
81 /** Moves the element to the taget session
82 * In addition to actually adding the element to the session
83 * changing ids, renaming files etc. should be taken care of.
85 virtual void _move () = 0;
87 /** Should take care of all tasks that need to be done
88 * before moving the element. This includes prompting
89 * the user for more information if necessary.
91 * @return whether or not the element can be moved
93 virtual bool _prepare_move () = 0;
96 virtual void _cancel_move () = 0;
99 XMLTree const & source;
102 ARDOUR::Session & session;
104 /// Ture if the element has been prepared and queued for importing
105 bool queued () { return _queued; }
110 /// The sample rate of the session from which we are importing
111 nframes_t sample_rate;
113 /// Converts timecode time to a string
114 std::string timecode_to_string (Timecode::Time & time) const;
116 /// Converts samples so that times match the sessions sample rate
117 nframes_t rate_convert_samples (nframes_t samples) const;
119 /// Converts samples so that times match the sessions sample rate (for straight use in XML)
120 std::string rate_convert_samples (std::string const & samples) const;
122 /// Set element broken
123 void set_broken () { _broken = true; }
130 } // namespace ARDOUR