export_channel.cc

Go to the documentation of this file.

/*
    Copyright (C) 2008 Paul Davis
    Author: Sakari Bergen

    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.

*/

#include "ardour/audio_buffer.h"
#include "ardour/audio_port.h"
#include "ardour/audio_track.h"
#include "ardour/audioengine.h"
#include "ardour/audioregion.h"
#include "ardour/capturing_processor.h"
#include "ardour/export_channel.h"
#include "ardour/export_failed.h"
#include "ardour/session.h"

#include "pbd/error.h"

#include "i18n.h"

using namespace ARDOUR;

PortExportChannel::PortExportChannel ()
        : buffer_size(0)
{
}

void PortExportChannel::set_max_buffer_size(framecnt_t frames)
{
        buffer_size = frames;
        buffer.reset (new Sample[frames]);
}

bool
PortExportChannel::operator< (ExportChannel const & other) const
{
        PortExportChannel const * pec;
        if (!(pec = dynamic_cast<PortExportChannel const *> (&other))) {
                return this < &other;
        }
        return ports < pec->ports;
}

void
PortExportChannel::read (Sample const *& data, framecnt_t frames) const
{
        assert(buffer);
        assert(frames <= buffer_size);

        if (ports.size() == 1) {
                boost::shared_ptr<AudioPort> p = ports.begin()->lock ();
                data = p->get_audio_buffer(frames).data();
                return;
        }

        memset (buffer.get(), 0, frames * sizeof (Sample));

        for (PortSet::const_iterator it = ports.begin(); it != ports.end(); ++it) {
                boost::shared_ptr<AudioPort> p = it->lock ();
                if (p) {
                        Sample* port_buffer = p->get_audio_buffer(frames).data();

                        for (uint32_t i = 0; i < frames; ++i) {
                                buffer[i] += (float) port_buffer[i];
                        }
                }
        }

        data = buffer.get();
}

void
PortExportChannel::get_state (XMLNode * node) const
{
        XMLNode * port_node;
        for (PortSet::const_iterator it = ports.begin(); it != ports.end(); ++it) {
                boost::shared_ptr<Port> p = it->lock ();
                if (p && (port_node = node->add_child ("Port"))) {
                        port_node->add_property ("name", p->name());
                }
        }
}

void
PortExportChannel::set_state (XMLNode * node, Session & session)
{
        XMLProperty * prop;
        XMLNodeList xml_ports = node->children ("Port");
        for (XMLNodeList::iterator it = xml_ports.begin(); it != xml_ports.end(); ++it) {
                if ((prop = (*it)->property ("name"))) {
                        std::string const & name = prop->value();
                        boost::shared_ptr<AudioPort> port = boost::dynamic_pointer_cast<AudioPort> (session.engine().get_port_by_name (name));
                        if (port) {
                                ports.insert (port);
                        } else {
                                PBD::warning << string_compose (_("Could not get port for export channel \"%1\", dropping the channel"), name) << endmsg;
                        }
                }
        }
}

RegionExportChannelFactory::RegionExportChannelFactory (Session * session, AudioRegion const & region, AudioTrack & track, Type type) 
        : region (region)
        , track (track)
        , type (type)
        , frames_per_cycle (session->engine().samples_per_cycle ())
        , buffers_up_to_date (false)
        , region_start (region.position())
        , position (region_start)
{
        switch (type) {
          case Raw:
                n_channels = region.n_channels();
                break;
          case Fades:
                n_channels = region.n_channels();

                mixdown_buffer.reset (new Sample [frames_per_cycle]);
                gain_buffer.reset (new Sample [frames_per_cycle]);
                std::fill_n (gain_buffer.get(), frames_per_cycle, Sample (1.0));

                break;
          case Processed:
                n_channels = track.n_outputs().n_audio();
                break;
          default:
                throw ExportFailed ("Unhandled type in ExportChannelFactory constructor");
        }

        session->ProcessExport.connect_same_thread (export_connection, boost::bind (&RegionExportChannelFactory::new_cycle_started, this, _1));

        buffers.ensure_buffers (DataType::AUDIO, n_channels, frames_per_cycle);
        buffers.set_count (ChanCount (DataType::AUDIO, n_channels));
}

