2 Copyright (C) 2007 Tim Mayberry
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.
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.
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.
19 #ifndef __ardour_session_directory_h__
20 #define __ardour_session_directory_h__
26 #include "ardour/libardour_visibility.h"
30 class LIBARDOUR_API SessionDirectory
35 * @param session_path An absolute path to a session directory.
37 SessionDirectory (const std::string& session_path);
40 * Change the root path of this SessionDirectory object
42 SessionDirectory& operator= (const std::string& path);
45 * @return the absolute path to the root directory of the session
47 const std::string root_path() const { return m_root_path; }
50 * @return the absolute path to the directory in which
51 * the session stores audio files.
53 * If the session is an older session with an existing
54 * "sounds" directory then it will return a path to that
55 * directory otherwise it will return the new location
56 * of root_path()/interchange/session_name/audiofiles
58 const std::string sound_path () const;
61 * @return the absolute path to the directory in which
62 * the session stores audio files for Ardour 2.X.
64 * If the session is an older session with an existing
65 * "sounds" directory then it will return a path to that
66 * directory otherwise it will return the new location
67 * of root_path()/interchange/session_name/audiofiles
69 const std::string sound_path_2X () const;
72 * @return the absolute path to the directory in which
73 * the session stores MIDI files, ie
74 * root_path()/interchange/session_name/midifiles
76 const std::string midi_path () const;
79 * @return the absolute path to the directory in which
80 * the session stores MIDNAM patch files, ie
81 * root_path()/interchange/session_name/patchfiles
83 const std::string midi_patch_path () const;
86 * @return The absolute path to the directory in which all
87 * peak files are stored for a session.
89 const std::string peak_path () const;
92 * @return The absolute path to the directory in which all
93 * video files are stored for a session.
95 const std::string video_path () const;
98 * @return The absolute path to the directory that source
99 * files are moved to when they are no longer part of the
102 const std::string dead_path () const;
105 * @return The absolute path to the directory that audio
106 * files are created in by default when exporting.
108 const std::string export_path () const;
111 * @return true if session directory and all the required
112 * subdirectories exist.
114 bool is_valid () const;
117 * Create the session directory and all the subdirectories.
119 * @return true If a new session directory and subdirectories were
120 * created, otherwise false.
127 * @return The path to the directory under which source directories
128 * are created for different source types.
129 * i.e root_path()/interchange/session_name
131 const std::string sources_root() const;
134 * @return The path to the directory under which source directories
135 * are created for different source types in Ardour 2.X
136 * i.e root_path()/interchange/session_name
138 const std::string sources_root_2X() const;
143 * @return The path to the old style sound directory.
144 * It isn't created by create().
146 const std::string old_sound_path () const;
149 * @return a vector containing the fullpath of all subdirectories.
151 const std::vector<std::string> sub_directories () const;
153 /// The path to the root of the session directory.
154 std::string m_root_path;
156 static std::map<std::string,std::string> root_cache;
159 } // namespace ARDOUR