projectclip.cpp 18.5 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 29
#include "doc/kthumb.h"
#include "kdenlivesettings.h"
30
#include "project/projectcommands.h"
31
#include "mltcontroller/clipcontroller.h"
32
#include "mltcontroller/clippropertiescontroller.h"
33 34 35

#include <QDomElement>
#include <QFile>
36
#include <QDir>
37 38 39 40 41 42 43
#include <QDebug>
#include <QCryptographicHash>

#include <KLocalizedString>



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

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


ProjectClip::~ProjectClip()
{
85
    // controller is deleted in bincontroller
86 87
}

88 89 90 91 92
QString ProjectClip::getToolTip() const
{
    return url().toLocalFile();
}

93 94 95 96 97 98 99 100 101 102 103 104 105
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;
}

106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
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;
}

125 126
ClipType ProjectClip::clipType() const
{
127 128
    if (m_controller == NULL) return Unknown;
    return m_controller->clipType();
129 130 131 132 133 134 135 136 137 138
}

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

139 140 141 142 143
ProjectFolder* ProjectClip::folder(const QString &id)
{
    return NULL;
}

144 145 146 147 148 149 150 151 152 153 154 155
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;
}

156 157 158 159 160 161 162 163
ProjectClip* ProjectClip::clipAt(int ix)
{
    if (ix == index()) {
        return this;
    }
    return NULL;
}

164
/*bool ProjectClip::isValid() const
165
{
166 167
    return m_controller->isValid();
}*/
168 169 170

QUrl ProjectClip::url() const
{
171
    if (m_controller) return m_controller->clipUrl();
172
    return m_temporaryUrl;
173 174 175 176
}

bool ProjectClip::hasLimitedDuration() const
{
177 178 179 180
    if (m_controller) {
        return m_controller->hasLimitedDuration();
    }
    return true;
181 182
}

183
GenTime ProjectClip::duration() const
184
{
185 186
    if (m_controller) {
	return m_controller->getPlaytime();
187
    }
188
    return GenTime();
189 190 191 192 193 194 195 196 197 198 199
}

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

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

void ProjectClip::setCurrent(bool current, bool notify)
{
    AbstractProjectItem::setCurrent(current, notify);
214
    if (current && m_controller) {
Jean-Baptiste Mardelle's avatar
cleanup  
Jean-Baptiste Mardelle committed
215
        bin()->openProducer(m_controller);
216
        bin()->editMasterEffect(m_controller);
217 218 219 220 221
    }
}

QDomElement ProjectClip::toXml(QDomDocument& document)
{
222 223 224
    if (m_controller) {
        m_controller->getProducerXML(document);
        return document.documentElement().firstChildElement("producer");
225
    }
226
    return QDomElement();
227 228 229 230
}

void ProjectClip::setThumbnail(QImage img)
{
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
231 232
    QPixmap thumb = roundedPixmap(QPixmap::fromImage(img));
    if (hasProxy() && !thumb.isNull()) {
233
        // Overlay proxy icon
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
234
        QPainter p(&thumb);
235
        QColor c(220, 220, 10, 200);
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
236
        QRect r(0, 0, thumb.height() / 2.5, thumb.height() / 2.5);
237 238 239 240 241 242 243 244
        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
245
    m_thumbnail = QIcon(thumb);
246 247 248
    bin()->emitItemUpdated(this);
}

249
void ProjectClip::setProducer(ClipController *controller, bool replaceProducer)
250
{
251
    if (!replaceProducer && m_controller) {
252 253 254
        qDebug()<<"// RECIEVED PRODUCER BUT WE ALREADY HAVE ONE\n----------";
        return;
    }
255 256
    if (m_controller) {
        // Replace clip for this controller
257
        //m_controller->updateProducer(m_id, &(controller->originalProducer()));
258
        delete controller;
259
    }
260 261 262 263 264
    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();
265
        m_temporaryUrl.clear();
266
    }
267
    m_clipStatus = StatusReady;
268 269 270 271 272 273
    bin()->emitItemUpdated(this);
    getFileHash();
}

Mlt::Producer *ProjectClip::producer()
{
274 275
    if (!m_controller) return NULL;
    return m_controller->masterProducer();
276 277
}

