1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

     5 ** Contact: Nokia Corporation (qt-info@nokia.com)

     6 **

     7 ** This file is part of the QtMultimedia module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

    11 ** This file contains pre-release code and may not be distributed.

    12 ** You may use this file in accordance with the terms and conditions

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

    17 ** Alternatively, this file may be used under the terms of the GNU Lesser

    18 ** General Public License version 2.1 as published by the Free Software

    19 ** Foundation and appearing in the file LICENSE.LGPL included in the

    20 ** packaging of this file.  Please review the following information to

    21 ** ensure the GNU Lesser General Public License version 2.1 requirements

    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

    23 **

    24 ** In addition, as a special exception, Nokia gives you certain additional

    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception

    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

    27 **

    28 ** If you have questions regarding the use of this file, please contact

    29 ** Nokia at qt-info@nokia.com.

    30 **

    31 **

    32 **

    33 **

    34 **

    35 **

    36 **

    37 **

    38 ** $QT_END_LICENSE$

    39 **

    40 ****************************************************************************/

    41 

    42 #ifndef QVIDEOSURFACEFORMAT_H

    43 #define QVIDEOSURFACEFORMAT_H

    44 

    45 #include <QtCore/qlist.h>

    46 #include <QtCore/qpair.h>

    47 #include <QtCore/qshareddata.h>

    48 #include <QtCore/qsize.h>

    49 #include <QtGui/qimage.h>

    50 #include <QtMultimedia/qvideoframe.h>

    51 

    52 QT_BEGIN_HEADER

    53 

    54 QT_BEGIN_NAMESPACE

    55 

    56 QT_MODULE(Multimedia)

    57 

    58 class QDebug;

    59 

    60 class QVideoSurfaceFormatPrivate;

    61 

    62 class Q_MULTIMEDIA_EXPORT QVideoSurfaceFormat

    63 {

    64 public:

    65     enum Direction

    66     {

    67         TopToBottom,

    68         BottomToTop

    69     };

    70 

    71     enum ViewportMode

    72     {

    73         ResetViewport,

    74         KeepViewport

    75     };

    76 

    77     enum YuvColorSpace

    78     {

    79         YCbCr_Undefined,

    80         YCbCr_BT601,

    81         YCbCr_BT709,

    82         YCbCr_xvYCC601,

    83         YCbCr_xvYCC709,

    84         YCbCr_JPEG,

    85 #ifndef qdoc

    86         YCbCr_CustomMatrix

    87 #endif

    88     };

    89 

    90     QVideoSurfaceFormat();

    91     QVideoSurfaceFormat(

    92             const QSize &size,

    93             QVideoFrame::PixelFormat pixelFormat,

    94             QAbstractVideoBuffer::HandleType handleType = QAbstractVideoBuffer::NoHandle);

    95     QVideoSurfaceFormat(const QVideoSurfaceFormat &format);

    96     ~QVideoSurfaceFormat();

    97 

    98     QVideoSurfaceFormat &operator =(const QVideoSurfaceFormat &format);

    99 

   100     bool operator ==(const QVideoSurfaceFormat &format) const;

   101     bool operator !=(const QVideoSurfaceFormat &format) const;

   102 

   103     bool isValid() const;

   104 

   105     QVideoFrame::PixelFormat pixelFormat() const;

   106     QAbstractVideoBuffer::HandleType handleType() const;

   107 

   108     QSize frameSize() const;

   109     void setFrameSize(const QSize &size, ViewportMode mode = ResetViewport);

   110     void setFrameSize(int width, int height, ViewportMode mode = ResetViewport);

   111 

   112     int frameWidth() const;

   113     int frameHeight() const;

   114 

   115     QRect viewport() const;

   116     void setViewport(const QRect &viewport);

   117 

   118     Direction scanLineDirection() const;

   119     void setScanLineDirection(Direction direction);

   120 

   121     qreal frameRate() const;

   122     void setFrameRate(qreal rate);

   123 

   124     QSize pixelAspectRatio() const;

   125     void setPixelAspectRatio(const QSize &ratio);

   126     void setPixelAspectRatio(int width, int height);

   127 

   128     YuvColorSpace yuvColorSpace() const;

   129     void setYuvColorSpace(YuvColorSpace colorSpace);

   130 

   131     QSize sizeHint() const;

   132 

   133     QList<QByteArray> propertyNames() const;

   134     QVariant property(const char *name) const;

   135     void setProperty(const char *name, const QVariant &value);

   136 

   137 private:

   138     QSharedDataPointer<QVideoSurfaceFormatPrivate> d;

   139 };

   140 

   141 #ifndef QT_NO_DEBUG_STREAM

   142 Q_MULTIMEDIA_EXPORT QDebug operator<<(QDebug, const QVideoSurfaceFormat &);

   143 #endif

   144 

   145 QT_END_NAMESPACE

   146 

   147 Q_DECLARE_METATYPE(QVideoSurfaceFormat::Direction)

   148 Q_DECLARE_METATYPE(QVideoSurfaceFormat::YuvColorSpace)

   149 

   150 QT_END_HEADER

   151 

   152 #endif

   153