/**
 ********************************************************************
 * @file    gdu_widget.h
 * @brief   This is the header file for "gdu_widget.c", defining the structure and
 * (exported) function prototypes.
 *
 * @copyright (c) 2021 GDU. All rights reserved.
 *
 * All information contained herein is, and remains, the property of GDU.
 * The intellectual and technical concepts contained herein are proprietary
 * to GDU and may be covered by U.S. and foreign patents, patents in process,
 * and protected by trade secret or copyright law.  Dissemination of this
 * information, including but not limited to data and other proprietary
 * material(s) incorporated within the information, in any form, is strictly
 * prohibited without the express written consent of GDU.
 *
 * If you receive this source code without GDU’s authorization, you may not
 * further disseminate the information, and you must immediately remove the
 * source code and notify GDU of its removal. GDU reserves the right to pursue
 * legal actions against you for any loss(es) or damage(s) caused by your
 * failure to do so.
 *
 *********************************************************************
 */

/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef GDU_WIDGET_H
#define GDU_WIDGET_H

/* Includes ------------------------------------------------------------------*/
#include <gdu_typedef.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Exported constants --------------------------------------------------------*/
/*! The maximum length of a message that can be displayed by the mobile app floating window */
#define GDU_WIDGET_FLOATING_WINDOW_MSG_MAX_LEN         255

/* Exported types ------------------------------------------------------------*/
/**
 * @brief Widget types.
 */
typedef enum {
    GDU_WIDGET_TYPE_BUTTON = 1, /*!< button widget type */
    GDU_WIDGET_TYPE_SWITCH = 2, /*!< switch widget type */
    GDU_WIDGET_TYPE_SCALE = 3, /*!< scale widget type */
    GDU_WIDGET_TYPE_LIST = 4, /*!< list widget type */
    GDU_WIDGET_TYPE_INT_INPUT_BOX = 5, /*!< integer input box widget type */
} E_GduWidgetType;

/**
 * @brief Button widget state.
 */
typedef enum {
    GDU_WIDGET_BUTTON_STATE_PRESS_DOWN = 1, /*!< Button is pressed down */
    GDU_WIDGET_BUTTON_STATE_RELEASE_UP = 0, /*!< Button is released up */
} E_GduWidgetButtonState;

/**
 * @brief Switch widget state.
 */
typedef enum {
    GDU_WIDGET_SWITCH_STATE_OFF = 0, /*!< Switch is turned off */
    GDU_WIDGET_SWITCH_STATE_ON = 1 /*!< Switch is turned on */
} E_GduWidgetSwitchState;

/**
 * @brief Switch widget speaker work mode.
 */
typedef enum {
    GDU_WIDGET_SPEAKER_WORK_MODE_TTS = 0,
    GDU_WIDGET_SPEAKER_WORK_MODE_VOICE = 1,
	GDU_WIDGET_SPEAKER_WORK_MODE_REAL_TIME_VOICE = 2,
} E_GduWidgetSpeakerWorkMode;

/**
 * @brief Switch widget speaker play mode.
 */
typedef enum {
    GDU_WIDGET_SPEAKER_PLAY_MODE_SINGLE_PLAY = 0,
    GDU_WIDGET_SPEAKER_PLAY_MODE_LOOP_PLAYBACK = 1,
} E_GduWidgetSpeakerPlayMode;

/**
 * @brief Switch widget speaker state.
 */
typedef enum {
    GDU_WIDGET_SPEAKER_STATE_IDEL = 0,
    GDU_WIDGET_SPEAKER_STATE_TRANSMITTING = 1,
    GDU_WIDGET_SPEAKER_STATE_PLAYING = 2,
    GDU_WIDGET_SPEAKER_STATE_ERROR = 3,
    GDU_WIDGET_SPEAKER_STATE_IN_TTS_CONVERSION = 4,
} E_GduWidgetSpeakerState;

/**
 * @brief Switch widget speaker data type.
 */
typedef enum {
    GDU_WIDGET_SPEAKER_MP3 = 0,
    GDU_WIDGET_SPEAKER_OPUS = 1,
    GDU_WIDGET_SPEAKER_AAC = 2,
} E_GduWidgetSpeakerDataType;


