libs/ardour/ardour/session_directory.h

   1 /*
   2         Copyright (C) 2007 Tim Mayberry
   3
   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.
   8
   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.
  13
  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.
  17 */
  18
  19 #ifndef __ardour_session_directory_h__
  20 #define __ardour_session_directory_h__
  21
  22 #include <string>
  23 #include <vector>
  24
  25 #include "pbd/filesystem.h"
  26
  27 namespace ARDOUR {
  28
  29 class SessionDirectory
  30 {
  31 public:
  32
  33         /**
  34          * @param session_path An absolute path to a session directory.
  35          */
  36         SessionDirectory (const PBD::sys::path& session_path);
  37
  38         /**
  39          * @return the absolute path to the root directory of the session
  40          */
  41         const PBD::sys::path root_path() const { return m_root_path; }
  42
  43         /**
  44          * @return the absolute path to the directory in which
  45          * the session stores audio files.
  46          *
  47          * If the session is an older session with an existing
  48          * "sounds" directory then it will return a path to that
  49          * directory otherwise it will return the new location
  50          * of root_path()/interchange/session_name/audiofiles
  51          */
  52         const PBD::sys::path sound_path () const;
  53
  54         /**
  55          * @return the absolute path to the directory in which
  56          * the session stores MIDI files, ie
  57          * root_path()/interchange/session_name/midifiles
  58          */
  59         const PBD::sys::path midi_path () const;
  60
  61         /**
  62          * @return the absolute path to the directory in which
  63          * the session stores MIDNAM patch files, ie
  64          * root_path()/interchange/session_name/patchfiles
  65          */
  66         const PBD::sys::path midi_patch_path () const;
  67
  68         /**
  69          * @return The absolute path to the directory in which all
  70          * peak files are stored for a session.
  71          */
  72         const PBD::sys::path peak_path () const;
  73
  74         /**
  75          * @return The absolute path to the directory that source
  76          * files are moved to when they are no longer part of the
  77          * session.
  78          */
  79         const PBD::sys::path dead_path () const;
  80
  81         /**
  82          * @return The absolute path to the directory that audio
  83          * files are created in by default when exporting.
  84          */
  85         const PBD::sys::path export_path () const;
  86
  87         /**
  88          * @return true if session directory and all the required
  89          * subdirectories exist.
  90          */
  91         bool is_valid () const;
  92
  93         /**
  94          * Create the session directory and all the subdirectories.
  95          *
  96          * @throw PBD::sys::filesystem_error if the directories were
  97          * not able to be created.
  98          *
  99          * @return true If a new session directory was created, otherwise
 100          * (if it already existed) false.
 101          *
 102          * @post is_valid ()
 103          */
 104         bool create ();
 105
 106 protected:
 107
 108         /**
 109          * @return The path to the old style sound directory.
 110          * It isn't created by create().
 111          */
 112         const PBD::sys::path old_sound_path () const;
 113
 114         /**
 115          * @return The path to the directory under which source directories
 116          * are created for different source types.
 117          * i.e root_path()/interchange/session_name
 118          */
 119         const PBD::sys::path sources_root() const;
 120
 121         /**
 122          * @return a vector containing the fullpath of all subdirectories.
 123          */
 124         const std::vector<PBD::sys::path> sub_directories () const;
 125
 126         /// The path to the root of the session directory.
 127         const PBD::sys::path m_root_path;
 128 };
 129
 130 } // namespace ARDOUR
 131
 132 #endif