sndfilesource.cc

Go to the documentation of this file.

/*
    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.

*/

#ifdef WAF_BUILD
#include "libardour-config.h"
#endif

#include <cstring>
#include <cerrno>
#include <climits>
#include <cstdarg>

#include <sys/stat.h>

#ifdef PLATFORM_WINDOWS
#include <glibmm/convert.h>
#endif
#include <glibmm/fileutils.h>
#include <glibmm/miscutils.h>

#include "ardour/sndfilesource.h"
#include "ardour/sndfile_helpers.h"
#include "ardour/utils.h"
#include "ardour/session.h"

#include "i18n.h"

using namespace std;
using namespace ARDOUR;
using namespace PBD;
using std::string;

gain_t* SndFileSource::out_coefficient = 0;
gain_t* SndFileSource::in_coefficient = 0;
framecnt_t SndFileSource::xfade_frames = 64;
const Source::Flag SndFileSource::default_writable_flags = Source::Flag (
                Source::Writable |
                Source::Removable |
                Source::RemovableIfEmpty |
                Source::CanRename );

SndFileSource::SndFileSource (Session& s, const XMLNode& node)
        : Source(s, node)
        , AudioFileSource (s, node)
        , _sndfile (0)
        , _broadcast_info (0)
        , _capture_start (false)
        , _capture_end (false)
        , file_pos (0)
        , xfade_buf (0)
{
        init_sndfile ();

        assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS));
        existence_check ();

        if (open()) {
                throw failed_constructor ();
        }
}

SndFileSource::SndFileSource (Session& s, const string& path, int chn, Flag flags)
        : Source(s, DataType::AUDIO, path, flags)
          /* note that the origin of an external file is itself */
        , AudioFileSource (s, path, Flag (flags & ~(Writable|Removable|RemovableIfEmpty|RemoveAtDestroy)))
        , _sndfile (0)
        , _broadcast_info (0)
        , _capture_start (false)
        , _capture_end (false)
        , file_pos (0)
        , xfade_buf (0)
{
        _channel = chn;

        init_sndfile ();

        assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS));
        existence_check ();

        if (open()) {
                throw failed_constructor ();
        }
}

SndFileSource::SndFileSource (Session& s, const string& path, const string& origin,
                              SampleFormat sfmt, HeaderFormat hf, framecnt_t rate, Flag flags)
        : Source(s, DataType::AUDIO, path, flags)
        , AudioFileSource (s, path, origin, flags, sfmt, hf)
        , _sndfile (0)
        , _broadcast_info (0)
        , _capture_start (false)
        , _capture_end (false)
        , file_pos (0)
        , xfade_buf (0)
{
        int fmt = 0;

        init_sndfile ();

        assert (!Glib::file_test (_path, Glib::FILE_TEST_EXISTS));
        existence_check ();

        _file_is_new = true;

        switch (hf) {
        case CAF:
                fmt = SF_FORMAT_CAF;
                _flags = Flag (_flags & ~Broadcast);
                break;

        case AIFF:
                fmt = SF_FORMAT_AIFF;
                _flags = Flag (_flags & ~Broadcast);
                break;

        case BWF:
                fmt = SF_FORMAT_WAV;
                _flags = Flag (_flags | Broadcast);
                break;

        case WAVE:
                fmt = SF_FORMAT_WAV;
                _flags = Flag (_flags & ~Broadcast);
                break;

        case WAVE64:
                fmt = SF_FORMAT_W64;
                _flags = Flag (_flags & ~Broadcast);
                break;

        default:
                fatal << string_compose (_("programming error: %1"), X_("unsupported audio header format requested")) << endmsg;
                abort(); /*NOTREACHED*/
                break;

        }

        switch (sfmt) {
        case FormatFloat:
                fmt |= SF_FORMAT_FLOAT;
                break;

        case FormatInt24:
                fmt |= SF_FORMAT_PCM_24;
                break;

        case FormatInt16:
                fmt |= SF_FORMAT_PCM_16;
                break;
        }

        _info.channels = 1;
        _info.samplerate = rate;
        _info.format = fmt;

        if (_flags & Destructive) {
                if (open()) {
                        throw failed_constructor();
                }
        } else {
                /* normal mode: do not open the file here - do that in {read,write}_unlocked() as needed
                 */
        }
}

