SequenceWorkflow.cpp

/*****************************************************************************
 * SequenceWorkflow.cpp : Manages tracks in a single sequence
 *****************************************************************************
 * Copyright (C) 2008-2016 VideoLAN
 *
 * Authors: Yikei Lu    <luyikei.qmltu@gmail.com>
 *
 * 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.
 *****************************************************************************/

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include "SequenceWorkflow.h"

#include "Backend/MLT/MLTTrack.h"
#include "Backend/MLT/MLTMultiTrack.h"
#include "EffectsEngine/EffectHelper.h"
#include "Workflow/MainWorkflow.h"
#include "Main/Core.h"
#include "Library/Library.h"
#include "Tools/VlmcDebug.h"
#include "Media/Media.h"

SequenceWorkflow::SequenceWorkflow( size_t trackCount )
    : m_multitrack( new Backend::MLT::MLTMultiTrack )
    , m_trackCount( trackCount )
{
    for ( int i = 0; i < trackCount; ++i )
    {
        auto audioTrack = std::shared_ptr<Backend::ITrack>( new Backend::MLT::MLTTrack );
        audioTrack->setVideoEnabled( false );
        m_tracks[Workflow::AudioTrack] << audioTrack;

        auto videoTrack = std::shared_ptr<Backend::ITrack>( new Backend::MLT::MLTTrack );
        videoTrack->setMute( true );
        m_tracks[Workflow::VideoTrack] << videoTrack;

        auto multitrack = std::shared_ptr<Backend::IMultiTrack>( new Backend::MLT::MLTMultiTrack );
        multitrack->setTrack( *videoTrack, 0 );
        multitrack->setTrack( *audioTrack, 1 );
        m_multiTracks << multitrack;

        m_multitrack->setTrack( *multitrack, i );
    }
}

SequenceWorkflow::~SequenceWorkflow()
{
    delete m_multitrack;
    clear();
}

QUuid
SequenceWorkflow::addClip( QSharedPointer<::Clip> clip, quint32 trackId, qint32 pos, const QUuid& uuid, bool isAudioClip )
{
    auto t = track( trackId, isAudioClip );
    auto ret = t->insertAt( *clip->input(), pos );
    if ( ret == false )
        return {};
    auto c = QSharedPointer<ClipInstance>::create( clip,
                                           uuid.isNull() == true ? QUuid::createUuid() : uuid,
                                           trackId, pos, isAudioClip );
    vlmcDebug() << "adding" << (isAudioClip ? "audio" : "video") <<  "clip instance:" << c->uuid;
    m_clips.insert( c->uuid, c ) ;
    clip->setOnTimeline( true );
    emit clipAdded( c->uuid.toString() );
    return c->uuid;
}

bool
SequenceWorkflow::moveClip( const QUuid& uuid, quint32 trackId, qint64 pos )
{
    auto it = m_clips.find( uuid );
    if ( it == m_clips.end() )
    {
        vlmcCritical() << "Couldn't find a clip " << uuid;
        return false;
    }
    auto& c = it.value();
    auto clip = c->clip;
    auto oldTrackId = c->trackId;
    auto oldPosition = c->pos;
    if ( oldPosition == pos && oldTrackId == trackId )
        return true;
    auto t = track( oldTrackId, c->isAudio );
    if ( trackId != oldTrackId )
    {
        // Don't call removeClip/addClip as they would destroy & recreate clip instances for nothing.
        // Simply fiddle with the track to move the clip around
        t->remove( t->clipIndexAt( oldPosition ) );
        auto newTrack = track( trackId, c->isAudio );
        if ( newTrack->insertAt( *clip->input(), pos ) == false )
            return false;
        c->pos = pos;
        c->trackId = trackId;
    }
    else
    {
        if ( t->move( oldPosition, pos ) == false )
            return false;
        c->pos = pos;
    }
    emit clipMoved( uuid.toString() );
    // TODO: If we detect collision too strictly, there will be a problem if we want to move multiple
    //       clips at the same time.
    return true;
}

