git.sesse.net Git - kdenlive/blob - src/projectlist.h

   1 /***************************************************************************
   2  *   Copyright (C) 2007 by Jean-Baptiste Mardelle (jb@kdenlive.org)        *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
  18  ***************************************************************************/
  19
  20
  21 #ifndef PROJECTLIST_H
  22 #define PROJECTLIST_H
  23
  24 #include <QDomNodeList>
  25 #include <QToolBar>
  26 #include <QToolButton>
  27 #include <QTreeWidget>
  28 #include <QPainter>
  29 #include <QStyledItemDelegate>
  30 #include <QUndoStack>
  31 #include <QTimer>
  32 #include <QApplication>
  33 #include <QFuture>
  34
  35 #include <KTreeWidgetSearchLine>
  36 #include <KUrl>
  37 #include <KIcon>
  38
  39 #ifdef NEPOMUK
  40 #include <nepomuk/kratingpainter.h>
  41 #include <nepomuk/resource.h>
  42 #endif
  43
  44 #include "definitions.h"
  45 #include "timecode.h"
  46 #include "kdenlivesettings.h"
  47 #include "folderprojectitem.h"
  48 #include "subprojectitem.h"
  49
  50 namespace Mlt
  51 {
  52 class Producer;
  53 };
  54
  55 class ProjectItem;
  56 class ProjectListView;
  57 class Render;
  58 class KdenliveDoc;
  59 class DocClipBase;
  60
  61 const int NameRole = Qt::UserRole;
  62 const int DurationRole = NameRole + 1;
  63 const int UsageRole = NameRole + 2;
  64
  65 class ItemDelegate: public QStyledItemDelegate
  66 {
  67 public:
  68     ItemDelegate(QAbstractItemView* parent = 0): QStyledItemDelegate(parent) {
  69     }
  70
  71     /*void drawFocus(QPainter *, const QStyleOptionViewItem &, const QRect &) const {
  72     }*/
  73
  74     void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const {
  75         if (index.column() == 0 && !index.data(DurationRole).isNull()) {
  76             QRect r1 = option.rect;
  77             painter->save();
  78             QStyleOptionViewItemV4 opt(option);
  79             QStyle *style = opt.widget ? opt.widget->style() : QApplication::style();
  80             style->drawPrimitive(QStyle::PE_PanelItemViewItem, &opt, painter, opt.widget);
  81
  82             if (option.state & QStyle::State_Selected) {
  83                 painter->setPen(option.palette.highlightedText().color());
  84             }
  85             const int textMargin = style->pixelMetric(QStyle::PM_FocusFrameHMargin) + 1;
  86             QPixmap pixmap = qVariantValue<QPixmap>(index.data(Qt::DecorationRole));
  87             painter->drawPixmap(r1.left() + textMargin, r1.top() + (r1.height() - pixmap.height()) / 2, pixmap);
  88             int decoWidth = pixmap.width() + 2 * textMargin;
  89
  90             QFont font = painter->font();
  91             font.setBold(true);
  92             painter->setFont(font);
  93             int mid = (int)((r1.height() / 2));
  94             r1.adjust(decoWidth, 0, 0, -mid);
  95             QRect r2 = option.rect;
  96             r2.adjust(decoWidth, mid, 0, 0);
  97             painter->drawText(r1, Qt::AlignLeft | Qt::AlignBottom , index.data().toString());
  98             font.setBold(false);
  99             painter->setFont(font);
 100             QString subText = index.data(DurationRole).toString();
 101             int usage = index.data(UsageRole).toInt();
 102             if (usage != 0) subText.append(QString(" (%1)").arg(usage));
 103             if (option.state & (QStyle::State_Selected)) painter->setPen(option.palette.color(QPalette::Mid));
 104             QRectF bounding;
 105             painter->drawText(r2, Qt::AlignLeft | Qt::AlignVCenter , subText, &bounding);
 106
 107             int proxy = index.data(Qt::UserRole + 5).toInt();
 108             if (proxy > 0) {
 109                 QRectF txtBounding;
 110                 QString proxyText;
 111                 QBrush brush;
 112                 QColor color;
 113                 if (proxy == PROXYDONE) {
 114                     proxyText = i18n("Proxy");
 115                     brush = option.palette.mid();
 116                     color = option.palette.color(QPalette::WindowText);
 117                 }
 118                 else {
 119                     switch (proxy)  {
 120                         case CREATINGPROXY:
 121                             proxyText = i18n("Generating proxy ...");
 122                             break;
 123                         case PROXYWAITING:
 124                             proxyText = i18n("Waiting proxy ...");
 125                             break;
 126                         case PROXYCRASHED:
 127                         default:
 128                             proxyText = i18n("Proxy crashed");
 129                     }
 130                     brush = option.palette.highlight();
 131                     color = option.palette.color(QPalette::HighlightedText);
 132                 }
 133
 134                 txtBounding = painter->boundingRect(r2, Qt::AlignRight | Qt::AlignVCenter, " " + proxyText + " ");
 135                 painter->setPen(Qt::NoPen);
 136                 painter->setBrush(brush);
 137                 painter->drawRoundedRect(txtBounding, 2, 2);
 138                 painter->setPen(option.palette.highlightedText().color());
 139                 painter->drawText(txtBounding, Qt::AlignHCenter | Qt::AlignVCenter , proxyText);
 140             }
 141
 142             painter->restore();
 143         } else if (index.column() == 2 && KdenliveSettings::activate_nepomuk()) {
 144             if (index.data().toString().isEmpty()) {
 145                 QStyledItemDelegate::paint(painter, option, index);
 146                 return;
 147             }
 148             QRect r1 = option.rect;
 149             if (option.state & (QStyle::State_Selected)) {
 150                 painter->fillRect(r1, option.palette.highlight());
 151             }
 152 #ifdef NEPOMUK
 153             KRatingPainter::paintRating(painter, r1, Qt::AlignCenter, index.data().toInt());
 154 #endif
 155         } else {
 156             QStyledItemDelegate::paint(painter, option, index);
 157         }
 158     }
 159 };
 160
 161 class ProjectList : public QWidget
 162 {
 163     Q_OBJECT
 164
 165 public:
 166     ProjectList(QWidget *parent = 0);
 167     virtual ~ProjectList();
 168
 169     QDomElement producersList();
 170     void setRenderer(Render *projectRender);
 171     void slotUpdateClipProperties(const QString &id, QMap <QString, QString> properties);
 172     QByteArray headerInfo() const;
 173     void setHeaderInfo(const QByteArray &state);
 174     void updateProjectFormat(Timecode t);
 175     void setupMenu(QMenu *addMenu, QAction *defaultAction);
 176     void setupGeneratorMenu(QMenu *addMenu, QMenu *transcodeMenu, QMenu *inTimelineMenu);
 177     QString currentClipUrl() const;
 178     KUrl::List getConditionalUrls(const QString &condition) const;
 179     QDomDocument generateTemplateXml(QString data, const QString &replaceString);
 180     void cleanup();
 181     void trashUnusedClips();
 182     QList <DocClipBase*> documentClipList() const;
 183     void addClipCut(const QString &id, int in, int out, const QString desc, bool newItem);
 184     void removeClipCut(const QString &id, int in, int out);
 185     void focusTree() const;
 186     SubProjectItem *getSubItem(ProjectItem *clip, QPoint zone);
 187     void doUpdateClipCut(const QString &id, const QPoint oldzone, const QPoint zone, const QString &comment);
 188     bool hasMissingClips();
 189     void deleteProjectFolder(QMap <QString, QString> map);
 190     void selectItemById(const QString &clipId);
 191
 192     /** @brief Returns a string list of all supported mime extensions. */
 193     static QString getExtensions();
 194     /** @brief Returns a list of urls containing original and proxy urls. */
 195     QMap <QString, QString> getProxies();
 196     /** @brief Enable / disable proxies. */
 197     void updateProxyConfig();
 198     /** @brief Get a property from the document. */
 199     QString getDocumentProperty(const QString &key) const;
 200
 201     /** @brief Does this project allow proxies. */
 202     bool useProxy() const;
 203     /** @brief Should we automatically create proxy clips for newly added clips. */
 204     bool generateProxy() const;
 205     /** @brief Should we automatically create proxy clips for newly added clips. */
 206     bool generateImageProxy() const;
 207     /** @brief Returns a list of the expanded folder ids. */
 208     QStringList expandedFolders() const;
 209
 210 public slots:
 211     void setDocument(KdenliveDoc *doc);
 212     void updateAllClips(bool displayRatioChanged, bool fpsChanged);
 213     void slotReplyGetImage(const QString &clipId, const QPixmap &pix);
 214     void slotReplyGetFileProperties(const QString &clipId, Mlt::Producer *producer, const QMap < QString, QString > &properties, const QMap < QString, QString > &metadata, bool replace, bool selectClip);
 215     void slotAddClip(DocClipBase *clip, bool getProperties);
 216     void slotDeleteClip(const QString &clipId);
 217     void slotUpdateClip(const QString &id);
 218     void slotRefreshClipThumbnail(const QString &clipId, bool update = true);
 219     void slotRefreshClipThumbnail(QTreeWidgetItem *item, bool update = true);
 220     void slotRemoveInvalidClip(const QString &id, bool replace);
 221     void slotRemoveInvalidProxy(const QString &id, bool durationError);
 222     void slotSelectClip(const QString &ix);
 223
 224     /** @brief Prepares removing the selected items. */
 225     void slotRemoveClip();
 226     void slotAddClip(const QList <QUrl> givenList = QList <QUrl> (), const QString &groupName = QString(), const QString &groupId = QString());
 227
 228     /** @brief Adds, edits or deletes a folder item.
 229     *
 230     * This is triggered by AddFolderCommand and EditFolderCommand. */
 231     void slotAddFolder(const QString foldername, const QString &clipId, bool remove, bool edit = false);
 232     void slotResetProjectList();
 233     void slotOpenClip();
 234     void slotEditClip();
 235     void slotReloadClip(const QString &id = QString());
 236
 237     /** @brief Shows dialog for setting up a color clip. */
 238     void slotAddColorClip();
 239     void regenerateTemplate(const QString &id);
 240     void slotUpdateClipCut(QPoint p);
 241     void slotAddClipCut(const QString &id, int in, int out);
 242     void slotForceProcessing(const QString &id);
 243
 244 private:
 245     ProjectListView *m_listView;
 246     Render *m_render;
 247     Timecode m_timecode;
 248     double m_fps;
 249     QMenu *m_menu;
 250     QFuture<void> m_queueRunner;
 251     QUndoStack *m_commandStack;
 252     ProjectItem *getItemById(const QString &id);
 253     QTreeWidgetItem *getAnyItemById(const QString &id);
 254     FolderProjectItem *getFolderItemById(const QString &id);
 255     QAction *m_openAction;
 256     QAction *m_reloadAction;
 257     QMenu *m_transcodeAction;
 258     KdenliveDoc *m_doc;
 259     ItemDelegate *m_listViewDelegate;
 260     /** @brief True if we have not yet finished opening the document. */
 261     bool m_refreshed;
 262     QToolButton *m_addButton;
 263     QToolButton *m_deleteButton;
 264     QToolButton *m_editButton;
 265     QMap <QString, QDomElement> m_infoQueue;
 266     QMap <QString, QDomElement> m_producerQueue;
 267     void requestClipInfo(const QDomElement xml, const QString id);
 268     QList <QString> m_thumbnailQueue;
 269     QAction *m_proxyAction;
 270     QStringList m_processingClips;
 271     /** @brief Holds a list of ids for the clips that need to be proxied. */
 272     QStringList m_proxyList;
 273     /** @brief Holds a list of proxy clip that should be aborted. */
 274     QStringList m_abortProxyId;
 275
 276     void requestClipThumbnail(const QString id);
 277
 278     /** @brief Creates an EditFolderCommand to change the name of an folder item. */
 279     void editFolder(const QString folderName, const QString oldfolderName, const QString &clipId);
 280
 281     /** @brief Gets the selected folder (or the folder of the selected item). */
 282     QStringList getGroup() const;
 283     void regenerateTemplate(ProjectItem *clip);
 284     void editClipSelection(QList<QTreeWidgetItem *> list);
 285
 286     /** @brief Enables and disables transcode actions based on the selected clip's type. */
 287     void adjustTranscodeActions(ProjectItem *clip) const;
 288     /** @brief Enables and disables proxy action based on the selected clip. */
 289     void adjustProxyActions(ProjectItem *clip) const;
 290
 291     /** @brief Sets the buttons enabled/disabled according to selected item. */
 292     void updateButtons() const;
 293
 294     /** @brief Set the Proxy status on a clip.
 295      * @param item The clip item to set status
 296      * @param status The proxy status (see definitions.h) */
 297     void setProxyStatus(const QString id, PROXYSTATUS status);
 298     void setProxyStatus(ProjectItem *item, PROXYSTATUS status);
 299
 300     void monitorItemEditing(bool enable);
 301
 302 private slots:
 303     void slotClipSelected();
 304     void slotAddSlideshowClip();
 305     void slotAddTitleClip();
 306     void slotAddTitleTemplateClip();
 307
 308     /** @brief Shows the context menu after enabling and disabling actions based on the item's type.
 309     * @param pos The position where the menu should pop up
 310     * @param item The item for which the checks should be done */
 311     void slotContextMenu(const QPoint &pos, QTreeWidgetItem *item);
 312
 313     /** @brief Creates an AddFolderCommand. */
 314     void slotAddFolder();
 315
 316     /** @brief This is triggered when a clip description has been modified. */
 317     void slotItemEdited(QTreeWidgetItem *item, int column);
 318     void slotUpdateClipProperties(ProjectItem *item, QMap <QString, QString> properties);
 319     void slotProcessNextClipInQueue();
 320     void slotProcessNextThumbnail();
 321     void slotCheckForEmptyQueue();
 322     void slotPauseMonitor();
 323     /** A clip was modified externally, change icon so that user knows it */
 324     void slotModifiedClip(const QString &id);
 325     void slotMissingClip(const QString &id);
 326     void slotAvailableClip(const QString &id);
 327     /** @brief Try to find a matching profile for given item. */
 328     bool adjustProjectProfileToItem(ProjectItem *item = NULL);
 329     /** @brief Add a sequence from the stopmotion widget. */
 330     void slotAddOrUpdateSequence(const QString frameName);
 331     /** @brief A proxy clip was created, update display. */
 332     void slotGotProxy(const QString &id);
 333     /** @brief Enable / disable proxy for current clip. */
 334     void slotProxyCurrentItem(bool doProxy);
 335     /** @brief Put clip in the proxy waiting list. */
 336     void slotCreateProxy(const QString id);
 337     /** @brief Stop creation of this clip's proxy. */
 338     void slotAbortProxy(const QString id);
 339     /** @brief Start creation of proxy clip. */
 340     void slotGenerateProxy(const QString id);
 341
 342 signals:
 343     void clipSelected(DocClipBase *, QPoint zone = QPoint());
 344     void getFileProperties(const QDomElement, const QString &, int pixHeight, bool, bool);
 345     void receivedClipDuration(const QString &);
 346     void showClipProperties(DocClipBase *);
 347     void showClipProperties(QList <DocClipBase *>, QMap<QString, QString> commonproperties);
 348     void projectModified();
 349     void loadingIsOver();
 350     void displayMessage(const QString, int progress);
 351     void clipNameChanged(const QString, const QString);
 352     void clipNeedsReload(const QString&, bool);
 353     /** @brief A property affecting display was changed, so we need to update monitors and thumbnails
 354      *  @param id: The clip's id string
 355      *  @param resetThumbs Should we recreate the timeline thumbnails. */
 356     void refreshClip(const QString &id, bool resetThumbs);
 357     void updateRenderStatus();
 358     void deleteProjectClips(QStringList ids, QMap <QString, QString> folderids);
 359     void findInTimeline(const QString &clipId);
 360     /** @brief Request a profile change for current document. */
 361     void updateProfile(const QString &);
 362     void processNextThumbnail();
 363 };
 364
 365 #endif
 366