/****************************************************************************

**

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

** All rights reserved.

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

**

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

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

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

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

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

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

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

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

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

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

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

**

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

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

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

**

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

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

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qvideoframe.h"

#include <private/qimagevideobuffer_p.h>

#include <private/qmemoryvideobuffer_p.h>

#include <qimage.h>

#include <qpair.h>

#include <qsize.h>

#include <qvariant.h>

#include <qvector.h>

QT_BEGIN_NAMESPACE

class QVideoFramePrivate : public QSharedData

{

public:

    QVideoFramePrivate()

        : startTime(-1)

        , endTime(-1)

        , data(0)

        , numBytes(0)

        , bytesPerLine(0)

        , pixelFormat(QVideoFrame::Format_Invalid)

        , fieldType(QVideoFrame::ProgressiveFrame)

        , buffer(0)

    {

    }

    QVideoFramePrivate(const QSize &size, QVideoFrame::PixelFormat format)

        : size(size)

        , startTime(-1)

        , endTime(-1)

        , data(0)

        , numBytes(0)

        , bytesPerLine(0)

        , pixelFormat(format)

        , fieldType(QVideoFrame::ProgressiveFrame)

        , buffer(0)

    {

    }

    ~QVideoFramePrivate()

    {

        delete buffer;

    }

    QSize size;

    qint64 startTime;

    qint64 endTime;

    uchar *data;

    int numBytes;

    int bytesPerLine;

    QVideoFrame::PixelFormat pixelFormat;

    QVideoFrame::FieldType fieldType;

    QAbstractVideoBuffer *buffer;

private:

    Q_DISABLE_COPY(QVideoFramePrivate)

};

/*!

    \class QVideoFrame

    \brief The QVideoFrame class provides a representation of a frame of video data.

    \preliminary

    \since 4.6

    A QVideoFrame encapsulates the data of a video frame, and information about the frame.

    The contents of a video frame can be mapped to memory using the map() function.  While

    mapped the video data can accessed using the bits() function which returns a pointer to a

    buffer, the total size of which is given by the numBytes(), and the size of each line is given

    by bytesPerLine().  The return value of the handle() function may be used to access frame data

    using the internal buffer's native APIs.

    The video data in a QVideoFrame is encapsulated in a QAbstractVideoBuffer.  A QVideoFrame

    may be constructed from any buffer type by subclassing the QAbstractVideoBuffer class.

    \note QVideoFrame is explicitly shared, any change made to video frame will also apply to any

    copies.

*/

