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         virtual ~AudioFileSource ();
  47
  48         bool set_name (const std::string& newname) {
  49                 return (set_source_name(newname, destructive()) == 0);
  50         }
  51         int set_source_name (Glib::ustring newname, bool destructive);
  52
  53         Glib::ustring path() const { return _path; }
  54         Glib::ustring peak_path (Glib::ustring audio_path);
  55         Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path,
  56                                              Glib::ustring audio_path);
  57
  58         uint16_t channel() const { return _channel; }
  59
  60         static void set_peak_dir (Glib::ustring dir) { peak_dir = dir; }
  61
  62         static bool get_soundfile_info (Glib::ustring path, SoundFileInfo& _info, std::string& error);
  63
  64         static bool safe_file_extension (Glib::ustring path);
  65
  66         void set_allow_remove_if_empty (bool yn);
  67         void mark_for_remove();
  68
  69         /* this block of methods do nothing for regular file sources, but are significant
  70            for files used in destructive recording.
  71         */
  72         virtual nframes_t last_capture_start_frame() const { return 0; }
  73         virtual void           mark_capture_start (nframes_t) {}
  74         virtual void           mark_capture_end () {}
  75         virtual void           clear_capture_marks() {}
  76         virtual bool           one_of_several_channels () const { return false; }
  77
  78         virtual int update_header (nframes_t when, struct tm&, time_t) = 0;
  79         virtual int flush_header () = 0;
  80
  81         int move_to_trash (const Glib::ustring& trash_dir_name);
  82
  83         static bool is_empty (Session&, Glib::ustring path);
  84         void mark_streaming_write_completed ();
  85
  86         void mark_take (Glib::ustring);
  87         Glib::ustring take_id() const { return _take_id; }
  88
  89         bool is_embedded() const { return _is_embedded; }
  90
  91         static void set_bwf_serial_number (int);
  92
  93         static void set_search_path (Glib::ustring string);
  94         static void set_header_position_offset (nframes_t offset );
  95
  96         int setup_peakfile ();
  97
  98         XMLNode& get_state ();
  99         int set_state (const XMLNode&);
 100
 101         bool         destructive() const        { return (_flags & Destructive); }
 102         virtual bool set_destructive (bool yn)  { return false; }
 103         bool         can_truncate_peaks() const { return !destructive(); }
 104         bool         can_be_analysed() const    { return _length > 0; }
 105
 106         void mark_immutable ();
 107
 108         static sigc::signal<void> HeaderPositionOffsetChanged;
 109
 110   protected:
 111
 112         /** Constructor to be called for existing external-to-session files */
 113         AudioFileSource (Session&, Glib::ustring path, Source::Flag flags);
 114
 115         /** Constructor to be called for new in-session files */
 116         AudioFileSource (Session&, Glib::ustring path, Source::Flag flags,
 117                          SampleFormat samp_format, HeaderFormat hdr_format);
 118
 119         /** Constructor to be called for existing in-session files */
 120         AudioFileSource (Session&, const XMLNode&, bool must_exit = true);
 121
 122         int init (Glib::ustring idstr, bool must_exist);
 123
 124         static bool determine_embeddedness (Glib::ustring path);
 125
 126         virtual void set_timeline_position (int64_t pos);
 127         virtual void set_header_timeline_position () = 0;
 128         virtual void handle_header_position_change () {}
 129
 130         bool find (Glib::ustring& path, bool must_exist, bool& is_new, uint16_t& chan);
 131         bool removable() const;
 132         bool writable() const { return _flags & Writable; }
 133
 134         static Sample* get_interleave_buffer (nframes_t size);
 135
 136         Glib::ustring _path;
 137         Glib::ustring _take_id;
 138         int64_t       _timeline_position;
 139         bool          _file_is_new;
 140         uint16_t      _channel;
 141         bool          _is_embedded;
 142
 143         static Glib::ustring peak_dir;
 144         static Glib::ustring search_path;
 145
 146         static char bwf_country_code[3];
 147         static char bwf_organization_code[4];
 148         static char bwf_serial_number[13];
 149
 150         static uint64_t header_position_offset;
 151
 152   private:
 153         Glib::ustring old_peak_path (Glib::ustring audio_path);
 154         Glib::ustring broken_peak_path (Glib::ustring audio_path);
 155 };
 156
 157 } // namespace ARDOUR
 158
 159 #endif /* __ardour_audiofilesource_h__ */
 160