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 namespace ARDOUR {
  26
  27 class SessionDirectory
  28 {
  29 public:
  30
  31         /**
  32          * @param session_path An absolute path to a session directory.
  33          */
  34         SessionDirectory (const std::string& session_path);
  35
  36         /**
  37          * Change the root path of this SessionDirectory object
  38          */
  39         SessionDirectory& operator= (const std::string& path);
  40
  41         /**
  42          * @return the absolute path to the root directory of the session
  43          */
  44         const std::string root_path() const { return m_root_path; }
  45
  46         /**
  47          * @return the absolute path to the directory in which
  48          * the session stores audio files.
  49          *
  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
  54          */
  55         const std::string sound_path () const;
  56
  57         /**
  58          * @return the absolute path to the directory in which
  59          * the session stores MIDI files, ie
  60          * root_path()/interchange/session_name/midifiles
  61          */
  62         const std::string midi_path () const;
  63
  64         /**
  65          * @return the absolute path to the directory in which
  66          * the session stores MIDNAM patch files, ie
  67          * root_path()/interchange/session_name/patchfiles
  68          */
  69         const std::string midi_patch_path () const;
  70
  71         /**
  72          * @return The absolute path to the directory in which all
  73          * peak files are stored for a session.
  74          */
  75         const std::string peak_path () const;
  76
  77         /**
  78          * @return The absolute path to the directory that source
  79          * files are moved to when they are no longer part of the
  80          * session.
  81          */
  82         const std::string dead_path () const;
  83
  84         /**
  85          * @return The absolute path to the directory that audio
  86          * files are created in by default when exporting.
  87          */
  88         const std::string export_path () const;
  89
  90         /**
  91          * @return true if session directory and all the required
  92          * subdirectories exist.
  93          */
  94         bool is_valid () const;
  95
  96         /**
  97          * Create the session directory and all the subdirectories.
  98          *
  99          * @return true If a new session directory and subdirectories were
 100          * created, otherwise false.
 101          *
 102          * @post is_valid ()
 103          */
 104         bool create ();
 105
 106         /**
 107          * @return The path to the directory under which source directories
 108          * are created for different source types.
 109          * i.e root_path()/interchange/session_name
 110          */
 111         const std::string sources_root() const;
 112
 113 private:
 114
 115         /**
 116          * @return The path to the old style sound directory.
 117          * It isn't created by create().
 118          */
 119         const std::string old_sound_path () const;
 120
 121         /**
 122          * @return a vector containing the fullpath of all subdirectories.
 123          */
 124         const std::vector<std::string> sub_directories () const;
 125
 126         /// The path to the root of the session directory.
 127         std::string m_root_path;
 128 };
 129
 130 } // namespace ARDOUR
 131
 132 #endif