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__
25 #include <pbd/filesystem.h>
33 class SessionDirectory
37 * @param session_path An absolute path to a session directory.
39 SessionDirectory (const string& session_path);
42 * @return the absolute path to the root directory of the session
44 const path root_path() const { return m_root_path; }
47 * @return the absolute path to the directory in which
48 * the session stores audio files.
50 * If the session is an older session with an existing
51 * "sounds" directory then it will return a path to that
52 * directory otherwise it will return the new location
53 * of root_path()/interchange/session_name/audiofiles
55 const path sound_path () const;
58 * @return The absolute path to the directory in which all
59 * peak files are stored for a session.
61 const path peak_path () const;
64 * @return The absolute path to the directory that audio
65 * files are moved to when they are no longer part of the
68 const path dead_sound_path () const;
71 * @return true if session directory and all the required
72 * subdirectories exist.
74 bool is_valid () const;
77 * @return true If a new session directory and all the
78 * subdirectories were created, otherwise false.
85 * @return The path to the old style sound directory.
86 * It isn't created by create().
88 const path old_sound_path () const;
91 * @return a vector containing the fullpath of all subdirectories.
93 const vector<PBD::sys::path> sub_directories () const;
95 /// The path to the root of the session directory.
96 const path m_root_path;