clips_menu_config.h

ZORAN 962/966 SOURCE CODE,DVD chip

/****************************************************************************************************
*  Copyright (c) 2005 ZORAN Corporation, All Rights Reserved
*  THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF ZORAN CORPORATION
*
*  File: clips_menu_config.h
*
* Description:
* =========
****************************************************************************************************/
/****************************************************************************************************
*	DEFINITION: Private typedefs 
****************************************************************************************************/

enum {
	CLIP_ITEM_TYPE_FILE,
	CLIP_ITEM_TYPE_DIR,
	CLIP_ITEM_TYPE_DEVICELIST,
	CLIP_ITEM_TYPE_DEVICE,
	CLIP_ITEM_TYPE_UNKNOWN
};
typedef UINT8 CLIP_ITEM_TYPE;

typedef UINT8 CLIP_FILE_TYPE;

//Define the icons for different kinds of clips file type.
#define BMP_CDDA		BMP_MUSIC
#define BMP_MP3			BMP_MUSIC
#define BMP_WMA		BMP_MUSIC
#define BMP_MUSIC		BMP_MUSIC

#define BMP_JPEG		BMP_PHOTO
#define BMP_PHOTO		BMP_PHOTO

#define BMP_MPEG		BMP_MOVIE
#define BMP_DIVX		BMP_MOVIE
#define BMP_MOVIE		BMP_MOVIE

#ifdef D_GUI_ITEM_ACCESS
#define FONT_ITEM_ACCSESS					FONT_0
#define BMP_BG_ITEM_ACCESS_COMPONENT	BMP_BG_2
#define DescriptorItemAccess    oItemAccessComponentDescriptor
#endif 

#define _MakeItemAccessParam(_CurrenItem_, _ItemType_)	(((UINT32)_CurrenItem_ << 16) | _ItemType_)
#define _GetCurrentItemFromParam(_Param_)					((UINT16)(_Param_ >> 16))
#define _GetItemTypeFromParam(_Param_)					((UINT16)_Param_)

// Define familly clip types
// eClipType_MP2 and eClipType_MP3 have the same values.
#define CLIPTYPE_FILTER_MUSIC		(CLIPTYPE_MP2 | CLIPTYPE_MP3 | CLIPTYPE_WMA | CLIPTYPE_CDDA | CLIPTYPE_M4A | CLIPTYPE_OGG)
#define CLIPTYPE_FILTER_PHOTO		(CLIPTYPE_JPEG | CLIPTYPE_YUV)
#define CLIPTYPE_FILTER_MOVIE		(CLIPTYPE_MPEG | CLIPTYPE_AVI | CLIPTYPE_ASF | CLIPTYPE_MP4)
#define CLIPTYPE_FILTER_DIVX		(CLIPTYPE_AVI | CLIPTYPE_ASF | CLIPTYPE_MP4)
#define CLIPTYPE_FILTER_DEFAULT	(CLIPTYPE_OFF | CLIPTYPE_NONE)  // NOTE : CLIPTYPE_NONE needs to be included to avoid bugs.

#define _IsFileTypeMusic(_FileType_)	(CLIPTYPE_FILTER_MUSIC & (1 << _FileType_))
#define _IsFileTypeMp3(_FileType_)	(eClipType_MP3 == _FileType_)
#define _IsFileTypeWma(_FileType_)	(eClipType_WMA == _FileType_)
#define _IsFileTypeCdda(_FileType_)	(eClipType_CDDA == _FileType_)
#ifdef D_OGG_VORBIS
#define _IsFileTypeOgg(_FileType_)	(eClipType_OGG== _FileType_)
#endif
#define _IsFileTypePhoto(_FileType_)	(CLIPTYPE_FILTER_PHOTO & (1 << _FileType_))
#define _IsFileTypeJpeg(_FileType_)	(eClipType_JPEG == _FileType_)

#define _IsFileTypeMovie(_FileType_)	(CLIPTYPE_FILTER_MOVIE & (1 << _FileType_))
#define _IsFileTypeDivx(_FileType_)	(CLIPTYPE_FILTER_DIVX & (1 << _FileType_))
#define _IsFileTypeMpeg(_FileType_)	(eClipType_MPEG == _FileType_)

#define _IsFileTypeVideo(_FileType_)	((CLIPTYPE_FILTER_MOVIE | CLIPTYPE_FILTER_PHOTO) & (1 << _FileType_))

/***************************************************************************************
*	Structure 	: 	MS_PARAM_CLIPS_MENU
*
*	Members	: 	2. mbJpegHasFinished	= 	This flag is set to TRUE if, during MP3 + JPEG playback, the JPEG
*										finishes playing first. In this case, the last JPEG has to be displayed
*										continuously untill the background MP3 is finished playing.
*
*				3. mwRequestedClipNum		=  This value mainly used for to keep Requested track index. 
*											Also used for to keep absolutly index in Item Access.
*
*				4. mbIsRipping			=	TRUE if ripping is in progress.
*
*				5. _mcRippingDummy	=	This is to make the total byte count an even number.
*										Should be deleted if no longer required.
*
*	Desc 	:	This structure contains a list of parameters used by the clips menu.
 ****************************************************************************************/