typedef enum {
    GDU_WIDGET_SPEAKER_RATE_8K = 0,
	GDU_WIDGET_SPEAKER_RATE_12K = 1,
    GDU_WIDGET_SPEAKER_RATE_16K = 2,
	GDU_WIDGET_SPEAKER_RATE_22K = 3,
	GDU_WIDGET_SPEAKER_RATE_24K = 4,
	GDU_WIDGET_SPEAKER_RATE_32K = 5,
	GDU_WIDGET_SPEAKER_RATE_44K = 6,
	GDU_WIDGET_SPEAKER_RATE_48K = 7,
	GDU_WIDGET_SPEAKER_RATE_96K = 8,
}E_GduWidgetSpeakerSampling;

typedef enum {
    GDU_WIDGET_SPEAKER_RATE_SINGLE = 0,
    GDU_WIDGET_SPEAKER_RATE_DOUBLE = 1,
}E_GduWidgetSpeakerSoundTrack;

typedef enum {
    GDU_WIDGET_SPEAKER_DIGIT_8 = 0,
    GDU_WIDGET_SPEAKER_DIGIT_16 = 1,
	GDU_WIDGET_SPEAKER_DIGIT_32 = 2,
}E_GduWidgetSpeakerDigit;

/**
 * @brief Switch widget transmit data event.
 */
typedef enum {
    GDU_WIDGET_TRANSMIT_DATA_EVENT_START,
    GDU_WIDGET_TRANSMIT_DATA_EVENT_TRANSMIT,
    GDU_WIDGET_TRANSMIT_DATA_EVENT_FINISH,
    GDU_WIDGET_TRANSMIT_DATA_EVENT_ABORT,
} E_GduWidgetTransmitDataEvent;

/**
 * @brief Widget file binary array.
 */
typedef struct {
    char *fileName; /*!< The file name of the widget file */
    uint32_t fileSize; /*!< The file size of the widget file, uint : byte */
    const uint8_t *fileBinaryArray; /*!< The binary C array of the widget file */
} T_GduWidgetFileBinaryArray;

/**
 * @brief Widget binary array config.
 */
typedef struct {
    uint16_t binaryArrayCount; /*!< Binary array count. */
    T_GduWidgetFileBinaryArray *fileBinaryArrayList; /*!< Pointer to binary array list */
} T_GduWidgetBinaryArrayConfig;

/**
 * @brief Widget handler item.
 */
typedef struct {
    /*! The index of widget, the index can be numbered starting from 0 and cannot be repeated */
    uint32_t widgetIndex;

    /*! The type of widget, refer to ::E_GduWidgetType */
    E_GduWidgetType widgetType;

    /**
     * @brief Prototype of callback function used to set widget value, the function will be call when the user triggers
     *        the widget.
     * @param widgetType: the type of widget, refer to ::E_GduWidgetType.
     * @param index: the index of widget.
     * @param value: the value of widget, need be set.
     * if the widget type is GDU_WIDGET_TYPE_BUTTON, the value is refer to ::E_GduWidgetButtonState;
     * if the widget type is GDU_WIDGET_TYPE_SWITCH, the value is refer to ::E_GduWidgetSwitchState;
     * if the widget type is GDU_WIDGET_TYPE_SCALE, the value is range from 0 to 100, which represents the percentage
     * of the scale slider;
     * if the Widget type is GDU_WIDGET_TYPE_LIST, the value is range from 0 to N-1 (N is the value of list item
     * count), which represents which item is chosen;
     * if the widget type is GDU_WIDGET_TYPE_INT_INPUT_BOX, the value is the input value of int input box widget.
     * @param userData: the user data need used in callback.
     * @return Execution result.
     */
    T_GduReturnCode (*SetWidgetValue)(E_GduWidgetType widgetType, uint32_t index, int32_t value, void *userData);

    /**
     * @brief Prototype of callback function used to get widget value.
     * @param widgetType: the type of widget, refer to ::E_GduWidgetType.
     * @param index
     * @param value: the value of widget, need be set.
     * if the widget type is GDU_WIDGET_TYPE_BUTTON, the value is refer to ::E_GduWidgetButtonState;
     * if the widget type is GDU_WIDGET_TYPE_SWITCH, the value is refer to ::E_GduWidgetSwitchState;
     * if the widget type is GDU_WIDGET_TYPE_SCALE, the value is range from 0 to 100, which represents the percentage
     * of the scale slider;
     * if the Widget type is GDU_WIDGET_TYPE_LIST, the value is range from 0 to N-1 (N is the value of list item
     * count), which represents which item is chosen;
     * if the widget type is GDU_WIDGET_TYPE_INT_INPUT_BOX, the value is the input value of int input box widget.
     * @param userData: the user data need used in callback function.
     * @return Execution result.
     */
    T_GduReturnCode (*GetWidgetValue)(E_GduWidgetType widgetType, uint32_t index, int32_t *value, void *userData);

    /*! the user data need used in SetWidgetValue and GetWidgetValue callback function. */
    void *userData;
} T_GduWidgetHandlerListItem;

