hxcodec.h

著名的 helix realplayer 基于手机 symbian 系统的 播放器全套源代码

/* ***** BEGIN LICENSE BLOCK ***** 
 * Version: RCSL 1.0/RPSL 1.0 
 *  
 * Portions Copyright (c) 1995-2002 RealNetworks, Inc. All Rights Reserved. 
 *      
 * The contents of this file, and the files included with this file, are 
 * subject to the current version of the RealNetworks Public Source License 
 * Version 1.0 (the "RPSL") available at 
 * http://www.helixcommunity.org/content/rpsl unless you have licensed 
 * the file under the RealNetworks Community Source License Version 1.0 
 * (the "RCSL") available at http://www.helixcommunity.org/content/rcsl, 
 * in which case the RCSL will apply. You may also obtain the license terms 
 * directly from RealNetworks.  You may not use this file except in 
 * compliance with the RPSL or, if you have a valid RCSL with RealNetworks 
 * applicable to this file, the RCSL.  Please see the applicable RPSL or 
 * RCSL for the rights, obligations and limitations governing use of the 
 * contents of the file.  
 *  
 * This file is part of the Helix DNA Technology. RealNetworks is the 
 * developer of the Original Code and owns the copyrights in the portions 
 * it created. 
 *  
 * This file, and the files included with this file, is distributed and made 
 * available on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 
 * EXPRESS OR IMPLIED, AND REALNETWORKS HEREBY DISCLAIMS ALL SUCH WARRANTIES, 
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS 
 * FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 
 * 
 * Technology Compatibility Kit Test Suite(s) Location: 
 *    http://www.helixcommunity.org/content/tck 
 * 
 * Contributor(s): 
 *  
 * ***** END LICENSE BLOCK ***** */ 


#ifndef __HXCODEC_H_
#define __HXCODEC_H_

#include "hxtypes.h"
#include "hxresult.h"
#include "hxcom.h"



#if !defined(BUILD_FOR_REALPRODUCER8)
#define ADD_HXCODEC_GETIPNUNKNOWN
#define ADD_HXCODEC_INPUT
#if defined (_WIN32)
#define HW_VIDEO_MEMORY_FRONTEND
#endif
#endif
// rv30win.pcf and rv4xwin.pcf will define BUILD_FOR_REALPRODUCER8 if
// an environment variable BUILD_FOR_REALPRODUCER8 exists

#ifndef __cplusplus
typedef _INTERFACE IHXCallback IHXCallback;
#endif

#ifdef __cplusplus

#include "hxengin.h"
extern "C" {            /* Assume C declarations for C++ */
#endif	/* __cplusplus */

#if defined( _WIN32 ) || defined( _WINDOWS )
#pragma pack(1)
//	disable warning on: zero-sized array in struct/union
#pragma warning( disable : 4200 )
#endif

// Byte alignment settings for Mac
#if defined( _MACINTOSH ) || defined(_MAC_UNIX)
#pragma options align=mac68k
#endif

#ifdef __cplusplus
class IHXUnknown;
class IHX20Codec;
class IHX20Stream;
class IHX20MemoryAllocator;
#else // !__cplusplus
typedef void * IHXUnknown;
typedef void * IHX20Codec;
typedef void * IHX20Stream;
typedef void * IHX20MemoryAllocator;
#endif // __cplusplus

typedef IHXUnknown* PIHXUnknown;
typedef ULONG32 HX_IID;

#define IID_IHXUnknown	0x00000000
#define IID_IHX20Codec	0x00000001
#define IID_IHX20Stream	0x00000002
#define IID_IHX20MemoryAllocator 0x00000003

typedef void *HXCODEC;
typedef void *HXSTREAM;
typedef void *HXMEMORY;
typedef void *HXPACKETBUFF;

typedef ULONG32 HX_MOFTAG;

#define STRINGTOMOFTAG(str)	(			\
			((HX_MOFTAG)(unsigned char*)str[0])<<24	|	\
			((HX_MOFTAG)(unsigned char*)str[1])<<16	|	\
			((HX_MOFTAG)(unsigned char*)str[2])<<8	|	\
			((HX_MOFTAG)(unsigned char*)str[3]))

