Logo Search packages:      
Sourcecode: ardour version File versions  Download package


    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
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.


#ifndef __ardour_audiofilesource_h__ 
#define __ardour_audiofilesource_h__

#include <exception>

#include <time.h>

#include <ardour/audiosource.h>

namespace ARDOUR {

class non_existent_source : public std::exception {
      virtual const char *what() const throw() { return "audio file does not exist"; }

struct SoundFileInfo {
    float       samplerate;
    uint16_t    channels;
    int64_t     length;
    std::string format_name;
    int64_t     timecode;

class AudioFileSource : public AudioSource {
      enum Flag {
            Writable = 0x1,
            CanRename = 0x2,
            Broadcast = 0x4,
            Removable = 0x8,
            RemovableIfEmpty = 0x10,
            RemoveAtDestroy = 0x20,
            NoPeakFile = 0x40,
            Destructive = 0x80

      virtual ~AudioFileSource ();

      int set_name (Glib::ustring newname, bool destructive);
      Glib::ustring path() const { return _path; }
      Glib::ustring peak_path (Glib::ustring audio_path);
      Glib::ustring find_broken_peakfile (Glib::ustring missing_peak_path, Glib::ustring audio_path);

      uint16_t channel() const { return _channel; }

      static void set_peak_dir (Glib::ustring dir) { peak_dir = dir; }

      static bool get_soundfile_info (Glib::ustring path, SoundFileInfo& _info, std::string& error);

      static bool safe_file_extension (Glib::ustring path);

      void set_allow_remove_if_empty (bool yn);
      void mark_for_remove();

      /* this block of methods do nothing for regular file sources, but are significant
         for files used in destructive recording.

      virtual nframes_t last_capture_start_frame() const { return 0; }
      virtual void           mark_capture_start (nframes_t) {}
      virtual void           mark_capture_end () {}
      virtual void           clear_capture_marks() {}
      virtual bool           one_of_several_channels () const { return false; }

      virtual int update_header (nframes_t when, struct tm&, time_t) = 0;
      virtual int flush_header () = 0;

      int move_to_trash (const Glib::ustring& trash_dir_name);

      static bool is_empty (Session&, Glib::ustring path);
      void mark_streaming_write_completed ();

      void   mark_take (Glib::ustring);
      Glib::ustring take_id() const { return _take_id; }

      bool is_embedded() const { return _is_embedded; }

      static void set_bwf_serial_number (int);
      static void set_search_path (Glib::ustring string);
      static void set_header_position_offset (nframes_t offset );

      int setup_peakfile ();

      static sigc::signal<void> HeaderPositionOffsetChanged;

      XMLNode& get_state ();
      int set_state (const XMLNode&);

      bool destructive() const { return (_flags & Destructive); }
      virtual bool set_destructive (bool yn) { return false; }
      bool can_truncate_peaks() const { return !destructive(); }

      Flag flags() const { return _flags; }

      void mark_immutable ();

      /* this should really be protected, but C++ is getting stricter
         and creating slots from protected member functions is starting
         to cause issues.

      virtual void handle_header_position_change () {}

      bool can_be_analysed() const { return _length > 0; } 

      /* constructor to be called for existing external-to-session files */

      AudioFileSource (Session&, Glib::ustring path, Flag flags);

      /* constructor to be called for new in-session files */

      AudioFileSource (Session&, Glib::ustring path, Flag flags,
                   SampleFormat samp_format, HeaderFormat hdr_format);

      /* constructor to be called for existing in-session files */

      AudioFileSource (Session&, const XMLNode&, bool must_exit = true);

      int init (Glib::ustring idstr, bool must_exist);

      Glib::ustring _path;
      Flag          _flags;
      Glib::ustring _take_id;
      int64_t       timeline_position;
      bool           file_is_new;
      uint16_t      _channel;

      bool          _is_embedded;
      static bool determine_embeddedness(Glib::ustring path);

      static Glib::ustring peak_dir;
      static Glib::ustring search_path;

      static char bwf_country_code[3];
      static char bwf_organization_code[4];
      static char bwf_serial_number[13];

      static uint64_t header_position_offset;

      virtual void set_timeline_position (int64_t pos);
      virtual void set_header_timeline_position () = 0;

      bool find (Glib::ustring& path, bool must_exist, bool& is_new, uint16_t& chan);
      bool removable() const;
      bool writable() const { return _flags & Writable; }

      static Sample* get_interleave_buffer (nframes_t size);

      Glib::ustring old_peak_path (Glib::ustring audio_path);
      Glib::ustring broken_peak_path (Glib::ustring audio_path);


} // namespace ARDOUR

#endif /* __ardour_audiofilesource_h__ */

Generated by  Doxygen 1.6.0   Back to index