/* SPDX-License-Identifier: LGPL-2.1-only OR BSD-3-Clause */
/******************************************************************************
 *
 * This file is provided under a dual license.  When you use or
 * distribute this software, you may choose to be licensed under
 * version 2.1 of the GNU Lesser General Public License
 * ("LGPLv2.1 License") or BSD License.
 *
 * LGPLv2.1 License
 *
 * Copyright(C) 2019 MediaTek Inc.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of version 2.1 of the GNU Lesser General Public
 * License as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html for more
 * details.
 *
 * BSD LICENSE
 *
 * Copyright(C) 2019 MediaTek Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *  * Neither the name of the copyright holder nor the names of its
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *****************************************************************************/

/*----------------------------------------------------------------------------*/
/*! @file 
 *  $RCSfile: $
 *  $Revision: #1 $
 *  $Date: 2015/06/02 $
 *  $Author: cong.wang $
 *  
 *  @par Description:
 *         This header file contains DRM specific definitions,
 *         which are exported.
 */
/*----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*/
/*! @defgroup groupMW_DRM DRM
 *
 *  @ingroup groupMW
 *  @brief Provides a unified interface for DRM
 *
 *  @see groupMW
 *  @{ 
 */
/*----------------------------------------------------------------------------*/

#ifndef _U_DRM_H_
#define _U_DRM_H_
/*-----------------------------------------------------------------------------
                    include files
 ----------------------------------------------------------------------------*/

#ifdef __cplusplus
extern "C" {
#endif
/*-----------------------------------------------------------------------------
                    macros, defines, typedefs, enums
 ----------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*/
/*! @struct DRM_OUTPUT_SIGNAL_PROTECTION_INFO_T
 *  @brief  This structure defines the drm output signal protection info.
 *  @code
 *  typedef struct _DRM_OUTPUT_SIGNAL_PROTECTION_INFO_T
 *  {
 *  #define CGMSA_COPYFREELY ((UINT8)0)
 *  #define CGMSA_COPYNOMORE ((UINT8)1)
 *  #define CGMSA_COPYONCE ((UINT8)2)
 *  #define CGMSA_COPYNEVER ((UINT8)3)
 *      UINT8 ui1_cgmsa_flag; 
 *  #define ACPTB_OFF ((UINT8)0)
 *  #define ACPTB_AGC ((UINT8)1)
 *  #define ACPTB_2LCB ((UINT8)2)
 *  #define ACPTB_4LCB ((UINT8)3)                                             
 *      UINT8 ui1_acptb_flag;   
 *  #define DIGITAL_PROTECTION_OFF ((UINT8)0)
 *  #define DIGITAL_PROTECTION_ON ((UINT8)1)                                            
 *      UINT8 ui1_digital_protection_flag;  
 *  #define ICT_OFF ((UINT8)0)
 *  #define ICT_ON ((UINT8)1)
 *      UINT8 ui1_ict_flag;
 *  } DRM_OUTPUT_SIGNAL_PROTECTION_INFO_T;
 *  @endcode
 *  @li@c  ui1_cgmsa_flag               - indicate CGMSA parameter.
 *  @li@c  ui1_acptb_flag               - indicate ACPTB parameter.
 *  @li@c  ui1_digital_protection_flag  - indicate Digital Protection parameter.
 *  @li@c  ui1_ict_flag                 - indicate ICT parameter. 
 */
/*---------------------------------------------------------------------------*/
typedef struct _DRM_OUTPUT_SIGNAL_PROTECTION_INFO_T
{
/* 
   CGMSA
   00 - CopyFreely
   01 - CopyNoMore
   10 - CopyOnce
   11 - CopyNever
*/    
#define CGMSA_COPYFREELY ((UINT8)0)
#define CGMSA_COPYNOMORE ((UINT8)1)
#define CGMSA_COPYONCE ((UINT8)2)
#define CGMSA_COPYNEVER ((UINT8)3)
    UINT8 ui1_cgmsa_flag; 
/*
   ACPTB
   00 - off
   01 - automatic gain control
   10 - 2 line color burst
   11 - 4 line color burst
*/
#define ACPTB_OFF ((UINT8)0)
#define ACPTB_AGC ((UINT8)1)
#define ACPTB_2LCB ((UINT8)2)
#define ACPTB_4LCB ((UINT8)3)                                             
    UINT8 ui1_acptb_flag;   
/*
   Digital Protection
   0 - off
   1 - on
*/
#define DIGITAL_PROTECTION_OFF ((UINT8)0)
#define DIGITAL_PROTECTION_ON ((UINT8)1)                                            
    UINT8 ui1_digital_protection_flag;  
/*
   ICT
   0 - analog HD allowed
   1 - analog image must be constrained
*/
#define ICT_OFF ((UINT8)0)
#define ICT_ON ((UINT8)1)
    UINT8 ui1_ict_flag;
} DRM_OUTPUT_SIGNAL_PROTECTION_INFO_T;

/*-----------------------------------------------------------------------------
                    extern data declarations
 ----------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------
                    data declarations
 ----------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------
                    functions declarations
 ----------------------------------------------------------------------------*/

#ifdef __cplusplus
}
#endif

#endif /* _U_DRM_H_ */

/*----------------------------------------------------------------------------*/
/*! @} */                                               /* end of groupMW_DRM */
/*----------------------------------------------------------------------------*/