/*!

    \enum QVideoFrame::PixelFormat

    Enumerates video data types.

    \value Format_Invalid

    The frame is invalid. 

    \value Format_ARGB32

    The frame is stored using a 32-bit ARGB format (0xAARRGGBB).  This is equivalent to

    QImage::Format_ARGB32.

    \value Format_ARGB32_Premultiplied

    The frame stored using a premultiplied 32-bit ARGB format (0xAARRGGBB).  This is equivalent

    to QImage::Format_ARGB32_Premultiplied.

    \value Format_RGB32

    The frame stored using a 32-bit RGB format (0xffRRGGBB).  This is equivalent to

    QImage::Format_RGB32

    \value Format_RGB24

    The frame is stored using a 24-bit RGB format (8-8-8).  This is equivalent to

    QImage::Format_RGB888

    \value Format_RGB565

    The frame is stored using a 16-bit RGB format (5-6-5).  This is equivalent to

    QImage::Format_RGB16.

    \value Format_RGB555

    The frame is stored using a 16-bit RGB format (5-5-5).  This is equivalent to

    QImage::Format_RGB555.

    \value Format_ARGB8565_Premultiplied

    The frame is stored using a 24-bit premultiplied ARGB format (8-6-6-5).

    \value Format_BGRA32

    The frame is stored using a 32-bit ARGB format (0xBBGGRRAA).

    \value Format_BGRA32_Premultiplied

    The frame is stored using a premultiplied 32bit BGRA format.

    \value Format_BGR32

    The frame is stored using a 32-bit BGR format (0xBBGGRRff).

    \value Format_BGR24

    The frame is stored using a 24-bit BGR format (0xBBGGRR).

    \value Format_BGR565

    The frame is stored using a 16-bit BGR format (5-6-5).

    \value Format_BGR555

    The frame is stored using a 16-bit BGR format (5-5-5).

    \value Format_BGRA5658_Premultiplied

    The frame is stored using a 24-bit premultiplied BGRA format (5-6-5-8).

    \value Format_AYUV444

    The frame is stored using a packed 32-bit AYUV format (0xAAYYUUVV).

    \value Format_AYUV444_Premultiplied

    The frame is stored using a packed premultiplied 32-bit AYUV format (0xAAYYUUVV).

    \value Format_YUV444

    The frame is stored using a 24-bit packed YUV format (8-8-8).

    \value Format_YUV420P

    The frame is stored using an 8-bit per component planar YUV format with the U and V planes

    horizontally and vertically sub-sampled, i.e. the height and width of the U and V planes are

    half that of the Y plane.

    \value Format_YV12

    The frame is stored using an 8-bit per component planar YVU format with the V and U planes

    horizontally and vertically sub-sampled, i.e. the height and width of the V and U planes are

    half that of the Y plane.

    \value Format_UYVY

    The frame is stored using an 8-bit per component packed YUV format with the U and V planes

    horizontally sub-sampled (U-Y-V-Y), i.e. two horizontally adjacent pixels are stored as a 32-bit

    macropixel which has a Y value for each pixel and common U and V values.

    \value Format_YUYV

    The frame is stored using an 8-bit per component packed YUV format with the U and V planes

    horizontally sub-sampled (Y-U-Y-V), i.e. two horizontally adjacent pixels are stored as a 32-bit

    macropixel which has a Y value for each pixel and common U and V values.

    \value Format_NV12

    The frame is stored using an 8-bit per component semi-planar YUV format with a Y plane (Y)

    followed by a horizontally and vertically sub-sampled, packed UV plane (U-V).

    \value Format_NV21

    The frame is stored using an 8-bit per component semi-planar YUV format with a Y plane (Y)

    followed by a horizontally and vertically sub-sampled, packed VU plane (V-U).

    \value Format_IMC1

    The frame is stored using an 8-bit per component planar YUV format with the U and V planes

    horizontally and vertically sub-sampled.  This is similar to the Format_YUV420P type, except

    that the bytes per line of the U and V planes are padded out to the same stride as the Y plane.

    \value Format_IMC2

    The frame is stored using an 8-bit per component planar YUV format with the U and V planes

    horizontally and vertically sub-sampled.  This is similar to the Format_YUV420P type, except

    that the lines of the U and V planes are interleaved, i.e. each line of U data is followed by a

    line of V data creating a single line of the same stride as the Y data.

    \value Format_IMC3

    The frame is stored using an 8-bit per component planar YVU format with the V and U planes

    horizontally and vertically sub-sampled.  This is similar to the Format_YV12 type, except that

    the bytes per line of the V and U planes are padded out to the same stride as the Y plane.

    \value Format_IMC4

    The frame is stored using an 8-bit per component planar YVU format with the V and U planes

    horizontally and vertically sub-sampled.  This is similar to the Format_YV12 type, except that

    the lines of the V and U planes are interleaved, i.e. each line of V data is followed by a line

    of U data creating a single line of the same stride as the Y data.

    \value Format_Y8

    The frame is stored using an 8-bit greyscale format.

    \value Format_Y16

    The frame is stored using a 16-bit linear greyscale format.  Little endian.

    \value Format_User

    Start value for user defined pixel formats.

*/

/*!

    \enum QVideoFrame::FieldType

    Specifies the field an interlaced video frame belongs to.

    \value ProgressiveFrame The frame is not interlaced.

    \value TopField The frame contains a top field.

    \value BottomField The frame contains a bottom field.

    \value InterlacedFrame The frame contains a merged top and bottom field.

*/

/*!

    Constructs a null video frame.

*/

QVideoFrame::QVideoFrame()

    : d(new QVideoFramePrivate)

{

}

/*!

    Constructs a video frame from a \a buffer of the given pixel \a format and \a size in pixels.

    \note This doesn't increment the reference count of the video buffer.

*/

QVideoFrame::QVideoFrame(

        QAbstractVideoBuffer *buffer, const QSize &size, PixelFormat format)

    : d(new QVideoFramePrivate(size, format))

{

    d->buffer = buffer;

}

/*!

    Constructs a video frame of the given pixel \a format and \a size in pixels.

    The \a bytesPerLine (stride) is the length of each scan line in bytes, and \a bytes is the total

    number of bytes that must be allocated for the frame.

*/

QVideoFrame::QVideoFrame(int bytes, const QSize &size, int bytesPerLine, PixelFormat format)

    : d(new QVideoFramePrivate(size, format))

{

    if (bytes > 0) {

        QByteArray data;

        data.resize(bytes);

        // Check the memory was successfully allocated.

        if (!data.isEmpty())

            d->buffer = new QMemoryVideoBuffer(data, bytesPerLine);

    }

}

/*!

    Constructs a video frame from an \a image.

    \note This will construct an invalid video frame if there is no frame type equivalent to the

    image format.

    \sa equivalentPixelFormat()

*/

QVideoFrame::QVideoFrame(const QImage &image)

    : d(new QVideoFramePrivate(

            image.size(), equivalentPixelFormat(image.format())))

{

    if (d->pixelFormat != Format_Invalid)

        d->buffer = new QImageVideoBuffer(image);

}

/*!

    Constructs a copy of \a other.

*/

QVideoFrame::QVideoFrame(const QVideoFrame &other)

    : d(other.d)

{

}

/*!

    Assigns the contents of \a other to a video frame.

*/

QVideoFrame &QVideoFrame::operator =(const QVideoFrame &other)

{

    d = other.d;

    return *this;

}

/*!

    Destroys a video frame.

*/

QVideoFrame::~QVideoFrame()

{

}

