epoc32/include/mmf/server/mmfvideoframebuffer.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// include\mmf\server\mmfvideoframebuffer.h
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
williamr@2
    19
#ifndef __MMF_SERVER_VIDEOFRAMEBUFFER_H__
williamr@2
    20
#define __MMF_SERVER_VIDEOFRAMEBUFFER_H__
williamr@2
    21
williamr@2
    22
#include <e32base.h>
williamr@2
    23
#include <fbs.h>
williamr@2
    24
#include <mmf/server/mmfbuffer.h>
williamr@2
    25
williamr@2
    26
williamr@2
    27
/**
williamr@2
    28
@publishedAll
williamr@2
    29
@deprecated
williamr@2
    30
williamr@2
    31
Class to store a frame of video data using an EPOC bitmap (RGB data).
williamr@2
    32
*/
williamr@2
    33
class CMMFBitmapFrameBuffer : public CMMFBuffer
williamr@2
    34
	{
williamr@2
    35
public:
williamr@2
    36
	IMPORT_C ~CMMFBitmapFrameBuffer();
williamr@2
    37
	IMPORT_C static CMMFBitmapFrameBuffer* NewL(const TSize& aSize,TDisplayMode aDisplayMode);
williamr@2
    38
	IMPORT_C static CMMFBitmapFrameBuffer* NewL(TInt aBitmapHandle);
williamr@2
    39
	inline TUint BufferSize() const;
williamr@2
    40
	inline CFbsBitmap* Data();
williamr@2
    41
private:
williamr@2
    42
	CMMFBitmapFrameBuffer() : CMMFBuffer(KUidMmfBitmapFrameBuffer) {};
williamr@2
    43
	void ConstructL();
williamr@2
    44
private:
williamr@2
    45
	CFbsBitmap* iFrame;
williamr@2
    46
	};
williamr@2
    47
williamr@2
    48
/**
williamr@2
    49
Dummy implementation. Not applicable to bitmap frame data.
williamr@2
    50
williamr@2
    51
@return Always zero for bitmap frames
williamr@2
    52
*/
williamr@2
    53
inline TUint CMMFBitmapFrameBuffer::BufferSize() const
williamr@2
    54
	{
williamr@2
    55
	return 0; //Not applicable to bitmap
williamr@2
    56
	}
williamr@2
    57
williamr@2
    58
/**
williamr@2
    59
Retrieves the frame data.
williamr@2
    60
williamr@2
    61
@return A pointer to a bitmap containing the frame data.
williamr@2
    62
*/
williamr@2
    63
inline CFbsBitmap* CMMFBitmapFrameBuffer::Data()
williamr@2
    64
	{
williamr@2
    65
	if (iFrame) return iFrame;
williamr@2
    66
	else return NULL;
williamr@2
    67
	}
williamr@2
    68
williamr@2
    69
williamr@2
    70
/**
williamr@2
    71
@publishedAll
williamr@2
    72
@deprecated
williamr@2
    73
williamr@2
    74
Class to store a frame of video data using YUV data instead of an EPOC bitmap.
williamr@2
    75
*/
williamr@2
    76
class CMMFYUVBuffer : public CMMFBuffer
williamr@2
    77
	{
williamr@2
    78
public:
williamr@2
    79
	IMPORT_C static CMMFYUVBuffer* NewL();
williamr@2
    80
	IMPORT_C ~CMMFYUVBuffer();
williamr@2
    81
	inline TUint BufferSize() const;
williamr@2
    82
private:
williamr@2
    83
	CMMFYUVBuffer() : CMMFBuffer(KUidMmfYUVBuffer) {};
williamr@2
    84
	void ConstructL();
williamr@2
    85
public:
williamr@2
    86
	/** The buffer to hold the YUV data */
williamr@2
    87
	HBufC8* iYUVBuffer;
williamr@2
    88
	/** The size of a pixel */
williamr@2
    89
	TSize iPixelSize;
williamr@2
    90
private:
williamr@2
    91
	};
williamr@2
    92
williamr@2
    93
/**
williamr@2
    94
Returns the buffer size.
williamr@2
    95
williamr@2
    96
@return The buffer size.
williamr@2
    97
*/
williamr@2
    98
inline TUint CMMFYUVBuffer::BufferSize() const
williamr@2
    99
	{
williamr@2
   100
	return iYUVBuffer->Size();
williamr@2
   101
	}
williamr@2
   102
williamr@2
   103
#endif