projectclip.cpp 12.8 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 60 61 62 63
    QString resource = getXmlProperty(description, "resource");
    if (!resource.isEmpty()) {
        m_name = QUrl::fromLocalFile(resource).fileName();
    }
    else m_name = description.attribute("name");
64 65
    if (description.hasAttribute("zone"))
	m_zone = QPoint(description.attribute("zone").section(':', 0, 0).toInt(), description.attribute("zone").section(':', 1, 1).toInt());
66
    setParent(parent);
67 68 69 70 71
}


ProjectClip::~ProjectClip()
{
72
    // controller is deleted in bincontroller
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
}

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

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

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

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

121 122 123 124 125
ProjectFolder* ProjectClip::folder(const QString &id)
{
    return NULL;
}

126 127 128 129 130 131 132 133
ProjectClip* ProjectClip::clipAt(int ix)
{
    if (ix == index()) {
        return this;
    }
    return NULL;
}

134
/*bool ProjectClip::isValid() const
135
{
136 137
    return m_controller->isValid();
}*/
138 139 140

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

bool ProjectClip::hasLimitedDuration() const
{
146 147 148 149
    if (m_controller) {
        return m_controller->hasLimitedDuration();
    }
    return true;
150 151
}

152
GenTime ProjectClip::duration() const
153
{
154 155
    if (m_controller) {
	return m_controller->getPlaytime();
156
    }
157
    return GenTime();
158 159 160 161 162 163 164 165 166 167 168
}

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

169
void ProjectClip::reloadProducer(bool thumbnailOnly)
170 171 172
{
    QDomDocument doc;
    QDomElement xml = toXml(doc);
173 174 175 176
    if (thumbnailOnly) {
        // set a special flag to request thumbnail only
        xml.setAttribute("thumbnailOnly", "1");
    }
177
    bin()->reloadProducer(m_id, xml);
178 179 180 181 182
}

void ProjectClip::setCurrent(bool current, bool notify)
{
    AbstractProjectItem::setCurrent(current, notify);
Jean-Baptiste Mardelle's avatar
cleanup  
Jean-Baptiste Mardelle committed
183 184
    if (current) {
        bin()->openProducer(m_controller);
185 186 187 188 189
    }
}

QDomElement ProjectClip::toXml(QDomDocument& document)
{
190 191 192
    if (m_controller) {
        m_controller->getProducerXML(document);
        return document.documentElement().firstChildElement("producer");
193
    }
194
    return QDomElement();
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
}

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
    if (m_controller) {
        // Replace clip for this controller
235
        //m_controller->updateProducer(m_id, &(controller->originalProducer()));
236
        delete controller;
237
    }
238 239 240 241 242 243
    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();
    }
244
    m_clipStatus = StatusReady;
245 246 247 248 249 250
    bin()->emitItemUpdated(this);
    getFileHash();
}

Mlt::Producer *ProjectClip::producer()
{
251 252
    if (!m_controller) return NULL;
    return m_controller->masterProducer();
253 254
}

255
bool ProjectClip::isReady() const
256
{
257
    return m_controller!= NULL;
258 259
}

260
QMap <QString, QString> ProjectClip::properties()
261
{
262
    //TODO: move into its own class in ClipController
263
    QMap <QString, QString> result;
264
    /*
265 266 267 268 269 270 271 272 273 274 275
    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()));
    }
276
    */
277
    return result;
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303
}

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)
{
304 305
    if (m_controller) {
	m_controller->setProperty(name, data);
306 307 308 309 310
    }
}

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

void ProjectClip::setProducerProperty(const char *name, const char *data)
{
318 319
    if (m_controller) {
        m_controller->setProperty(name, data);
320 321 322
    }
}

323 324 325 326 327 328 329 330
int ProjectClip::getProducerIntProperty(const QString &key) const
{
    int value = 0;
    if (m_controller) {
        value = m_controller->int_property(key);
    }
    return value;
}
331

332
QString ProjectClip::getProducerProperty(const QString &key) const
333 334
{
    QString value;
335 336
    if (m_controller) {
	value = m_controller->property(key);
337 338 339 340 341 342
    }
    return value;
}

const QString ProjectClip::hash()
{
343 344 345 346 347 348
    if (!m_controller) return QString();
    QString clipHash = m_controller->property("file_hash");
    if (clipHash.isEmpty()) {
        return getFileHash();
    }
    return clipHash;
349 350
}

351
const QString ProjectClip::getFileHash() const
352
{
353
    if (clipType() == SlideShow) return QString();
354
    QFile file(m_controller->clipUrl().toLocalFile());
355 356 357 358
    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;
359
        //m_properties.insert("file_size", QString::number(file.size()));
360 361 362 363 364 365 366 367 368 369 370 371
        /*
               * 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);
372 373 374
        QString result = fileHash.toHex();
        m_controller->setProperty("file_hash", result);
        return result;
375
    }
376
    return QString();
377 378 379 380
}

bool ProjectClip::hasProxy() const
{
381
    QString proxy = getProducerProperty("proxy");
382 383 384 385
    if (proxy.isEmpty() || proxy == "-") return false;
    return true;
}

386
void ProjectClip::setProperties(QMap <QString, QString> properties, bool refreshPanel)
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404
{
    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;
    }
    if (properties.contains("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);
            }
405 406 407
            else {
                reloadProducer();
            }
408 409
        }
        else {
410 411 412
            // A proxy was requested, make sure to keep original url
            setProducerProperty("kdenlive_originalUrl", url().toLocalFile().toUtf8().data());
            bin()->startJob(m_id, AbstractClipJob::PROXYJOB);
413 414
        }
    }
415 416 417 418 419 420 421 422 423 424 425 426 427
    else if (properties.contains("resource")) {
        // Clip resource changed, update thumbnail
        reloadProducer(true);
        refreshProducer = true;
    }
    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);
    }
428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443
}

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

445 446 447 448 449 450 451 452

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