Fix broken whitespace. I'd apologize for the compile times if it was my fault :D
[ardour.git] / libs / ardour / ardour / audiofilesource.h
index ecbac569d52416587e3a9959ee5b67b073b93c2f..cc26371a78d719b148513173fdca2a6f36b8002d 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2006 Paul Davis 
+    Copyright (C) 2006 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
 
 */
 
-#ifndef __ardour_audiofilesource_h__ 
+#ifndef __ardour_audiofilesource_h__
 #define __ardour_audiofilesource_h__
 
+#include <exception>
 #include <time.h>
-
-#include <ardour/audiosource.h>
+#include "ardour/audiosource.h"
+#include "ardour/file_source.h"
 
 namespace ARDOUR {
 
@@ -31,127 +32,94 @@ struct SoundFileInfo {
     uint16_t    channels;
     int64_t     length;
     std::string format_name;
+    int64_t     timecode;
 };
 
-class AudioFileSource : public AudioSource {
-  public:
-       enum Flag {
-               Writable = 0x1,
-               CanRename = 0x2,
-               Broadcast = 0x4,
-               Removable = 0x8,
-               RemovableIfEmpty = 0x10,
-               RemoveAtDestroy = 0x20,
-               BuildPeaks = 0x40
-       };
-
+class AudioFileSource : public AudioSource, public FileSource {
+public:
        virtual ~AudioFileSource ();
 
-       int set_name (string newname, bool destructive);
-
-       string path() const { return _path; }
-       string peak_path (string audio_path);
-       string old_peak_path (string audio_path);
-
-       static void set_peak_dir (string dir) { peak_dir = dir; }
+       bool set_name (const std::string& newname) {
+               return (set_source_name(newname, destructive()) == 0);
+       }
 
-       /* factory for an existing but not-used-in-session audio file. this exists
-          because there maybe multiple back-end derivations of AudioFileSource,
-          some of which can handle formats that cannot be handled by others.
-          For example, CoreAudioFileSource can handle MP3 files, which SndFileSource
-          cannot.
-        */
+       std::string peak_path (std::string audio_path);
+       std::string find_broken_peakfile (std::string missing_peak_path,
+                                         std::string audio_path);
 
-       static AudioFileSource* create (string path_plus_channel);
-       static AudioFileSource* create (const XMLNode&);
+       static void set_peak_dir (std::string dir) { peak_dir = dir; }
 
-       static bool get_soundfile_info (string path, SoundFileInfo& _info, string& error);
+       static bool get_soundfile_info (std::string path, SoundFileInfo& _info, std::string& error);
 
-       void set_allow_remove_if_empty (bool yn);
-       void mark_for_remove();
+       bool safe_file_extension (const std::string& path) const {
+               return safe_audio_file_extension(path);
+       }
 
        /* this block of methods do nothing for regular file sources, but are significant
           for files used in destructive recording.
        */
+       virtual framepos_t last_capture_start_frame() const { return 0; }
+       virtual void      mark_capture_start (framepos_t) {}
+       virtual void      mark_capture_end () {}
+       virtual void      clear_capture_marks() {}
+       virtual bool      one_of_several_channels () const { return false; }
 
-       virtual jack_nframes_t last_capture_start_frame() const { return 0; }
-       virtual void           mark_capture_start (jack_nframes_t) {}
-       virtual void           mark_capture_end () {}
-       virtual void           clear_capture_marks() {}
-
-       virtual int update_header (jack_nframes_t when, struct tm&, time_t) = 0;
+       virtual int update_header (framepos_t when, struct tm&, time_t) = 0;
        virtual int flush_header () = 0;
 
-       int move_to_trash (const string trash_dir_name);
-
-       static bool is_empty (string path);
        void mark_streaming_write_completed ();
 
-       void   mark_take (string);
-       string take_id() const { return _take_id; }
+       int setup_peakfile ();
 
-       static void set_bwf_country_code (string x);
-       static void set_bwf_organization_code (string x);
-       static void set_bwf_serial_number (int);
-       
-       static void set_search_path (string);
-       static void set_header_position_offset (jack_nframes_t offset, bool negative);
+       XMLNode& get_state ();
+       int set_state (const XMLNode&, int version);
 
-       static sigc::signal<void,struct tm*, time_t> HeaderPositionOffsetChanged;
+       bool can_truncate_peaks() const { return !destructive(); }
+       bool can_be_analysed() const    { return _length > 0; }
 
-       XMLNode& get_state ();
-       int set_state (const XMLNode&);
+       static bool safe_audio_file_extension (const std::string& path);
 
-       /* this should really be protected, but C++ is getting stricter
-          and creating slots from protected member functions is starting
-          to cause issues.
-       */
+       static bool is_empty (Session&, std::string path);
 
-       void handle_header_position_change (struct tm*, time_t tnow);
+       static void set_bwf_serial_number (int);
+       static void set_header_position_offset (framecnt_t offset);
 
-  protected:
-       
-       /* constructor to be called for existing external-to-session files */
+       static PBD::Signal0<void> HeaderPositionOffsetChanged;
 
-       AudioFileSource (std::string path, Flag flags);
+protected:
+       /** Constructor to be called for existing external-to-session files */
+       AudioFileSource (Session&, const std::string& path, Source::Flag flags);
 
-       /* constructor to be called for new in-session files */
+       /** Constructor to be called for new in-session files */
+       AudioFileSource (Session&, const std::string& path, const std::string& origin, Source::Flag flags,
+                       SampleFormat samp_format, HeaderFormat hdr_format);
 
-       AudioFileSource (std::string path, Flag flags,
-                        SampleFormat samp_format, HeaderFormat hdr_format);
+       /** Constructor to be called for existing in-session files */
+       AudioFileSource (Session&, const XMLNode&, bool must_exist = true);
 
-       /* constructor to be called for existing in-session files */
+       int init (const std::string& idstr, bool must_exist);
 
-       AudioFileSource (const XMLNode&);
+       virtual void set_header_timeline_position () = 0;
+       virtual void handle_header_position_change () {}
 
-       int init (string idstr, bool must_exist);
+       int move_dependents_to_trash();
 
-       uint16_t       channel;
-       string        _path;
-       Flag          _flags;
-       string        _take_id;
-       bool           allow_remove_if_empty;
-       uint64_t       timeline_position;
+       static Sample* get_interleave_buffer (framecnt_t size);
 
-       static string peak_dir;
-       static string search_path;
+       static std::string peak_dir;
 
        static char bwf_country_code[3];
        static char bwf_organization_code[4];
        static char bwf_serial_number[13];
 
        static uint64_t header_position_offset;
-       static bool     header_position_negative;
-
-       virtual void set_timeline_position (jack_nframes_t pos);
-       virtual void set_header_timeline_position () = 0;
 
-       bool find (std::string path, bool must_exist, bool& is_new);
-       bool removable() const;
-       bool writable() const { return _flags & Writable; }
+  private:
+       std::string old_peak_path (std::string audio_path);
+       std::string broken_peak_path (std::string audio_path);
 };
 
-}; /* namespace ARDOUR */
+} // namespace ARDOUR
 
 #endif /* __ardour_audiofilesource_h__ */