#define HXCODEC_INPUT 				1	// Read: Codec, please fill out the input field
#define HXCODEC_OUTPUT 				2	// Read: Codec, please fill out the output field
#define HXCODEC_API_VERSION 		0x20000000 //(2.0 in PN Version format)
#define HXCODEC_MAX_NAME_LENGTH 	32

// HXCODEC return values and errors
//#define HXR_OK					0
//#define HXR_OUTOFMEMORY				1
#define HXCODEC_LOAD_ERR                MAKE_HX_RESULT(1, SS_DEC, 101)
#define HXCODEC_INVALID_ERR             MAKE_HX_RESULT(1, SS_DEC, 102)
#define HXCODEC_BAD_FORMAT_ERR          MAKE_HX_RESULT(1, SS_DEC, 103)
#define HXCODEC_SETTINGS_ERR            MAKE_HX_RESULT(1, SS_DEC, 104)
#define HXSTREAM_DATA_READY             MAKE_HX_RESULT(1, SS_DEC, 105)
#define HXSTREAM_OPEN_ERR               MAKE_HX_RESULT(1, SS_DEC, 106)
#define HXSTREAM_BUF_SIZE_ERR           MAKE_HX_RESULT(1, SS_DEC, 107)
#define HXSTREAM_INVALID_ERR            MAKE_HX_RESULT(1, SS_DEC, 108)
#define HXSTREAM_BAD_FORMAT_ERR         MAKE_HX_RESULT(1, SS_DEC, 109)
#define HXSTREAM_NO_LOAD_BACKEND        MAKE_HX_RESULT(1, SS_DEC, 110)
#define HXSTREAM_BAD_STATE              MAKE_HX_RESULT(1, SS_DEC, 111)
#define HXSTREAM_PROP_NOT_SUPPORTED     MAKE_HX_RESULT(1, SS_DEC, 112)
#define HXSTREAM_PROP_NOSET_AFTERINPUT  MAKE_HX_RESULT(1, SS_DEC, 113)
#define HXCODEC_NOT_FOUND               MAKE_HX_RESULT(1, SS_DEC, 114)

#define HX_NO_INTERFACE                 MAKE_HX_RESULT(1, SS_DEC, 4096)


// Stream property flags
#define SP_INTERPOLATE				0x00010000
#define SP_SPEED_QUALITY			0x00010001	// ULONG32: 1=max speed, 100=max quality
#define SP_LIVE					0x00010002	// BOOL: TRUE=live source, FALSE=static source
#define SP_BITRATE				0x00010003	// ULONG32: bitrate to encode at
#define SP_VARIABLE_FRAME_RATE			0x00010004	// BOOL: TRUE allow frame rate to vary, FALSE

								//  Fixed frame rate.
#define SP_QUALITY_MOTION			0x00010005
#define SP_DITHER			        0x00010006	// ptr to dithering colors.
#define SP_POSTFILTER				0x00010007
#define SP_ADVANCED_MP				0x00010008	// Temporary for fiji-preview
#define SP_TEMPORALINTERP			0x00010009
#define SP_MAX_FRAMERATE			0x00010010
#define SP_INLOOP_DEBLOCKING		0x0001000a
#define SP_LASTENCODETIME			0x0001000B
#define SP_CPUCONSUMPTION			0x0001000C
#define SP_PRIORITY					0x0001000D
#define SP_FORCEDMV					0x0001000E
#define SP_HIGHDURESSMODE			0x0001000F
#define SP_MAX_FRAMERATE			0x00010010
#define SP_FRAMERATE				0x00010011


