/*
    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
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    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.

    $Id$
*/

#ifndef __sndfile_source_h__ 
#define __sndfile_source_h__

#include <sndfile.h>

#include <ardour/audiofilesource.h>

namespace ARDOUR {

class SndFileSource : public AudioFileSource {
  public:
	/* constructor to be called for existing external-to-session files */

	SndFileSource (Session&, std::string path, Flag flags);

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

	SndFileSource (Session&, std::string path, SampleFormat samp_format, HeaderFormat hdr_format, nframes_t rate, 
		       Flag flags = SndFileSource::default_writable_flags);
		       
	/* constructor to be called for existing in-session files */
	
	SndFileSource (Session&, const XMLNode&);

	~SndFileSource ();

	float sample_rate () const;
	int update_header (nframes_t when, struct tm&, time_t);
	int flush_header ();

	nframes_t natural_position () const;

	nframes_t last_capture_start_frame() const;
	void mark_capture_start (nframes_t);
	void mark_capture_end ();
	void clear_capture_marks();

	bool set_destructive (bool yn);

	static void setup_standard_crossfades (nframes_t sample_rate);
	static const AudioFileSource::Flag default_writable_flags;

  protected:
	void set_header_timeline_position ();

	nframes_t read_unlocked (Sample *dst, nframes_t start, nframes_t cnt) const;
	nframes_t write_unlocked (Sample *dst, nframes_t cnt);

	nframes_t write_float (Sample* data, nframes_t pos, nframes_t cnt);

  private:
	SNDFILE *sf;
	SF_INFO _info;
	SF_BROADCAST_INFO *_broadcast_info;

	mutable float *interleave_buf;
	mutable nframes_t interleave_bufsize;

	void init (string str);
	int open();
	void close();
	int setup_broadcast_info (nframes_t when, struct tm&, time_t);

	/* destructive */

	static nframes_t xfade_frames;
	static gain_t* out_coefficient;
	static gain_t* in_coefficient;

	bool          _capture_start;
	bool          _capture_end;
	nframes_t      capture_start_frame;
	nframes_t      file_pos; // unit is frames
	Sample*        xfade_buf;

	nframes_t crossfade (Sample* data, nframes_t cnt, int dir);
	void set_timeline_position (nframes_t);
	nframes_t destructive_write_unlocked (Sample *dst, nframes_t cnt);
	nframes_t nondestructive_write_unlocked (Sample *dst, nframes_t cnt);
	void handle_header_position_change ();
};

} // namespace ARDOUR

#endif /* __sndfile_source_h__ */