projectclip.cpp 12 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 28 29 30 31 32 33 34 35 36

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

#include <KLocalizedString>



37
ProjectClip::ProjectClip(const QString &id, ClipController *controller, ProjectFolder* parent) :
38 39 40 41
    AbstractProjectItem(AbstractProjectItem::ClipItem, id, parent)
    , m_controller(controller)
    , audioFrameCache()
    , m_audioThumbCreated(false)
42 43
{
    m_properties = QMap <QString, QString> ();
44 45
    m_name = m_controller->clipName();
    m_duration = m_controller->getStringDuration();
46 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 58
{
    Q_ASSERT(description.hasAttribute("id"));
    m_properties = QMap <QString, QString> ();
59 60
    QUrl resource = QUrl::fromLocalFile(getXmlProperty(description, "resource"));
    m_name = resource.fileName();
61 62
    if (description.hasAttribute("zone"))
	m_zone = QPoint(description.attribute("zone").section(':', 0, 0).toInt(), description.attribute("zone").section(':', 1, 1).toInt());
63
    setParent(parent);
64 65 66 67 68
}


ProjectClip::~ProjectClip()
{
69
    delete m_controller;
70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
}

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

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103
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;
}

104 105
ClipType ProjectClip::clipType() const
{
106 107
    if (m_controller == NULL) return Unknown;
    return m_controller->clipType();
108 109 110 111 112 113 114 115 116 117
}

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

118 119 120 121 122
ProjectFolder* ProjectClip::folder(const QString &id)
{
    return NULL;
}

123 124 125 126 127 128 129 130
ProjectClip* ProjectClip::clipAt(int ix)
{
    if (ix == index()) {
        return this;
    }
    return NULL;
}

131
/*bool ProjectClip::isValid() const
132
{
133 134
    return m_controller->isValid();
}*/
135 136 137

QUrl ProjectClip::url() const
{
138
    return m_controller->clipUrl();
139 140 141 142 143 144 145 146
}

bool ProjectClip::hasLimitedDuration() const
{
    //TODO: should be false for color and image clips
    return m_hasLimitedDuration;
}

147
GenTime ProjectClip::duration() const
148
{
149 150
    if (m_controller) {
	return m_controller->getPlaytime();
151
    }
152
    return GenTime();
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173
}

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

void ProjectClip::reloadProducer()
{
    QDomDocument doc;
    QDomElement xml = toXml(doc);
    bin()->reloadProducer(m_id, doc.documentElement());
}

void ProjectClip::setCurrent(bool current, bool notify)
{
    AbstractProjectItem::setCurrent(current, notify);
Jean-Baptiste Mardelle's avatar
cleanup  
Jean-Baptiste Mardelle committed
174 175
    if (current) {
        bin()->openProducer(m_controller);
176 177 178 179 180 181 182 183 184 185 186 187
    }
}

QDomElement ProjectClip::toXml(QDomDocument& document)
{
    QDomElement prod = document.createElement("producer");
    document.appendChild(prod);
    QDomElement prop = document.createElement("property");
    prop.setAttribute("name", "resource");
    QString path = m_properties.value("proxy");
    if (path.length() < 2) {
        // No proxy
188
        path = m_controller->clipUrl().toLocalFile();
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
    }
    QDomText value = document.createTextNode(path);
    prop.appendChild(value);
    prod.appendChild(prop);
    prod.setAttribute("id", m_id);
    return prod;
}

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

227
void ProjectClip::setProducer(ClipController *controller, bool replaceProducer)
228
{
229
    if (!replaceProducer && m_controller) {
230 231 232
        qDebug()<<"// RECIEVED PRODUCER BUT WE ALREADY HAVE ONE\n----------";
        return;
    }
233 234 235 236
    if (m_controller) {
        // Replace clip for this controller
        m_controller->updateProducer(controller->masterProducer());
        delete controller;
237
    }
238 239
    else m_controller = controller;
    m_duration = m_controller->getStringDuration();
240 241 242 243 244 245
    bin()->emitItemUpdated(this);
    getFileHash();
}

