xref: /utopia/UTPA2-700.0.x/mxlib/include/apiVOIPMFE.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)

//<MStar Software>
//******************************************************************************
// MStar Software
// Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
// All software, firmware and related documentation herein ("MStar Software") are
// intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
// law, including, but not limited to, copyright law and international treaties.
// Any use, modification, reproduction, retransmission, or republication of all
// or part of MStar Software is expressly prohibited, unless prior written
// permission has been granted by MStar.
//
// By accessing, browsing and/or using MStar Software, you acknowledge that you
// have read, understood, and agree, to be bound by below terms ("Terms") and to
// comply with all applicable laws and regulations:
//
// 1. MStar shall retain any and all right, ownership and interest to MStar
//    Software and any modification/derivatives thereof.
//    No right, ownership, or interest to MStar Software and any
//    modification/derivatives thereof is transferred to you under Terms.
//
// 2. You understand that MStar Software might include, incorporate or be
//    supplied together with third party`s software and the use of MStar
//    Software may require additional licenses from third parties.
//    Therefore, you hereby agree it is your sole responsibility to separately
//    obtain any and all third party right and license necessary for your use of
//    such third party`s software.
//
// 3. MStar Software and any modification/derivatives thereof shall be deemed as
//    MStar`s confidential information and you agree to keep MStar`s
//    confidential information in strictest confidence and not disclose to any
//    third party.
//
// 4. MStar Software is provided on an "AS IS" basis without warranties of any
//    kind. Any warranties are hereby expressly disclaimed by MStar, including
//    without limitation, any warranties of merchantability, non-infringement of
//    intellectual property rights, fitness for a particular purpose, error free
//    and in conformity with any international standard.  You agree to waive any
//    claim against MStar for any loss, damage, cost or expense that you may
//    incur related to your use of MStar Software.
//    In no event shall MStar be liable for any direct, indirect, incidental or
//    consequential damages, including without limitation, lost of profit or
//    revenues, lost or damage of data, and unauthorized system use.
//    You agree that this Section 4 shall still apply without being affected
//    even if MStar Software has been modified by MStar in accordance with your
//    request or instruction for your use, except otherwise agreed by both
//    parties in writing.
//
// 5. If requested, MStar may from time to time provide technical supports or
//    services in relation with MStar Software to you for your use of
//    MStar Software in conjunction with your or your customer`s product
//    ("Services").
//    You understand and agree that, except otherwise agreed by both parties in
//    writing, Services are provided on an "AS IS" basis and the warranty
//    disclaimer set forth in Section 4 above shall apply.
//
// 6. Nothing contained herein shall be construed as by implication, estoppels
//    or otherwise:
//    (a) conferring any license or right to use MStar name, trademark, service
//        mark, symbol or any other identification;
//    (b) obligating MStar or any of its affiliates to furnish any person,
//        including without limitation, you and your customers, any assistance
//        of any kind whatsoever, or any information; or
//    (c) conferring any license or right under any intellectual property right.
//
// 7. These terms shall be governed by and construed in accordance with the laws
//    of Taiwan, R.O.C., excluding its conflict of law rules.
//    Any and all dispute arising out hereof or related hereto shall be finally
//    settled by arbitration referred to the Chinese Arbitration Association,
//    Taipei in accordance with the ROC Arbitration Law and the Arbitration
//    Rules of the Association by three (3) arbitrators appointed in accordance
//    with the said Rules.
//    The place of arbitration shall be in Taipei, Taiwan and the language shall
//    be English.
//    The arbitration award shall be final and binding to both parties.
//
//******************************************************************************
//<MStar Software>
////////////////////////////////////////////////////////////////////////////////
//
// Copyright (c) 2009-2010 MStar Semiconductor, Inc.
// All rights reserved.
//
// Unless otherwise stipulated in writing, any and all information contained
// herein regardless in any format shall remain the sole proprietary of
// MStar Semiconductor Inc. and be kept in strict confidence
// ("MStar Confidential Information") by the recipient.
// Any unauthorized act including without limitation unauthorized disclosure,
// copying, use, reproduction, sale, distribution, modification, disassembling,
// reverse engineering and compiling of the contents of MStar Confidential
// Information is unlawful and strictly prohibited. MStar hereby reserves the
// rights to any and all damages, losses, costs and expenses resulting therefrom.
//
////////////////////////////////////////////////////////////////////////////////

///////////////////////////////////////////////////////////////////////////////////////////////////
///
/// @file   apiVOIPMFE.h
/// @brief  MStar Multi Format Video Encoder driver
/// @author MStar Semiconductor Inc.
/// @version 1.0
///////////////////////////////////////////////////////////////////////////////////////////////////

