]> git.sesse.net Git - kdenlive/blobdiff - src/projectlist.h
Merge branch 'stabilize' of git.kde.org:kdenlive into stabilize
[kdenlive] / src / projectlist.h
index f2a2d494ba5ba94956b1cb7070f9b8d368712596..423b3df9f96c00b230ad879e3e3b692f0c59f2ed 100644 (file)
-#ifndef PRJECTLIST_H
-#define PRJECTLIST_H
+/***************************************************************************
+ *   Copyright (C) 2007 by Jean-Baptiste Mardelle (jb@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) any later version.                                   *
+ *                                                                         *
+ *   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, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
+ ***************************************************************************/
+
+
+#ifndef PROJECTLIST_H
+#define PROJECTLIST_H
 
 #include <QDomNodeList>
+#include <QHash>
 #include <QToolBar>
+#include <QToolButton>
 #include <QTreeWidget>
+#include <QPainter>
+#include <QStyledItemDelegate>
+#include <QUndoStack>
+#include <QTimer>
+#include <QApplication>
+#include <QFuture>
+#include <QFutureSynchronizer>
+#include <QListWidget>
 
-#include <KUndoStack>
 #include <KTreeWidgetSearchLine>
+#include <KUrl>
+#include <KIcon>
+
+#ifdef NEPOMUK
+#include <nepomuk/kratingpainter.h>
+#include <nepomuk/resource.h>
+#endif
 
-#include "docclipbase.h"
-#include "kdenlivedoc.h"
-#include "renderer.h"
+#include "definitions.h"
 #include "timecode.h"