RegionExportChannelFactory::~RegionExportChannelFactory ()
{
}

ExportChannelPtr
RegionExportChannelFactory::create (uint32_t channel)
{
        assert (channel < n_channels);
        return ExportChannelPtr (new RegionExportChannel (*this, channel));
}

void
RegionExportChannelFactory::read (uint32_t channel, Sample const *& data, framecnt_t frames_to_read)
{
        assert (channel < n_channels);
        assert (frames_to_read <= frames_per_cycle);

        if (!buffers_up_to_date) {
                update_buffers(frames_to_read);
                buffers_up_to_date = true;
        }

        data = buffers.get_audio (channel).data();
}

void
RegionExportChannelFactory::update_buffers (framecnt_t frames)
{
        assert (frames <= frames_per_cycle);

        switch (type) {
          case Raw:
                for (size_t channel = 0; channel < n_channels; ++channel) {
                        region.read (buffers.get_audio (channel).data(), position - region_start, frames, channel);
                }
                break;
          case Fades:
                assert (mixdown_buffer && gain_buffer);
                for (size_t channel = 0; channel < n_channels; ++channel) {
                        memset (mixdown_buffer.get(), 0, sizeof (Sample) * frames);
                        buffers.get_audio (channel).silence(frames);
                        region.read_at (buffers.get_audio (channel).data(), mixdown_buffer.get(), gain_buffer.get(), position, frames, channel);
                }
                break;
        case Processed:
                track.export_stuff (buffers, position, frames, track.main_outs(), true, true, false);
                break;
        default:
                throw ExportFailed ("Unhandled type in ExportChannelFactory::update_buffers");
        }

        position += frames;
}


RouteExportChannel::RouteExportChannel(boost::shared_ptr<CapturingProcessor> processor, size_t channel,
                                       boost::shared_ptr<ProcessorRemover> remover)
  : processor (processor)
  , channel (channel)
  , remover (remover)
{
}

RouteExportChannel::~RouteExportChannel()
{
}

void
RouteExportChannel::create_from_route(std::list<ExportChannelPtr> & result, boost::shared_ptr<Route> route)
{
        boost::shared_ptr<CapturingProcessor> processor = route->add_export_point();
        uint32_t channels = processor->input_streams().n_audio();

        boost::shared_ptr<ProcessorRemover> remover (new ProcessorRemover (route, processor));
        result.clear();
        for (uint32_t i = 0; i < channels; ++i) {
                result.push_back (ExportChannelPtr (new RouteExportChannel (processor, i, remover)));
        }
}

void
RouteExportChannel::set_max_buffer_size(framecnt_t frames)
{
        if (processor) {
                processor->set_block_size (frames);
        }
}

void
RouteExportChannel::read (Sample const *& data, framecnt_t frames) const
{
        assert(processor);
        AudioBuffer const & buffer = processor->get_capture_buffers().get_audio (channel);
#ifndef NDEBUG
        (void) frames;
#else
        assert (frames <= (framecnt_t) buffer.capacity());
#endif
        data = buffer.data();
}

void
RouteExportChannel::get_state (XMLNode *) const
{
        // TODO
}

void
RouteExportChannel::set_state (XMLNode *, Session &)
{
        // TODO
}

bool
RouteExportChannel::operator< (ExportChannel const & other) const
{
        RouteExportChannel const * rec;
        if ((rec = dynamic_cast<RouteExportChannel const *>(&other)) == 0) {
                return this < &other;
        }

        if (processor.get() == rec->processor.get()) {
                return channel < rec->channel;
        }
        return processor.get() < rec->processor.get();
}

RouteExportChannel::ProcessorRemover::~ProcessorRemover()
{
        route->remove_processor (processor);
}