delivery.h

Go to the documentation of this file.

/*
 * Copyright (C) 2009-2011 David Robillard <d@drobilla.net>
 * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2009-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2013-2019 Robin Gareus <robin@gareus.org>
 * Copyright (C) 2018 Len Ovens <len@ovenwerks.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>
 
#if __cplusplus >= 202002L
#include <memory>
#else
#include <boost/smart_ptr/atomic_shared_ptr.hpp>
#endif
 
#include "pbd/ringbuffer.h"
 
#include "ardour/libardour_visibility.h"
#include "ardour/types.h"
#include "ardour/chan_count.h"
#include "ardour/io_processor.h"
#include "ardour/midi_buffer.h"
#include "ardour/gain_control.h"
 
namespace ARDOUR {
 
class Amp;
class BufferSet;
class IO;
class MuteMaster;
class PannerShell;
class Panner;
class Pannable;
 
class LIBARDOUR_API Delivery : public IOProcessor
{
public:
        enum Role {
                /* main outputs - delivers out-of-place to port buffers, and cannot be removed */
                Main   = 0x1,
                /* send - delivers to port buffers, leaves input buffers untouched */
                Send   = 0x2,
                /* insert - delivers to port buffers and receives in-place from port buffers */
                Insert = 0x4,
                /* listen - internal send used only to deliver to control/monitor bus */
                Listen = 0x8,
                /* aux - internal send used to deliver to any bus, by user request */
                Aux    = 0x10,
                /* foldback - internal send used only to deliver to a personal monitor bus */
                Foldback = 0x20,
                /* direct outs - used only with LiveTrax, delivers to master bus */
                DirectOuts = 0x40
        };
 
        static bool role_from_xml (const XMLNode&, Role&);
 
        static bool role_requires_output_ports (Role r) { return r == Main || r == Send || r == Insert || r == DirectOuts; }
 
        bool does_routing() const { return true; }
 
        /* Delivery to an existing output */
 
        Delivery (Session& s, std::shared_ptr<IO> io, std::shared_ptr<Pannable>, std::shared_ptr<MuteMaster> mm, const std::string& name, Role);
 
        /* Delivery to a new output owned by this object */
 
        Delivery (Session& s, std::shared_ptr<Pannable>, std::shared_ptr<MuteMaster> mm, const std::string& name, Role);
        ~Delivery ();
 
        bool set_name (const std::string& name);
        std::string display_name() const;
 
        Role role() const { return _role; }
        bool can_support_io_configuration (const ChanCount& in, ChanCount& out);
        bool configure_io (ChanCount in, ChanCount out);
 
        void activate ();
        void deactivate ();
 
        void run (BufferSet& bufs, samplepos_t start_sample, samplepos_t end_sample, double speed, pframes_t nframes, bool);
 
        void set_midi_mute_mask (int);
 
        /* supplemental method used with MIDI */
 
        void flush_buffers (samplecnt_t nframes);
        void no_outs_cuz_we_no_monitor(bool);
        void non_realtime_transport_stop (samplepos_t now, bool flush);
        void realtime_locate (bool);
 
        BufferSet& output_buffers() { return *_output_buffers; }
 
        PBD::Signal<void()> MuteChange;
 
        int set_state (const XMLNode&, int version);
 
        /* Panning */
 
        static int  disable_panners (void);
        static void reset_panners ();
 
        std::shared_ptr<PannerShell> panner_shell() const { return _panshell; }
        std::shared_ptr<Panner> panner() const;
 
        void set_gain_control (std::shared_ptr<GainControl> gc);
 
        using RTARingBuffer    = PBD::RingBuffer<ARDOUR::Sample>;
        using RTARingBufferPtr = std::shared_ptr<RTARingBuffer>;
        using RTABufferList    = std::vector<RTARingBufferPtr>;
#if __cplusplus >= 202002L
        using RTABufferListPtr = std::shared_ptr<RTABufferList>;
#else
        using RTABufferListPtr = boost::shared_ptr<RTABufferList>;
#endif
 
        void set_analysis_buffers (RTABufferListPtr rb) {
                _rtabuffers.store (rb);
        }
        bool analysis_active () const;
        void set_analysis_active (bool);
 
        void set_polarity_control (std::shared_ptr<AutomationControl> ac) {
                _polarity_control = ac;
        }
 
        void unpan ();
        void reset_panner ();
        void defer_pan_reset ();
        void allow_pan_reset ();
 
        uint32_t pans_required() const { return _configured_input.n_audio(); }
        virtual uint32_t pan_outs() const;
 
        std::shared_ptr<GainControl> gain_control () const {
                return _gain_control;
        }
 
        std::shared_ptr<AutomationControl> polarity_control () const {
                return _polarity_control;
        }
 
        std::shared_ptr<Amp> amp() const {
                return _amp;
        }
 
protected:
        XMLNode& state () const;
 
        Role        _role;
        BufferSet*  _output_buffers;
        gain_t      _current_gain;
        std::shared_ptr<PannerShell> _panshell;
        std::shared_ptr<Amp>         _amp;
 
        gain_t target_gain ();
        void maybe_merge_midi_mute (BufferSet&, bool always);
 
private:
        bool _no_outs_cuz_we_no_monitor;
 
        std::shared_ptr<MuteMaster>        _mute_master;
        std::shared_ptr<GainControl>       _gain_control;
        std::shared_ptr<AutomationControl> _polarity_control;
 
#if __cplusplus >= 202002L
        std::atomic<std::shared_ptr<RTABufferList>> _rtabuffers;
#else
        boost::atomic_shared_ptr<RTABufferList> _rtabuffers;
#endif
        std::atomic<bool> _rta_active;
 
        static bool panners_legal;
        static PBD::Signal<void()> PannersLegal;
 
        void panners_became_legal ();
        PBD::ScopedConnection panner_legal_c;
        void output_changed (IOChange);
 
        bool _no_panner_reset;
        std::atomic<int> _midi_mute_mask;
        MidiBuffer _midi_mute_buffer;
 
        void resize_midi_mute_buffer ();
};
 
 
} // namespace ARDOUR