]> git.sesse.net Git - kdenlive/blob - src/projecttree/meltjob.cpp
Cleanup data processing framework
[kdenlive] / src / projecttree / meltjob.cpp
1 /***************************************************************************
2  *                                                                         *
3  *   Copyright (C) 2011 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
4  *                                                                         *
5  *   This program is free software; you can redistribute it and/or modify  *
6  *   it under the terms of the GNU General Public License as published by  *
7  *   the Free Software Foundation; either version 2 of the License, or     *
8  *   (at your option) any later version.                                   *
9  *                                                                         *
10  *   This program is distributed in the hope that it will be useful,       *
11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
13  *   GNU General Public License for more details.                          *
14  *                                                                         *
15  *   You should have received a copy of the GNU General Public License     *
16  *   along with this program; if not, write to the                         *
17  *   Free Software Foundation, Inc.,                                       *
18  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
19  ***************************************************************************/
20
21 #include "meltjob.h"
22 #include "kdenlivesettings.h"
23 #include "kdenlivedoc.h"
24
25 #include <KDebug>
26 #include <KUrl>
27 #include <KLocale>
28
29 #include <mlt++/Mlt.h>
30
31
32 static void consumer_frame_render(mlt_consumer, MeltJob * self, mlt_frame /*frame_ptr*/)
33 {
34     // detect if the producer has finished playing. Is there a better way to do it?
35     self->emitFrameNumber();
36 }
37
38 MeltJob::MeltJob(CLIPTYPE cType, const QString &id, QStringList parameters, QStringList extraParams) : AbstractClipJob(MLTJOB, cType, id, parameters),
39     addClipToProject(0),
40     m_producer(NULL),
41     m_profile(NULL),
42     m_consumer(NULL),
43     m_showFrameEvent(NULL),
44     m_length(0),
45     m_extra(extraParams)
46 {
47     jobStatus = JOBWAITING;
48     m_params = parameters;
49     description = i18n("Process clip");
50     QString consum = m_params.at(5);
51     if (consum.contains(':')) m_dest = consum.section(':', 1);
52 }
53
54 void MeltJob::setProducer(Mlt::Producer *producer, KUrl url)
55 {
56     m_producer = producer;
57     m_url = QString::fromUtf8(m_producer->get("resource"));
58     if (m_url == "<playlist>" || m_url == "<tractor>" || m_url == "<producer>")
59         m_url == url.path();
60 }
61
62 void MeltJob::startJob()
63 {
64     if (!m_producer) {
65         m_errorMessage.append(i18n("No producer for this clip."));
66         setStatus(JOBCRASHED);
67         return;
68     }
69     int in = m_params.takeFirst().toInt();
70     int out = m_params.takeFirst().toInt();
71     QString producerParams =m_params.takeFirst(); 
72     QString filter = m_params.takeFirst();
73     QString filterParams = m_params.takeFirst();
74     QString consumer = m_params.takeFirst();
75     if (consumer.contains(':')) m_dest = consumer.section(':', 1);
76     QString consumerParams = m_params.takeFirst();
77     
78     // optional params
79     int startPos = -1;
80     if (!m_params.isEmpty()) startPos = m_params.takeFirst().toInt();
81     int track = -1;
82     if (!m_params.isEmpty()) track = m_params.takeFirst().toInt();
83     QString finalFilter;
84     if (!m_params.isEmpty()) finalFilter = m_params.takeFirst();
85     else finalFilter = filter;
86
87     // Check if we want to return analysis data
88     QString properties;
89     for (int i = 0; i < m_extra.count(); i++) {
90         if (m_extra.at(i).startsWith("key:")) {
91             properties = m_extra.at(i).section(':', 1);
92             break;
93         }
94     }
95
96
97     if (out != -1 && out <= in) {
98         m_errorMessage.append(i18n("Clip zone undefined (%1 - %2).", in, out));
99         setStatus(JOBCRASHED);
100         return;
101     }
102     Mlt::Producer *prod ;
103     if (m_extra.contains("producer_profile")) {
104         m_profile = new Mlt::Profile;
105         m_profile->set_explicit(false);
106     }
107     else {
108         m_profile = new Mlt::Profile(KdenliveSettings::current_profile().toUtf8().constData());
109     }
110     if (out == -1) {
111         prod = new Mlt::Producer(*m_profile,  m_url.toUtf8().constData());
112     }
113     else {
114         Mlt::Producer *tmp = new Mlt::Producer(*m_profile,  m_url.toUtf8().constData());
115         prod = tmp->cut(in, out);
116         delete tmp;
117     }
118     if (m_extra.contains("prducer_profile")) {
119         m_profile->from_producer(*prod);
120         m_profile->set_explicit(true);
121     }
122     QStringList list = producerParams.split(' ', QString::SkipEmptyParts);
123     foreach(const QString &data, list) {
124         if (data.contains('=')) {
125             prod->set(data.section('=', 0, 0).toUtf8().constData(), data.section('=', 1, 1).toUtf8().constData());
126         }
127     }
128     if (consumer.contains(":")) {
129         m_consumer = new Mlt::Consumer(*m_profile, consumer.section(':', 0, 0).toUtf8().constData(), consumer.section(':', 1).toUtf8().constData());
130     }
131     else {
132         m_consumer = new Mlt::Consumer(*m_profile, consumer.toUtf8().constData());
133     }
134     if (!m_consumer || !m_consumer->is_valid()) {
135         m_errorMessage.append(i18n("Cannot create consumer %1.", consumer));
136         setStatus(JOBCRASHED);
137         return;
138     }
139
140     //m_consumer->set("terminate_on_pause", 1 );
141     //m_consumer->set("eof", "pause" );
142     m_consumer->set("real_time", -KdenliveSettings::mltthreads() );
143
144
145     list = consumerParams.split(' ', QString::SkipEmptyParts);
146     foreach(const QString &data, list) {
147         if (data.contains('=')) {
148             kDebug()<<"// filter con: "<<data;
149             m_consumer->set(data.section('=', 0, 0).toUtf8().constData(), data.section('=', 1, 1).toUtf8().constData());
150         }
151     }
152     
153     Mlt::Filter mltFilter(*m_profile, filter.toUtf8().data());
154     list = filterParams.split(' ', QString::SkipEmptyParts);
155     foreach(const QString &data, list) {
156         if (data.contains('=')) {
157             kDebug()<<"// filter p: "<<data;
158             mltFilter.set(data.section('=', 0, 0).toUtf8().constData(), data.section('=', 1, 1).toUtf8().constData());
159         }
160     }
161     Mlt::Tractor tractor;
162     Mlt::Playlist playlist;
163     playlist.append(*prod);
164     tractor.set_track(playlist, 0);
165     m_length = prod->get_length();
166     m_consumer->connect(tractor);
167     prod->set_speed(0);
168     prod->seek(0);
169     prod->attach(mltFilter);
170     m_showFrameEvent = m_consumer->listen("consumer-frame-show", this, (mlt_listener) consumer_frame_render);
171     m_consumer->start();
172     prod->set_speed(1);
173     while (jobStatus != JOBABORTED && !m_consumer->is_stopped()) {
174         
175     }
176     m_consumer->stop();
177     QStringList wanted = properties.split(',', QString::SkipEmptyParts);
178     stringMap jobResults;
179     foreach(const QString &key, wanted) {
180         QString value = mltFilter.get(key.toUtf8().constData());
181         jobResults.insert(key, value);
182     }
183     if (!jobResults.isEmpty() && jobStatus != JOBABORTED) emit gotFilterJobResults(m_clipId, startPos, track, finalFilter, jobResults, m_extra);
184     setStatus(JOBDONE);
185     delete m_consumer;
186     delete prod;
187     return;
188 }
189
190
191 MeltJob::~MeltJob()
192 {
193 }
194
195 const QString MeltJob::destination() const
196 {
197     return m_dest;
198 }
199
200 stringMap MeltJob::cancelProperties()
201 {
202     QMap <QString, QString> props;
203     return props;
204 }
205
206 const QString MeltJob::statusMessage()
207 {
208     QString statusInfo;
209     switch (jobStatus) {
210         case JOBWORKING:
211             statusInfo = description;
212             break;
213         case JOBWAITING:
214             statusInfo = i18n("Waiting to process clip");
215             break;
216         default:
217             break;
218     }
219     return statusInfo;
220 }
221
222 void MeltJob::emitFrameNumber()
223 {
224     if (m_consumer && m_length > 0) {
225         emit jobProgress(m_clipId, (int) (100 * m_consumer->position() / m_length), jobType);
226     }
227 }
228
229 bool MeltJob::isProjectFilter() const
230 {
231     return m_extra.contains("projecttreefilter");
232 }
233
234
235