projectclip.cpp 12.6 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 25
/*
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"
#include "bin.h"
26
#include "mltcontroller/clipcontroller.h"
27
#include "mltcontroller/clippropertiescontroller.h"
28 29 30 31 32 33 34 35 36 37

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

#include <KLocalizedString>



38
ProjectClip::ProjectClip(const QString &id, ClipController *controller, ProjectFolder* parent) :
39 40 41 42
    AbstractProjectItem(AbstractProjectItem::ClipItem, id, parent)
    , m_controller(controller)
    , audioFrameCache()
    , m_audioThumbCreated(false)
43
{
44
    m_clipStatus = StatusReady;
45 46
    m_name = m_controller->clipName();
    m_duration = m_controller->getStringDuration();
47
    getFileHash();
48
    setParent(parent);
49 50 51
}

ProjectClip::ProjectClip(const QDomElement& description, ProjectFolder* parent) :
52
    AbstractProjectItem(AbstractProjectItem::ClipItem, description, parent)
53
    , m_controller(NULL)
54 55
    , audioFrameCache()
    , m_audioThumbCreated(false)
56 57
{
    Q_ASSERT(description.hasAttribute("id"));
58
    m_clipStatus = StatusWaiting;
59
    QString resource = getXmlProperty(description, "resource");
60
    QString clipName = getXmlProperty(description, "kdenlive:clipname");
61 62 63 64
    if (!clipName.isEmpty()) {
        m_name = clipName;
    }
    else if (!resource.isEmpty()) {
65 66
        m_name = QUrl::fromLocalFile(resource).fileName();
    }
67
    else m_name = i18n("Untitled");
68 69
    if (description.hasAttribute("zone"))
	m_zone = QPoint(description.attribute("zone").section(':', 0, 0).toInt(), description.attribute("zone").section(':', 1, 1).toInt());
70
    setParent(parent);
71 72 73 74 75
}


ProjectClip::~ProjectClip()
{
76
    // controller is deleted in bincontroller
77 78
}

79 80 81 82 83
QString ProjectClip::getToolTip() const
{
    return url().toLocalFile();
}

84 85 86 87 88 89 90 91 92 93 94 95 96
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;
}

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
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;
}

116 117
ClipType ProjectClip::clipType() const
{
118 119
    if (m_controller == NULL) return Unknown;
    return m_controller->clipType();
120 121 122 123 124 125 126 127 128 129
}

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

130 131 132 133 134
ProjectFolder* ProjectClip::folder(const QString &id)
{
    return NULL;
}

135 136 137 138 139 140 141 142
ProjectClip* ProjectClip::clipAt(int ix)
{
    if (ix == index()) {
        return this;
    }
    return NULL;
}

143
/*bool ProjectClip::isValid() const
144
{
145 146
    return m_controller->isValid();
}*/
147 148 149

QUrl ProjectClip::url() const
{
150
    return m_controller->clipUrl();
151 152 153 154
}

bool ProjectClip::hasLimitedDuration() const
{
155 156 157 158
    if (m_controller) {
        return m_controller->hasLimitedDuration();
    }
    return true;
159 160
}

161
GenTime ProjectClip::duration() const
162
{
163 164
    if (m_controller) {
	return m_controller->getPlaytime();
165
    }
166
    return GenTime();
167 168 169 170 171 172 173 174 175 176 177
}

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

178
void ProjectClip::reloadProducer(bool thumbnailOnly)
179 180 181
{
    QDomDocument doc;
    QDomElement xml = toXml(doc);
182 183 184 185
    if (thumbnailOnly) {
        // set a special flag to request thumbnail only
        xml.setAttribute("thumbnailOnly", "1");
    }
186
    bin()->reloadProducer(m_id, xml);
187 188 189 190 191
}

void ProjectClip::setCurrent(bool current, bool notify)
{
    AbstractProjectItem::setCurrent(current, notify);
Jean-Baptiste Mardelle's avatar
cleanup  
Jean-Baptiste Mardelle committed
192 193
    if (current) {
        bin()->openProducer(m_controller);
194 195 196 197 198
    }
}

QDomElement ProjectClip::toXml(QDomDocument& document)
{
199 200 201
    if (m_controller) {
        m_controller->getProducerXML(document);
        return document.documentElement().firstChildElement("producer");
202
    }
203
    return QDomElement();
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
}

QPixmap ProjectClip::thumbnail(bool force)
{
/*    if ((force || m_thumbnail.isNull()) && m_baseProducer) {
	int width = 80 * bin()->project()->displayRatio();
	if (width % 2 == 1) width++;
	bin()->project()->monitorManager()->requestThumbnails(m_id, QList <int>() << 0);
    }
    */
    return m_thumbnail;
}

void ProjectClip::setThumbnail(QImage img)
{
    m_thumbnail = roundedPixmap(QPixmap::fromImage(img));
    if (hasProxy() && !m_thumbnail.isNull()) {
        // Overlay proxy icon
        QPainter p(&m_thumbnail);
        QColor c(220, 220, 10, 200);
        QRect r(0, 0, m_thumbnail.height() / 2.5, m_thumbnail.height() / 2.5);
        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"));
    }
    bin()->emitItemUpdated(this);
}

236
void ProjectClip::setProducer(ClipController *controller, bool replaceProducer)
237
{
238
    if (!replaceProducer && m_controller) {
239 240 241
        qDebug()<<"// RECIEVED PRODUCER BUT WE ALREADY HAVE ONE\n----------";
        return;
    }
242 243
    if (m_controller) {
        // Replace clip for this controller
244
        //m_controller->updateProducer(m_id, &(controller->originalProducer()));
245
        delete controller;
246
    }
247 248 249 250 251 252
    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();
    }