bool
SequenceWorkflow::resizeClip( const QUuid& uuid, qint64 newBegin, qint64 newEnd, qint64 newPos )
{
    auto it = m_clips.find( uuid );
    if ( it == m_clips.end() )
    {
        vlmcCritical() << "Couldn't find a clip " << uuid;
        return false;
    }
    auto& c = it.value();
    auto trackId = c->trackId;
    auto position = c->pos;
    auto t = track( trackId, c->isAudio );
    auto clipIndex = t->clipIndexAt( position );
    // This will only duplicate the clip once; no need to panic about endless duplications
    if ( c->duplicateClipForResize( newBegin, newEnd ) == true )
    {
        vlmcDebug() << "Duplicating clip for resize" << c->uuid << "is now using" << c->clip->uuid();
        t->remove( clipIndex );
        t->insertAt( *c->clip->input(), position );
    }
    auto ret = t->resizeClip( clipIndex, newBegin, newEnd );
    if ( ret == false )
        return false;
    ret = moveClip( uuid, trackId, newPos );
    emit clipResized( uuid.toString() );
    return ret;
}

QSharedPointer<SequenceWorkflow::ClipInstance>
SequenceWorkflow::removeClip( const QUuid& uuid )
{
    vlmcDebug() << "Removing clip instance" << uuid;
    auto it = m_clips.find( uuid );
    if ( it == m_clips.end() )
    {
        vlmcCritical() << "Couldn't find a sequence workflow clip " << uuid;
        return {};
    }
    auto c = it.value();
    auto clip = c->clip;
    auto trackId = c->trackId;
    auto position = c->pos;
    auto t = track( trackId, c->isAudio );
    t->remove( t->clipIndexAt( position ) );
    m_clips.erase( it );
    clip->disconnect( this );
    bool onTimeline = false;
    for ( const auto& clipInstance : m_clips )
        if ( clipInstance->clip->uuid() == clip->uuid() )
            onTimeline = true;
    clip->setOnTimeline( onTimeline );
    emit clipRemoved( uuid.toString() );
    return c;

}

bool
SequenceWorkflow::linkClips( const QUuid& uuidA, const QUuid& uuidB )
{
    auto clipA = clip( uuidA );
    auto clipB = clip( uuidB );
    if ( !clipA || !clipB )
    {
        vlmcCritical() << "Couldn't find clips: " << uuidA << " and " << uuidB;
        return false;
    }
    clipA->linkedClips.append( clipB->uuid );
    clipB->linkedClips.append( clipA->uuid );
    emit clipLinked( clipA->uuid.toString(), clipB->uuid.toString() );
    return true;
}

bool
SequenceWorkflow::unlinkClips( const QUuid& uuidA, const QUuid& uuidB )
{
    vlmcDebug() << "Unlinking clips" << uuidA.toString() << "and" << uuidB.toString();
    auto clipA = clip( uuidA );
    auto clipB = clip( uuidB );
    if ( !clipA || !clipB )
    {
        vlmcCritical() << "Couldn't find clips: " << uuidA << " and " << uuidB;
        return false;
    }
    bool ret = true;
    if ( clipA->linkedClips.removeOne( uuidB ) == false )
    {
        ret = false;
        vlmcWarning() << "Failed to unlink" << uuidB << "from Clip instance" << uuidA;
    }
    if ( clipB->linkedClips.removeOne( uuidA ) == false )
    {
        ret = false;
        vlmcWarning() << "Failed to unlink" << uuidA << "from Clip instance" << uuidB;
    }
    if ( ret == true )
        emit clipUnlinked( uuidA.toString(), uuidB.toString() );
    return ret;
}

