io_plug.h

Go to the documentation of this file.

/*
 * Copyright (C) 2022 Robin Gareus <robin@gareus.org>
 *
 * 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.
 */
 
#ifndef _libardour_io_plug_h_
#define _libardour_io_plug_h_
 
#include <atomic>
 
#include "pbd/timing.h"
 
#include "ardour/ardour.h"
#include "ardour/automation_control.h"
#include "ardour/buffer_set.h"
#include "ardour/latent.h"
#include "ardour/graphnode.h"
#include "ardour/plugin.h"
#include "ardour/port_manager.h"
#include "ardour/session_object.h"
#include "ardour/plug_insert_base.h"
 
namespace Gtkmm2ext {
class WindowProxy;
}
 
namespace ARDOUR {
 
class IO;
class ReadOnlyControl;
 
class LIBARDOUR_API IOPlug : public SessionObject, public PlugInsertBase, public Latent, public GraphNode
{
public:
        IOPlug (Session&, std::shared_ptr<Plugin> = std::shared_ptr<Plugin>(), bool pre = true);
        virtual ~IOPlug ();
 
        bool set_name (std::string const&);
 
        std::string io_name (std::string const& name = "") const;
 
        XMLNode& get_state (void) const;
        int set_state (const XMLNode&, int version);
 
        void connect_and_run (samplepos_t, pframes_t);
        int  set_block_size (pframes_t);
        void set_public_latency (bool);
        bool ensure_io ();
        void set_pretty_port_names ();
 
        bool is_pre () const { return _pre; }
 
        std::shared_ptr<IO> input () const { return _input; }
        std::shared_ptr<IO> output () const { return _output; }
 
        Gtkmm2ext::WindowProxy* window_proxy () const { return _window_proxy; }
        void set_window_proxy (Gtkmm2ext::WindowProxy* wp) { _window_proxy = wp; }
 
        PortManager::AudioInputPorts audio_input_ports () const { return _audio_input_ports; }
        PortManager::MIDIInputPorts  midi_input_ports () const { return _midi_input_ports; }
 
        void reset_input_meters ();
 
        /* Latent */
        samplecnt_t signal_latency () const;
 
        /* PlugInsertBase */
        uint32_t get_count () const { return 1; }
        std::shared_ptr<Plugin> plugin (uint32_t num = 0) const { return _plugin; }
        PluginType type () const { return _plugin->get_info()->type; }
 
        UIElements ui_elements () const;
 
        bool write_immediate_event (Evoral::EventType event_type, size_t size, const uint8_t* buf);
        bool load_preset (Plugin::PresetRecord);
 
        std::shared_ptr<ReadOnlyControl> control_output (uint32_t) const;
 
        bool reset_parameters_to_default ();
        bool can_reset_all_parameters ();
 
        virtual bool provides_stats () const { return true; }
        virtual bool get_stats (PBD::microseconds_t&, PBD::microseconds_t&, double&, double&) const;
        virtual void clear_stats ();
 
        ChanMapping input_map (uint32_t num) const;
        ChanMapping output_map (uint32_t num) const;
 
        /* ControlSet */
        std::shared_ptr<Evoral::Control> control_factory (const Evoral::Parameter& id);
 
        /* GraphNode */
        std::string graph_node_name () const {
                return name ();
        }
        bool direct_feeds_according_to_reality (std::shared_ptr<GraphNode>, bool* via_send_only = 0);
        void process ();
 
protected:
        std::string describe_parameter (Evoral::Parameter);
 
private:
        /* disallow copy construction */
        IOPlug (IOPlug const&);
 
        std::string ensure_io_name (std::string) const;
        void create_parameters ();
        void parameter_changed_externally (uint32_t, float);
        void property_changed_externally (uint32_t, Variant);
        void processor_change (RouteProcessorChange const&);
 
        void setup ();
 
        ChanCount _n_in;
        ChanCount _n_out;
        PluginPtr _plugin;
        bool      _pre;
        uint32_t  _plugin_signal_latency;
 
        typedef std::map<uint32_t, std::shared_ptr<ReadOnlyControl> >CtrlOutMap;
        CtrlOutMap _control_outputs;
 
        BufferSet             _bufs;
        std::shared_ptr<IO> _input;
        std::shared_ptr<IO> _output;
        bool                _configuring_io;
 
        PortManager::AudioInputPorts _audio_input_ports;
        PortManager::MIDIInputPorts  _midi_input_ports;
 
        Gtkmm2ext::WindowProxy* _window_proxy;
 
        PBD::TimingStats  _timing_stats;
        std::atomic<int> _stat_reset;
        std::atomic<int> _reset_meters;
};
 
}
#endif