/* 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 c_dm_dlna.h 
 *  $RCSfile: $
 *  $Revision: #1 $
 *  $Date: 2015/05/29 $
 *  $Author: brianpc.huang $
 *  
 *  @par Description:
 *             This file contains public API for manipulating dlna devices.
 */
/*----------------------------------------------------------------------------*/


#ifndef _C_DM_DLNA_H_
#define _C_DM_DLNA_H_

/*-----------------------------------------------------------------------------
                    include files
-----------------------------------------------------------------------------*/
#include "u_socket_dev.h"

/*!
 * @addtogroup    groupMW_FM_DLNAFS
 * @brief    Provide  API about DLNA device management.
 * 
 * @see groupMW_FM
 *
 * @{
 * */

typedef VOID (*c_sktdev_st_nfy_fct)(
    VOID              *pv_nfy_tag,          /*!< private data set from middleware */
    SKTDEV_STATUS_T   e_nfy_st,             /*!< device status */
    VOID              *pv_data              /*!< notification data sent from socket device */
);
/*-----------------------------------------------------------------------------
                    External functions implementations
 ----------------------------------------------------------------------------*/
/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_release_device(UINT32 ui4_id)
 * @brief    Release  dlna device by the index maintained in dm.
 *
 * @param    [in] ui4_id - the index identify the device.
 *
 */
extern VOID c_dm_dlna_release_device(UINT32 ui4_id);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_get_device(UINT32 ui4_id)
 * @brief    Get the pointer of dlna device by index.
 *
 * @param    [in] ui4_id - the index identify the device.
 *
 * @return the pointer of the device.
 */
extern VOID* c_dm_dlna_get_device(UINT32 ui4_id);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_init()
 * @brief    Initialize dlna implementation system.
 */
extern VOID c_dm_dlna_init(VOID);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_register_notify(c_sktdev_st_nfy_fct pf_sktdev_st_nfy, VOID*  pv_tag)
 * @brief    Register callback function to receive event about device adding or removing.
 *
 * @param    [in] pf_sktdev_st_nfy - callback functon.
 * @param    [in] pv_tag - tag data sent back when callback.
 *
 * @return error code.
 * @retval    return 0 if success, otherwise means fail.
 */
extern INT32 c_dm_dlna_register_notify(c_sktdev_st_nfy_fct pf_sktdev_st_nfy, VOID*  pv_tag);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_deregister_notify(c_sktdev_st_nfy_fct pf_sktdev_st_nfy, VOID*  pv_tag)
 * @brief    un-Register callback function..
 *
 * @param    [in] pf_sktdev_st_nfy - callback functon.
 * @param    [in] pv_tag - tag data sent back when callback.
 *
 * @return error code.
 * @retval    return 0 if success, otherwise means fail.
 */
extern VOID c_dm_dlna_deregister_notify(c_sktdev_st_nfy_fct pf_sktdev_st_nfy, VOID*  pv_tag);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_dmp_start(VOID)
 * @brief    Start dlna dmp, so that all dlna devices can be found.
 *
 */
extern VOID c_dm_dlna_dmp_start(VOID);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_dmp_stop(VOID)
 * @brief    Stop dlna dmp.
 *
 */
extern VOID c_dm_dlna_dmp_stop(VOID);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_dmp_suspend(VOID)
 * @brief    suspend dlna dmp, so that dmp function is paused.
 *
 */
extern VOID c_dm_dlna_dmp_suspend(VOID);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_dmp_resume(VOID)
 * @brief    Restart the dlna dmp.
 *
 */
extern VOID c_dm_dlna_dmp_resume(VOID);

/*-----------------------------------------------------------------------------*/
/*! @fn VOID c_dm_dlna_dmp_refresh_dms_state(VOID)
 * @brief    Refresh dms state, so that dms' states will be updated.
 */
extern VOID c_dm_dlna_dmp_refresh_dms_state(VOID);

/*! @} */

#endif /*_C_DM_DLNA_H_*/
