libs/ardour/ardour/audiofilesource.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   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
  20 #ifndef __ardour_audiofilesource_h__
  21 #define __ardour_audiofilesource_h__
  22
  23 #include <exception>
  24
  25 #include <time.h>
  26
  27 #include <ardour/audiosource.h>
  28
  29 namespace ARDOUR {
  30
  31 class non_existent_source : public std::exception {
  32   public:
  33         virtual const char *what() const throw() { return "audio file does not exist"; }
  34 };
  35
  36 struct SoundFileInfo {
  37     float       samplerate;
  38     uint16_t    channels;
  39     int64_t     length;
  40     std::string format_name;
  41     int64_t     timecode;
  42 };
  43
  44 class AudioFileSource : public AudioSource {
  45   public:
  46         enum Flag {
  47                 Writable = 0x1,
  48                 CanRename = 0x2,
  49                 Broadcast = 0x4,
  50                 Removable = 0x8,
  51                 RemovableIfEmpty = 0x10,
  52                 RemoveAtDestroy = 0x20,
  53                 NoPeakFile = 0x40,
  54                 Destructive = 0x80
  55         };
  56
  57         virtual ~AudioFileSource ();
  58
  59         bool set_name (const std::string& newname) { return (set_source_name(newname, destructive()) == 0); }
  60         int set_source_name (Glib::ustring newname, bool destructive);
  61
  62         Glib::ustring path() const { return _path; }
  63         Glib::ustring peak_path (Glib::ustring audio_path);
  64         Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path,
  65                                              Glib::ustring audio_path);
  66
  67         uint16_t channel() const { return _channel; }
  68
  69         static void set_peak_dir (Glib::ustring dir) { peak_dir = dir; }
  70
  71         static bool get_soundfile_info (Glib::ustring path, SoundFileInfo& _info, std::string& error);
  72
  73         static bool safe_file_extension (Glib::ustring path);
  74
  75         void set_allow_remove_if_empty (bool yn);
  76         void mark_for_remove();
  77
  78         /* this block of methods do nothing for regular file sources, but are significant
  79            for files used in destructive recording.
  80         */
  81
  82         virtual nframes_t last_capture_start_frame() const { return 0; }
  83         virtual void           mark_capture_start (nframes_t) {}
  84         virtual void           mark_capture_end () {}
  85         virtual void           clear_capture_marks() {}
  86         virtual bool           one_of_several_channels () const { return false; }
  87
  88         virtual int update_header (nframes_t when, struct tm&, time_t) = 0;
  89         virtual int flush_header () = 0;
  90
  91         int move_to_trash (const Glib::ustring& trash_dir_name);
  92
  93         static bool is_empty (Session&, Glib::ustring path);
  94         void mark_streaming_write_completed ();
  95
  96         void   mark_take (Glib::ustring);
  97         Glib::ustring take_id() const { return _take_id; }
  98
  99         bool is_embedded() const { return _is_embedded; }
 100
 101         static void set_bwf_serial_number (int);
 102
 103         static void set_search_path (Glib::ustring string);
 104         static void set_header_position_offset (nframes_t offset );
 105
 106         int setup_peakfile ();
 107
 108         static sigc::signal<void> HeaderPositionOffsetChanged;
 109
 110         XMLNode& get_state ();
 111         int set_state (const XMLNode&);
 112
 113         bool destructive() const { return (_flags & Destructive); }
 114         virtual bool set_destructive (bool yn) { return false; }
 115         bool can_truncate_peaks() const { return !destructive(); }
 116
 117         Flag flags() const { return _flags; }
 118
 119         void mark_immutable ();
 120
 121         /* this should really be protected, but C++ is getting stricter
 122            and creating slots from protected member functions is starting
 123            to cause issues.
 124         */
 125
 126         virtual void handle_header_position_change () {}
 127
 128   protected:
 129
 130         /* constructor to be called for existing external-to-session files */
 131
 132         AudioFileSource (Session&, Glib::ustring path, Flag flags);
 133
 134         /* constructor to be called for new in-session files */
 135
 136         AudioFileSource (Session&, Glib::ustring path, Flag flags,
 137                          SampleFormat samp_format, HeaderFormat hdr_format);
 138
 139         /* constructor to be called for existing in-session files */
 140
 141         AudioFileSource (Session&, const XMLNode&, bool must_exit = true);
 142
 143         int init (Glib::ustring idstr, bool must_exist);
 144
 145         Glib::ustring _path;
 146         Flag          _flags;
 147         Glib::ustring _take_id;
 148         int64_t       timeline_position;
 149         bool           file_is_new;
 150         uint16_t      _channel;
 151
 152         bool          _is_embedded;
 153         static bool determine_embeddedness(Glib::ustring path);
 154
 155         static Glib::ustring peak_dir;
 156         static Glib::ustring search_path;
 157
 158         static char bwf_country_code[3];
 159         static char bwf_organization_code[4];
 160         static char bwf_serial_number[13];
 161
 162         static uint64_t header_position_offset;
 163
 164         virtual void set_timeline_position (int64_t pos);
 165         virtual void set_header_timeline_position () = 0;
 166
 167         bool find (Glib::ustring& path, bool must_exist, bool& is_new, uint16_t& chan);
 168         bool removable() const;
 169         bool writable() const { return _flags & Writable; }
 170
 171   private:
 172         Glib::ustring old_peak_path (Glib::ustring audio_path);
 173         Glib::ustring broken_peak_path (Glib::ustring audio_path);
 174 };
 175
 176 } // namespace ARDOUR
 177
 178 #endif /* __ardour_audiofilesource_h__ */
 179