+#include "kdenlivesettings.h"
+#include "folderprojectitem.h"
+#include "subprojectitem.h"
+#include <kdialog.h>
+
+namespace Mlt
+{
+class Producer;
+};
+
+struct PROXYINFO {
+    QString dest;
+    QString src;
+    CLIPTYPE type;
+    int exif;
+};
+
+class ProjectItem;
+class ProjectListView;
+class Render;
+class KdenliveDoc;
+class DocClipBase;
+
+const int NameRole = Qt::UserRole;
+const int DurationRole = NameRole + 1;
+const int UsageRole = NameRole + 2;
+
+class InvalidDialog: public KDialog
+{
+    Q_OBJECT
+public:
+    InvalidDialog(const QString &caption, const QString &message, bool infoOnly, QWidget *parent = 0);
+    virtual ~InvalidDialog();
+    void addClip(const QString &id, const QString &path);
+    QStringList getIds() const;
+private:
+    QListWidget *m_clipList;
+};
+
+
+class ItemDelegate: public QStyledItemDelegate
+{
+public:
+    ItemDelegate(QAbstractItemView* parent = 0): QStyledItemDelegate(parent) {
+    }
+
+    /*void drawFocus(QPainter *, const QStyleOptionViewItem &, const QRect &) const {
+    }*/
+
+    void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& index) const {
+        if (index.column() == 0 && !index.data(DurationRole).isNull()) {
+            QRect r1 = option.rect;
+            painter->save();
+            QStyleOptionViewItemV4 opt(option);
+            QStyle *style = opt.widget ? opt.widget->style() : QApplication::style();
+            style->drawPrimitive(QStyle::PE_PanelItemViewItem, &opt, painter, opt.widget);
+
+            if (option.state & QStyle::State_Selected) {
+                painter->setPen(option.palette.highlightedText().color());
+            }
+            const int textMargin = style->pixelMetric(QStyle::PM_FocusFrameHMargin) + 1;
+            QPixmap pixmap = qVariantValue<QPixmap>(index.data(Qt::DecorationRole));
+            painter->drawPixmap(r1.left() + textMargin, r1.top() + (r1.height() - pixmap.height()) / 2, pixmap);
+            int decoWidth = pixmap.width() + 2 * textMargin;
+
+            QFont font = painter->font();
+            font.setBold(true);
+            painter->setFont(font);
+            int mid = (int)((r1.height() / 2));
+            r1.adjust(decoWidth, 0, 0, -mid);
+            QRect r2 = option.rect;
+            r2.adjust(decoWidth, mid, 0, 0);
+            painter->drawText(r1, Qt::AlignLeft | Qt::AlignBottom , index.data().toString());
+            font.setBold(false);
+            painter->setFont(font);
+            QString subText = index.data(DurationRole).toString();
+            int usage = index.data(UsageRole).toInt();
+            if (usage != 0) subText.append(QString(" (%1)").arg(usage));
+            if (option.state & (QStyle::State_Selected)) painter->setPen(option.palette.color(QPalette::Mid));
+            QRectF bounding;
+            painter->drawText(r2, Qt::AlignLeft | Qt::AlignVCenter , subText, &bounding);
+            
+            int proxy = index.data(Qt::UserRole + 5).toInt();
+            if (proxy != 0) {
+                QRectF txtBounding;
+                QString proxyText;
+                QBrush brush;
+                QColor color;
+                if (proxy > 0) {
+                    proxyText = QString::number(proxy) + "% ";
+                    proxyText.append(i18n("Generating proxy ..."));
+                    brush = option.palette.highlight();
+                    color = option.palette.color(QPalette::HighlightedText);
+                    
+                }
+                else if (proxy == PROXYDONE) {
+                    proxyText = i18n("Proxy");
+                    brush = option.palette.mid();
+                    color = option.palette.color(QPalette::WindowText);
+                }
+                else {
+                    switch (proxy)  {
+                        case CREATINGPROXY:
+                            proxyText = i18n("Generating proxy ...");
+                            break;
+                        case PROXYWAITING:
+                            proxyText = i18n("Waiting proxy ...");
+                            break;
+                        case PROXYCRASHED:
+                        default:
+                            proxyText = i18n("Proxy crashed");
+                    }
+                    brush = option.palette.highlight();
+                    color = option.palette.color(QPalette::HighlightedText);
+                }
+               
+                txtBounding = painter->boundingRect(r2, Qt::AlignRight | Qt::AlignVCenter, " " + proxyText + " ");
+                painter->setPen(Qt::NoPen);
+                painter->setBrush(brush);
+                painter->drawRoundedRect(txtBounding, 2, 2);
+                painter->setPen(option.palette.highlightedText().color());
+                painter->drawText(txtBounding, Qt::AlignHCenter | Qt::AlignVCenter , proxyText);
+            }
+            
+            painter->restore();
+        } else if (index.column() == 2 && KdenliveSettings::activate_nepomuk()) {
+            if (index.data().toString().isEmpty()) {
+                QStyledItemDelegate::paint(painter, option, index);
+                return;
+            }
+            QRect r1 = option.rect;
+            if (option.state & (QStyle::State_Selected)) {
+                painter->fillRect(r1, option.palette.highlight());
+            }
+#ifdef NEPOMUK
+            KRatingPainter::paintRating(painter, r1, Qt::AlignCenter, index.data().toInt());
+#endif
+        } else {
+            QStyledItemDelegate::paint(painter, option, index);
+        }
+    }
+};
 
 class ProjectList : public QWidget
 {
-  Q_OBJECT
-  
-  public:
-    ProjectList(KUndoStack *commandStack, QWidget *parent=0);
+    Q_OBJECT
+
+public:
+    ProjectList(QWidget *parent = 0);
+    virtual ~ProjectList();
 
     QDomElement producersList();
     void setRenderer(Render *projectRender);
+    void slotUpdateClipProperties(const QString &id, QMap <QString, QString> properties);
+    QByteArray headerInfo() const;
+    void setHeaderInfo(const QByteArray &state);
+    void updateProjectFormat(Timecode t);
+    void setupMenu(QMenu *addMenu, QAction *defaultAction);
+    void setupGeneratorMenu(const QHash<QString,QMenu*>& menus);
+    QString currentClipUrl() const;
+    KUrl::List getConditionalUrls(const QString &condition) const;
+    QDomDocument generateTemplateXml(QString data, const QString &replaceString);
+    void cleanup();
+    void trashUnusedClips();
+    QList <DocClipBase*> documentClipList() const;
+    void addClipCut(const QString &id, int in, int out, const QString desc, bool newItem);
+    void removeClipCut(const QString &id, int in, int out);
+    void focusTree() const;
+    SubProjectItem *getSubItem(ProjectItem *clip, QPoint zone);
+    void doUpdateClipCut(const QString &id, const QPoint oldzone, const QPoint zone, const QString &comment);
+    bool hasMissingClips();
+    void deleteProjectFolder(QMap <QString, QString> map);
+    void selectItemById(const QString &clipId);
 
-    void addClip(const QStringList &name, const QDomElement &elem, const int clipId, const KUrl &url = KUrl());
-    void deleteClip(const int clipId);
+    /** @brief Returns a string list of all supported mime extensions. */
+    static QString getExtensions();
+    /** @brief Returns a list of urls containing original and proxy urls. */
+    QMap <QString, QString> getProxies();
+    /** @brief Enable / disable proxies. */
+    void updateProxyConfig();
+    /** @brief Get a property from the document. */
+    QString getDocumentProperty(const QString &key) const;
+    
+    /** @brief Does this project allow proxies. */
+    bool useProxy() const;
+    /** @brief Should we automatically create proxy clips for newly added clips. */
+    bool generateProxy() const;
+    /** @brief Should we automatically create proxy clips for newly added clips. */
+    bool generateImageProxy() const;
+    /** @brief Returns a list of the expanded folder ids. */
+    QStringList expandedFolders() const;
+    /** @brief Deselect all clips in project tree. */
+    void clearSelection();
 
-  public slots:
+public slots:
     void setDocument(KdenliveDoc *doc);
-    void addProducer(QDomElement producer);
-    void slotReplyGetImage(int clipId, int pos, const QPixmap &pix, int w, int h);
-    void slotReplyGetFileProperties(int clipId, const QMap < QString, QString > &properties, const QMap < QString, QString > &metadata);
+    void updateAllClips(bool displayRatioChanged, bool fpsChanged, QStringList brokenClips);
+    void slotReplyGetImage(const QString &clipId, const QImage &img);
+    void slotReplyGetImage(const QString &clipId, const QString &name, int width, int height);
+    void slotReplyGetFileProperties(const QString &clipId, Mlt::Producer *producer, const stringMap &properties, const stringMap &metadata, bool replace);
+    void slotAddClip(DocClipBase *clip, bool getProperties);
+    void slotDeleteClip(const QString &clipId);
+    void slotUpdateClip(const QString &id);
+    void slotRefreshClipThumbnail(const QString &clipId, bool update = true);
+    void slotRefreshClipThumbnail(QTreeWidgetItem *item, bool update = true);
+    void slotRemoveInvalidClip(const QString &id, bool replace);
+    void slotRemoveInvalidProxy(const QString &id, bool durationError);
+    void slotSelectClip(const QString &ix);
+
+    /** @brief Prepares removing the selected items. */
+    void slotRemoveClip();
+    void slotAddClip(const QList <QUrl> givenList = QList <QUrl> (), const QString &groupName = QString(), const QString &groupId = QString());
 
+    /** @brief Adds, edits or deletes a folder item.
+    *
+    * This is triggered by AddFolderCommand and EditFolderCommand. */
+    void slotAddFolder(const QString foldername, const QString &clipId, bool remove, bool edit = false);
+    void slotResetProjectList();
+    void slotOpenClip();
+    void slotEditClip();
+    void slotReloadClip(const QString &id = QString());
+
+    /** @brief Shows dialog for setting up a color clip. */
+    void slotAddColorClip();
+    void regenerateTemplate(const QString &id);
+    void slotUpdateClipCut(QPoint p);
+    void slotAddClipCut(const QString &id, int in, int out);
+    void slotForceProcessing(const QString &id);
+    /** @brief Remove all instances of a proxy and delete the file. */
+    void slotDeleteProxy(const QString proxyPath);
 
-  private:
-    QTreeWidget *listView;
-    KTreeWidgetSearchLine *searchView;
+private:
+    ProjectListView *m_listView;
     Render *m_render;
     Timecode m_timecode;
     double m_fps;
-    QToolBar *m_toolbar;
-    KUndoStack *m_commandStack;
-    int m_clipIdCounter;
+    QMenu *m_menu;
+    QFuture<void> m_queueRunner;
+    QUndoStack *m_commandStack;
+    ProjectItem *getItemById(const QString &id);
+    QTreeWidgetItem *getAnyItemById(const QString &id);
+    FolderProjectItem *getFolderItemById(const QString &id);
+    QAction *m_openAction;
+    QAction *m_reloadAction;
+    QMenu *m_transcodeAction;
+    QMenu *m_stabilizeAction;
+    KdenliveDoc *m_doc;
+    ItemDelegate *m_listViewDelegate;
+    /** @brief False if we have not yet finished opening the document. */
+    bool m_refreshed;
+    /** @brief False if we have not yet finished checking all project tree thumbs. */
+    bool m_allClipsProcessed;
+    QToolButton *m_addButton;
+    QToolButton *m_deleteButton;
+    QToolButton *m_editButton;
+    //QMap <QString, QDomElement> m_infoQueue;
+    QMap <QString, QDomElement> m_producerQueue;
+    QList <QString> m_thumbnailQueue;
+    QAction *m_proxyAction;
+    QStringList m_processingClips;
+    /** @brief Holds a list of proxy urls that should be aborted. */
+    QStringList m_abortProxy;
+    /** @brief Holds a list of proxy urls that are currently being created. */
+    QStringList m_processingProxy;
+    QMutex m_mutex;
+    bool m_abortAllProxies;
+    QList <PROXYINFO> m_proxyList;
+    QFutureSynchronizer<void> m_proxyThreads;
+    InvalidDialog *m_invalidClipDialog;
+    
+    void requestClipThumbnail(const QString id);
 
-  private slots:
-    void slotAddClip();
-    void slotRemoveClip();
-    void slotEditClip();
+    /** @brief Creates an EditFolderCommand to change the name of an folder item. */
+    void editFolder(const QString folderName, const QString oldfolderName, const QString &clipId);
+
+    /** @brief Gets the selected folder (or the folder of the selected item). */
+    QStringList getGroup() const;
+    void regenerateTemplate(ProjectItem *clip);
+    void editClipSelection(QList<QTreeWidgetItem *> list);
+
+    /** @brief Enables and disables transcode actions based on the selected clip's type. */
+    void adjustTranscodeActions(ProjectItem *clip) const;
+    /** @brief Enables and disables stabilize actions based on the selected clip's type. */
+    void adjustStabilizeActions(ProjectItem *clip) const;
+    /** @brief Enables and disables proxy action based on the selected clip. */
+    void adjustProxyActions(ProjectItem *clip) const;
+
+    /** @brief Sets the buttons enabled/disabled according to selected item. */
+    void updateButtons() const;
+
+    /** @brief Set the Proxy status on a clip. 
+     * @param item The clip item to set status
+     * @param status The proxy status (see definitions.h) */
+    void setProxyStatus(ProjectItem *item, PROXYSTATUS status, int progress = 0);
+    /** @brief Process ffmpeg output to find out process progress. */
+    void processLogInfo(QList <ProjectItem *>items, int *duration, const QString &log);
+    void monitorItemEditing(bool enable);
+    /** @brief Set thumbnail for a project's clip. */
+    void setThumbnail(const QString &clipId, const QPixmap &pix);
+    /** @brief Get cached thumbnail for a project's clip or create it if no cache. */
+    void getCachedThumbnail(ProjectItem *item);
+    void getCachedThumbnail(SubProjectItem *item);
+    /** @brief The clip is about to be reloaded, cancel thumbnail requests. */
+    void resetThumbsProducer(DocClipBase *clip);
+
+private slots:
     void slotClipSelected();
-    void slotAddColorClip();
+    void slotAddSlideshowClip();
+    void slotAddTitleClip();
+    void slotAddTitleTemplateClip();
+
+    /** @brief Shows the context menu after enabling and disabling actions based on the item's type.
+    * @param pos The position where the menu should pop up
+    * @param item The item for which the checks should be done */
+    void slotContextMenu(const QPoint &pos, QTreeWidgetItem *item);
+
+    /** @brief Creates an AddFolderCommand. */
+    void slotAddFolder();
 
-  signals:
-    void clipSelected(const QDomElement &);
-    void getFileProperties(const QDomElement&, int);
+    /** @brief This is triggered when a clip description has been modified. */
+    void slotItemEdited(QTreeWidgetItem *item, int column);
+    void slotUpdateClipProperties(ProjectItem *item, QMap <QString, QString> properties);
+    void slotProcessNextThumbnail();
+    void slotCheckForEmptyQueue();
+    void slotPauseMonitor();
+    /** A clip was modified externally, change icon so that user knows it */
+    void slotModifiedClip(const QString &id);
+    void slotMissingClip(const QString &id);
+    void slotAvailableClip(const QString &id);
+    /** @brief Try to find a matching profile for given item. */
+    bool adjustProjectProfileToItem(ProjectItem *item = NULL);
+    /** @brief Add a sequence from the stopmotion widget. */
+    void slotAddOrUpdateSequence(const QString frameName);
+    /** @brief A proxy clip was created, update display. */
+    void slotGotProxy(const QString &proxyPath);
+    void slotGotProxy(ProjectItem *item);
+    /** @brief Enable / disable proxy for current clip. */
+    void slotProxyCurrentItem(bool doProxy, ProjectItem *itemToProxy = NULL);
+    /** @brief Put clip in the proxy waiting list. */
+    void slotCreateProxy(const QString id);
+    /** @brief Stop creation of this clip's proxy. */
+    void slotAbortProxy(const QString id, const QString path);
+    /** @brief Start creation of proxy clip. */
+    void slotGenerateProxy();
+
+signals:
+    void clipSelected(DocClipBase *, QPoint zone = QPoint());
+    void receivedClipDuration(const QString &);
+    void showClipProperties(DocClipBase *);
+    void showClipProperties(QList <DocClipBase *>, QMap<QString, QString> commonproperties);
+    void projectModified();
+    void loadingIsOver();
+    void displayMessage(const QString, int progress);
+    void clipNameChanged(const QString, const QString);
+    void clipNeedsReload(const QString&);
+    /** @brief A property affecting display was changed, so we need to update monitors and thumbnails
+     *  @param id: The clip's id string
+     *  @param resetThumbs Should we recreate the timeline thumbnails. */
+    void refreshClip(const QString &id, bool resetThumbs);
+    void updateRenderStatus();
+    void deleteProjectClips(QStringList ids, QMap <QString, QString> folderids);
+    void findInTimeline(const QString &clipId);
+    /** @brief Request a profile change for current document. */
+    void updateProfile(const QString &);
+    void processNextThumbnail();
+    /** @brief Activate the clip monitor. */
+    void raiseClipMonitor();
 };
 
 #endif
+