projectclip.cpp 16.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*
Copyright (C) 2012  Till Theato <root@ttill.de>
Copyright (C) 2014  Jean-Baptiste Mardelle <jb@kdenlive.org>
This file is part of Kdenlive. See www.kdenlive.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) version 3 or any later version
accepted by the membership of KDE e.V. (or its successor approved
by the membership of KDE e.V.), which shall act as a proxy 
defined in Section 14 of version 3 of the license.

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, see <http://www.gnu.org/licenses/>.
*/

#include "projectclip.h"
#include "projectfolder.h"
25
#include "projectsubclip.h"
26
#include "bin.h"
27
#include "timecode.h"
28
#include "project/projectcommands.h"
29
#include "mltcontroller/clipcontroller.h"
30
#include "mltcontroller/clippropertiescontroller.h"
31 32 33 34 35 36 37 38 39 40

#include <QDomElement>
#include <QFile>
#include <QDebug>
#include <QCryptographicHash>

#include <KLocalizedString>



Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
41
ProjectClip::ProjectClip(const QString &id, QIcon thumb, ClipController *controller, ProjectFolder* parent) :
42 43 44 45
    AbstractProjectItem(AbstractProjectItem::ClipItem, id, parent)
    , m_controller(controller)
    , audioFrameCache()
    , m_audioThumbCreated(false)
46
{
47
    m_clipStatus = StatusReady;
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
48
    m_thumbnail = thumb;
49 50
    m_name = m_controller->clipName();
    m_duration = m_controller->getStringDuration();
51
    getFileHash();
52
    setParent(parent);
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
53
    bin()->loadSubClips(id, m_controller->getSubClips());
54 55
}

56
ProjectClip::ProjectClip(const QDomElement& description, QIcon thumb, ProjectFolder* parent) :
57
    AbstractProjectItem(AbstractProjectItem::ClipItem, description, parent)
58
    , m_controller(NULL)
59 60
    , audioFrameCache()
    , m_audioThumbCreated(false)
61 62
{
    Q_ASSERT(description.hasAttribute("id"));
63
    m_clipStatus = StatusWaiting;
64
    m_thumbnail = thumb;
65
    m_temporaryUrl = QUrl::fromLocalFile(getXmlProperty(description, "resource"));
66
    QString clipName = getXmlProperty(description, "kdenlive:clipname");
67 68 69
    if (!clipName.isEmpty()) {
        m_name = clipName;
    }
70 71
    else if (m_temporaryUrl.isValid()) {
        m_name = m_temporaryUrl.fileName();
72
    }
73
    else m_name = i18n("Untitled");
74
    setParent(parent);
75 76 77 78 79
}


ProjectClip::~ProjectClip()
{
80
    // controller is deleted in bincontroller
81 82
}

83 84 85 86 87
QString ProjectClip::getToolTip() const
{
    return url().toLocalFile();
}

88 89 90 91 92 93 94 95 96 97 98 99 100
QString ProjectClip::getXmlProperty(const QDomElement &producer, const QString &propertyName)
{
    QString value;
    QDomNodeList props = producer.elementsByTagName("property");
    for (int i = 0; i < props.count(); ++i) {
        if (props.at(i).toElement().attribute("name") == propertyName) {
            value = props.at(i).firstChild().nodeValue();
            break;
        }
    }
    return value;
}

101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
void ProjectClip::updateAudioThumbnail(const audioByteArray& data)
{
    ////qDebug() << "CLIPBASE RECIEDVED AUDIO DATA*********************************************";
    audioFrameCache = data;
    m_audioThumbCreated = true;
    emit gotAudioData();
}

QList < CommentedTime > ProjectClip::commentedSnapMarkers() const
{
    if (m_controller) return m_controller->commentedSnapMarkers();
    return QList < CommentedTime > ();
}

bool ProjectClip::audioThumbCreated() const
{
    return m_audioThumbCreated;
}

120 121
ClipType ProjectClip::clipType() const
{
122 123
    if (m_controller == NULL) return Unknown;
    return m_controller->clipType();
124 125 126 127 128 129 130 131 132 133
}