SndFileSource::SndFileSource (Session& s, const string& path, int chn)
        : Source (s, DataType::AUDIO, path, Flag (0))
          /* the final boolean argument is not used, its value is irrelevant. see audiofilesource.h for explanation */
        , AudioFileSource (s, path, Flag (0))
        , _sndfile (0)
        , _broadcast_info (0)
        , _capture_start (false)
        , _capture_end (false)
        , file_pos (0)
        , xfade_buf (0)
{
        _channel = chn;

        init_sndfile ();

        assert (Glib::file_test (_path, Glib::FILE_TEST_EXISTS));
        existence_check ();

        if (open()) {
                throw failed_constructor ();
        }
}

void
SndFileSource::init_sndfile ()
{
        /* although libsndfile says we don't need to set this,
           valgrind and source code shows us that we do.
        */

        memset (&_info, 0, sizeof(_info));

        if (destructive()) {
                xfade_buf = new Sample[xfade_frames];
                _timeline_position = header_position_offset;
        }

        AudioFileSource::HeaderPositionOffsetChanged.connect_same_thread (header_position_connection, boost::bind (&SndFileSource::handle_header_position_change, this));
}

void
SndFileSource::close ()
{
        if (_sndfile) {
                sf_close (_sndfile);
                _sndfile = 0;
        }
}

int
SndFileSource::open ()
{
        string path_to_open;

        if (_sndfile) {
                return 0;
        }
        
#ifdef PLATFORM_WINDOWS
        path_to_open = Glib::locale_from_utf8(_path);
#else
        path_to_open = _path;
#endif

        _sndfile = sf_open (path_to_open.c_str(), writable() ? SFM_RDWR : SFM_READ, &_info);

        if (_sndfile == 0) {
                char errbuf[1024];
                sf_error_str (0, errbuf, sizeof (errbuf) - 1);
#ifndef HAVE_COREAUDIO
                /* if we have CoreAudio, we will be falling back to that if libsndfile fails,
                   so we don't want to see this message.
                */

                cerr << "failed to open " << path_to_open << " with name " << _name << endl;

                error << string_compose(_("SndFileSource: cannot open file \"%1\" for %2 (%3)"),
                                        path_to_open, (writable() ? "read+write" : "reading"), errbuf) << endmsg;
#endif
                return -1;
        }

        if (_channel >= _info.channels) {
#ifndef HAVE_COREAUDIO
                error << string_compose(_("SndFileSource: file only contains %1 channels; %2 is invalid as a channel number"), _info.channels, _channel) << endmsg;
#endif
                sf_close (_sndfile);
                _sndfile = 0;
                return -1;
        }

        _length = _info.frames;

        if (!_broadcast_info) {
                _broadcast_info = new BroadcastInfo;
        }

        bool bwf_info_exists = _broadcast_info->load_from_file (_sndfile);

        if (_file_is_new && _length == 0 && writable() && !bwf_info_exists) {
                /* newly created files will not have a BWF header at this point in time.
                 * Import will have called Source::set_timeline_position() if one exists
                 * in the original. */
                header_position_offset = _timeline_position;
        }

        /* Set our timeline position to either the time reference from a BWF header or the current
           start of the session.
        */
        set_timeline_position (bwf_info_exists ? _broadcast_info->get_time_reference() : header_position_offset);

        if (_length != 0 && !bwf_info_exists) {
                delete _broadcast_info;
                _broadcast_info = 0;
                _flags = Flag (_flags & ~Broadcast);
        } 

        /* Set the broadcast flag if the BWF info is already there. We need
         * this when recovering or using existing files.
         */
        
        if (bwf_info_exists) {
                _flags = Flag (_flags | Broadcast);
        }

        if (writable()) {
                sf_command (_sndfile, SFC_SET_UPDATE_HEADER_AUTO, 0, SF_FALSE);

                if (_flags & Broadcast) {

                        if (!_broadcast_info) {
                                _broadcast_info = new BroadcastInfo;
                        }

                        _broadcast_info->set_from_session (_session, header_position_offset);
                        _broadcast_info->set_description (string_compose ("BWF %1", _name));

                        if (!_broadcast_info->write_to_file (_sndfile)) {
                                error << string_compose (_("cannot set broadcast info for audio file %1 (%2); dropping broadcast info for this file"),
                                                         path_to_open, _broadcast_info->get_error())
                                      << endmsg;
                                _flags = Flag (_flags & ~Broadcast);
                                delete _broadcast_info;
                                _broadcast_info = 0;
                        }
                }
        }
        
        return 0;
}