QVariant
SequenceWorkflow::toVariant() const
{
    QVariantList l;
    for ( auto it = m_clips.begin(); it != m_clips.end(); ++it )
    {
        auto c = it.value();
        QVariantHash h = {
            { "uuid", c->uuid.toString() },
            { "clipUuid", c->clip->uuid().toString() },
            { "position", c->pos },
            { "trackId", c->trackId },
            { "filters", EffectHelper::toVariant( c->clip->input() ) },
            { "isAudio",c->isAudio }
        };
        QList<QVariant> linkedClipList;
        for ( const auto& uuid : c->linkedClips )
            linkedClipList.append( uuid.toString() );
        h["linkedClips"] = linkedClipList;
        l << h;
    }
    QVariantHash h{ { "clips", l }, { "filters", EffectHelper::toVariant( m_multitrack ) } };
    return h;
}

void
SequenceWorkflow::loadFromVariant( const QVariant& variant )
{
    for ( auto& var : variant.toMap()["clips"].toList() )
    {
        auto m = var.toMap();
        auto clip = Core::instance()->library()->clip( m["clipUuid"].toUuid() );

        if ( clip == nullptr )
        {
            vlmcCritical() << "Couldn't find an acceptable library clip to be added.";
            continue;
        }

        Q_ASSERT( m.contains( "uuid" ) && m.contains( "isAudio" ) );

        auto uuid = m["uuid"].toUuid();
        auto isAudio = m["isAudio"].toBool();
        //FIXME: Add missing clip type handling. We don't know if we're adding an audio clip or not
        addClip( clip, m["trackId"].toUInt(), m["position"].toLongLong(), uuid, isAudio );
        auto c = m_clips[uuid];

        auto linkedClipsList = m["linkedClip"].toList();
        for ( const auto& uuid : linkedClipsList )
        {
            c->linkedClips.append( uuid.toUuid() );
        }

        EffectHelper::loadFromVariant( m["filters"], clip->input() );

        emit Core::instance()->workflow()->clipAdded( clip->uuid().toString() );
    }
    EffectHelper::loadFromVariant( variant.toMap()["filters"], m_multitrack );
}

void
SequenceWorkflow::clear()
{
    auto it = m_clips.begin();
    while ( it != m_clips.end() )
    {
        removeClip( it.key() );
        // m_clips.begin() can be changed
        it = m_clips.begin();
    }
}

QSharedPointer<SequenceWorkflow::ClipInstance>
SequenceWorkflow::clip( const QUuid& uuid )
{
    auto it = m_clips.find( uuid );
    if ( it == m_clips.end() )
        return {};
    return it.value();
}

quint32
SequenceWorkflow::trackId( const QUuid& uuid )
{
    auto it = m_clips.find( uuid );
    if ( it == m_clips.end() )
        return 0;
    return it.value()->trackId;
}

qint32
SequenceWorkflow::position( const QUuid& uuid )
{
    auto it = m_clips.find( uuid );
    if ( it == m_clips.end() )
        return 0;
    return it.value()->pos;
}

Backend::IInput*
SequenceWorkflow::input()
{
    return m_multitrack;
}

Backend::IInput*
SequenceWorkflow::trackInput( quint32 trackId )
{
    Q_ASSERT( trackId < m_multiTracks.size() );
    return m_multiTracks[trackId].get();
}

std::shared_ptr<Backend::ITrack>
SequenceWorkflow::track( quint32 trackId, bool isAudio )
{
    if ( trackId >= (quint32)m_trackCount )
        return nullptr;
    if ( isAudio == true )
        return m_tracks[Workflow::AudioTrack][trackId];
    return m_tracks[Workflow::VideoTrack][trackId];
}

SequenceWorkflow::ClipInstance::ClipInstance(QSharedPointer<::Clip> c, const QUuid& uuid, quint32 tId, qint64 p, bool isAudio )
    : clip( c )
    , uuid( uuid )
    , trackId( tId )
    , pos( p )
    , isAudio( isAudio )
    , m_hasClonedClip( false )
{
}

bool
SequenceWorkflow::ClipInstance::duplicateClipForResize( qint64 begin, qint64 end )
{
    if ( m_hasClonedClip == true )
        return false;
    clip = clip->media()->cut( begin, end );
    m_hasClonedClip = true;
    return true;
}