/* **************************************************************************************
*  Copyright (c) 2005 ZORAN Corporation, All Rights Reserved
*  THIS IS UNPUBLISHED PROPRIETARY SOURCE CODE OF ZORAN CORPORATION
*
*  File: $Workfile: o_dvdvr_defs.h $
*
* Description:
* ============
*
****************************************************************************************/
#include "Config.h"		// Global Configuration - do not remove!

#ifndef __O_DVDVR_DEFS_H__
#define __O_DVDVR_DEFS_H__

#include "GUI\Menu_system\ms_component_defs.h"

/***************************************************************************************
*	Enumeration 	: 	PGC_TYPE
*
*	Desc 		:	Program Chain Type
****************************************************************************************/
typedef enum
{
	PGC_TYPE_ORIGINAL		= 0	,
	PGC_TYPE_USERDEFINED		,
	PGC_TYPE_NONE
} PGC_TYPE;

/***************************************************************************************
*	Structure : 	MS_PARAM_DVDVR
*
*	Members	: 	1. mcProgramChain 	= Display the Original Program list if 
*									   PGC_TYPE_ORIGINAL, otherwise display the 
*									   User Defined Program list.
*
*				2. mbDisplayActiveTitle	= Display the active title in the Browser list when TRUE.
*
*	Desc 	:	The DVDVR component parameters.
****************************************************************************************/
typedef struct ms_param_dvdvr {
	UINT8	mcProgramChain;
	BOOL	mbDisplayActiveItem;
}MS_PARAM_DVDVR;

/***************************************************************************************
* The DVDVR component object.
****************************************************************************************/
typedef struct mso_dvdvr {	
	MSO_COMPONENT 		moComponent;
	MS_PARAM_DVDVR	moParam;
}MSO_DVDVR;

/***************************************************************************************
* The DVDVR component descriptor.
****************************************************************************************/
typedef struct ms_descriptor_dvdvr {
	MS_DESCRIPTOR_COMPONENT 	moDescriptor;
	CONST UINT8* 				mpBgBmp;		// Background bitmap
	UINT16						mwTextColor;		// Text color	
}MS_DESCRIPTOR_DVDVR;

/***************************************************************************************
*	Structure : 	MSO_DISCNAME
*
*	Members	: 	None.
*
*	Desc 	:	This text object displays the disc name of DVDVR in the tray.
****************************************************************************************/
typedef MSO_TEXT MSO_DISCNAME;

/***************************************************************************************
*	Structure : 	MS_DESCRIPTOR_DISCNAME
*
*	Members	: 	None.
*
*	Desc 	:	Discriptor of the MSO_DISCNAME text object.
****************************************************************************************/
typedef MS_DESCRIPTOR_TEXT MS_DESCRIPTOR_DISCNAME;

/***************************************************************************************
*	Structure : 	MS_PARAM_PROGRAM_CHAIN
*
*	Members	: 	1. mtProgramChain	= 0 if the Original Program Chain is currently displayed.
*
*	Desc 	:	This structure contains a list of parameters used by the Program chain object.
****************************************************************************************/
typedef struct ms_param_program_chain {
	PGC_TYPE	mtProgramChain;	
} MS_PARAM_PROGRAM_CHAIN;

/***************************************************************************************
*	Structure : 	MSO_PROGRAM_CHAIN
*
*	Members	: 	None.
*
*	Desc 	:	This text object displays the current program chain (Original / User Defined).
****************************************************************************************/
typedef struct mso_program_chain {
	MSO_TEXT					moText;
	MS_PARAM_PROGRAM_CHAIN	moParam;
} MSO_PROGRAM_CHAIN;

/***************************************************************************************
*	Structure : 	MS_DESCRIPTOR_PROGRAM_CHAIN
*
*	Members	: 	None.
*
*	Desc 	:	Discriptor of the MSO_PROGRAM_CHAIN text object.
****************************************************************************************/
typedef MS_DESCRIPTOR_TEXT MS_DESCRIPTOR_PROGRAM_CHAIN;

/***************************************************************************************
*	Structure : 	MS_PARAM_PLAYTITLE
*
*	Members	: 	1. mwTitleCurrent	=	Currently playing title number.
*
*				2. mwTitlesTotal	=	Total number of titles in the current program chain.
*
*	Desc 	:	This structure contains a list of parameters used by the Play Info object.
****************************************************************************************/
typedef struct ms_param_playtitle {
	UINT16 mwTitleCurrent;
	UINT16 mwTitlesTotal;
} MS_PARAM_PLAYTITLE;