SndFileSource::~SndFileSource ()
{
        close ();
        delete _broadcast_info;
        delete [] xfade_buf;
}

float
SndFileSource::sample_rate () const
{
        return _info.samplerate;
}

framecnt_t
SndFileSource::read_unlocked (Sample *dst, framepos_t start, framecnt_t cnt) const
{
        assert (cnt >= 0);
        
        framecnt_t nread;
        float *ptr;
        framecnt_t real_cnt;
        framepos_t file_cnt;

        if (writable() && !_sndfile) {
                /* file has not been opened yet - nothing written to it */
                memset (dst, 0, sizeof (Sample) * cnt);
                return cnt;
        }

        if (const_cast<SndFileSource*>(this)->open()) {
                error << string_compose (_("could not open file %1 for reading."), _path) << endmsg;
                return 0;
        }

        if (start > _length) {

                /* read starts beyond end of data, just memset to zero */

                file_cnt = 0;

        } else if (start + cnt > _length) {

                /* read ends beyond end of data, read some, memset the rest */

                file_cnt = _length - start;

        } else {

                /* read is entirely within data */

                file_cnt = cnt;
        }

        assert (file_cnt >= 0);

        if (file_cnt != cnt) {
                framepos_t delta = cnt - file_cnt;
                memset (dst+file_cnt, 0, sizeof (Sample) * delta);
        }

        if (file_cnt) {

                if (sf_seek (_sndfile, (sf_count_t) start, SEEK_SET|SFM_READ) != (sf_count_t) start) {
                        char errbuf[256];
                        sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                        error << string_compose(_("SndFileSource: could not seek to frame %1 within %2 (%3)"), start, _name.val().substr (1), errbuf) << endmsg;
                        return 0;
                }

                if (_info.channels == 1) {
                        framecnt_t ret = sf_read_float (_sndfile, dst, file_cnt);
                        if (ret != file_cnt) {
                                char errbuf[256];
                                sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                                error << string_compose(_("SndFileSource: @ %1 could not read %2 within %3 (%4) (len = %5, ret was %6)"), start, file_cnt, _name.val().substr (1), errbuf, _length, ret) << endl;
                        }
                        return ret;
                }
        }

        real_cnt = cnt * _info.channels;

        Sample* interleave_buf = get_interleave_buffer (real_cnt);

        nread = sf_read_float (_sndfile, interleave_buf, real_cnt);
        ptr = interleave_buf + _channel;
        nread /= _info.channels;

        /* stride through the interleaved data */

        for (framecnt_t n = 0; n < nread; ++n) {
                dst[n] = *ptr;
                ptr += _info.channels;
        }

        return nread;
}

framecnt_t
SndFileSource::write_unlocked (Sample *data, framecnt_t cnt)
{
        if (open()) {
                return 0; // failure
        }

        if (destructive()) {
                return destructive_write_unlocked (data, cnt);
        } else {
                return nondestructive_write_unlocked (data, cnt);
        }
}

framecnt_t
SndFileSource::nondestructive_write_unlocked (Sample *data, framecnt_t cnt)
{
        if (!writable()) {
                warning << string_compose (_("attempt to write a non-writable audio file source (%1)"), _path) << endmsg;
                return 0;
        }

        if (_info.channels != 1) {
                fatal << string_compose (_("programming error: %1 %2"), X_("SndFileSource::write called on non-mono file"), _path) << endmsg;
                abort(); /*NOTREACHED*/
                return 0;
        }

        framepos_t frame_pos = _length;

        if (write_float (data, frame_pos, cnt) != cnt) {
                return 0;
        }

        update_length (_length + cnt);

        if (_build_peakfiles) {
                compute_and_write_peaks (data, frame_pos, cnt, true, true);
        }

        return cnt;
}

