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 #include <time.h>
  25 #include "ardour/audiosource.h"
  26 #include "ardour/file_source.h"
  27
  28 namespace ARDOUR {
  29
  30 struct LIBARDOUR_API SoundFileInfo {
  31         float       samplerate;
  32         uint16_t    channels;
  33         int64_t     length;
  34         std::string format_name;
  35         int64_t     timecode;
  36 };
  37
  38 class LIBARDOUR_API AudioFileSource : public AudioSource, public FileSource {
  39 public:
  40         virtual ~AudioFileSource ();
  41
  42         std::string peak_path (std::string audio_path);
  43         std::string find_broken_peakfile (std::string missing_peak_path,
  44                                           std::string audio_path);
  45
  46         static void set_peak_dir (std::string dir) { peak_dir = dir; }
  47
  48         static bool get_soundfile_info (std::string path, SoundFileInfo& _info, std::string& error);
  49
  50         bool safe_file_extension (const std::string& path) const {
  51                 return safe_audio_file_extension(path);
  52         }
  53
  54         /* this block of methods do nothing for regular file sources, but are significant
  55            for files used in destructive recording.
  56         */
  57         virtual framepos_t last_capture_start_frame() const { return 0; }
  58         virtual void      mark_capture_start (framepos_t) {}
  59         virtual void      mark_capture_end () {}
  60         virtual void      clear_capture_marks() {}
  61         virtual bool      one_of_several_channels () const { return false; }
  62
  63         virtual void flush () = 0;
  64         virtual int update_header (framepos_t when, struct tm&, time_t) = 0;
  65         virtual int flush_header () = 0;
  66
  67         void mark_streaming_write_completed ();
  68
  69         int setup_peakfile ();
  70
  71         XMLNode& get_state ();
  72         int set_state (const XMLNode&, int version);
  73
  74         bool can_truncate_peaks() const { return !destructive(); }
  75         bool can_be_analysed() const    { return _length > 0; }
  76
  77         static bool safe_audio_file_extension (const std::string& path);
  78
  79         static bool is_empty (Session&, std::string path);
  80
  81         static void set_bwf_serial_number (int);
  82         static void set_header_position_offset (framecnt_t offset);
  83
  84         static PBD::Signal0<void> HeaderPositionOffsetChanged;
  85
  86 protected:
  87         /** Constructor to be called for existing external-to-session files */
  88         AudioFileSource (Session&, const std::string& path, Source::Flag flags);
  89
  90         /** Constructor to be called for new in-session files */
  91         AudioFileSource (Session&, const std::string& path, const std::string& origin, Source::Flag flags,
  92                         SampleFormat samp_format, HeaderFormat hdr_format);
  93
  94         /** Constructor to be called for existing in-session files */
  95         AudioFileSource (Session&, const XMLNode&, bool must_exist = true);
  96
  97         /** Constructor to be called for crash recovery. Final argument is not
  98          * used but exists to differentiate from the external-to-session
  99          * constructor above.
 100          */
 101         AudioFileSource (Session&, const std::string& path, Source::Flag flags, bool);
 102
 103         int init (const std::string& idstr, bool must_exist);
 104
 105         virtual void set_header_timeline_position () = 0;
 106         virtual void handle_header_position_change () {}
 107
 108         int move_dependents_to_trash();
 109
 110         static Sample* get_interleave_buffer (framecnt_t size);
 111
 112         static std::string peak_dir;
 113
 114         static char bwf_country_code[3];
 115         static char bwf_organization_code[4];
 116         static char bwf_serial_number[13];
 117
 118         /** Kept up to date with the position of the session location start */
 119         static framecnt_t header_position_offset;
 120
 121   private:
 122         std::string old_peak_path (std::string audio_path);
 123         std::string broken_peak_path (std::string audio_path);
 124 };
 125
 126 } // namespace ARDOUR
 127
 128 #endif /* __ardour_audiofilesource_h__ */
 129