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 construct_peak_filepath (const std::string& audio_path, const bool in_session = false, const bool old_peak_name = false) const;
  43
  44         static bool get_soundfile_info (const std::string& path, SoundFileInfo& _info, std::string& error);
  45
  46         bool safe_file_extension (const std::string& path) const {
  47                 return safe_audio_file_extension(path);
  48         }
  49
  50         /* this block of methods do nothing for regular file sources, but are significant
  51            for files used in destructive recording.
  52         */
  53         virtual samplepos_t last_capture_start_sample() const { return 0; }
  54         virtual void      mark_capture_start (samplepos_t) {}
  55         virtual void      mark_capture_end () {}
  56         virtual void      clear_capture_marks() {}
  57         virtual bool      one_of_several_channels () const { return false; }
  58
  59         virtual void flush () = 0;
  60         virtual int update_header (samplepos_t when, struct tm&, time_t) = 0;
  61         virtual int flush_header () = 0;
  62
  63         void mark_streaming_write_completed (const Lock& lock);
  64
  65         int setup_peakfile ();
  66         void set_gain (float g, bool temporarily = false);
  67
  68         XMLNode& get_state ();
  69         int set_state (const XMLNode&, int version);
  70
  71         bool can_truncate_peaks() const { return !destructive(); }
  72         bool can_be_analysed() const    { return _length > 0; }
  73
  74         static bool safe_audio_file_extension (const std::string& path);
  75
  76         static bool is_empty (Session&, std::string path);
  77
  78         static void set_bwf_serial_number (int);
  79         static void set_header_position_offset (samplecnt_t offset);
  80
  81         static PBD::Signal0<void> HeaderPositionOffsetChanged;
  82
  83 protected:
  84         /** Constructor to be called for existing external-to-session files */
  85         AudioFileSource (Session&, const std::string& path, Source::Flag flags);
  86
  87         /** Constructor to be called for new in-session files */
  88         AudioFileSource (Session&, const std::string& path, const std::string& origin, Source::Flag flags,
  89                         SampleFormat samp_format, HeaderFormat hdr_format);
  90
  91         /** Constructor to be called for existing in-session files */
  92         AudioFileSource (Session&, const XMLNode&, bool must_exist = true);
  93
  94         /** Constructor to be called for crash recovery. Final argument is not
  95          * used but exists to differentiate from the external-to-session
  96          * constructor above.
  97          */
  98         AudioFileSource (Session&, const std::string& path, Source::Flag flags, bool);
  99
 100         int init (const std::string& idstr, bool must_exist);
 101
 102         virtual void set_header_timeline_position () = 0;
 103         virtual void handle_header_position_change () {}
 104
 105         int move_dependents_to_trash();
 106
 107         static Sample* get_interleave_buffer (samplecnt_t size);
 108
 109         static char bwf_country_code[3];
 110         static char bwf_organization_code[4];
 111         static char bwf_serial_number[13];
 112
 113         /** Kept up to date with the position of the session location start */
 114         static samplecnt_t header_position_offset;
 115 };
 116
 117 } // namespace ARDOUR
 118
 119 #endif /* __ardour_audiofilesource_h__ */
 120