Clip.h 4.8 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 <QHash>
34
#include <QSharedPointer>
35
#include <QStringList>
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
36
#include <QUuid>
37
#include <QXmlStreamWriter>
luyikei's avatar
luyikei committed
38
#include "Backend/IInput.h"
39

40 41
#include <memory>

42
class   Media;
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.
         */
Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
67 68
        Clip( QSharedPointer<Media> parent, qint64 begin = 0, qint64 end = Backend::IInput::EndOfMedia, const QUuid &uuid = QStringLiteral() );

69
        virtual ~Clip();
70

71
        /**
72
            \return         Returns the clip length in seconds.
73
        */
74
        qint64              lengthSecond() const;
75

76
        /**
77
            \return         Returns the Media that the clip was basep uppon.
78
        */
79 80
        QSharedPointer<Media>       media();
        QSharedPointer<const Media> media() const;
Hugo Beauzee-Luyssen's avatar
Hugo Beauzee-Luyssen committed
81

82
        /**
83 84
            \brief          Returns an unique Uuid for this clip (which is NOT the
                            parent's Uuid).
85

86
            \return         The Clip's Uuid as a QUuid
87
        */
88
        const QUuid         &uuid() const override;
89
        void                setUuid( const QUuid &uuid );
90

91 92 93 94 95 96 97
        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;

luyikei's avatar
luyikei committed
98 99 100 101 102 103
        void                setLinkedClipUuid( const QUuid& uuid );
        const QUuid&        linkedClipUuid() const;

        void                setLinked( bool isLinked );
        bool                isLinked() const;

104 105 106
        const QStringList   &metaTags() const;
        void                setMetaTags( const QStringList &tags );
        bool                matchMetaTag( const QString &tag ) const;
107

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

luyikei's avatar
luyikei committed
111 112
        QVariant            toVariant() const;

luyikei's avatar
luyikei committed
113 114 115
        Formats             formats() const;
        void                setFormats( Formats formats );

luyikei's avatar
luyikei committed
116
        Backend::IInput* input();
luyikei's avatar
luyikei committed
117

Hugo Beauzée-Luyssen's avatar
Hugo Beauzée-Luyssen committed
118 119
        //FIXME: This shouldn't be represented in the Library
        void                loadFilters(const QVariantMap& v );
120

121
    private:
122 123
        QSharedPointer<Media>               m_media;
        std::unique_ptr<Backend::IInput>    m_input;
luyikei's avatar
luyikei committed
124

125 126
        QStringList         m_metaTags;
        QString             m_notes;
127

luyikei's avatar
luyikei committed
128 129 130
        QUuid               m_linkedClipUuid;
        bool                m_isLinked;

luyikei's avatar
luyikei committed
131 132
        Formats             m_formats;

133
    signals:
134 135 136 137
        /**
         *  \brief          Act just like QObject::destroyed(), but before the clip deletion.
         */
        void                unloaded( Clip* );
138 139
};

luyikei's avatar
luyikei committed
140 141
Q_DECLARE_OPERATORS_FOR_FLAGS( Clip::Formats )

142
#endif //CLIP_H__