/*! \defgroup VDEC VDEC modules

    *! \defgroup VENC VENC(video encoder) interface.
     *  \ingroup VDEC
    This is the MStar Multi Format Video Encoder driver

    <b>Calling sequences</b>

   -# MApi_MFE_Initialize
   -# MApi_MFE_Encode
   -# MApi_MFE_CompressOnePicture     //loop
   -# (optional) MApi_MFE_GetVOL
   -# (optional) MApi_MFE_SetConfig
   -# (optional) MApi_MFE_GetConfig
   -# MApi_MFE_DeInitialize

 *! \defgroup MFE Multi Format Video Encoder driver
 *  \ingroup VENC

 * *! \defgroup MFE_BASIC MFE driver basic.
 *  \ingroup MFE

 *! \defgroup MFE_CONFIG MFE driver set/get configure.
 *  \ingroup MFE

 *! \defgroup MFE_OPERATION MFE driver operation.
 *  \ingroup MFE

 *! \defgroup MFE_toBeRemove MFE driver API to be removed.
 *  \ingroup MFE
 */

#ifndef _API_VOIP_MFE_H_
#define _API_VOIP_MFE_H_

#ifdef __cplusplus
extern "C"
{
#endif

// below function is used for T8/T12/Janus2 VOIP project

/* vop coding modes */
// type: I_VOP, P_VOP, or B_VOP
#define I_VOP        0UL
#define P_VOP        1UL
#define B_VOP        2UL


// OBSOLETE
 typedef enum {
    PQ_LOW,
    PQ_NORMAL,
    PQ_HIGH
 } PQ_LEVEL;

// OBSOLETE
 typedef enum {
    VOIP_MPEG4,
    VOIP_H263,
    VOIP_H264,
    VOIP_JPEG
 } VOIP_CODEC_TYPE;

// Codec type
typedef enum {
    MPEG4_ENC = 0,  // OBSOLETE
    H263_ENC = 1,   // OBSOLETE
    H264_ENC = 2,   // H.264 encoder
    JPEG_ENC = 3,   // OBSOLETE
    UNKNOWN_TYPE = 0xFF
} MFE_CODEC_TYPE;


/*
typedef enum {
    MFE_RET_OK                      = 1,
    MFE_RET_FAIL                    = -1000,
    MFE_RET_CLOSE_FAIL              = -1002,

    MFE_RET_DEC_INIT_FAIL           = -2000,

    MFE_RET_INVALID_PARAM           = -4000
} MFE_ERROR_CODE;
*/

//-------------------------------------------------------------------------------------------------
/// Configuration type for MApi_MFE_SetConfig and MApi_MFE_GetConfig
///
///     MFE_ENC_SETCONF_FRAME_TYPE
///         (MS_S32*) value: frame type
///         If frame type is I_VOP, force compress I frame.
///
///     MFE_ENC_SETCONF_CHANGE_FRAME_RATE
///         (MS_S32*) value: frame rate x 100
///         Sets frame rate.
///
///     MFE_ENC_SETCONF_CHANGE_BIT_RATE
///         (MS_S32*) value: bit rate (bits per second)
///         Sets bit rate.
///
///     MFE_ENC_SETCONF_OUT_BSP_BUFFER
///         (MEMMAP_t*) value: output buffer descriptor
///         Sets output buffer.
///
///     MFE_ENC_SETCONF_FRAME_TAG
///         (MS_S32*) value: frame type
///         Sets a tag associated the next frame.
///         This value can be retrieved with MFE_ENC_GETCONF_FRAME_TAG.
///
///     MFE_ENC_SETCONF_CHANGE_BIT_RATE_AND_FRAME_RATE
///         (PVR_Info*) value: encode info
///         Sets frame rate and bit rate using PVR_Info's nBitrate and FrameRatex100 fields.
///
///     MFE_ENC_SETCONF_RESET_SPSPPS
///         (void*) value: not used
///         Resets SPS and PPS header content with current configuration.
///
///     MFE_ENC_SETCONF_SET_COLORFORMAT
///         (MS_S32*) value: input data format (MFE_COLOR_FORMAT_INFO)
///         Sets input data format with values from MFE_COLOR_FORMAT_INFO.
///
///     MFE_ENC_GETCONF_FRAME_TAG
///         (MS_U32*) value: frame tag
///         Gets frame tag previously set by MFE_ENC_SETCONF_FRAME_TAG.
///
///     MFE_ENC_GETCONF_OUT_BSP_BUFFER
///         (MEMMAP_t*) value: output buffer descriptor
///         Gets descriptor of output buffer.
///
///     MFE_ENC_GETCONF_CONFIG
///         (PVR_Info*) value: encode info
///         Gets a copy of encode info used during initialization.
///
//-------------------------------------------------------------------------------------------------
typedef enum {
    MFE_ENC_SETCONF_FRAME_TYPE = 100,
    MFE_ENC_SETCONF_CHANGE_FRAME_RATE,
    MFE_ENC_SETCONF_CHANGE_BIT_RATE,
    MFE_ENC_SETCONF_OUT_BSP_BUFFER,
    MFE_ENC_SETCONF_FRAME_TAG,
    MFE_ENC_SETCONF_JPE_QUALITY,                        // OBSOLETE
    MFE_ENC_SETCONF_CHANGE_BIT_RATE_AND_FRAME_RATE,
    MFE_ENC_SETCONF_RESET_SPSPPS,
    MFE_ENC_SETCONF_SET_COLORFORMAT,

    MFE_ENC_GETCONF_FRAME_TAG = 300,
    MFE_ENC_GETCONF_OUT_BSP_BUFFER,
    MFE_ENC_GETCONF_JPE_QUALITY,                        // OBSOLETE
    MFE_ENC_GETCONF_DROP,                               // OBSOLETE
    MFE_ENC_GETCONF_CONFIG,
} MFE_ENC_CONF;

// <<< Calling sequences >>>
//
//      MApi_MFE_Initialize
//      MApi_MFE_Encode
//      MApi_MFE_CompressOnePicture     //loop
//      (optional) MApi_MFE_GetVOL
//      (optional) MApi_MFE_SetConfig
//      (optional) MApi_MFE_GetConfig
//      MApi_MFE_DeInitialize


//-------------------------------------------------------------------------------------------------
/// Notify driver to start encoder.
/// @ingroup MFE_toBeRemove
/// @return TRUE : succeed
/// @return FALSE : fail
//-------------------------------------------------------------------------------------------------
MS_BOOL MApi_MFE_Encode(void);

//-------------------------------------------------------------------------------------------------
/// Encode one frame.
/// @ingroup MFE_BASIC
/// @param  YUVPlane               \b IN: DRAM location of input frame data.
/// @param  bForceIframe           \b IN: If TRUE, force this frame to be I-frame.
/// @return TRUE : succeed
/// @return FALSE : fail
//-------------------------------------------------------------------------------------------------
MS_BOOL MApi_MFE_CompressOnePicture_ex(MEMMAP_CUR_t YUVPlane, MS_BOOL bForceIframe);

//-------------------------------------------------------------------------------------------------
/// Get bitstream header.
/// @ingroup MFE_BASIC
/// @param  header_info              \b OUT: return header size and length.
/// @return TRUE : succeed
/// @return FALSE : fail
//-------------------------------------------------------------------------------------------------
MS_BOOL MApi_MFE_GetVOL_ex(void *header_info);

//-------------------------------------------------------------------------------------------------
/// De-initialize MFE driver
/// @ingroup MFE_BASIC
/// @return TRUE : succeed
/// @return FALSE : fail
//-------------------------------------------------------------------------------------------------
MS_BOOL MApi_MFE_DeInitialize(void);

//-------------------------------------------------------------------------------------------------
/// Get MFE driver state.
/// @ingroup MFE_operation
/// @return MFE driver state
//-------------------------------------------------------------------------------------------------
MFE_STATE MApi_MFE_GetState(void);


//-------------------------------------------------------------------------------------------------
/// Initializes MFE driver.
/// @ingroup MFE_CONFIG
/// @param  in_Info                \b IN: encoding paramemters
/// @param  out_cb                 \b IN: callback function invoked after frame is encoded
/// @param  mfe_CleanBufStatus     \b IN: callback function invoked to signal input buffer status
/// @param  ctx                    \b IN: custom context to be associated with encode task
/// @return TRUE : succeed
/// @return FALSE : fail
//-------------------------------------------------------------------------------------------------
MS_BOOL MApi_MFE_Initialize_ex(PVR_Info* in_Info,
StreamCallback out_cb,CleanCallback mfe_CleanBufStatus, void *ctx);

//-------------------------------------------------------------------------------------------------
/// Set config to MFE driver.
/// @ingroup MFE_CONFIG
/// @param  conf_type              \b IN: set config type.
/// @param  value                  \b IN: set config value.
/// @return TRUE : succeed
/// @return FALSE : fail
//-------------------------------------------------------------------------------------------------
MS_BOOL MApi_MFE_SetConfig(MFE_ENC_CONF conf_type, void *value);

//-------------------------------------------------------------------------------------------------
/// Get config from MFE driver.
/// @ingroup MFE_CONFIG
/// @param  conf_type              \b IN: get config type.
/// @param  value                  \b OUT: return config value.
/// @return TRUE : succeed
/// @return FALSE : fail
//-------------------------------------------------------------------------------------------------
MS_BOOL MApi_MFE_GetConfig(MFE_ENC_CONF conf_type, void *value);

//-------------------------------------------------------------------------------------------------
/// Get MFE HW capability.
/// @ingroup MFE_CONFIG
/// @param  pDrv                 \b OUT: Get HW capability.
/// @param  len                  \b OUT: Get HW capability length of struct.
/// @return TRUE : succeed
/// @return FALSE : fail
//-------------------------------------------------------------------------------------------------
MS_BOOL MApi_MFE_GetHWCap(MFE_HwCapV0 *pDrv, MS_U32 *len);
#ifdef __cplusplus
}
#endif

#endif