/***************************************************************************************
*	Structure : 	MSO_PLAYTITLE
*
*	Members	: 	1. moText 	=	Base of all text objects.
*
*				2. moParam	=	Play item parameters.
*
*	Desc 	:	The DVDVR Play Info structure.
****************************************************************************************/
typedef struct mso_playtitle {
	MSO_TEXT			moText;
	MS_PARAM_PLAYTITLE	moParam;
} MSO_PLAYTITLE;

/***************************************************************************************
*	Structure : 	MS_DESCRIPTOR_PLAYTITLE
*
*	Members	: 	None.
*
*	Desc 	:	oPlayTitleDescriptor descriptor.
****************************************************************************************/
typedef MS_DESCRIPTOR_TEXT MS_DESCRIPTOR_PLAYTITLE;

/***************************************************************************************
*	Structure : 	MS_PARAM_DVDVR_LISTITEM
*
*	Members	: 	1. mwScTitleName		= Scratch pad address where the title name string is stored.
*
*				2. mwScCreationTime	= Scratch pad address where the creation time string is stored.
*
*				3. mwAbsTitleIndex	= The absolute title index.
*
*				4. mbIsPlaying		= TRUE if this title is currently playing.
*
*	Desc 	:	This structure contains a list of parameters used by the list item object.
****************************************************************************************/
typedef struct ms_param_dvdvr_listitem {
	SC_PTR 	mwScTitleName;
	SC_PTR 	mwScCreationTime;
	UINT16 	mwAbsTitleIndex;
	BOOL	mbIsPlaying;
	UINT8	_mcDummy;
} MS_PARAM_DVDVR_LISTITEM;

/***************************************************************************************
*	Structure : 	MSO_DVDVR_LISTITEM
*
*	Members	: 	1. moText 	=	Base of all text objects.
*
*				2. moParam	=	List item parameters.
*
*	Desc 	:	The DVDVR list item structure.
****************************************************************************************/
typedef struct mso_dvdvr_listitem {
	MSO_OBJECT					moObject;
	MS_PARAM_DVDVR_LISTITEM	moParam;
} MSO_DVDVR_LISTITEM;

/***************************************************************************************
*	Structure : 	MS_DESCRIPTOR_DVDVR_LISTITEM
*
*	Members	: 	None
*
*	Desc 	:	MSO_DVDVR_LISTITEM descriptor.
****************************************************************************************/
typedef struct ms_descriptor_dvdvr_listitem {
	MS_DESCRIPTOR	moDescriptor;
	MS_COLOR_SET*	mpColorSetText;
	MS_BITMAP_SET*	mpBmpSetBg;
	FONT_INDEX		mtFontIndex;
} MS_DESCRIPTOR_DVDVR_LISTITEM;

/***************************************************************************************
*	Structure : 	MS_PARAM_DVDVR_HELPTEXT
*
*	Members	: 	1. mtProgramChain	=	0 if the Original Program Chain is currently displayed.
*
*	Desc 	:	This structure contains a list of parameters used by the DVDVR help text object.
****************************************************************************************/
typedef struct ms_param_dvdvr_helptext {
	PGC_TYPE	mtProgramChain;
} MS_PARAM_DVDVR_HELPTEXT;

/***************************************************************************************
*	Structure : 	MSO_DVDVR_HELPTEXT
*
*	Members	: 	1. moHScrollText 	=	Base of all H-Scroll text objects.
*
*				2. moParam		=	DVDVR help text parameters.
*
*	Desc 	:	The DVDVR list item structure.
****************************************************************************************/
typedef struct mso_dvdvr_helptext {
	MSO_HSCROLL_TEXT			moHScrollText;
	MS_PARAM_DVDVR_HELPTEXT	moParam;
} MSO_DVDVR_HELPTEXT;

/***************************************************************************************
*	Structure : 	MS_DESCRIPTOR_DVDVR_HELPTEXT
*
*	Members	: 	None.
*
*	Desc 	:	MSO_DVDVR_HELPTEXT descriptor.
****************************************************************************************/
typedef MS_DESCRIPTOR_HSCROLL_TEXT MS_DESCRIPTOR_DVDVR_HELPTEXT;


#endif // __O_DVDVR_DEFS_H__