graphicscomposition/openwfsupport/src/openwfcstream.cpp
changeset 0 5d03bc08d59c
child 98 bf7481649c98
child 163 bbf46f59e123
equal deleted inserted replaced
-1:000000000000 0:5d03bc08d59c
       
     1 // Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // openwfcstream.cpp
       
    15 // C API for surface stream implementation of OpenWF-C NativeStream 
       
    16 //
       
    17 
       
    18 
       
    19 //  Include Files  
       
    20 #include <e32def.h>
       
    21 #include <graphics/suerror.h>
       
    22 #include "symbianstream.h"
       
    23 #include "surfacestream.h"
       
    24 #include "streammap.h"
       
    25 #include "openwfcpanic.h"
       
    26 
       
    27 
       
    28 extern "C"{
       
    29 
       
    30 EXPORT_C TErrCode SymbianStreamAcquire( const TSurfaceId* aId, SymbianStreamType* aReturnStream)
       
    31 	{
       
    32 	if (aId && !aId->IsNull())
       
    33 		{
       
    34         CSurfaceStream* stream = NULL;
       
    35         if (aId->Type()==TSurfaceId::EStreamHandle)
       
    36             {
       
    37             stream=CSurfaceStream::FromHandle(aId);
       
    38             __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamUnexpectedError));
       
    39             stream->AddReference();
       
    40             *aReturnStream= stream->ToHandle();
       
    41             return KErrNone;
       
    42             }
       
    43         else
       
    44             {
       
    45             TRAPD(err,stream = COpenWfcStreamMap::InstanceL().AcquireL(*aId));
       
    46             if (stream)
       
    47                 {
       
    48                 *aReturnStream = stream->ToHandle();
       
    49                 return KErrNone;
       
    50                 }
       
    51             else
       
    52                 {
       
    53                 return err;
       
    54                 }
       
    55             }
       
    56 		}
       
    57 	else
       
    58 		{
       
    59 		*aReturnStream = NULL;
       
    60 		return KErrBadHandle;
       
    61 		}	
       
    62 	}
       
    63 
       
    64 EXPORT_C TErrCode SymbianStreamFind( const TSurfaceId* aId, SymbianStreamType* aReturnStream)
       
    65 	{
       
    66 	if (aId && !aId->IsNull())
       
    67 		{
       
    68         CSurfaceStream* stream=NULL;
       
    69         if (aId->Type()==TSurfaceId::EStreamHandle)
       
    70             {
       
    71             stream=CSurfaceStream::FromHandle(aId);
       
    72             __ASSERT_DEBUG(stream, Panic(EOwfSymbianStreamBadArgument));
       
    73             stream->AddReference();
       
    74             *aReturnStream= stream->ToHandle();
       
    75             return KErrNone;
       
    76             }
       
    77         else
       
    78             {
       
    79             TRAPD(err,stream = COpenWfcStreamMap::InstanceL().Find(*aId));
       
    80             if (stream)
       
    81                 {
       
    82                 *aReturnStream = stream->ToHandle();
       
    83                 return KErrNone;
       
    84                 }
       
    85             else
       
    86                 {
       
    87                 *aReturnStream = NULL;
       
    88                 if (err==KErrNone)
       
    89                     {
       
    90                     return KErrNotFound;
       
    91                     }
       
    92                 else
       
    93                     {
       
    94                     return err;
       
    95                     }
       
    96                 }
       
    97             }
       
    98         }
       
    99 	else
       
   100 		{
       
   101 		*aReturnStream = NULL;
       
   102 		return KErrBadHandle;
       
   103 		}	
       
   104 	}
       
   105 
       
   106 EXPORT_C void SymbianStreamAddReference(SymbianStreamType aStream)
       
   107 	{
       
   108 	CSurfaceStream*	sstream=CSurfaceStream::FromHandle(aStream);
       
   109 	if (sstream)
       
   110 		{
       
   111 		sstream->AddReference();
       
   112 		}
       
   113 	}
       
   114 
       
   115 EXPORT_C TErrCode SymbianStreamGetBufferId( SymbianStreamType aStream, 
       
   116                         SymbianStreamBuffer aBufferHandle, 
       
   117                         khronos_int32_t* aReturnIndex, 
       
   118                         const TSurfaceId** aReturnSurface)
       
   119 	{
       
   120 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   121     __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamBadArgument));
       
   122     if (aReturnIndex)
       
   123         {
       
   124         *aReturnIndex=stream->BufferHandleToIndex(aBufferHandle);
       
   125         *aReturnSurface = &stream->SurfaceId();
       
   126         }
       
   127     return KErrNone;
       
   128 	}
       
   129 
       
   130 EXPORT_C void SymbianStreamRemoveReference(SymbianStreamType aStream)
       
   131 	{
       
   132 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   133     __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamBadArgument));
       
   134     stream->ReleaseReference();
       
   135 	}
       
   136 EXPORT_C void SymbianStreamGetHeader( SymbianStreamType aStream,
       
   137                             khronos_int32_t* aWidth, 
       
   138                             khronos_int32_t* aHeight, 
       
   139                             khronos_int32_t* aStride, 
       
   140                             TUidPixelFormat* aFormat, 
       
   141                             khronos_int32_t* aPixelSize)
       
   142 	{
       
   143 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   144     __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamBadArgument));
       
   145     stream->GetHeader(aWidth,aHeight,aStride,aFormat,aPixelSize);
       
   146 	}
       
   147 
       
   148 EXPORT_C TErrCode SymbianStreamAcquireReadBuffer( SymbianStreamType aStream, SymbianStreamBuffer* aReturnBuffer)
       
   149 	{
       
   150 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   151     __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamBadArgument));
       
   152     *aReturnBuffer = stream->AcquireReadBuffer();
       
   153     return KErrNone;
       
   154 	}
       
   155 EXPORT_C TErrCode SymbianStreamReleaseReadBuffer( SymbianStreamType aStream, 
       
   156                                                     SymbianStreamBuffer aBuffer)
       
   157 	{
       
   158 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   159     __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamBadArgument));
       
   160     return stream->ReleaseReadBuffer(aBuffer);
       
   161 	}
       
   162 
       
   163 EXPORT_C TErrCode SymbianStreamAcquireWriteBuffer( SymbianStreamType aStream, SymbianStreamBuffer* aReturnBuffer)
       
   164 	{
       
   165 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   166     __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamBadArgument));
       
   167     *aReturnBuffer = stream->AcquireWriteBuffer();
       
   168     if (*aReturnBuffer != NULL)
       
   169         {
       
   170         return KErrNone;
       
   171         }
       
   172     else 
       
   173         {
       
   174         return KErrInUse;
       
   175         }
       
   176 	}
       
   177 
       
   178 EXPORT_C TErrCode SymbianStreamReleaseWriteBuffer( SymbianStreamType aStream, 
       
   179                                                     SymbianStreamBuffer aBuffer)
       
   180 	{
       
   181 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   182     __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamBadArgument));
       
   183     stream->ReleaseWriteBuffer(aBuffer);
       
   184     return KErrNone;
       
   185 	}
       
   186 
       
   187 EXPORT_C TErrCode SymbianStreamAddObserver( SymbianStreamType aStream, 
       
   188                             SymbianStreamCallback aObserver, 
       
   189                             void* aData)
       
   190 	{
       
   191     CSurfaceStream* stream=CSurfaceStream::FromHandle(aStream);
       
   192     if (stream && aObserver)
       
   193         {
       
   194         SYMOWF_DEFAULT_EVENT_PARAM eventPar;
       
   195         eventPar.length = sizeof(eventPar);
       
   196         eventPar.event = ESOWF_NoEvent;
       
   197         aObserver(SYMBIAN_INVALID_HANDLE, ESOWF_ObserverReturnDefaultEvent, NULL, &eventPar);
       
   198         return stream->AddObserver(aObserver, eventPar.event, KNoAssociatedScreenNumber, aData);
       
   199         }
       
   200     return KErrBadHandle;
       
   201 	}
       
   202 
       
   203 EXPORT_C TErrCode SymbianStreamRemoveObserver( SymbianStreamType aStream, 
       
   204                                                 void* aData, 
       
   205                                                 SymbianStreamEventBits aEvents)
       
   206     {
       
   207     CSurfaceStream* stream = CSurfaceStream::FromHandle(aStream);
       
   208     if (stream)
       
   209         {
       
   210             return stream->RemoveObserver(aEvents, aData);
       
   211         }
       
   212     return KErrBadHandle;
       
   213     }
       
   214 
       
   215 
       
   216 EXPORT_C TErrCode SymbianStreamGetBufferPointer( SymbianStreamType aStream, 
       
   217                             SymbianStreamBuffer aBuffer,
       
   218                             void** aReturnPointer)
       
   219 	{
       
   220 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   221     __ASSERT_ALWAYS(stream, Panic(EOwfSymbianStreamBadArgument));
       
   222     *aReturnPointer = NULL;
       
   223     TRAPD(err,*aReturnPointer = stream->GetBufferPtrL(aBuffer));
       
   224     return err;
       
   225 	}
       
   226 
       
   227 EXPORT_C void 
       
   228 SymbianStreamSetProtectionFlag( SymbianStreamType aStream, khronos_bool aFlag)
       
   229 	{
       
   230 	CSurfaceStream*	stream=CSurfaceStream::FromHandle(aStream);
       
   231 	if (stream)
       
   232 		{
       
   233 		stream->SetProtectionFlag(aFlag);
       
   234 		}
       
   235 	}
       
   236 
       
   237 /*!
       
   238  * \brief Register a screen number for surface update notifications.
       
   239  *
       
   240  * \param aScreenNum Screen number.
       
   241  * 
       
   242  * 
       
   243  * \return Standard error code or KErrNone
       
   244  */
       
   245 EXPORT_C TErrCode SymbianStreamRegisterScreenNotifications( khronos_int32_t aScreenNumber, 
       
   246                                             khronos_int32_t aPriority, 
       
   247                                             khronos_int32_t aInternalVersion)
       
   248 	{
       
   249 	khronos_int32_t err2=KErrUnknown;
       
   250 	TRAPD(err,err2=COpenWfcStreamMap::InstanceL().RegisterScreenNotifications(aScreenNumber,aPriority,aInternalVersion));
       
   251 	if (err)
       
   252 		{
       
   253 		return err;
       
   254 		}
       
   255 	else
       
   256 		{
       
   257 		return err2;
       
   258 		}
       
   259 	}
       
   260 /*!
       
   261  * \brief Get handle to registration of a screen number for surface update notifications.
       
   262  *
       
   263  * \param aScreenNum Screen number.
       
   264  * 
       
   265  * 
       
   266  * \return Handle to internal object (currently a CBase), or NULL if not registered
       
   267  */
       
   268 EXPORT_C TErrCode 
       
   269 SymbianStreamHasRegisteredScreenNotifications( khronos_int32_t aScreenNumber,void** aReturnState)
       
   270     {
       
   271     TRAPD(err,*aReturnState=(COpenWfcStreamMap::InstanceL().RegisteredScreenNotifications(aScreenNumber)));
       
   272     return err;
       
   273     }
       
   274 
       
   275 
       
   276 /*!
       
   277  * \brief Unregister a screen number for surface update notifications.
       
   278  *
       
   279  * \param aScreenNum Screen number.
       
   280  * 
       
   281  * 
       
   282  * \return Standard error code or KErrNone
       
   283  */
       
   284 EXPORT_C TErrCode 
       
   285 SymbianStreamUnregisterScreenNotifications(khronos_int32_t aScreenNumber)
       
   286 	{
       
   287 	khronos_int32_t err2=KErrUnknown;
       
   288 	TRAPD(err,err2=COpenWfcStreamMap::InstanceL().UnregisterScreenNotifications(aScreenNumber));
       
   289 	if (err)
       
   290 		{
       
   291 		return err;
       
   292 		}
       
   293 	else
       
   294 		{
       
   295 		return err2;
       
   296 		}
       
   297 	}
       
   298 
       
   299 /*!
       
   300  * \brief Check if two stream objects are the same surface.
       
   301  *
       
   302  * \param 	aStream 	compare these two streams.
       
   303  * \param	aStream2	compare these two streams.
       
   304  * 
       
   305  * \return TRUE if they are the same object.
       
   306  */
       
   307 EXPORT_C khronos_bool SymbianStreamSame(SymbianStreamType aStream, SymbianStreamType aStream2)
       
   308 	{
       
   309 	if  (aStream==aStream2)
       
   310 		return KHR_BOOLEAN_TRUE;
       
   311 	if (!aStream || !aStream2)
       
   312 		return KHR_BOOLEAN_FALSE;
       
   313 	if (*aStream==*aStream2)
       
   314 		return KHR_BOOLEAN_TRUE;
       
   315 	SymbianStreamType found;
       
   316 	if (	aStream->Type()!=aStream->EStreamHandle
       
   317 		&&	aStream2->Type()==aStream2->EStreamHandle)
       
   318 		{
       
   319 		if(KErrNone==SymbianStreamFind(aStream,&found))
       
   320 			{
       
   321 			if  (found==aStream2)
       
   322 				return KHR_BOOLEAN_TRUE;
       
   323 			}
       
   324 		return KHR_BOOLEAN_FALSE;
       
   325 		}
       
   326 	if (	aStream2->Type()!=aStream2->EStreamHandle
       
   327 		&&	aStream->Type()==aStream->EStreamHandle)
       
   328 		{
       
   329 		if(KErrNone==SymbianStreamFind(aStream2,&found))
       
   330 			{
       
   331 			if  (aStream==found)
       
   332 				return KHR_BOOLEAN_TRUE;
       
   333 			}
       
   334 		return KHR_BOOLEAN_FALSE;
       
   335 		}
       
   336 	return KHR_BOOLEAN_FALSE;
       
   337 	}
       
   338 
       
   339 EXPORT_C void
       
   340 SymbianStreamProcessNotifications(SymbianStreamType aStream, 
       
   341                                   khronos_int32_t aEvent, 
       
   342                                   khronos_int32_t aScreenNumber,
       
   343                                   khronos_int32_t aSerialNumber,
       
   344                                   khronos_int32_t* aReturnMask)
       
   345     {
       
   346     CSurfaceStream* stream = CSurfaceStream::FromHandle(aStream);
       
   347     if (stream)
       
   348         {
       
   349         stream->ProcessNotifications(aEvent, aScreenNumber, CSurfaceStream::EDefaultOperation, aSerialNumber, aReturnMask);
       
   350         }
       
   351     }
       
   352 
       
   353 EXPORT_C void
       
   354 SymbianStreamCheckVisible(SymbianStreamType aStream, 
       
   355                           khronos_int32_t aEvent, 
       
   356                           khronos_int32_t aScreenNumber,
       
   357                           khronos_int32_t aSerialNumber)
       
   358     {
       
   359     CSurfaceStream* stream = CSurfaceStream::FromHandle(aStream);
       
   360     if (stream)
       
   361         {
       
   362         stream->ProcessNotifications(aEvent, aScreenNumber, CSurfaceStream::ECheckVisibleOperation, aSerialNumber, NULL);
       
   363         }
       
   364     }
       
   365 
       
   366 EXPORT_C TInt32
       
   367 SymbianStreamProcessDisplayedNotifications(SymbianStreamType aStream, 
       
   368                                            khronos_int32_t aEvent, 
       
   369                                            khronos_int32_t aScreenNumber,
       
   370                                            khronos_int32_t aSerialNumber,
       
   371                                            khronos_int32_t* aReturnMask)
       
   372     {
       
   373     CSurfaceStream* stream = CSurfaceStream::FromHandle(aStream);
       
   374     TInt32 event = aEvent & (ESOWF_EventDisplayed | ESOWF_EventDisplayedX);
       
   375     if (stream && event)
       
   376         {
       
   377         stream->ProcessNotifications(aEvent, 
       
   378                                      aScreenNumber, 
       
   379                                      CSurfaceStream::EDefaultOperation, 
       
   380                                      aSerialNumber, 
       
   381                                      aReturnMask);
       
   382         }
       
   383     return event;
       
   384     }
       
   385 
       
   386 EXPORT_C TInt32
       
   387 SymbianStreamProcessAvailableNotifications(SymbianStreamType aStream, 
       
   388                                            khronos_int32_t aEvent, 
       
   389                                            khronos_int32_t aScreenNumber,
       
   390                                            khronos_int32_t aSerialNumber,
       
   391                                            khronos_int32_t* aReturnMask)
       
   392     {
       
   393     CSurfaceStream* stream = CSurfaceStream::FromHandle(aStream);
       
   394     TInt32 event = aEvent & ESOWF_EventAvailable;
       
   395     if (stream && event)
       
   396         {
       
   397         stream->ProcessNotifications(aEvent, 
       
   398                                      aScreenNumber, 
       
   399                                      CSurfaceStream::EDefaultOperation, 
       
   400                                      aSerialNumber, 
       
   401                                      aReturnMask);
       
   402         }
       
   403     return ESOWF_EventAvailable;
       
   404     }
       
   405 
       
   406 EXPORT_C TErrCode 
       
   407 SymbianStreamAddExtendedObserver(SymbianStreamType aStream, 
       
   408                                 SymbianStreamCallback aObserver, 
       
   409                                 void* aData, 
       
   410                                 khronos_int32_t aScreenNumber, 
       
   411                                 SymbianStreamEventBits aEvents)
       
   412     {
       
   413     CSurfaceStream* stream=CSurfaceStream::FromHandle(aStream);
       
   414     if (stream && aObserver)
       
   415         {
       
   416         TInt ret = KErrNone;
       
   417         if (!((ret = stream->AddObserver(aObserver, aEvents, aScreenNumber, aData)) == KErrNone) || aEvents != ESOWF_EventUpdated)
       
   418             {
       
   419             return ret;
       
   420             }
       
   421         if (!((ret = stream->AddObserver(NULL, ESOWF_EventAvailable, aScreenNumber, aData)) == KErrNone))
       
   422             {
       
   423             return ret;
       
   424             }
       
   425         if (!((ret = stream->AddObserver(NULL, ESOWF_EventDisplayed, aScreenNumber, aData)) == KErrNone))
       
   426             {
       
   427             return ret;
       
   428             }
       
   429         ret = stream->AddObserver(NULL, ESOWF_EventDisplayedX, aScreenNumber, aData);
       
   430         return ret;
       
   431         }
       
   432     else
       
   433         {
       
   434         return KErrArgument;
       
   435         }
       
   436     }
       
   437 
       
   438 
       
   439 
       
   440 EXPORT_C void
       
   441 SymbianStreamSetFlipState(SymbianStreamType aStream, SymOwfBool aFlip)
       
   442     {
       
   443     CSurfaceStream* stream = CSurfaceStream::FromHandle(aStream);
       
   444     if (stream)
       
   445         {
       
   446         stream->SetFlipState(aFlip);
       
   447         }
       
   448     }
       
   449 }	//extern "C" helps fix and verify linkage
       
   450