ProjectClip* ProjectClip::clip(const QString &id)
{
    if (id == m_id) {
        return this;
    }
    return NULL;
}

134 135 136 137 138
ProjectFolder* ProjectClip::folder(const QString &id)
{
    return NULL;
}

139 140 141 142 143 144 145 146 147 148 149 150
ProjectSubClip* ProjectClip::getSubClip(int in, int out)
{
    ProjectSubClip *clip;
    for (int i = 0; i < count(); ++i) {
        clip = static_cast<ProjectSubClip *>(at(i))->subClip(in, out);
        if (clip) {
            return clip;
        }
    }
    return NULL;
}

151 152 153 154 155 156 157 158
ProjectClip* ProjectClip::clipAt(int ix)
{
    if (ix == index()) {
        return this;
    }
    return NULL;
}

159
/*bool ProjectClip::isValid() const
160
{
161 162
    return m_controller->isValid();
}*/
163 164 165

QUrl ProjectClip::url() const
{
166
    if (m_controller) return m_controller->clipUrl();
167
    return m_temporaryUrl;
168 169 170 171
}

bool ProjectClip::hasLimitedDuration() const
{
172 173 174 175
    if (m_controller) {
        return m_controller->hasLimitedDuration();
    }
    return true;
176 177
}

178
GenTime ProjectClip::duration() const
179
{
180 181
    if (m_controller) {
	return m_controller->getPlaytime();
182
    }
183
    return GenTime();
184 185 186 187 188 189 190 191 192 193 194
}

QString ProjectClip::serializeClip()
{
    /*Mlt::Consumer *consumer = bin()->project()->xmlConsumer();
    consumer->connect(*m_baseProducer);
    consumer->run();
    return QString::fromUtf8(consumer->get("kdenlive_clip"));*/
    return QString();
}

195
void ProjectClip::reloadProducer(bool thumbnailOnly)
196 197 198
{
    QDomDocument doc;
    QDomElement xml = toXml(doc);
199 200 201 202
    if (thumbnailOnly) {
        // set a special flag to request thumbnail only
        xml.setAttribute("thumbnailOnly", "1");
    }
203
    bin()->reloadProducer(m_id, xml);
204 205 206 207 208
}

void ProjectClip::setCurrent(bool current, bool notify)
{
    AbstractProjectItem::setCurrent(current, notify);
209
    if (current && m_controller) {
Jean-Baptiste Mardelle's avatar
cleanup  
Jean-Baptiste Mardelle committed
210
        bin()->openProducer(m_controller);
211
        bin()->editMasterEffect(m_controller);
212 213 214 215 216
    }
}

QDomElement ProjectClip::toXml(QDomDocument& document)
{
217 218 219
    if (m_controller) {
        m_controller->getProducerXML(document);
        return document.documentElement().firstChildElement("producer");
220
    }
221
    return QDomElement();
222 223 224 225
}

void ProjectClip::setThumbnail(QImage img)
{
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
226 227
    QPixmap thumb = roundedPixmap(QPixmap::fromImage(img));
    if (hasProxy() && !thumb.isNull()) {
228
        // Overlay proxy icon
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
229
        QPainter p(&thumb);
230
        QColor c(220, 220, 10, 200);
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
231
        QRect r(0, 0, thumb.height() / 2.5, thumb.height() / 2.5);
232 233 234 235 236 237 238 239
        p.fillRect(r, c);
        QFont font = p.font();
        font.setPixelSize(r.height());
        font.setBold(true);
        p.setFont(font);
        p.setPen(Qt::black);
        p.drawText(r, Qt::AlignCenter, i18nc("The first letter of Proxy, used as abbreviation", "P"));
    }
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
240
    m_thumbnail = QIcon(thumb);
241 242 243
    bin()->emitItemUpdated(this);
}