/*!

    Identifies whether a video frame is valid.

    An invalid frame has no video buffer associated with it.

    Returns true if the frame is valid, and false if it is not.

*/

bool QVideoFrame::isValid() const

{

    return d->buffer != 0;

}

/*!

    Returns the color format of a video frame.

*/

QVideoFrame::PixelFormat QVideoFrame::pixelFormat() const

{

    return d->pixelFormat;

}

/*!

    Returns the type of a video frame's handle.

*/

QAbstractVideoBuffer::HandleType QVideoFrame::handleType() const

{

    return d->buffer ? d->buffer->handleType() : QAbstractVideoBuffer::NoHandle;

}

/*!

    Returns the size of a video frame.

*/

QSize QVideoFrame::size() const

{

    return d->size;

}

/*!

    Returns the width of a video frame.

*/

int QVideoFrame::width() const

{

    return d->size.width();

}

/*!

    Returns the height of a video frame.

*/

int QVideoFrame::height() const

{

    return d->size.height();

}

/*!

    Returns the field an interlaced video frame belongs to.

    If the video is not interlaced this will return WholeFrame.

*/

QVideoFrame::FieldType QVideoFrame::fieldType() const

{

    return d->fieldType;

}

/*!

    Sets the \a field an interlaced video frame belongs to.

*/

void QVideoFrame::setFieldType(QVideoFrame::FieldType field)

{

    d->fieldType = field;

}

/*!

    Identifies if a video frame's contents are currently mapped to system memory.

    This is a convenience function which checks that the \l {QAbstractVideoBuffer::MapMode}{MapMode}

    of the frame is not equal to QAbstractVideoBuffer::NotMapped.

    Returns true if the contents of the video frame are mapped to system memory, and false

    otherwise.

    \sa mapMode() QAbstractVideoBuffer::MapMode

*/

bool QVideoFrame::isMapped() const

{

    return d->buffer != 0 && d->buffer->mapMode() != QAbstractVideoBuffer::NotMapped;

}

/*!

    Identifies if the mapped contents of a video frame will be persisted when the frame is unmapped.

    This is a convenience function which checks if the \l {QAbstractVideoBuffer::MapMode}{MapMode}

    contains the QAbstractVideoBuffer::WriteOnly flag.

    Returns true if the video frame will be updated when unmapped, and false otherwise.

    \note The result of altering the data of a frame that is mapped in read-only mode is undefined.

    Depending on the buffer implementation the changes may be persisted, or worse alter a shared

    buffer.

    \sa mapMode(), QAbstractVideoBuffer::MapMode

*/

bool QVideoFrame::isWritable() const

{

    return d->buffer != 0 && (d->buffer->mapMode() & QAbstractVideoBuffer::WriteOnly);

}

/*!

    Identifies if the mapped contents of a video frame were read from the frame when it was mapped.

    This is a convenience function which checks if the \l {QAbstractVideoBuffer::MapMode}{MapMode}

    contains the QAbstractVideoBuffer::WriteOnly flag.

    Returns true if the contents of the mapped memory were read from the video frame, and false

    otherwise.

    \sa mapMode(), QAbstractVideoBuffer::MapMode

*/

bool QVideoFrame::isReadable() const

{

    return d->buffer != 0 && (d->buffer->mapMode() & QAbstractVideoBuffer::ReadOnly);

}

/*!

    Returns the mode a video frame was mapped to system memory in.

    \sa map(), QAbstractVideoBuffer::MapMode

*/

QAbstractVideoBuffer::MapMode QVideoFrame::mapMode() const

{

    return d->buffer != 0 ? d->buffer->mapMode() : QAbstractVideoBuffer::NotMapped;

}

/*!

    Maps the contents of a video frame to memory.

    The map \a mode indicates whether the contents of the mapped memory should be read from and/or

    written to the frame.  If the map mode includes the QAbstractVideoBuffer::ReadOnly flag the

    mapped memory will be populated with the content of the video frame when mapped.  If the map

    mode inclues the QAbstractVideoBuffer::WriteOnly flag the content of the mapped memory will be

    persisted in the frame when unmapped.

    While mapped the contents of a video frame can be accessed directly through the pointer returned

    by the bits() function.

    When access to the data is no longer needed be sure to call the unmap() function to release the

    mapped memory.

    Returns true if the buffer was mapped to memory in the given \a mode and false otherwise.

    \sa unmap(), mapMode(), bits()

*/

bool QVideoFrame::map(QAbstractVideoBuffer::MapMode mode)

{

    if (d->buffer != 0 && d->data == 0) {

        Q_ASSERT(d->bytesPerLine == 0);

        Q_ASSERT(d->numBytes == 0);

        d->data = d->buffer->map(mode, &d->numBytes, &d->bytesPerLine);

        return d->data != 0;

    }

    return false;

}

/*!

    Releases the memory mapped by the map() function.

    If the \l {QAbstractVideoBuffer::MapMode}{MapMode} included the QAbstractVideoBuffer::WriteOnly

    flag this will persist the current content of the mapped memory to the video frame.