framecnt_t
SndFileSource::destructive_write_unlocked (Sample* data, framecnt_t cnt)
{
        if (!writable()) {
                warning << string_compose (_("attempt to write a non-writable audio file source (%1)"), _path) << endmsg;
                return 0;
        }

        if (_capture_start && _capture_end) {

                /* start and end of capture both occur within the data we are writing,
                   so do both crossfades.
                */

                _capture_start = false;
                _capture_end = false;

                /* move to the correct location place */
                file_pos = capture_start_frame - _timeline_position;

                // split cnt in half
                framecnt_t subcnt = cnt / 2;
                framecnt_t ofilepos = file_pos;

                // fade in
                if (crossfade (data, subcnt, 1) != subcnt) {
                        return 0;
                }

                file_pos += subcnt;
                Sample * tmpdata = data + subcnt;

                // fade out
                subcnt = cnt - subcnt;
                if (crossfade (tmpdata, subcnt, 0) != subcnt) {
                        return 0;
                }

                file_pos = ofilepos; // adjusted below

        } else if (_capture_start) {

                /* start of capture both occur within the data we are writing,
                   so do the fade in
                */

                _capture_start = false;
                _capture_end = false;

                /* move to the correct location place */
                file_pos = capture_start_frame - _timeline_position;

                if (crossfade (data, cnt, 1) != cnt) {
                        return 0;
                }

        } else if (_capture_end) {

                /* end of capture both occur within the data we are writing,
                   so do the fade out
                */

                _capture_start = false;
                _capture_end = false;

                if (crossfade (data, cnt, 0) != cnt) {
                        return 0;
                }

        } else {

                /* in the middle of recording */

                if (write_float (data, file_pos, cnt) != cnt) {
                        return 0;
                }
        }

        update_length (file_pos + cnt);

        if (_build_peakfiles) {
                compute_and_write_peaks (data, file_pos, cnt, true, true);
        }

        file_pos += cnt;

        return cnt;
}

int
SndFileSource::update_header (framepos_t when, struct tm& now, time_t tnow)
{
        set_timeline_position (when);

        if (_flags & Broadcast) {
                if (setup_broadcast_info (when, now, tnow)) {
                        return -1;
                }
        }

        return flush_header ();
}

int
SndFileSource::flush_header ()
{
        if (!writable()) {
                warning << string_compose (_("attempt to flush a non-writable audio file source (%1)"), _path) << endmsg;
                return -1;
        }

        if (_sndfile == 0) {
                error << string_compose (_("could not allocate file %1 to write header"), _path) << endmsg;
                return -1;
        }

        int const r = sf_command (_sndfile, SFC_UPDATE_HEADER_NOW, 0, 0) != SF_TRUE;

        return r;
}

void
SndFileSource::flush ()
{
        if (!writable()) {
                warning << string_compose (_("attempt to flush a non-writable audio file source (%1)"), _path) << endmsg;
                return;
        }

        if (_sndfile == 0) {
                error << string_compose (_("could not allocate file %1 to flush contents"), _path) << endmsg;
                return;
        }

        // Hopefully everything OK
        sf_write_sync (_sndfile);
}

int
SndFileSource::setup_broadcast_info (framepos_t /*when*/, struct tm& now, time_t /*tnow*/)
{
        if (!writable()) {
                warning << string_compose (_("attempt to store broadcast info in a non-writable audio file source (%1)"), _path) << endmsg;
                return -1;
        }

        if (!_sndfile) {
                warning << string_compose (_("attempt to set BWF info for an un-opened audio file source (%1)"), _path) << endmsg;
                return -1;
        }

        if (!(_flags & Broadcast) || !_broadcast_info) {
                return 0;
        }

        _broadcast_info->set_originator_ref_from_session (_session);
        _broadcast_info->set_origination_time (&now);

        /* now update header position taking header offset into account */

        set_header_timeline_position ();

        return 0;
}

void
SndFileSource::set_header_timeline_position ()
{
        if (!(_flags & Broadcast)) {
                return;
        }
        assert (_broadcast_info);

        _broadcast_info->set_time_reference (_timeline_position);

        if (_sndfile == 0 || !_broadcast_info->write_to_file (_sndfile)) {
                error << string_compose (_("cannot set broadcast info for audio file %1 (%2); dropping broadcast info for this file"),
                                           _path, _broadcast_info->get_error())
                      << endmsg;
                _flags = Flag (_flags & ~Broadcast);
                delete _broadcast_info;
                _broadcast_info = 0;
        }
}