244
void ProjectClip::setProducer(ClipController *controller, bool replaceProducer)
245
{
246
    if (!replaceProducer && m_controller) {
247 248 249
        qDebug()<<"// RECIEVED PRODUCER BUT WE ALREADY HAVE ONE\n----------";
        return;
    }
250 251
    if (m_controller) {
        // Replace clip for this controller
252
        //m_controller->updateProducer(m_id, &(controller->originalProducer()));
253
        delete controller;
254
    }
255 256 257 258 259
    else {
        // We did not yet have the controller, update info
        m_controller = controller;
        if (m_name.isEmpty()) m_name = m_controller->clipName();
        m_duration = m_controller->getStringDuration();
260
        m_temporaryUrl.clear();
261
    }
262
    m_clipStatus = StatusReady;
263 264 265 266 267 268
    bin()->emitItemUpdated(this);
    getFileHash();
}

Mlt::Producer *ProjectClip::producer()
{
269 270
    if (!m_controller) return NULL;
    return m_controller->masterProducer();
271 272
}

273 274 275 276 277
ClipController *ProjectClip::controller()
{
    return m_controller;
}

278
bool ProjectClip::isReady() const
279
{
280
    return m_controller!= NULL;
281 282
}

283
/*void ProjectClip::setZone(const QPoint &zone)
284 285
{
    m_zone = zone;
286
}*/
287 288 289

QPoint ProjectClip::zone() const
{
290 291 292
    int x = getProducerIntProperty("kdenlive:zone_in");
    int y = getProducerIntProperty("kdenlive:zone_out");
    return QPoint(x, y);
293 294 295 296 297 298 299 300 301 302 303 304 305 306
}

void ProjectClip::addMarker(int position)
{
    m_markers << position;
    //bin()->markersUpdated(m_id, m_markers);
}

void ProjectClip::removeMarker(int position)
{
    m_markers.removeAll(position);
    //bin()->markersUpdated(m_id, m_markers);
}

Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
307 308 309 310 311 312 313 314
void ProjectClip::resetProducerProperty(const QString &name)
{
    if (m_controller) {
        m_controller->resetProperty(name);
    }
}

void ProjectClip::setProducerProperty(const QString &name, int data)
315
{
316 317
    if (m_controller) {
	m_controller->setProperty(name, data);
318 319 320
    }
}

Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
321
void ProjectClip::setProducerProperty(const QString &name, double data)
322
{
323 324
    if (m_controller) {
        m_controller->setProperty(name, data);
325 326 327
    }
}

Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
328
void ProjectClip::setProducerProperty(const QString &name, const QString &data)
329
{
330 331
    if (m_controller) {
        m_controller->setProperty(name, data);
332 333 334
    }
}

335 336 337 338 339 340 341 342 343 344 345 346 347 348
QMap <QString, QString> ProjectClip::currentProperties(const QMap <QString, QString> &props)
{
    QMap <QString, QString> currentProps;
    if (!m_controller) {
        return currentProps;
    }
    QMap<QString, QString>::const_iterator i = props.constBegin();
    while (i != props.constEnd()) {
        currentProps.insert(i.key(), m_controller->property(i.key()));
        ++i;
    }
    return currentProps;
}

349 350 351 352 353 354 355 356
QColor ProjectClip::getProducerColorProperty(const QString &key) const
{
    if (m_controller) {
        return m_controller->color_property(key);
    }
    return QColor();
}

357 358 359 360 361 362 363 364
int ProjectClip::getProducerIntProperty(const QString &key) const
{
    int value = 0;
    if (m_controller) {
        value = m_controller->int_property(key);
    }
    return value;
}
365

366
QString ProjectClip::getProducerProperty(const QString &key) const
367 368
{
    QString value;
369 370
    if (m_controller) {
	value = m_controller->property(key);
371 372 373 374 375 376
    }
    return value;
}

const QString ProjectClip::hash()
{
377 378 379 380 381 382
    if (m_controller) {
        QString clipHash = m_controller->property("kdenlive:file_hash");
        if (clipHash.isEmpty()) {
            return getFileHash();
        }
        return clipHash;
383
    }
384
    return getFileHash();
385 386
}

