OMX_ContentPipe.h

Go to the documentation of this file.

/*
 * Copyright (c) 2007 The Khronos Group Inc. 
 * 
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files (the
 * "Software"), to deal in the Software without restriction, including
 * without limitation the rights to use, copy, modify, merge, publish,
 * distribute, sublicense, and/or sell copies of the Software, and to
 * permit persons to whom the Software is furnished to do so, subject
 * to the following conditions: 
 * The above copyright notice and this permission notice shall be included
 * in all copies or substantial portions of the Software. 
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 
 *
 */

#ifndef OMX_CONTENTPIPE_H
#define OMX_CONTENTPIPE_H

#ifndef KD_EACCES
/* OpenKODE error codes. CPResult values may be zero (indicating success
   or one of the following values) */
#define KD_EACCES (13)
#define KD_EADDRINUSE (98)
#define KD_EAGAIN (11)
#define KD_EBADF (9)
#define KD_EBUSY (16)
#define KD_ECANCELED (125)
#define KD_ECONNABORTED (103)
#define KD_ECONNREFUSED (111)
#define KD_ECONNRESET (104)
#define KD_EDEADLK (35)
#define KD_EDESTADDRREQ (89)
#define KD_EDOM (33)
#define KD_ERANGE (34)
#define KD_EEXIST (17)
#define KD_EFAULT (14)
#define KD_EFBIG (27)
#define KD_EHOSTUNREACH (113)
#define KD_EINPROGRESS (115)
#define KD_EINTR (4)
#define KD_EINVAL (22)
#define KD_EIO (5)
#define KD_EISCONN (106)
#define KD_EISDIR (21)
#define KD_EMFILE (24)
#define KD_ENAMETOOLONG (36)
#define KD_ENETDOWN (100)
#define KD_ENETRESET (102)
#define KD_ENETUNREACH (101)
#define KD_ENOBUFS (105)
#define KD_ENOENT (2)
#define KD_ENOMEM (12)
#define KD_ENOSPC (28)
#define KD_ENOSYS (28)
#define KD_ENOTCONN (107)
#define KD_ENOTDIR (20)
#define KD_ENOTEMPTY (39)
#define KD_ENOTSOCK (88)
#define KD_ENOTSUP (95)
#define KD_EPERM (1)
#define KD_EPROTO (71)
#define KD_ETIMEDOUT (110)
#define KD_EILSEQ (84)
#endif

typedef OMX_U32    CPresult;
typedef char *     CPstring;  
typedef void *     CPhandle;
typedef OMX_U32    CPuint;
typedef OMX_S32    CPint;  
typedef char       CPbyte;  
typedef OMX_BOOL   CPbool;

typedef enum CP_ORIGINTYPE {
    CP_OriginBegin,      
    CP_OriginCur,      
    CP_OriginEnd,      
    CP_OriginMax = 0X7FFFFFFF
} CP_ORIGINTYPE;

typedef enum CP_ACCESSTYPE {
    CP_AccessRead,      
    CP_AccessWrite,  
    CP_AccessReadWrite ,  
    CP_AccessMax = 0X7FFFFFFF
} CP_ACCESSTYPE;

typedef enum CP_CHECKBYTESRESULTTYPE
{
    CP_CheckBytesOk,                    
    CP_CheckBytesNotReady,              
    CP_CheckBytesInsufficientBytes  ,     
    CP_CheckBytesAtEndOfStream,         
    CP_CheckBytesOutOfBuffers,          
    CP_CheckBytesMax = 0X7FFFFFFF
} CP_CHECKBYTESRESULTTYPE;

typedef enum CP_EVENTTYPE{
    CP_BytesAvailable,              
    CP_Overflow,                   
    CP_PipeDisconnected  ,              
    CP_EventMax = 0X7FFFFFFF
} CP_EVENTTYPE;

typedef struct CP_PIPETYPE
{
    CPresult (*Open)( CPhandle* hContent, CPstring szURI, CP_ACCESSTYPE eAccess );

    CPresult (*Close)( CPhandle hContent );

    CPresult (*Create)( CPhandle *hContent, CPstring szURI );

    CPresult (*CheckAvailableBytes)( CPhandle hContent, CPuint nBytesRequested, CP_CHECKBYTESRESULTTYPE *eResult );

    CPresult (*SetPosition)( CPhandle  hContent, CPint nOffset, CP_ORIGINTYPE eOrigin);

    CPresult (*GetPosition)( CPhandle hContent, CPuint *pPosition);

    CPresult (*Read)( CPhandle hContent, CPbyte *pData, CPuint nSize); 

    CPresult (*ReadBuffer)( CPhandle hContent, CPbyte **ppBuffer, CPuint *nSize, CPbool bForbidCopy);

    CPresult (*ReleaseReadBuffer)(CPhandle hContent, CPbyte *pBuffer);

    CPresult (*Write)( CPhandle hContent, CPbyte *data, CPuint nSize); 

    CPresult (*GetWriteBuffer)( CPhandle hContent, CPbyte **ppBuffer, CPuint nSize);

    CPresult (*WriteBuffer)( CPhandle hContent, CPbyte *pBuffer, CPuint nFilledSize);

    CPresult (*RegisterCallback)( CPhandle hContent, CPresult (*ClientCallback)(CP_EVENTTYPE eEvent, CPuint iParam));

} CP_PIPETYPE;

#endif

---

Generated for OpenMAX Bellagio rel. 0.3.5-svn by  1.5.1