typedef struct ms_param_clips_menu {
	BOOL					mbJpegHasFinished;
	UINT16 					mwRequestedClipNum;
	UINT32 					mwRequestedTimeIndex;
	BOOL					mbPlayJPEGIndefinitely;
#ifdef D_GUI_TOOLKIT_ADD_RIPPING
	BOOL					mbIsRipping;
	UINT8					_mcRippingDummy;
#endif
} MS_PARAM_CLIPS_MENU;

/***************************************************************************************
*	Structure 	: 	MSO_CLIPS_MENU
*
*	Members	: 	1. moMenu 	=	Base of all menus.
*
*				2. moParam	=	Clips menu parameters.
*
*	Desc 	:	The Clips menu structure.
****************************************************************************************/
typedef struct mso_clips_menu {
	MSO_MENU				moMenu;
	MS_PARAM_CLIPS_MENU	moParam;
} MSO_CLIPS_MENU;

/***************************************************************************************
*	Structure 	: 	MS_DESCRIPTOR_CLIPS_MENU
*
*	Members	: 	None.
*
*	Desc 	:	The Clips menu desriptor structure.
****************************************************************************************/
typedef MS_DESCRIPTOR_MENU		MS_DESCRIPTOR_CLIPS_MENU;


/***************************************************************************************
*	Structure 	: 	MS_PARAM_HELP_TEXT
*
*	Members	: 	1. mwCurrFileIndex 	=	current playing file index.
*
*
*	Desc 	:	The help text parameter structure.
****************************************************************************************/
typedef struct{
	UINT16					mwCurrFileIndex;
}MS_PARAM_HELP_TEXT;

/***************************************************************************************
*	Structure 	: 	MSO_HELP_TEXT
*
*	Members	: 	1. moParam 	=	current playing file index.
*
*
*	Desc 	:	The help text  structure.
****************************************************************************************/
typedef struct {
	MSO_HSCROLL_TEXT			moHscrollText;
	MS_PARAM_HELP_TEXT		moParam;
}MSO_HELP_TEXT;

/***************************************************************************************
*	Structure 	: 	EXT_INFO_CONFIG
*
*	Members	: 	1. moParam 	=	current playing file index.
*
*
*	Desc 	:	The help text  structure.
****************************************************************************************/
typedef struct{
	OSD_MESSAGES		eString;
	enClipsExtInfoType		eInfoType;
}EXT_INFO_CONFIG;
/***************************************************************************************
*	Structure 	: 	MS_PARAM_PREVIEW_WINDOW
*
*	Members	: 	1. mwWidth 	=	Width of the JPEG being currently previewed.
*
*				2. mwHeight	=	Height of the JPEG being currently previewed.
*                          3. mcTimer     =    Time out in ticks for which to wait for focus on same JPEG track beyond
*                                                      one time value, After the time out,  this focus  track  will be in preview.
*                          4. mwClipNum  =   focus item number
*                          5. mwDirNum   =   focus item directory number
*                          6. bDecoding   =    JPEG file is Decoding or not.
*
*	Desc 	:	This structure contains a list of parameters used by the JPEG preview window.
****************************************************************************************/
typedef struct ms_param_preview_window {
	UINT16	mwWidth;
	UINT16	mwHeight;
	UINT8     mcTimer;
	UINT16	mwClipNum;
	UINT16	mwDirNum;
	BOOL     bDecoding;
} MS_PARAM_PREVIEW_WINDOW;

/***************************************************************************************
*	Structure 	: 	MSO_PREVIEW_WINDOW
*
*	Members	: 	1. moObject 	=	Base of all menu system objects.
*
*				2. moParam	=	Preview window parameters.
*
*	Desc 	:	The preview window structure.
****************************************************************************************/
typedef struct mso_preview_window {
	MSO_OBJECT					moObject;
	MS_PARAM_PREVIEW_WINDOW	moParam;
} MSO_PREVIEW_WINDOW;


/***************************************************************************************
*	Structure 	: 	MSO_BROWSER_VLIST
*
*	Members	: 	1. moVlist .
*
*				2. moParam	
*
*	Desc 	:	This structure contains a list of parameters used by BrowserVlist
****************************************************************************************/
#ifdef D_GUI_ITEM_ACCESS
typedef struct mso_browser_param_vlist {
	ITEM_ACCESS_TYPE		mwItemAccessType;
} MSO_BROSWER_PARAM_VLIST;

typedef struct mso_browser_vlist {
	MSO_VLIST						moVlist;
	MSO_BROSWER_PARAM_VLIST		moParam;
} MSO_BROWSER_VLIST;