387
const QString ProjectClip::getFileHash() const
388
{
389
    if (clipType() == SlideShow) return QString();
390
    QFile file(m_controller ? m_controller->clipUrl().toLocalFile() : m_temporaryUrl.toLocalFile());
391 392 393 394
    if (file.open(QIODevice::ReadOnly)) { // write size and hash only if resource points to a file
        QByteArray fileData;
        QByteArray fileHash;
        ////qDebug() << "SETTING HASH of" << value;
395
        //m_properties.insert("file_size", QString::number(file.size()));
396 397 398 399 400 401 402 403 404 405 406 407
        /*
               * 1 MB = 1 second per 450 files (or faster)
               * 10 MB = 9 seconds per 450 files (or faster)
               */
        if (file.size() > 2000000) {
            fileData = file.read(1000000);
            if (file.seek(file.size() - 1000000))
                fileData.append(file.readAll());
        } else
            fileData = file.readAll();
        file.close();
        fileHash = QCryptographicHash::hash(fileData, QCryptographicHash::Md5);
408
        QString result = fileHash.toHex();
409
        if (m_controller) m_controller->setProperty("kdenlive:file_hash", result);
410
        return result;
411
    }
412
    return QString();
413
}
414 415 416 417 418 419

double ProjectClip::getOriginalFps() const
{
    if (!m_controller) return 0;
    return m_controller->originalFps();
}
420 421 422

bool ProjectClip::hasProxy() const
{
423
    QString proxy = getProducerProperty("kdenlive:proxy");
424 425 426 427
    if (proxy.isEmpty() || proxy == "-") return false;
    return true;
}

428
void ProjectClip::setProperties(QMap <QString, QString> properties, bool refreshPanel)
429 430 431 432 433 434 435
{
    QMapIterator<QString, QString> i(properties);
    bool refreshProducer = false;
    QStringList keys;
    keys << "luma_duration" << "luma_file" << "fade" << "ttl" << "softness" << "crop" << "animation";
    while (i.hasNext()) {
        i.next();
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
436
        setProducerProperty(i.key(), i.value());
437 438
        if (clipType() == SlideShow && keys.contains(i.key())) refreshProducer = true;
    }
439 440
    if (properties.contains("kdenlive:proxy")) {
        QString value = properties.value("kdenlive:proxy");
441 442 443 444 445 446
        // If value is "-", that means user manually disabled proxy on this clip
        if (value.isEmpty() || value == "-") {
            // reset proxy
            if (bin()->hasPendingJob(m_id, AbstractClipJob::PROXYJOB)) {
                bin()->discardJobs(m_id, AbstractClipJob::PROXYJOB);
            }
447 448 449
            else {
                reloadProducer();
            }
450 451
        }
        else {
452
            // A proxy was requested, make sure to keep original url
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
453
            setProducerProperty("kdenlive:originalurl", url().toLocalFile());
454
            bin()->startJob(m_id, AbstractClipJob::PROXYJOB);
455 456
        }
    }
457 458
    else if (properties.contains("resource")) {
        // Clip resource changed, update thumbnail
459 460 461 462
        if (clipType() == Color) {
            //reloadProducer(true);
        }
        else {
463
            reloadProducer();
464
        }
465 466
        refreshProducer = true;
    }
467 468 469
    if (properties.contains("xmldata")) {
        refreshProducer = true;
    }
470 471 472 473 474
    if (properties.contains("length")) {
        m_duration = m_controller->getStringDuration();
        bin()->emitItemUpdated(this);
    }

475 476 477 478
    if (properties.contains("kdenlive:clipname")) {
        m_name = properties.value("kdenlive:clipname");
        bin()->emitItemUpdated(this);
    }
479 480 481 482 483 484
    if (refreshPanel) {
        // Some of the clip properties have changed through a command, update properties panel
        emit refreshPropertiesPanel();
    }
    if (refreshProducer) {
        // producer has changed, refresh monitor
485
        bin()->refreshClip(m_id);
486
    }
487 488 489 490 491 492
}

void ProjectClip::setJobStatus(AbstractClipJob::JOBTYPE jobType, ClipJobStatus status, int progress, const QString &statusMessage)
{
    m_jobType = jobType;
    if (progress > 0) {
493
        if (m_jobProgress == progress) return;
494 495 496 497 498 499 500 501 502 503
	m_jobProgress = progress;
    }
    else {
	m_jobProgress = status;
	if ((status == JobAborted || status == JobCrashed  || status == JobDone) || !statusMessage.isEmpty()) {
	    m_jobMessage = statusMessage;
	}
    }
    bin()->emitItemUpdated(this);
}
504