typedef struct {
    union {
        /*! When event is 'GDU_WIDGET_TRANSMIT_DATA_EVENT_START', the buf contains file name, uuid and decoder bitrate. */
        struct {
            uint8_t fileName[32];
            uint8_t fileUuid[32];
            uint32_t fileDecodeBitrate;
        } transDataStartContent;

        /*! When event is 'GDU_WIDGET_TRANSMIT_DATA_EVENT_START', the buf contains file md5 sum. */
        struct {
            uint8_t md5Sum[16];
        } transDataEndContent;
    };
} T_GduWidgetTransDataContent;

typedef struct {
    E_GduWidgetSpeakerState state;
    E_GduWidgetSpeakerWorkMode workMode;
    E_GduWidgetSpeakerPlayMode playMode;
    uint8_t volume;
} T_GduWidgetSpeakerState;

typedef struct {
    E_GduWidgetSpeakerDataType dataType;
    E_GduWidgetSpeakerSampling samplingRate;
    E_GduWidgetSpeakerSoundTrack soundTrack;
    E_GduWidgetSpeakerDigit digit;
} T_GduWidgetSpeakerParam;

typedef struct {
    T_GduReturnCode (*GetSpeakerState)(T_GduWidgetSpeakerState *speakerState);
    T_GduReturnCode (*SetWorkMode)(E_GduWidgetSpeakerWorkMode workMode);
    T_GduReturnCode (*SetPlayMode)(E_GduWidgetSpeakerPlayMode playMode);
    T_GduReturnCode (*SetVolume)(uint8_t volume);

    T_GduReturnCode (*StartPlay)(void);
    T_GduReturnCode (*StopPlay)(void);

    T_GduReturnCode (*ReceiveTtsData)(E_GduWidgetTransmitDataEvent event,
                                      uint32_t offset, uint8_t *buf, uint16_t size);
    T_GduReturnCode (*ReceiveVoiceData)(E_GduWidgetTransmitDataEvent event,
                                        uint32_t offset, uint8_t *buf, uint16_t size);

    T_GduReturnCode (*ReceiveMp3VoiceData)(E_GduWidgetTransmitDataEvent event,
                                        uint32_t offset, uint8_t *buf, uint16_t size);
    T_GduReturnCode (*ReceiveRealTimeVoiceData)(E_GduWidgetTransmitDataEvent event,
                                        uint32_t offset, uint8_t *buf, uint16_t size);
    T_GduReturnCode (*GetSpeakerParam)(T_GduWidgetSpeakerParam *speakerParam);
} T_GduWidgetSpeakerHandler;

/* Exported functions --------------------------------------------------------*/
/**
 * @brief Initialise widget module, and user should call this function before using widget features.
 * @return Execution result.
 */
T_GduReturnCode GduWidget_Init(void);