278 279 280 281 282
ClipController *ProjectClip::controller()
{
    return m_controller;
}

283
bool ProjectClip::isReady() const
284
{
285
    return m_controller!= NULL;
286 287
}

288
/*void ProjectClip::setZone(const QPoint &zone)
289 290
{
    m_zone = zone;
291
}*/
292 293 294

QPoint ProjectClip::zone() const
{
295 296 297
    int x = getProducerIntProperty("kdenlive:zone_in");
    int y = getProducerIntProperty("kdenlive:zone_out");
    return QPoint(x, y);
298 299 300 301 302 303 304 305 306 307 308 309 310 311
}

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
312 313 314 315 316 317 318 319
void ProjectClip::resetProducerProperty(const QString &name)
{
    if (m_controller) {
        m_controller->resetProperty(name);
    }
}

void ProjectClip::setProducerProperty(const QString &name, int data)
320
{
321 322
    if (m_controller) {
	m_controller->setProperty(name, data);
323 324 325
    }
}

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

Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
333
void ProjectClip::setProducerProperty(const QString &name, const QString &data)
334
{
335 336
    if (m_controller) {
        m_controller->setProperty(name, data);
337 338 339
    }
}

340 341 342 343 344 345 346 347 348 349 350 351 352 353
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;
}

354 355 356 357 358 359 360 361
QColor ProjectClip::getProducerColorProperty(const QString &key) const
{
    if (m_controller) {
        return m_controller->color_property(key);
    }
    return QColor();
}

362 363 364 365 366 367 368 369
int ProjectClip::getProducerIntProperty(const QString &key) const
{
    int value = 0;
    if (m_controller) {
        value = m_controller->int_property(key);
    }
    return value;
}
370

371
QString ProjectClip::getProducerProperty(const QString &key) const
372 373
{
    QString value;
374 375
    if (m_controller) {
	value = m_controller->property(key);
376 377 378 379 380 381
    }
    return value;
}

const QString ProjectClip::hash()
{
382 383 384 385 386 387
    if (m_controller) {
        QString clipHash = m_controller->property("kdenlive:file_hash");
        if (clipHash.isEmpty()) {
            return getFileHash();
        }
        return clipHash;
388
    }
389
    return getFileHash();
390 391
}

