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