framecnt_t
SndFileSource::write_float (Sample* data, framepos_t frame_pos, framecnt_t cnt)
{
        if (_sndfile == 0 || sf_seek (_sndfile, frame_pos, SEEK_SET|SFM_WRITE) < 0) {
                char errbuf[256];
                sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                error << string_compose (_("%1: cannot seek to %2 (libsndfile error: %3)"), _path, frame_pos, errbuf) << endmsg;
                return 0;
        }

        if (sf_writef_float (_sndfile, data, cnt) != (ssize_t) cnt) {
                return 0;
        }

        return cnt;
}

framepos_t
SndFileSource::natural_position() const
{
        return _timeline_position;
}

bool
SndFileSource::set_destructive (bool yn)
{
        if (yn) {
                _flags = Flag (_flags | Writable | Destructive);
                if (!xfade_buf) {
                        xfade_buf = new Sample[xfade_frames];
                }
                clear_capture_marks ();
                _timeline_position = header_position_offset;
        } else {
                _flags = Flag (_flags & ~Destructive);
                _timeline_position = 0;
                /* leave xfade buf alone in case we need it again later */
        }

        return true;
}

void
SndFileSource::clear_capture_marks ()
{
        _capture_start = false;
        _capture_end = false;
}

void
SndFileSource::mark_capture_start (framepos_t pos)
{
        if (destructive()) {
                if (pos < _timeline_position) {
                        _capture_start = false;
                } else {
                        _capture_start = true;
                        capture_start_frame = pos;
                }
        }
}

void
SndFileSource::mark_capture_end()
{
        if (destructive()) {
                _capture_end = true;
        }
}

framecnt_t
SndFileSource::crossfade (Sample* data, framecnt_t cnt, int fade_in)
{
        framecnt_t xfade = min (xfade_frames, cnt);
        framecnt_t nofade = cnt - xfade;
        Sample* fade_data = 0;
        framepos_t fade_position = 0; // in frames
        ssize_t retval;
        framecnt_t file_cnt;

        if (fade_in) {
                fade_position = file_pos;
                fade_data = data;
        } else {
                fade_position = file_pos + nofade;
                fade_data = data + nofade;
        }

        if (fade_position > _length) {

                /* read starts beyond end of data, just memset to zero */

                file_cnt = 0;

        } else if (fade_position + xfade > _length) {

                /* read ends beyond end of data, read some, memset the rest */

                file_cnt = _length - fade_position;

        } else {

                /* read is entirely within data */

                file_cnt = xfade;
        }

        if (file_cnt) {

                if ((retval = read_unlocked (xfade_buf, fade_position, file_cnt)) != (ssize_t) file_cnt) {
                        if (retval >= 0 && errno == EAGAIN) {
                                /* XXX - can we really trust that errno is meaningful here?  yes POSIX, i'm talking to you.
                                 * short or no data there */
                                memset (xfade_buf, 0, xfade * sizeof(Sample));
                        } else {
                                error << string_compose(_("SndFileSource: \"%1\" bad read retval: %2 of %5 (%3: %4)"), _path, retval, errno, strerror (errno), xfade) << endmsg;
                                return 0;
                        }
                }
        }

        if (file_cnt != xfade) {
                framecnt_t delta = xfade - file_cnt;
                memset (xfade_buf+file_cnt, 0, sizeof (Sample) * delta);
        }

        if (nofade && !fade_in) {
                if (write_float (data, file_pos, nofade) != nofade) {
                        error << string_compose(_("SndFileSource: \"%1\" bad write (%2)"), _path, strerror (errno)) << endmsg;
                        return 0;
                }
        }

        if (xfade == xfade_frames) {

                framecnt_t n;

                /* use the standard xfade curve */

                if (fade_in) {

                        /* fade new material in */

                        for (n = 0; n < xfade; ++n) {
                                xfade_buf[n] = (xfade_buf[n] * out_coefficient[n]) + (fade_data[n] * in_coefficient[n]);
                        }

                } else {


                        /* fade new material out */

                        for (n = 0; n < xfade; ++n) {
                                xfade_buf[n] = (xfade_buf[n] * in_coefficient[n]) + (fade_data[n] * out_coefficient[n]);
                        }
                }

        } else if (xfade < xfade_frames) {

                std::vector<gain_t> in(xfade);
                std::vector<gain_t> out(xfade);

                /* short xfade, compute custom curve */

                compute_equal_power_fades (xfade, &in[0], &out[0]);

                for (framecnt_t n = 0; n < xfade; ++n) {
                        xfade_buf[n] = (xfade_buf[n] * out[n]) + (fade_data[n] * in[n]);
                }

        } else if (xfade) {

                /* long xfade length, has to be computed across several calls */

        }

        if (xfade) {
                if (write_float (xfade_buf, fade_position, xfade) != xfade) {
                        error << string_compose(_("SndFileSource: \"%1\" bad write (%2)"), _path, strerror (errno)) << endmsg;
                        return 0;
                }
        }

        if (fade_in && nofade) {
                if (write_float (data + xfade, file_pos + xfade, nofade) != nofade) {
                        error << string_compose(_("SndFileSource: \"%1\" bad write (%2)"), _path, strerror (errno)) << endmsg;
                        return 0;
                }
        }

        return cnt;
}