/**
 * @brief  Register default widget UI configuration file directory path.
 * @note Under Linux system, there are two functions to set the custom widget configuration directory path, function
 *       GduWidget_RegDefaultConfigByDirPath and GduWidget_RegUiConfigByDirPath. When you don't need multi-language
 *       and multi-screen size support, you can just use GduWidget_RegDefaultUiConfigByDirPath function set widget UI
 *       Config directory path. If you need support multi-language and multi-screen size support, you can use function
 *       GduWidget_RegUiConfigByDirPath to specify widget configuration. When the language and screen size is not
 *       cover in your setting by GduWidget_RegUiConfigByDirPath, the widget UI configuration uses setting by
 *       GduWiget_RegDefaultUiConfigByDirPath function.
 * @param widgetConfigDirPath: the widget UI configuration directory path.
 * @return Execution result.
 */
T_GduReturnCode GduWidget_RegDefaultUiConfigByDirPath(const char *widgetConfigDirPath);

/**
 * @brief Register widget UI configuration file directory path.
 * @note Different widget UI configurations for several language and screen size require the same widget type, index and
 * count.
 * @param appLanguage: mobile app language type.
 * @param appScreenType: mobile app screen type.
 * @param widgetConfigDirPath: the widget UI configuration directory path.
 * @return Execution result.
 */
T_GduReturnCode GduWidget_RegUiConfigByDirPath(E_GduMobileAppLanguage appLanguage,
                                               E_GduMobileAppScreenType appScreenType,
                                               const char *widgetConfigDirPath);

/**
 * @brief Register default widget UI config by binary array configuration.
 * @note In RTOS, most likely there is no file system. The widget config file content can use C array express. Use this
 * function and GduWidget_RegDefaultUiConfigBinaryArray set widget UI configuration. When the language and screen size
 * is not cover in your setting by GduWidget_RegUiConfigByBinaryArray, the widget UI configuration uses setting by this
 * function.
 * @param binaryArrayConfig: the binary array config for widget UI configuration.
 * @return Execution result.
 */
T_GduReturnCode GduWidget_RegDefaultUiConfigByBinaryArray(const T_GduWidgetBinaryArrayConfig *binaryArrayConfig);

/**
 * @brief Register widget UI config by binary array configuration.
 * @note Different widget UI configurations for several language and screen size require the same widget type, index and
 * count.
 * @param appLanguage: mobile app language type.
 * @param screenType: mobile app screen type.
 * @param binaryArrayConfig: the binary array config for widget UI configuration.
 * @return Execution result.
 */
T_GduReturnCode GduWidget_RegUiConfigByBinaryArray(E_GduMobileAppLanguage appLanguage,
                                                   E_GduMobileAppScreenType screenType,
                                                   const T_GduWidgetBinaryArrayConfig *binaryArrayConfig);

/**
 * @brief Register handler list for widgets.
 * @param widgetHandlerList: widget handler list for widgets.
 * @param itemCount: the item count of widget handler list.
 * @return Execution result.
 */
T_GduReturnCode GduWidget_RegHandlerList(const T_GduWidgetHandlerListItem *widgetHandlerList, uint32_t itemCount);

/**
 * @brief Send message to mobile app floating window.
 * @note the message length can't more than GDU_WIDGET_FLOATING_WINDOW_MSG_MAX_LEN. The max data bandwidth of floating
 * windows message is 2KB/s.
 * @param str: pointer to message string.
 * @return Execution result.
 */
T_GduReturnCode GduWidgetFloatingWindow_ShowMessage(const char *str);

/**
 * @brief Get data transmission state of floating window channel. User can use the state as base for controlling
 * floating windows message send.
 * @param state: pointer to floating window channel state.
 * @return Execution result.
 */
T_GduReturnCode GduWidgetFloatingWindow_GetChannelState(T_GduDataChannelState *state);

/**
 * @brief Register the handler for widget speaker function interfaces.
 * @note This interface registers the widget speaker function interface, including speaker settings, play operation,
 * speaker status interface.
 * @param widgetSpeakerHandler: pointer to the handler for widget speaker functions.
 * @return Execution result.
 */
T_GduReturnCode GduWidget_RegSpeakerHandler(const T_GduWidgetSpeakerHandler *widgetSpeakerHandler);
#ifdef __cplusplus
}
#endif

#endif // GDU_WIDGET_H
/************************ (C) COPYRIGHT GDU Innovations *******END OF FILE******/