Mlt::Producer *ProjectClip::producer()
{
246 247
    if (!m_controller) return NULL;
    return m_controller->masterProducer();
248 249
}

250
bool ProjectClip::isReady() const
251
{
252
    return m_controller!= NULL;
253 254
}

255
QMap <QString, QString> ProjectClip::properties()
256
{
257
    //TODO: move into its own class in ClipController
258
    QMap <QString, QString> result;
259
    /*
260 261 262 263 264 265 266 267 268 269 270
    if (m_producer) {
        mlt_properties props = m_producer->get_properties();
        QString key = "video_index";
        int video_index = mlt_properties_get_int(props, key.toUtf8().constData());
        QString codecKey = "meta.media." + QString::number(video_index) + ".codec.long_name";
        result.insert(i18n("Video codec"), mlt_properties_get(props, codecKey.toUtf8().constData()));
        key = "audio_index";
        int audio_index = mlt_properties_get_int(props, key.toUtf8().constData());
        codecKey = "meta.media." + QString::number(audio_index) + ".codec.long_name";
        result.insert(i18n("Audio codec"), mlt_properties_get(props, codecKey.toUtf8().constData()));
    }
271
    */
272
    return result;
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
}

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)
{
299 300
    if (m_controller) {
	m_controller->setProperty(name, data);
301 302 303 304 305
    }
}

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

void ProjectClip::setProducerProperty(const char *name, const char *data)
{
313 314
    if (m_controller) {
        m_controller->setProperty(name, data);
315 316 317
    }
}

318 319 320 321 322 323 324 325
int ProjectClip::getProducerIntProperty(const QString &key) const
{
    int value = 0;
    if (m_controller) {
        value = m_controller->int_property(key);
    }
    return value;
}
326

327
QString ProjectClip::getProducerProperty(const QString &key) const
328 329
{
    QString value;
330 331
    if (m_controller) {
	value = m_controller->property(key);
332 333 334 335 336 337
    }
    return value;
}

const QString ProjectClip::hash()
{
338 339 340 341 342 343
    if (!m_controller) return QString();
    QString clipHash = m_controller->property("file_hash");
    if (clipHash.isEmpty()) {
        return getFileHash();
    }
    return clipHash;
344 345
}

346
const QString ProjectClip::getFileHash() const
347
{
348
    if (clipType() == SlideShow) return QString();
349
    QFile file(m_controller->clipUrl().toLocalFile());
350 351 352 353
    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;
354
        //m_properties.insert("file_size", QString::number(file.size()));
355 356 357 358 359 360 361 362 363 364 365 366
        /*
               * 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);
367 368 369
        QString result = fileHash.toHex();
        m_controller->setProperty("file_hash", result);
        return result;
370
    }
371
    return QString();
372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
}

const QString ProjectClip::getProperty(const QString &key) const
{
    return m_properties.value(key);
}

bool ProjectClip::hasProxy() const
{
    QString proxy = m_properties.value("proxy");
    if (proxy.isEmpty() || proxy == "-") return false;
    return true;
}

void ProjectClip::setProperties(QMap <QString, QString> properties)
{
    QMapIterator<QString, QString> i(properties);
    bool refreshProducer = false;
    QStringList keys;
    keys << "luma_duration" << "luma_file" << "fade" << "ttl" << "softness" << "crop" << "animation";
    QString oldProxy = m_properties.value("proxy");
    while (i.hasNext()) {
        i.next();
        setProducerProperty(i.key().toUtf8().data(), i.value().toUtf8().data());
	m_properties.insert(i.key(), i.value());
        if (clipType() == SlideShow && keys.contains(i.key())) refreshProducer = true;
    }
    if (properties.contains("proxy")) {
	qDebug()<<"/// CLIP UPDATE, ASK PROXY";
        QString value = properties.value("proxy");
        // 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);
            }
            else reloadProducer();
        }
        else {
	    bin()->startJob(m_id, AbstractClipJob::PROXYJOB);
        }
    }
    //if (refreshProducer) slotRefreshProducer();
}

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