viewer/include/msg-ui-viewer-play-view.h

   1 /*
   2  * Copyright 2012  Samsung Electronics Co., Ltd
   3  *
   4  * Licensed under the Flora License, Version 1.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *    http://floralicense.org/license
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __MSG_UI_VIEWER_PLAY_VIEW_H__
  18 #define __MSG_UI_VIEWER_PLAY_VIEW_H__
  19 /*==================================================================================================
  20  *                                                                      INCLUDE HEADERS
  21  *==================================================================================================*/
  22 #include <msg.h>
  23
  24 #include "msg-smil-player-interface.h"
  25 #include "msg-ui-viewer-types.h"
  26
  27 #include <Ecore.h>
  28 #include <Elementary.h>
  29 #include <ui-gadget-module.h>
  30
  31 /*==================================================================================================
  32  *                                                                      DEFINITIONS
  33  *==================================================================================================*/
  34 #define VIEWER_BUFFER_SIZE_64 64
  35 #define VIEWER_TITLE_MENU_GENLIST_MAX_ITEM 3
  36 #define VIEWER_TITLE_MENU_LINE_HEIGHT 129
  37 #define VIEWER_ATTACH_GL_ITEM_HEIGHT 112
  38 #define VIEWER_TITLE_FONT_LEN 100
  39 #define VIEWER_NAVI_FRAME_HEIGHT 98
  40 #define VIEWER_NAVIFRAME_BOTTOM_H 114
  41
  42 #define VIEWER_PLAY_CONTROLLER_LIFETIME 3
  43 #define VIEWER_PLAY_CONTROLLER_PROGRESSBAR_TIME 1
  44 #define VIEWER_PLAY_CONTROLLER_HEIGHT 218
  45
  46 #define VIEWER_DETAILS_TEXT_SPACE " "
  47 #define VIEWER_DETAILS_TEXT_LEFT_BRACE "("
  48 #define VIEWER_DETAILS_TEXT_RIGHT_BRACE ")"
  49 #define VIEWER_DETAILS_TEXT_MSG_SIZE_KB 1024
  50
  51 #define MSG_VIEWER_EDJ EDJDIR"/msg_viewer.edj"
  52 /*==================================================================================================
  53  *                                                                              ENUMERATIONS
  54  *==================================================================================================*/
  55 typedef enum {
  56         MSG_VIEWER_PLAY = 0,
  57         MSG_VIEWER_PAUSE,
  58         MSG_VIEWER_STOP,
  59         MSG_VIEWER_CLOSE,
  60         MSG_VIEWER_UNKOWN,
  61 } MSG_VIEWER_PLAY_STATUS_E;
  62
  63 typedef enum {
  64         MSG_VIEWER_ACTION_NONE = 0,
  65         MSG_VIEWER_ACTION_TOOLBAR_PLAY,         /* action tapping play button in play toolbar */
  66         MSG_VIEWER_ACTION_TOOLBAR_PAUSE,        /* action tapping pause button in play toolbar */
  67         MSG_VIEWER_ACTION_AUTO_PLAY,            /* action auto play by related UX flow */
  68         MSG_VIEWER_ACTION_AUTO_PAUSE,           /* action auto pause by related UX flow */
  69 } MSG_VIEWER_ACTION_TYPE_E;
  70
  71 typedef enum {
  72         MSG_VIEWER_DEFAULT_MODE = 0,
  73         MSG_VIEWER_LOAD_OTHER_UG_MODE,  /*launch other ug mode like calling contact ug*/
  74         MSG_VIEWER_LOAD_OTHER_APP_MODE, /*launch other application mode like calling voice call*/
  75 } MSG_VIEWER_LAUNCH_CMD_TYPE_E;
  76
  77 typedef enum {
  78         MSG_VIEWER_CMD_NONE = 0,
  79         MSG_VIEWER_CMD_LOAD_CONTACT,
  80         MSG_VIEWER_CMD_LOAD_EMAIL_COMPOSER,
  81         MSG_VIEWER_CMD_LOAD_MESSAGE_COMPOSER,
  82         MSG_VIEWER_CMD_LOAD_CALL,
  83         MSG_VIEWER_CMD_LOAD_VIDEO_CALL,
  84         MSG_VIEWER_CMD_LOAD_BROWSER
  85 } MSG_VIEWER_CMD_TYPE_E;
  86
  87 typedef enum {
  88         MSG_VIEWER_FILE_SAVE_SUCCESS = 0,
  89         MSG_VIEWER_FILE_SAVE_FAILED,
  90         MSG_VIEWER_FILE_SAVE_INVALID_ERROR,
  91 } MSG_VIEWER_FILE_SAVE_STATUS_E;
  92
  93 typedef enum {
  94         MSG_VIEWER_POPUP_NONE = 0,
  95         MSG_VIEWER_NORMAL_POPUP,
  96         MSG_VIEWER_DELETE_POPUP,
  97         MSG_VIEWER_ATTACHMENTS_POPUP,
  98         MSG_VIEWER_DETAILS_POPUP,
  99         MSG_VIEWER_MENU_CTX_POPUP,
 100         MSG_VIEWER_CUTLINK_POPUP,
 101         MSG_VIEWER_TITLE_MENU_POPUP,
 102         MSG_VIEWER_BLOCK_POPOP,
 103 } MSG_VIEWER_POPUP_TYPE_E;
 104
 105 typedef enum {
 106         MSG_VIEWER_MEDIA_INVALID = 0,
 107         MSG_VIEWER_MEDIA_IMG,
 108         MSG_VIEWER_MEDIA_AUDIO,
 109         MSG_VIEWER_MEDIA_VIDEO,
 110         MSG_VIEWER_MEDIA_TEXT,
 111         MSG_VIEWER_MEDIA_ANIMATE,
 112         MSG_VIEWER_MEDIA_IMG_OR_VIDEO,
 113         MSG_VIEWER_MEDIA_ATTACH,
 114         MSG_VIEWER_MEDIA_DRM,
 115 } MSG_VIEWER_MEDIA_TYPE_E;
 116
 117 typedef enum {
 118         MSG_VIEWER_OPTION_CONTACT = 0,
 119         MSG_VIEWER_OPTION_BLOCK,
 120 } MSG_VIEWER_OPTION_CHANGE_TYPE_E;
 121
 122 typedef enum {
 123         MSG_VIEWER_FONT_SIZE_NONE,
 124         MSG_VIEWER_ACCESSIBILITY_FONT_SIZE,
 125         MSG_VIEWER_MSG_FONT_SIZE
 126 } MSG_VIEWER_FONT_SIZE_TYPE_E;
 127
 128 typedef enum {
 129         MSG_VIEWER_FONT_CHANGE_LOAD_SETTING,
 130         MSG_VIEWER_FONT_CHANGE_LATEST_UPDATE,
 131 } MSG_VIEWER_FONT_CHANGE_TYPE_E;
 132
 133 typedef enum {
 134         MSG_VIEWER_ENTRY_NORMAL_TEXT,
 135         MSG_VIEWER_ENTRY_HELP_TEXT,
 136 } MSG_VIEWER_ENTRY_TYPE_E;
 137 /*==================================================================================================
 138  *                                                                              STRUCTURES
 139  *==================================================================================================*/
 140 typedef struct _MSG_VIEWER_ADDR_INFO_S{
 141         int contact_id;
 142         char address[MAX_ADDRESS_VAL_LEN+1];
 143         char name[MAX_DISPLAY_NAME_LEN+1];
 144 } MSG_VIEWER_ADDR_INFO;
 145
 146 typedef struct _MSG_VIEWER_ADDR_LIST_S{
 147         int addr_cnt;
 148         MSG_VIEWER_ADDR_INFO addr_info[MAX_TO_ADDRESS_CNT];
 149 } MSG_VIEWER_ADDR_LIST;
 150
 151 typedef struct _MSG_PLAY_DATA_S {
 152         struct ug_cbs   cbs;
 153         void    *viewer_main;
 154         Evas_Object *main_window;
 155         Evas_Object *navi_frame;
 156         Evas_Object *navi_title_layout;         /* navi title area layout */
 157         Evas_Object *title_button;                              /* navi title button */
 158         Evas_Object *attach_button;                             /* attachment button */
 159         Evas_Object *more_btn;                          /* control toolbar */
 160         Evas_Object *title_box_layout;                  /* title box layout for genlist */
 161         Evas_Object *play_layout;                               /* play viewer main layout */
 162         Evas_Object *subject_index_layout;      /* subject / page index */
 163         Evas_Object *play_controller;                   /* play controller */
 164         Evas_Object *progressbar;                               /* progressbar of play controller */
 165
 166         Evas_Object *help_page_gl;                      /* help page genlist */
 167         Evas_Object *save_attachment_gl;                /* save attachments genlist(controlbar menu) */
 168         Evas_Object *render_entry;                      /* entry handle of SMIL render */
 169
 170         Evas_Object *save_button;                       /* save attachment's popup button */
 171         Evas_Object *sa_check;                          /* select all check object in save attachment popup */
 172         Eina_Bool isSelectAll;                                  /* check if save attachments select all mode is enable */
 173
 174         Elm_Object_Item *navi_item;                     /* naviframe item */
 175
 176         Evas_Object *popup;                                     /*simple popup*/
 177         MSG_VIEWER_POPUP_TYPE_E popup_type;
 178         SMIL_SLIDE_CLIENT_CB_PARAM_S *smil_eventStatus;
 179
 180         int m_x;
 181         int m_y;
 182         int window_width;
 183         int window_height;
 184
 185         Ecore_Event_Handler *mouse_down_event_handler;
 186         Ecore_Event_Handler *mouse_up_event_handler;
 187
 188         msg_handle_t msgHandle; /*ipc handler between viewer and MF*/
 189         msg_struct_t msg_t;
 190         msg_struct_t mms_t;
 191         int     msgID;
 192         MSG_VIEWER_LAUNCH_CMD_TYPE_E launch_cmd;
 193         void *SmilHandle;
 194         MSG_VIEWER_PLAY_STATUS_E status;
 195         MSG_VIEWER_PLAY_STATUS_E previous_status;
 196         MSG_VIEWER_CMD_TYPE_E cmd_type;
 197         int font_size;
 198
 199         Ecore_Idler *del_idler;
 200         Ecore_Timer *play_controller_timer;
 201         Ecore_Timer *play_controller_progressbar_timer;
 202
 203         int ctrl_start_x;               /* play controller mouse pointer */
 204         int ctrl_start_y;               /* play controller mouse pointer */
 205         int ctrl_end_x;                 /* play controller mouse pointer */
 206         int ctrl_end_y;                 /* play controller mouse pointer */
 207
 208         int insert_count;       /*inserted contents count, except text file*/
 209         int attach_count;       /*attached contents count*/
 210
 211         Eina_List *insert_list; /*inserted content list */
 212         Eina_List *attach_list; /*attached contents list */
 213
 214         bool title_menu_opened; /* check if title button option is opened*/
 215         bool playcontroller_opened;             /*check play controller is shown or not */
 216         bool auto_resume_state;         /* check state of auto resume availablity */
 217         bool msg_box_viewer;    /* TRUE is viewer is launched from message box */
 218
 219         int totalProgressTime;          /* total progress time for all slide*/
 220         int elapsedProgressTime;                /*progress time from 1st slide to current slide*/
 221
 222         Elm_Genlist_Item_Class itc_title_single;        /* title button single recipient item */
 223         Elm_Genlist_Item_Class itc_title;       /* title button multi recipient item */
 224         Elm_Genlist_Item_Class hp_sa_class;     /* help page attach list save all item */
 225         Elm_Genlist_Item_Class hp_class;        /* help page attach list item */
 226         Elm_Genlist_Item_Class attach_sa_class; /*attachments select all item */
 227         Elm_Genlist_Item_Class attach_item_class;       /*attachments each item */
 228
 229         Elm_Theme *title_th;    /* title theme */
 230         Elm_Theme *progress_th;         /* progressbar theme*/
 231 } MSG_PLAY_DATA_S;
 232
 233 typedef struct {
 234         char pfile_name[MSG_VIEWER_FILENAME_MAX_LEN + 1];
 235         char pfile_path[MSG_VIEWER_FILEPATH_MAX_LEN + 1];
 236         int pfile_size;
 237         bool isSaveAll;                 /* for select all item */
 238         Eina_Bool isChecked;            /* check object status of save attachment genlist */
 239         Evas_Object *check_item;        /* check object for save attachments genlist */
 240         MSG_VIEWER_MEDIA_TYPE_E media_type;
 241         MSG_PLAY_DATA_S *viewer_play_data;
 242 } MSG_VIEWER_ATTACH_MEDIA_INFO_S;
 243 /*==================================================================================================
 244  *                                                                      FUNCTION DECLARATIONS
 245  *==================================================================================================*/
 246 MSG_BOOL msg_ui_viewer_create_player_view(MSG_PLAY_DATA_S *data);
 247
 248 /*
 249  *@fn           msg_ui_viewer_show_player_view(MSG_PLAY_DATA_S *data);
 250  *@brief                This function is used to show player view again when player view is already ready.
 251  * @param[in] data MSG_PLAY_DATA_S structure
 252  * @return      return TRUE if player view is playing, else FALSE
 253  */
 254 MSG_BOOL msg_ui_viewer_show_player_view(MSG_PLAY_DATA_S *data);
 255
 256 void msg_ui_viewer_play_view_init(void *data);
 257 void msg_ui_viewer_destroy_play_view(void *data);
 258 void msg_ui_viewer_connect_handler(void *data);
 259 void msg_ui_viewer_disconnect_handler(void *data);
 260
 261 /*
 262  *@fn           msg_ui_viewer_update_play_controller(void *data, MSG_VIEWER_PLAY_STATUS_E status);
 263  *@brief                This function is used to enable/disable prev & next button
 264  * @param[in] data MSG_PLAY_DATA_S structure
 265  * @param[in] status viewer play status.
 266  */
 267 void msg_ui_viewer_update_play_controller(void *data, MSG_VIEWER_PLAY_STATUS_E status);
 268 Evas_Object *msg_ui_viewer_create_navigation_layout(Evas_Object *parent);
 269 Evas_Object     *msg_ui_viewer_create_navi_title_layout(MSG_PLAY_DATA_S *data);
 270 void msg_ui_viewer_set_navi_title_layout(MSG_PLAY_DATA_S *data);
 271 void msg_ui_viewer_open_title_menu_genlist(void *data);
 272 void msg_ui_viewer_close_title_menu_genlist(void *data);
 273 void msg_ui_viewer_show_popup(void *data, Evas_Object *parent, char *pcontent);
 274 void msg_ui_viewer_create_msg_detail_popup(MSG_PLAY_DATA_S *data);
 275 void msg_ui_viewer_create_play_controller_timer(MSG_PLAY_DATA_S *data);
 276 void msg_ui_viewer_create_progressbar(MSG_PLAY_DATA_S *data, int slideIdx);
 277 void msg_ui_viewer_destroy_play_controller_progressbar_timer(MSG_PLAY_DATA_S *data);
 278 void msg_ui_viewer_destroy_play_controller_timer(MSG_PLAY_DATA_S *data);
 279 void msg_ui_viewer_copy_message_text_to_clipboard(MSG_PLAY_DATA_S *data);
 280
 281 /* ========================VIEWER  CALLBACK========================*/
 282 /*
 283  *@fn           msg_ui_viewer_smil_cb(SMIL_SLIDE_EVENT_PARAM_S *eventStatus, void *appUserData);
 284  *@brief                This function is SMIL callback function
 285  * @param[in] eventStatus  this is the slide info to be used by the application.
 286  * @param[in] appUserData appdata structure
 287  * @return MSG_SMIL_ERROR_E
 288  */
 289 MSG_SMIL_ERROR_E msg_ui_viewer_smil_cb(SMIL_SLIDE_CLIENT_CB_PARAM_S *eventStatus, void *appUserData);
 290 MSG_SMIL_ERROR_E msg_ui_viewer_set_entry_handle_cb(MSG_PLAY_DATA_S *data, void *entry);
 291
 292 Eina_Bool msg_ui_viewer_mouse_down_cb(void *data, int type, void *event);
 293 Eina_Bool msg_ui_viewer_mouse_up_cb(void *data, int type, void *event);
 294 void msg_ui_viewer_play_layout_mouse_down_cb(void *data, Evas *e, Evas_Object *obj, void *event_info);
 295 void msg_ui_viewer_play_layout_mouse_up_cb(void *data, Evas *e, Evas_Object *obj, void *event_info);
 296 void msg_ui_viewer_play_layout_clicked_cb(void *data, Evas_Object *obj, const char *emission, const char *source);
 297 void msg_ui_viewer_title_button_clicked_cb(void *data, Evas_Object *obj, void *event_info);
 298 void msg_ui_viewer_save_button_cb(void *data, Evas_Object *obj, void *event_info);
 299 void msg_ui_viewer_delete_button_cb(void *data, Evas_Object *obj, void *event_info);
 300 void msg_ui_viewer_forward_button_cb(void *data, Evas_Object *obj, void *event_info);
 301 void msg_ui_viewer_resend_button_cb(void *data, Evas_Object *obj, void *event_info);
 302 void msg_ui_viewer_reply_button_cb(void *data, Evas_Object *obj, void *event_info);
 303 void msg_ui_viewer_more_button_cb(void *data, Evas_Object *obj, void *event_info);
 304 void msg_ui_viewer_back_button_cb(void *data, Evas_Object *obj, void *event_info);
 305 void msg_ui_viewer_toolbar_email_cb(void *data, Evas_Object *obj, void *event_info);
 306 void msg_ui_viewer_toolbar_call_cb(void *data, Evas_Object *obj, void *event_info);
 307 void msg_ui_viewer_toolbar_vcall_cb(void *data, Evas_Object *obj, void *event_info);
 308 void msg_ui_viewer_toolbar_add_to_contact_cb(void *data, Evas_Object *obj, void *event_info);
 309 void msg_ui_viewer_toolbar_view_contact_cb(void *data, Evas_Object *obj, void *event_info);
 310 void msg_ui_viewer_toolbar_block_address_cb(void *data, Evas_Object *obj, void *event_info);
 311 void msg_ui_viewer_toolbar_unblock_address_cb(void *data, Evas_Object *obj, void *event_info);
 312
 313 /* Play controller */
 314 void msg_ui_viewer_volume_button_cb(void *data, Evas_Object *o, const char *emission, const char *source);
 315 void msg_ui_viewer_prev_button_cb(void *data, Evas_Object *o, const char *emission, const char *source);
 316 void msg_ui_viewer_play_pause_button_cb(void *data, Evas_Object *o, const char *emission, const char *source);
 317 void msg_ui_viewer_next_button_cb(void *data, Evas_Object *o, const char *emission, const char *source);
 318 Eina_Bool  msg_ui_viewer_play_controller_progressbar_timer_cb(void *data);
 319 Eina_Bool msg_ui_viewer_play_controller_timer_cb(void *data);
 320 MSG_BOOL msg_ui_viewer_command_play_pause(void *data, MSG_VIEWER_ACTION_TYPE_E action_type);
 321
 322 /* help page create cb - called from SMIL renderer */
 323 MSG_SMIL_ERROR_E msg_ui_viewer_help_page_smilrenderer_cb(MSG_PLAY_DATA_S *data, void **attach_list, void *box);
 324 void msg_ui_viewer_help_page_save_button_clicked_cb(void *data, Evas_Object *obj, void *event_info);
 325
 326 /* popup */
 327 void msg_ui_viewer_create_save_attachments_popup(MSG_PLAY_DATA_S *data);
 328 void msg_ui_viewer_popup_block_clicked_cb(void *data, Evas_Object *obj, void *event_info);
 329 void msg_ui_viewer_popup_timeout_cb(void *data, Evas_Object *obj, void *event_info);
 330
 331 /* message info */
 332 int msg_ui_viewer_get_thread_address_count(MSG_PLAY_DATA_S *data);
 333 void msg_ui_viewer_get_thread_address_nth_address(MSG_PLAY_DATA_S *data, int number, char **address, int *contact_id);
 334 void msg_ui_viewer_title_update(MSG_PLAY_DATA_S *data, MSG_VIEWER_OPTION_CHANGE_TYPE_E option_type);
 335 MSG_BOOL msg_ui_viewer_check_address_is_blocked(void *data, char *address, int *filter_id);
 336 void msg_ui_viewer_set_font_size(MSG_PLAY_DATA_S *data, MSG_VIEWER_ENTRY_TYPE_E entry_type, MSG_VIEWER_FONT_CHANGE_TYPE_E change_type);
 337 #endif  /* __MSG_UI_VIEWER_PLAY_VIEW_H__*/