Clip.h 5.95 KB
Newer Older
1
/*****************************************************************************
2
 * Clip.h : Represents a basic container for media informations.
3
 *****************************************************************************
4
 * Copyright (C) 2008-2016 VideoLAN
5
 *
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
6
 * Authors: Hugo Beauzée-Luyssen <hugo@beauzee.fr>
7
 *          Yikei Lu    <luyikei.qmltu@gmail.com>
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * 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.
 *****************************************************************************/

/** \file
  * This file contains the Clip class declaration/definition.
  * It's used by the timeline in order to represent a subset of a media
  */

#ifndef CLIP_H__
# define CLIP_H__

luyikei's avatar
luyikei committed
32
#include "Workflow/Helper.h"
33
#include <QStringList>
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
34
#include <QUuid>
35
#include <QXmlStreamWriter>
36
#include "Backend/IProducer.h"
37

38 39
#include <memory>

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
40
class   MediaContainer;
41
class   Media;
luyikei's avatar
luyikei committed
42
class   ClipWorkflow;
43

luyikei's avatar
luyikei committed
44
class   Clip : public Workflow::Helper
45 46 47 48
{
    Q_OBJECT

    public:
luyikei's avatar
luyikei committed
49 50 51 52 53 54 55 56
        enum    Format
        {
            None          = 0,
            Audio         = 1 << 0,
            Video         = 1 << 1,
        };
        Q_DECLARE_FLAGS( Formats, Format )

57
        static const int DefaultFPS;
58 59 60 61 62 63 64 65 66
        /**
         *  \brief  Constructs a Clip that is a subpart of a Media.
         *
         *  \param  parent  The media to represent.
         *  \param  begin   The clip beginning (in frames, from the parent's beginning)
         *  \param  end     The end, in frames, from the parent's beginning. If not given,
         *                  the end of the parent will be used.
         *  \param  uuid    A unique identifier. If not given, one will be generated.
         */
67
        Clip( Media *parent, qint64 begin = 0, qint64 end = Backend::IProducer::EndOfMedia, const QString &uuid = QString() );
68 69 70 71 72 73 74 75 76
        /**
         *  \brief  Clones a Clip, potentially with a new begin and end.
         *
         *  \param  creator The clip to clone.
         *  \param  begin   The clip beginning (in frames, from the parent's beginning).
         *                  If not given, 0 is assumed.
         *  \param  end     The end, in frames, from the parent's beginning. If not given,
         *                  the end of the parent will be used.
         */
77
        Clip( Clip *creator, qint64 begin = -1, qint64 end = Backend::IProducer::EndOfParent, const QString& uuid = QString() );
78
        virtual ~Clip();
79

80
        /**
81
            \return         Returns the clip length in seconds.
82
        */
83
        qint64              lengthSecond() const;
84

85
        /**
86
            \return         Returns the Media that the clip was basep uppon.
87
        */
luyikei's avatar
luyikei committed
88 89
        Media*              media();
        const Media*        media() const;
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
90

luyikei's avatar
luyikei committed
91 92
        Clip                *parent();
        const Clip          *parent() const;
93 94
        MediaContainer*     mediaContainer();
        const MediaContainer*     mediaContainer() const;
95 96

        /**
97 98
            \brief          Returns an unique Uuid for this clip (which is NOT the
                            parent's Uuid).
99

100
            \return         The Clip's Uuid as a QUuid
101
        */
102
        const QUuid         &uuid() const;
103
        void                setUuid( const QUuid &uuid );
104

105 106 107 108 109 110 111
        virtual qint64      begin() const override;
        virtual qint64      end() const override;
        virtual void        setBegin( qint64 begin ) override;
        virtual void        setEnd( qint64 end ) override;
        virtual qint64      length() const override;
        virtual void        setBoundaries( qint64 begin, qint64 end ) override;

112 113 114
        const QStringList   &metaTags() const;
        void                setMetaTags( const QStringList &tags );
        bool                matchMetaTag( const QString &tag ) const;
115

116 117
        const QString       &notes() const;
        void                setNotes( const QString &notes );
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
118

119 120
        bool                isRootClip() const;
        Clip*               rootClip();
121

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
122 123 124 125 126
        /**
         *  \brief          Clear all the clip subclips recursively.
         */
        void                clear();

127
        bool                addSubclip( Clip* clip );
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
128

129 130 131 132 133
        /**
         *  \return         true if the clip is a child of the given clip uuid
         */
        bool                isChild( const QUuid& uuid ) const;

luyikei's avatar
luyikei committed
134 135 136
        QVariant            toVariant() const;
        QVariant            toVariantFull() const;

luyikei's avatar
luyikei committed
137 138 139
        Formats             formats() const;
        void                setFormats( Formats formats );

140
        Backend::IProducer* producer();
luyikei's avatar
luyikei committed
141

142
    private:
143
        Media*              m_media;
144
        std::unique_ptr<Backend::IProducer> m_producer;
luyikei's avatar
luyikei committed
145

146 147
        QStringList         m_metaTags;
        QString             m_notes;
148

149 150 151 152 153 154 155
        /**
         *  \brief          Return the root clip.
         *
         *  The root clip is the base clip for the parent media.
         */
        Clip*               m_rootClip;

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
156 157 158 159
        MediaContainer*     m_childs;

        Clip*               m_parent;

luyikei's avatar
luyikei committed
160 161 162 163
        Formats             m_formats;

        ClipWorkflow*       m_clipWorkflow;

164
    private slots:
165
        void                mediaMetadataUpdated();
166

167
    signals:
168 169 170 171
        /**
         *  \brief          Act just like QObject::destroyed(), but before the clip deletion.
         */
        void                unloaded( Clip* );
172 173
};

luyikei's avatar
luyikei committed
174 175
Q_DECLARE_OPERATORS_FOR_FLAGS( Clip::Formats )

176
#endif //CLIP_H__