#define SP_CODING_MODE              0x00010012
#define SP_PREVIEW_MODE             0x00010013
#define SP_QUALITY1             0x00010014
#define SP_QUALITY2             0x00010015
#define SP_QUALITY3             0x00010016
#define SP_NEXT_FRAME_TIMESTAMP 0x00010017
#define SP_WILL_ENCODE_FRAME 0x00010018

#define SP_DECODER_CPU_SCALABILITY_STATUS 0x00010019
#define SP_OUPUT_QUEUE_STATUS  0x0001001a
#define SP_50_COMPATIBLE			0x0001001B
#define SP_OUPUT_QUEUE_STATUS2  0x0001001c
#define SP_SEEK			0x0001001d
#define SP_DECODE_B_FRAMES	0x0001001e

#define SP_CODEC_SETUP_DONE	0x0001001f  // pass TRUE for this prop when setup of stream properties is done
#define SP_G2GOLD_COMPATIBLE	0x00010020	// Makes the stream compatible with G2 Gold players
#define SP_ECC					0x00010021	// Sets the percentage of the bitstream dedicated to error correction
#define ECC_NONE				0
#define	ECC_LOW					1
#define	ECC_MED					2
#define ECC_HIGH				3
#define SP_PREFILTERING_MODE	0x00010022	// Sets the prefiltering mode
#define PREFILTERING_MODE_NONE	0
#define PREFILTERING_MODE_LOW	1
#define PREFILTERING_MODE_HIGH	2
#define SP_ANALYSIS_FILENAME	0x00010023
#define SP_MAXBITRATE			0x00010024
#define SP_KEYFRAMERATE			0x00010025
#define SP_NUMBFRAMES			0x00010026
#define SP_MIN_REDUCEDFRAMERATE	0x00010027
#define SP_TARGET_LATENCY		0x00010028
#define SP_INTERLACE_PREFILTER  0x00010029
#define SP_3_2_PULLDOWN_PREFILTER 0x0001002a
#define SP_ALLOW_DIFFERENT_OUPUT_SIZES 0x0001002b
#define SP_RESIZING_ACCURACY	0x0001002c
#define SP_ALLOW_SIDEBANDINFO	0x0001002d	//flag for allowing sideband info to be add to data stream
#define SP_BITSTREAM_VERSION	0x0001002e	//bit stream versioning
#define SP_CALLBACKFUNCTION            0x0001002f      //so core can validate for secure content
#define SP_BACKENDFUNCTIONPOINTERS     0x00010030     //so core can validate for secure content
#define SP_QUALITY				0x00010031	
#define SP_AUTO_PREFILTER		0x00010032
#define SP_COMPONENTGUID	    0x00010033
#define SP_BACKENDDECODERCOMPONENTGUID     0x00010034
#define SP_HW_VIDEO_MEMORY		0x00010035
#define SP_NOFULLDECODE			0x00010036
#define SP_NODEBLOCKBFRAMES		0x00010037
#define SP_COOP_MULTITASK_MODE	0x00010038
#define SP_SECURE_MODE		0x00010039
#define SP_DVPF_SURFACE         0x0001003a
#define SP_LOADLEVEL			0x0001003b



// co-operative multi-tasking callback
typedef struct tag_HX_CMTM
{
	ULONG32 ulInterval;	// desired callback interval in ms (may not be obeyed)
	IHXCallback* pCallback;
} HX_CMTM;



// output queue status object
typedef struct tag_HX_OQS
{
    ULONG32 	queueDepth; 	// current size of the queue
    ULONG32 	maxQueueDepth; 	// desired maximum queue size 
				// decode is halted if more than this number of frames is
				// in the queue
    ULONG32 	oldestQueueElementTimeStamp; 	// timestamp of the oldest thing in the queue
    ULONG32 	newestQueueElementTimeStamp; 	// timestamp of the youngest thing in the queue
    ULONG32 	currentTimeStamp; 	// current timestamp used to display elements of the queue
} HX_OQS;