392
const QString ProjectClip::getFileHash() const
393
{
394
    if (clipType() == SlideShow) return QString();
395
    QFile file(m_controller ? m_controller->clipUrl().toLocalFile() : m_temporaryUrl.toLocalFile());
396 397 398 399
    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;
400
        //m_properties.insert("file_size", QString::number(file.size()));
401 402 403 404 405 406 407 408 409 410 411 412
        /*
               * 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);
413
        QString result = fileHash.toHex();
414
        if (m_controller) m_controller->setProperty("kdenlive:file_hash", result);
415
        return result;
416
    }
417
    return QString();
418
}
419 420 421 422 423 424

double ProjectClip::getOriginalFps() const
{
    if (!m_controller) return 0;
    return m_controller->originalFps();
}
425 426 427

bool ProjectClip::hasProxy() const
{
428
    QString proxy = getProducerProperty("kdenlive:proxy");
429 430 431 432
    if (proxy.isEmpty() || proxy == "-") return false;
    return true;
}

433
void ProjectClip::setProperties(QMap <QString, QString> properties, bool refreshPanel)
434 435 436 437 438 439 440
{
    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
441
        setProducerProperty(i.key(), i.value());
442 443
        if (clipType() == SlideShow && keys.contains(i.key())) refreshProducer = true;
    }
444 445
    if (properties.contains("kdenlive:proxy")) {
        QString value = properties.value("kdenlive:proxy");
446 447 448 449 450 451
        // 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);
            }
452 453 454
            else {
                reloadProducer();
            }
455 456
        }
        else {
457
            // A proxy was requested, make sure to keep original url
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
458
            setProducerProperty("kdenlive:originalurl", url().toLocalFile());
459
            bin()->startJob(m_id, AbstractClipJob::PROXYJOB);
460 461
        }
    }
462 463
    else if (properties.contains("resource")) {
        // Clip resource changed, update thumbnail
464 465 466 467
        if (clipType() == Color) {
            //reloadProducer(true);
        }
        else {
468
            reloadProducer();
469
        }
470 471
        refreshProducer = true;
    }
472 473 474
    if (properties.contains("xmldata")) {
        refreshProducer = true;
    }
475 476 477 478 479
    if (properties.contains("length")) {
        m_duration = m_controller->getStringDuration();
        bin()->emitItemUpdated(this);
    }

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

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

510 511 512

ClipPropertiesController *ProjectClip::buildProperties(QWidget *parent)
{
513
    ClipPropertiesController *panel = new ClipPropertiesController(bin()->projectTimecode(), m_controller, parent);
514 515 516 517
    connect(this, SIGNAL(refreshPropertiesPanel()), panel, SLOT(slotReloadProperties()));
    return panel;
}

518 519
void ProjectClip::updateParentInfo(const QString &folderid, const QString &foldername)
{
520
    m_controller->setProperty("kdenlive:folderid", folderid);
521 522
}

523 524 525 526 527 528
bool ProjectClip::matches(QString condition)
{
    //TODO
    return true;
}

529
const QString ProjectClip::codec(bool audioCodec) const
530
{
531 532
    if (!m_controller) return QString();
    return m_controller->codec(audioCodec);
533
}
534 535 536 537 538 539 540 541 542 543 544 545 546 547

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;
}

548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
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);
576
    return true;
577 578 579 580 581 582 583 584 585 586 587 588 589 590
}

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();
}
591

592
void ProjectClip::addEffect(const ProfileInfo pInfo, QDomElement &effect)
593
{
594
    m_controller->addEffect(pInfo, effect);
595
    bin()->editMasterEffect(m_controller);
596
    bin()->emitItemUpdated(this);
597 598
}

599 600 601 602
void ProjectClip::removeEffect(const ProfileInfo pInfo, int ix)
{
    m_controller->removeEffect(pInfo, ix);
    bin()->editMasterEffect(m_controller);
603 604 605 606 607 608 609
    bin()->emitItemUpdated(this);
}

QVariant ProjectClip::data(DataType type) const
{
    switch (type) {
      case AbstractProjectItem::IconOverlay:
Jean-Baptiste Mardelle's avatar
Jean-Baptiste Mardelle committed
610
            return m_controller != NULL ? (m_controller->hasEffects() ? QVariant("kdenlive-track_has_effect") : QVariant()) : QVariant();
611 612 613 614 615
            break;
        default:
	    break;
    }
    return AbstractProjectItem::data(type);
616
}
617 618 619

void ProjectClip::slotExtractImage(QList <int> frames)
{
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652
    Mlt::Producer *prod = producer();
    if (prod == NULL) return;
    // Check if we are using GPU accel, then we need to use alternate producer
    if (KdenliveSettings::gpu_accel()) {
	if (m_gpuProducer == NULL) {
            QString service = prod->get("mlt_service");
            m_gpuProducer = new Mlt::Producer(*prod->profile(), service.toUtf8().constData(), prod->get("resource"));
            Mlt::Filter scaler(*prod->profile(), "swscale");
	    Mlt::Filter converter(*prod->profile(), "avcolor_space");
	    m_gpuProducer->attach(scaler);
	    m_gpuProducer->attach(converter);
        }
	prod = m_gpuProducer;
    }
    int imageWidth = (int)((double) 150 * prod->profile()->width() / prod->profile()->height() + 0.5);
    int fullWidth = (int)((double) 150 * prod->profile()->dar() + 0.5);
    QDir thumbFolder(bin()->projectFolder().path() + "/thumbs/");
    for (int i = 0; i < frames.count(); i++) {
        int pos = frames.at(i);
        if (thumbFolder.exists(hash() + '_' + QString::number(pos) + ".png")) {
            emit thumbReady(pos, QImage(thumbFolder.absoluteFilePath(hash() + '_' + QString::number(pos) + ".png")));
            continue;
        }
	int max = prod->get_out();
	if (pos >= max) pos = max - 1;
	prod->seek(pos);
	Mlt::Frame *frame = prod->get_frame();
	if (frame && frame->is_valid()) {
            QImage img = KThumb::getFrame(frame, imageWidth, fullWidth, 150);
            emit thumbReady(frames.at(i), img);
        }
        delete frame;
    }
653
}