element_importer.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008-2009 Sakari Bergen <sakari.bergen@beatwaves.net>
 * Copyright (C) 2009-2010 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2009-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2009 David Robillard <d@drobilla.net>
 *
 * 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.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#pragma once
 
#include <string>
#include <utility>
 
#include "pbd/signals.h"
#include "ardour/libardour_visibility.h"
#include "ardour/types.h"
 
class XMLTree;
namespace ARDOUR {
 
class Session;
class ImportStatus;
 
class LIBARDOUR_API ElementImporter
{
  public:
 
        ElementImporter (XMLTree const & source, ARDOUR::Session & session);
        virtual ~ElementImporter ();
 
        virtual std::string get_name () const { return name; };
 
        virtual std::string get_info () const = 0;
 
        virtual ImportStatus * get_import_status () { return 0; }
 
        bool prepare_move ();
 
        void cancel_move ();
 
        void move ();
 
        bool broken () { return _broken; }
 
        static PBD::Signal<std::pair<bool, std::string>(std::string, std::string)> Rename;
 
        static PBD::Signal<bool(std::string)> Prompt;
 
  protected:
 
        virtual void _move () = 0;
 
        virtual bool _prepare_move () = 0;
 
        virtual void _cancel_move () = 0;
 
        XMLTree const & source;
 
        ARDOUR::Session & session;
 
        bool queued () { return _queued; }
 
        std::string  name;
 
        samplecnt_t sample_rate;
 
        std::string timecode_to_string (Timecode::Time & time) const;
 
        samplecnt_t rate_convert_samples (samplecnt_t samples) const;
 
        std::string rate_convert_samples (std::string const & samples) const;
 
        void set_broken () { _broken = true; }
 
  private:
        bool _queued;
        bool _broken;
};
 
} // namespace ARDOUR