// HX_OQS2 starts with HX_OQS so it can be used for either set property call, the new members
// are just ignored by the SP_OUTPUT_QUEUE_STATUS handler
typedef struct tag_HX_OQS2
{
    ULONG32 	queueDepth; 	// current size of the queue
    ULONG32 	maxQueueDepth; 	// desired maximum queue size 
				// decode is halted if more than this number of frames is
				// in the queue
    ULONG32 	oldestQueueElementTimeStamp; 	// timestamp of the oldest thing in the queue
    ULONG32 	newestQueueElementTimeStamp; 	// timestamp of the youngest thing in the queue
    ULONG32 	currentTimeStamp; 	// current timestamp used to display elements of the queue
    ULONG32	nonFRUDroppedFrames;
    ULONG32	TotalDroppedFrames;
} HX_OQS2;


/*  SPCODINGMODEs are the allowed values when setting the SP_CODING_MODE param in  */
/*  PNStream_SetProperty  */
#define SPCODINGMODE_VIDEO	0x00000000
#define SPCODINGMODE_POWERPOINT 0x00000001
#define SPCODINGMODE_HIGHDURESS 0x00000002
#define SPCODINGMODE_SLIDESHOW 0x00000003
#define SPCODINGMODE_ANALYSIS 0x00000004
#define SPCODINGMODE_FROMFILE 0x00000005
#define SPCODINGMODE_ENCODE   0x00000006

/*  allowed values for SP_PREVIEW MODE are HX_RGB24_ID or HX_YUV420_ID  */


// Flags used in the data_ready callback function
#define HX_RELIABLE_FLAG			0x0001
#define HX_KEYFRAME_FLAG			0x0002
#define HX_LASTFRAME_FLAG			0x0004
#define	HX_INTERFRAME_MODE_FLAG		0x0008


#define HX_INLOOP_DEBLOCKING_FLAG	0x0010
#define HX_POSTFILTER_FLAG			0x0020	// refers to smoothing postfilter OR deblocking postfilter
#define HX_FRU_FLAG					0x0040
#define HX_SEGMENT_CONTAINS_OUTPUT_SIZE_FLAG 0x0100
#define HX_SEGMENT_CONTAINS_OUTPUT_YUVDATA   0x0200

/* 
 * IMPORTANT!!
 * Do not used flag value 0x0008 it is defined as follows in ravents.h
 * #define HX_EVENT_FLAG			0x0008
*/

// HX_MOF base Media object format struct
typedef struct tag_HX_MOF
{
	ULONG32 	cbLength; 	// size of structure in bytes
	HX_MOFTAG 	moftag;		// identifier of media format
	HX_MOFTAG 	submoftag;	// identifier of object format
} HX_MOF;

// Media Native HX_MOF struct
typedef struct tag_HX_FORMAT_NATIVE
{
	ULONG32		cbLength;	// the size of this struct in bytes
	HX_MOFTAG 	moftag;		// always == HX_MEDIA_NATIVE
	HX_MOFTAG 	submoftag;	// media format identifier
	UINT8		data[1];	// format native initialization data
} HX_FORMAT_NATIVE;

// Generic Audio HX_MOF struct
typedef struct tag_HX_FORMAT_AUDIO
{
	ULONG32		cbLength;			// the size of this struct in bytes
	HX_MOFTAG 	moftag;				// always == HX_MEDIA_AUDIO
	HX_MOFTAG 	submoftag;			// audio format identifier
	// General attributes of the audio stream independent of bitwise encoding
	UINT16		uiBitsPerSample;	// number of bits per audio sample
	UINT16		uiNumChannels;		// number of audio channels in stream
	UINT16		uiBytesPerSample;	// number of bytes per sample
	ULONG32		ulSampleRate;		// audio sample rate
	ULONG32		ulAvgBytesPerSec;	// average bytes/sec of audio stream
} HX_FORMAT_AUDIO;

// Generic Image HX_MOF struct
typedef struct tag_HX_FORMAT_IMAGE
{