Clip.h 6.83 KB
Newer Older
1
/*****************************************************************************
2
 * Clip.h : Represents a basic container for media informations.
3
 *****************************************************************************
Ludovic Fauvet's avatar
Ludovic Fauvet committed
4
 * Copyright (C) 2008-2010 VideoLAN
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31
 *
 * Authors: Hugo Beauzee-Luyssen <hugo@vlmc.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.
 *****************************************************************************/

/** \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__

#include <QObject>
32
#include <QStringList>
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
33
#include <QUuid>
34

Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
35
class   MediaContainer;
36
class   Media;
37

38
class   QXmlStreamWriter;
39

40 41 42 43 44
class   Clip : public QObject
{
    Q_OBJECT

    public:
45
        static const int DefaultFPS;
46 47 48 49 50 51 52 53 54
        /**
         *  \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.
         */
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
55
        Clip( Media *parent, qint64 begin = 0, qint64 end = -1, const QString &uuid = QString() );
56 57 58 59 60 61 62 63 64
        /**
         *  \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.
         */
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
65
        Clip( Clip *creator, qint64 begin = -1, qint64 end = -1, const QString& uuid = QString() );
66
        virtual ~Clip();
67

68 69
        qint64              begin() const;
        qint64              end() const;
70

71 72 73
        void                setBegin( qint64 begin, bool updateMax = false );
        void                setEnd( qint64 end, bool updateMax = false );
        void                setBoundaries( qint64 newBegin, qint64 newEnd, bool updateMax = false );
74

75
        /**
76
            \return         Returns the clip length in frame.
77
        */
78
        qint64              length() const;
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
        */
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
88
        Media*              getMedia();
89
        const Media*        getMedia() const;
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
90 91 92 93 94

        Clip                *getParent();
        const Clip          *getParent() const;
        MediaContainer*     getChilds();
        const MediaContainer*     getChilds() 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
        const QStringList   &metaTags() const;
        void                setMetaTags( const QStringList &tags );
        bool                matchMetaTag( const QString &tag ) const;
108

109 110
        const QString       &notes() const;
        void                setNotes( const QString &notes );
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
111

112 113
        qint64              maxBegin() const;
        qint64              maxEnd() const;
114

115
        void                computeLength();
116

117 118
        bool                isRootClip() const;
        Clip*               rootClip();
119

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

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

127 128
        void                save( QXmlStreamWriter& project );

129 130 131 132 133 134 135 136 137
        /**
         *  \brief          Generates a full Clip id
         *
         *  A full id is the list of all the parent Clip's UUID, separated by '/'
         *  IE, {uuid1}/{uuid2}/{uuid2}/{current-clip-uuid}
         *  \return     The full Clip id.
         */
        QString             fullId() const;

138 139 140 141 142
        /**
         *  \return         true if the clip is a child of the given clip uuid
         */
        bool                isChild( const QUuid& uuid ) const;

143
    private:
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
144
        Media               *m_media;
145 146 147 148
        /**
         *  \brief  This represents the beginning of the Clip in frames, from the
         *          beginning of the parent Media.
         */
149
        qint64              m_begin;
150 151 152 153
        /**
         *  \brief  This represents the end of the Clip in frames, from the
         *          beginning of the parent Media.
         */
154
        qint64              m_end;
155 156 157 158

        /**
         *  \brief  The length in frames
         */
159
        qint64              m_length;
160 161 162
        /**
         *  \brief  The length in seconds (Be carreful, VLC uses MILLIseconds)
         */
163
        qint64              m_lengthSeconds;
164 165 166 167 168
        /**
         *  The Clip's timeline UUID. Used to identify the Clip in the
         *  timeline, as a unique object, even if this clip is present more than
         *  once.
         */
169
        QUuid               m_uuid;
170 171
        QStringList         m_metaTags;
        QString             m_notes;
172

173 174 175 176
        /**
         *  This is used for the resize. The clip won't be abble to be resized beyond this value.
         *  ie this clip won't start before m_maxBegin.
         */
177
        qint64              m_maxBegin;
178 179 180 181 182

        /**
         *  This is used for the resize. The clip won't be abble to be resized beyond this value
         *  ie this clip won't end before m_maxEnd.
         */
183
        qint64              m_maxEnd;
184

185 186 187 188 189 190 191
        /**
         *  \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
192 193 194 195
        MediaContainer*     m_childs;

        Clip*               m_parent;

196
    signals:
197
        void                lengthUpdated();
198 199 200
};

#endif //CLIP_H__