hdmvmod.h

这是DVD中伺服部分的核心代码

/*****************************************************************************
******************************************************************************
**                                                                          **
**  Copyright (c) 2005-2006 Videon Central, Inc.                            **
**  All rights reserved.                                                    **
**                                                                          **
**  The computer program contained herein contains proprietary information  **
**  which is the property of Videon Central, Inc.  The program may be used  **
**  and/or copied only with the written permission of Videon Central, Inc.  **
**  or in accordance with the terms and conditions stipulated in the        **
**  agreement/contract under which the programs have been supplied.         **
**                                                                          **
******************************************************************************
*****************************************************************************/
/**
 * @file hdmvmod.h
 *
 * Defines the API to the BD-ROM Navigator's HDMV Module.
 * The HDMV Module is responsible for processing Movie Objects
 * and Button Objects in HDMV mode.
 *
 * $Id: hdmvmod.h,v 1.10 2006/10/25 23:38:48 rbehe Exp $
 */

#ifndef HDMVMOD_H
#define HDMVMOD_H

#ifdef __cplusplus
extern "C" {
#endif

#include "vdvd_types.h"

/**
 * HDMV Module Status types
 */
typedef ERR_CODE HDMVMOD_STATUS;
#define HDMVMOD_SUCCESS         (HDMVMOD_STATUS)(0)
#define HDMVMOD_FAILURE         (HDMVMOD_STATUS)(-1)
#define HDMVMOD_NULL_PTR        (HDMVMOD_STATUS)(-2)
#define HDMVMOD_INVALID_PARAM   (HDMVMOD_STATUS)(-3)
#define HDMVMOD_NOT_IMPLEMENTED (HDMVMOD_STATUS)(-4)

/**
 * HDMV Module State
 */
typedef enum tagHDMVMOD_STATE
{
    HDMVMOD_STATE_TERMINATED = 0,
    HDMVMOD_STATE_RUNNING,
    HDMVMOD_STATE_INVALID
} HDMVMOD_STATE;

/**
 * HDMV Callback Events
 */
typedef enum tagHDMV_EVENT_CODE
{
    HDMV_EVENT_MOBJ_COMPLETE = 0,
    HDMV_EVENT_RESUME_MOBJ,
    HDMV_EVENT_JUMP_MOBJ,
    HDMV_EVENT_CALL_MOBJ,
    HDMV_EVENT_JUMP_TITLE,
    HDMV_EVENT_CALL_TITLE,
    HDMV_EVENT_INVALID
} HDMV_EVENT_CODE;

/**
 * HDMV Callback
 */
typedef void (*HDMV_CALLBACK)(PVOID pvContext, HDMV_EVENT_CODE event, ULONG ulParam);

/**
 * HDMV Module API functions
 */
HDMVMOD_STATUS  HdmvModInitialize(HDMV_CALLBACK callback, PVOID pvContext);
HDMVMOD_STATUS  HdmvModUninitialize(void);
HDMVMOD_STATE   HdmvModGetState(void);
HDMVMOD_STATUS  HdmvModProcessMobj(ULONG ulMobjID);
HDMVMOD_STATUS  HdmvModTerminateMobj(void);
HDMVMOD_STATUS  HdmvModSuspendMobj(ULONG *pulCmdID);
HDMVMOD_STATUS  HdmvModResumeMobj(ULONG ulMobjID, ULONG ulCmdID);
HDMVMOD_STATUS  HdmvModLoadMobj(ULONG ulMobjID, ULONG ulCmdID);
HDMVMOD_STATUS  HdmvModAllocBobjBuffer(MVOBJ_NAV_COMMAND **ppButtonProgram, ULONG ulNumberOfCommands);
HDMVMOD_STATUS  HdmvModFreeBobjBuffer(MVOBJ_NAV_COMMAND *pButtonProgram);
HDMVMOD_STATUS  HdmvModProcessBobj(MVOBJ_NAV_COMMAND *pButtonProgram, ULONG ulNumberOfCommands, PVOID pContext);
HDMVMOD_STATUS  HdmvModPlaybackComplete(void);
HDMVMOD_STATUS  HdmvModNavTimerExpire(void);
HDMVMOD_STATUS  HdmvModSetTitleRepeat(BOOLEAN fOnOff);
BOOLEAN         HdmvModIsTitleRepeatOn(void);
uint32          HdmvModGetNavCmdID(void);

#ifdef __cplusplus
}
#endif

#endif