505 506 507

ClipPropertiesController *ProjectClip::buildProperties(QWidget *parent)
{
508
    ClipPropertiesController *panel = new ClipPropertiesController(bin()->projectTimecode(), m_controller, parent);
509 510 511 512
    connect(this, SIGNAL(refreshPropertiesPanel()), panel, SLOT(slotReloadProperties()));
    return panel;
}

513 514
void ProjectClip::updateParentInfo(const QString &folderid, const QString &foldername)
{
515
    m_controller->setProperty("kdenlive:folderid", folderid);
516 517
}

518 519 520 521 522 523
bool ProjectClip::matches(QString condition)
{
    //TODO
    return true;
}

524
const QString ProjectClip::codec(bool audioCodec) const
525
{
526 527
    if (!m_controller) return QString();
    return m_controller->codec(audioCodec);
528
}
529 530 531 532 533 534 535 536 537 538 539 540 541 542

bool ProjectClip::rename(const QString &name)
{
    if (m_name == name) return false;
    // Rename clip
    QMap <QString, QString> newProperites;
    QMap <QString, QString> oldProperites;
    oldProperites.insert("kdenlive:clipname", m_name);
    newProperites.insert("kdenlive:clipname", name);
    bin()->slotEditClipCommand(m_id, oldProperites, newProperites);
    m_name = name;
    return true;
}

543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570
void ProjectClip::addClipMarker(QList <CommentedTime> newMarkers, QUndoCommand *groupCommand)
{
    if (!m_controller) return;
    QList <CommentedTime> oldMarkers;
    for (int i = 0; i < newMarkers.count(); ++i) {
        CommentedTime oldMarker = m_controller->markerAt(newMarkers.at(i).time());
        if (oldMarker == CommentedTime()) {
            oldMarker = newMarkers.at(i);
            oldMarker.setMarkerType(-1);
        }
        oldMarkers << oldMarker;
    }
    (void) new AddMarkerCommand(this, oldMarkers, newMarkers, groupCommand);
}

bool ProjectClip::deleteClipMarkers(QUndoCommand *command)
{
    QList <CommentedTime> markers = commentedSnapMarkers();
    if (markers.isEmpty()) {
        return false;
    }
    QList <CommentedTime> newMarkers;
    for (int i = 0; i < markers.size(); ++i) {
        CommentedTime marker = markers.at(i);
        marker.setMarkerType(-1);
        newMarkers << marker;
    }
    new AddMarkerCommand(this, markers, newMarkers, command);
571
    return true;
572 573 574 575 576 577 578 579 580 581 582 583 584 585
}

void ProjectClip::addMarkers(QList <CommentedTime> &markers)
{
    if (!m_controller) return;
    for (int i = 0; i < markers.count(); ++i) {
      if (markers.at(i).markerType() < 0) m_controller->deleteSnapMarker(markers.at(i).time());
      else m_controller->addSnapMarker(markers.at(i));
    }
    // refresh markers in clip monitor
    bin()->refreshClipMarkers(m_id);
    // refresh markers in timeline clips
    emit refreshClipDisplay();
}
586

587
void ProjectClip::addEffect(const ProfileInfo pInfo, QDomElement &effect)
588
{
589
    m_controller->addEffect(pInfo, effect);
590
    bin()->editMasterEffect(m_controller);
591
    bin()->emitItemUpdated(this);
592 593
}

594 595 596 597
void ProjectClip::removeEffect(const ProfileInfo pInfo, int ix)
{
    m_controller->removeEffect(pInfo, ix);
    bin()->editMasterEffect(m_controller);
598 599 600 601 602 603 604
    bin()->emitItemUpdated(this);
}

QVariant ProjectClip::data(DataType type) const
{
    switch (type) {
      case AbstractProjectItem::IconOverlay:
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
605
            return m_controller != NULL ? (m_controller->hasEffects() ? QVariant("kdenlive-track_has_effect") : QVariant()) : QVariant();
606 607 608 609 610
            break;
        default:
	    break;
    }
    return AbstractProjectItem::data(type);
611
}