253
    m_clipStatus = StatusReady;
254 255 256 257 258 259
    bin()->emitItemUpdated(this);
    getFileHash();
}

Mlt::Producer *ProjectClip::producer()
{
260 261
    if (!m_controller) return NULL;
    return m_controller->masterProducer();
262 263
}

264
bool ProjectClip::isReady() const
265
{
266
    return m_controller!= NULL;
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
}

void ProjectClip::setZone(const QPoint &zone)
{
    m_zone = zone;
}

QPoint ProjectClip::zone() const
{
    return m_zone;
}

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

void ProjectClip::setProducerProperty(const char *name, int data)
{
293 294
    if (m_controller) {
	m_controller->setProperty(name, data);
295 296 297 298 299
    }
}

void ProjectClip::setProducerProperty(const char *name, double data)
{
300 301
    if (m_controller) {
        m_controller->setProperty(name, data);
302 303 304 305 306
    }
}

void ProjectClip::setProducerProperty(const char *name, const char *data)
{
307 308
    if (m_controller) {
        m_controller->setProperty(name, data);
309 310 311
    }
}

312 313 314 315 316 317 318 319
int ProjectClip::getProducerIntProperty(const QString &key) const
{
    int value = 0;
    if (m_controller) {
        value = m_controller->int_property(key);
    }
    return value;
}
320

321
QString ProjectClip::getProducerProperty(const QString &key) const
322 323
{
    QString value;
324 325
    if (m_controller) {
	value = m_controller->property(key);
326 327 328 329 330 331
    }
    return value;
}

const QString ProjectClip::hash()
{
332 333 334 335 336 337
    if (!m_controller) return QString();
    QString clipHash = m_controller->property("file_hash");
    if (clipHash.isEmpty()) {
        return getFileHash();
    }
    return clipHash;
338 339
}

340
const QString ProjectClip::getFileHash() const
341
{
342
    if (clipType() == SlideShow) return QString();
343
    QFile file(m_controller->clipUrl().toLocalFile());
344 345 346 347
    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;
348
        //m_properties.insert("file_size", QString::number(file.size()));
349 350 351 352 353 354 355 356 357 358 359 360
        /*
               * 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);
361 362 363
        QString result = fileHash.toHex();
        m_controller->setProperty("file_hash", result);
        return result;
364
    }
365
    return QString();
366 367 368 369
}

bool ProjectClip::hasProxy() const
{
370
    QString proxy = getProducerProperty("kdenlive:proxy");
371 372 373 374
    if (proxy.isEmpty() || proxy == "-") return false;
    return true;
}

375
void ProjectClip::setProperties(QMap <QString, QString> properties, bool refreshPanel)
376 377 378 379 380 381 382 383 384 385
{
    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();
        setProducerProperty(i.key().toUtf8().data(), i.value().toUtf8().data());
        if (clipType() == SlideShow && keys.contains(i.key())) refreshProducer = true;
    }
386 387
    if (properties.contains("kdenlive:proxy")) {
        QString value = properties.value("kdenlive:proxy");
388 389 390 391 392 393
        // 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);
            }
394 395 396
            else {
                reloadProducer();
            }
397 398
        }
        else {
399
            // A proxy was requested, make sure to keep original url
400
            setProducerProperty("kdenlive:originalurl", url().toLocalFile().toUtf8().data());
401
            bin()->startJob(m_id, AbstractClipJob::PROXYJOB);
402 403
        }
    }
404 405 406 407 408
    else if (properties.contains("resource")) {
        // Clip resource changed, update thumbnail
        reloadProducer(true);
        refreshProducer = true;
    }
409 410 411 412
    if (properties.contains("kdenlive:clipname")) {
        m_name = properties.value("kdenlive:clipname");
        bin()->emitItemUpdated(this);
    }
413 414 415 416 417 418 419 420
    if (refreshPanel) {
        // Some of the clip properties have changed through a command, update properties panel
        emit refreshPropertiesPanel();
    }
    if (refreshProducer) {
        // producer has changed, refresh monitor
        bin()->refreshMonitor(m_id);
    }
421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
}

void ProjectClip::setJobStatus(AbstractClipJob::JOBTYPE jobType, ClipJobStatus status, int progress, const QString &statusMessage)
{
    m_jobType = jobType;
    if (progress > 0) {
	m_jobProgress = progress;
    }
    else {
	m_jobProgress = status;
	if ((status == JobAborted || status == JobCrashed  || status == JobDone) || !statusMessage.isEmpty()) {
	    m_jobMessage = statusMessage;
	}
    }
    bin()->emitItemUpdated(this);
}
437

438 439 440 441 442 443 444 445

ClipPropertiesController *ProjectClip::buildProperties(QWidget *parent)
{
    ClipPropertiesController *panel = new ClipPropertiesController(m_id, clipType(), m_controller->properties(), parent);
    connect(this, SIGNAL(refreshPropertiesPanel()), panel, SLOT(slotReloadProperties()));
    return panel;
}

446 447
void ProjectClip::updateParentInfo(const QString &folderid, const QString &foldername)
{
448
    m_controller->setProperty("kdenlive:folderid", folderid);
449 450
}

451 452 453 454 455 456 457
bool ProjectClip::matches(QString condition)
{
    //TODO
    return true;
}