/***************************************************************************************
* The Item Access  component descriptor.
****************************************************************************************/
typedef struct  ms_descriptor_item_access_component {
	MS_DESCRIPTOR_COMPONENT   moDescriptor;
	CONST UINT8*				mpBgBmp;		// Background bitmap
} MS_DESCRIPTOR_ITEM_ACCESS_COMPONENT;

typedef MSO_COMPONENT MSO_ITEM_ACCESS_COMPONENT;

#else //D_GUI_ITEM_ACCESS
typedef 	MSO_VLIST	MSO_BROWSER_VLIST;
#endif //D_GUI_ITEM_ACCESS


/***************************************************************************************
*	Structure 	: 	MS_PARAM_PLAYSTATE
*
*	Members	: 	1. mtPlayState 	=	Current play state.
*
*				2. mnScanSpeed	=	Current Scan speed.
*
*	Desc 	:	This structure contains a list of parameters used by the Play state object.
****************************************************************************************/
typedef struct ms_param_playstate {
	PLAY_STATE 	mtPlayState;
	INT16 		mnScanSpeed;
} MS_PARAM_PLAYSTATE;

/***************************************************************************************
*	Structure 	: 	MSO_PLAYSTATE
*
*	Members	: 	1. moObject 	=	Base of all menu system objects.
*
*				2. moParam	=	Play state parameters.
*
*	Desc 	:	The Play state structure.
****************************************************************************************/
typedef struct mso_playstate {
	MSO_OBJECT			moObject;
	MS_PARAM_PLAYSTATE	moParam;
} MSO_PLAYSTATE;

/***************************************************************************************
*	Structure 	: 	MS_DESCRIPTOR_PLAYSTATE
*
*	Members	: 	1. moDescriptor	=	The base of all descriptors.
*
*				2. mwTextColor	=	Text color.
*
*	Desc 	:	The Vertical list descriptor.
****************************************************************************************/
typedef struct ms_descriptor_playstate {
	MS_DESCRIPTOR	moDescriptor;
	UINT16			mwTextColor;
}MS_DESCRIPTOR_PLAYSTATE;

/***************************************************************************************
*	Structure 	: 	MS_PARAM_PLAYFILE
*
*	Members	: 	1. mwActiveItem	=	Currently playing item.
*
*				2. mwTotalItems	=	Total number of items in the current directory.
*
*	Desc 	:	This structure contains a list of parameters used by the Play Info object.
****************************************************************************************/
typedef struct ms_param_playfile {
	UINT16 mwCurrentTrack;
	UINT16 mwTotalTracks;
} MS_PARAM_PLAYFILE;

/***************************************************************************************
*	Structure 	: 	MSO_PLAYFILE
*
*	Members	: 	1. moObject 	=	Base of all menu system objects.
*
*				2. moParam	=	Play item parameters.
*
*	Desc 	:	The Play Info structure.
****************************************************************************************/
typedef struct mso_playfile {
	MSO_OBJECT			moObject;
	MS_PARAM_PLAYFILE	moParam;
} MSO_PLAYFILE;

/***************************************************************************************
*	Structure 	: 	MS_DESCRIPTOR_PLAYFILE
*
*	Members	: 	1. moDescriptor		=	The base of all descriptors.
*
*				2. mwTextColor	=	Text color.
*
*	Desc 	:	MSO_PLAYFILE descriptor.
****************************************************************************************/
typedef struct ms_descriptor_playfile {
	MS_DESCRIPTOR	moDescriptor;
	UINT16			mwTextColor;
}MS_DESCRIPTOR_PLAYFILE;

/***************************************************************************************
*	Structure 	: 	MS_PARAM_PLAYTIME
*
*	Members	: 	1. mwElapsedTime	=	Elapsed time.
*
*	Desc 	:	This structure contains a list of parameters used by the Play Info object.
****************************************************************************************/
typedef struct ms_param_playtime {
	UINT16 mwElapsedTime;
} MS_PARAM_PLAYTIME;

/***************************************************************************************
*	Structure 	: 	MSO_PLAYTIME
*
*	Members	: 	1. moObject 	=	Base of all menu system objects.
*
*				2. moParam	=	Play Info parameters.
*
*	Desc 	:	The Play Info structure.
****************************************************************************************/
typedef struct mso_playtime {
	MSO_OBJECT			moObject;
	MS_PARAM_PLAYTIME	moParam;
} MSO_PLAYTIME;

/***************************************************************************************
*	Structure 	: 	MS_DESCRIPTOR_PLAYTIME
*
*	Members	: 	1. moDescriptor	=	The base of all descriptors.
*
*				3. mwTextColor	=	Text color of the time.
*
*	Desc 	:	The Vertical list descriptor.
****************************************************************************************/
typedef struct ms_descriptor_playtime {
	MS_DESCRIPTOR	moDescriptor;