framepos_t
SndFileSource::last_capture_start_frame () const
{
        if (destructive()) {
                return capture_start_frame;
        } else {
                return 0;
        }
}

void
SndFileSource::handle_header_position_change ()
{
        if (destructive()) {
                if ( _length != 0 ) {
                        error << string_compose(_("Filesource: start time is already set for existing file (%1): Cannot change start time."), _path ) << endmsg;
                        //in the future, pop up a dialog here that allows user to regenerate file with new start offset
                } else if (writable()) {
                        _timeline_position = header_position_offset;
                        set_header_timeline_position ();  //this will get flushed if/when the file is recorded to
                }
        }
}

void
SndFileSource::setup_standard_crossfades (Session const & s, framecnt_t rate)
{
        /* This static method is assumed to have been called by the Session
           before any DFS's are created.
        */

        xfade_frames = (framecnt_t) floor ((s.config.get_destructive_xfade_msecs () / 1000.0) * rate);

        delete [] out_coefficient;
        delete [] in_coefficient;

        out_coefficient = new gain_t[xfade_frames];
        in_coefficient = new gain_t[xfade_frames];

        compute_equal_power_fades (xfade_frames, in_coefficient, out_coefficient);
}

void
SndFileSource::set_timeline_position (framepos_t pos)
{
        // destructive track timeline postion does not change
        // except at instantion or when header_position_offset
        // (session start) changes

        if (!destructive()) {
                AudioFileSource::set_timeline_position (pos);
        }
}

int
SndFileSource::get_soundfile_info (const string& path, SoundFileInfo& info, string& error_msg)
{
        SNDFILE *sf;
        SF_INFO sf_info;
        BroadcastInfo binfo;

        sf_info.format = 0; // libsndfile says to clear this before sf_open().

        if ((sf = sf_open (const_cast<char*>(path.c_str()), SFM_READ, &sf_info)) == 0) {
                char errbuf[256];
                error_msg = sf_error_str (0, errbuf, sizeof (errbuf) - 1);
                return false;
        }

        info.samplerate  = sf_info.samplerate;
        info.channels    = sf_info.channels;
        info.length      = sf_info.frames;

        string major = sndfile_major_format(sf_info.format);
        string minor = sndfile_minor_format(sf_info.format);

        if (major.length() + minor.length() < 16) { /* arbitrary */
                info.format_name = string_compose("%1/%2", major, minor);
        } else {
                info.format_name = string_compose("%1\n%2", major, minor);
        }

        info.timecode = binfo.load_from_file (sf) ? binfo.get_time_reference() : 0;

        sf_close (sf);

        return true;
}

bool
SndFileSource::one_of_several_channels () const
{
        return _info.channels > 1;
}

bool
SndFileSource::clamped_at_unity () const
{
        int const type = _info.format & SF_FORMAT_TYPEMASK;
        int const sub = _info.format & SF_FORMAT_SUBMASK;
        /* XXX: this may not be the full list of formats that are unclamped */
        return (sub != SF_FORMAT_FLOAT && sub != SF_FORMAT_DOUBLE && type != SF_FORMAT_OGG);
}

void
SndFileSource::file_closed ()
{
        /* stupid libsndfile updated the headers on close,
           so touch the peakfile if it exists and has data
           to make sure its time is as new as the audio
           file.
        */

        touch_peakfile ();
}

void
SndFileSource::set_path (const string& p)
{
        FileSource::set_path (p);
}