wgui_image.c 36.7 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984
/*****************************************************************************
*  Copyright Statement:
*  --------------------
*  This software is protected by Copyright and the information contained
*  herein is confidential. The software may not be copied and the information
*  contained herein may not be used or disclosed except with the written
*  permission of MediaTek Inc. (C) 2005
*
*  BY OPENING THIS FILE, BUYER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
*  THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
*  RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO BUYER ON
*  AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL WARRANTIES,
*  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
*  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
*  NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
*  SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
*  SUPPLIED WITH THE MEDIATEK SOFTWARE, AND BUYER AGREES TO LOOK ONLY TO SUCH
*  THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. MEDIATEK SHALL ALSO
*  NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE RELEASES MADE TO BUYER'S
*  SPECIFICATION OR TO CONFORM TO A PARTICULAR STANDARD OR OPEN FORUM.
*
*  BUYER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND CUMULATIVE
*  LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
*  AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE MEDIATEK SOFTWARE AT ISSUE,
*  OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY BUYER TO
*  MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE. 
*
*  THE TRANSACTION CONTEMPLATED HEREUNDER SHALL BE CONSTRUED IN ACCORDANCE
*  WITH THE LAWS OF THE STATE OF CALIFORNIA, USA, EXCLUDING ITS CONFLICT OF
*  LAWS PRINCIPLES.  ANY DISPUTES, CONTROVERSIES OR CLAIMS ARISING THEREOF AND
*  RELATED THERETO SHALL BE SETTLED BY ARBITRATION IN SAN FRANCISCO, CA, UNDER
*  THE RULES OF THE INTERNATIONAL CHAMBER OF COMMERCE (ICC).
*
*****************************************************************************/
/*****************************************************************************
 *
 * Filename:
 * ---------
 *  wgui_image.c
 *
 * Project:
 * -------- 
 *  MAUI
 *
 * Description:
 * ------------
 *  Public Source
 *
 * Author:
 * -------
 * -------
 *
 *============================================================================
 *             HISTORY
 * Below this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *------------------------------------------------------------------------------
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 * removed!
 * removed!
 *
 * removed!
 *------------------------------------------------------------------------------
 * Upper this line, this part is controlled by PVCS VM. DO NOT MODIFY!!
 *============================================================================
 ****************************************************************************/
#include "MMI_features.h"
#include "MMIDataType.h"
#include "kal_release.h"
#include "MMI_trc_Int.h"
/*****************************************************************************
 * include
 ****************************************************************************/
/* Write your #include header file here */
#include "gui_image.h"
#include "wgui_image.h"

/*****************************************************************************
 * Static Declaration
 ****************************************************************************/
/* Define your local variable here */
/* Local variable are those variable only be used within this .c file. */

/* wgui_image_list includes WGUI_IMAGE_MAX_ANIMATION_COUNT's animated image 
 * components in the fore part, and followed WGUI_IMAGE_MAX_STILL_COUNT's 
 * still image components
 */
static gui_image_struct wgui_image_list[WGUI_IMAGE_MAX_COUNT];
static U32 wgui_image_count = 0;
/* Declare your local function here */
static void wgui_image_get_available_index(U32 *index);

/*****************************************************************************
 * Global Variable
 ****************************************************************************/
/* Write your global variable here */


/*****************************************************************************
 * Local Function
 ****************************************************************************/


/*****************************************************************************
 * FUNCTION
 *  wgui_image_get_available_index
 * DESCRIPTION
 *  the function used to get the index of the available image component
 * PARAMETERS
 *  index   [IN]
 * RETURNS
 *  void
 *****************************************************************************/
static void wgui_image_get_available_index(U32 *index)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    U32 i;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    /* when meet the first available index, return */
    for (i = 0 ; i < WGUI_IMAGE_MAX_COUNT; i++)
    {
        if (wgui_image_list[i].active == MMI_FALSE)
        {
            *index = i;
            return;
        }
    }
}


/*****************************************************************************
 * Global Function
 ****************************************************************************/
/* Write your global function here */
/*****************************************************************************
 * FUNCTION
 *  wgui_image_create_from_file
 * DESCRIPTION
 *  Create API of image component, , which create image from image file.
 *  It will return valid image_index if success.
 *  The API will return GDI_RESULT.
 * PARAMETERS
 *  image_index [IN/OUT]  index of image component, returned by wgui_image_create
 *  x           [IN]      x position of image component
 *  y           [IN]      y position of image component
 *  width       [IN]      width of image component
 *  height      [IN]      height of image component
 *  file_name   [IN]      name of image file
 *  flags       [IN]      flags
 *  target_layer[IN]      
 * RETURNS
 *  
 *****************************************************************************/
GDI_RESULT wgui_image_create_from_file(
            S32 *image_index,
            S32 x,
            S32 y,
            S32 width,
            S32 height,
            const PU8 file_name,
            U32 flags,
            gdi_handle target_layer)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    GDI_RESULT result = GDI_FAILED;
    U32 index;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    if (wgui_image_count >= WGUI_IMAGE_MAX_COUNT)
    {
        *image_index = WGUI_IMAGE_CREATE_NO_AVAILABLE_INDEX;
        return result;
    }

    wgui_image_get_available_index(&index);
    MMI_DBG_ASSERT(index < WGUI_IMAGE_MAX_COUNT);
    result = gui_image_create_from_file(
                 &wgui_image_list[index],
                 x,
                 y,
                 width,
                 height,
                 file_name,
                 flags,
                 target_layer);

    if (result == GDI_SUCCEED)
    {
        *image_index = (S32)index;
        wgui_image_count++;
    }
    else
    {
        *image_index = WGUI_IMAGE_CREATE_GDI_FAIL;
    }
    return result;
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_create_from_res
 * DESCRIPTION
 *  Create API of image component, which create image from resource.
 *  It will return valid image_index if success.
 *  The API will return GDI_RESULT.
 * PARAMETERS
 *  image_index [IN/OUT]  index of image component, returned by wgui_image_create
 *  x           [IN]      x position of image component
 *  y           [IN]      y position of image component
 *  width       [IN]      width of image component
 *  height      [IN]      height of image component
 *  image_res   [IN]      buffer of image resource
 *  flags       [IN]      flags
 *  target_layer[IN]      
 * RETURNS
 *  
 *****************************************************************************/
GDI_RESULT wgui_image_create_from_res(
            S32 *image_index,
            S32 x,
            S32 y,
            S32 width,
            S32 height,
            const PU8 image_res,
            U32 flags,
            gdi_handle target_layer)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    GDI_RESULT result = GDI_FAILED;
    U32 index;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    if (wgui_image_count >= WGUI_IMAGE_MAX_COUNT)
    {
        *image_index = WGUI_IMAGE_CREATE_NO_AVAILABLE_INDEX;
        return result;
    }

    wgui_image_get_available_index(&index);
    MMI_DBG_ASSERT(index < WGUI_IMAGE_MAX_COUNT);
    result = gui_image_create_from_res(
                 &wgui_image_list[index],
                 x,
                 y,
                 width,
                 height,
                 image_res,
                 flags,
                 target_layer);

    if (result == GDI_SUCCEED)
    {
        *image_index = (S32)index;
        wgui_image_count++;
    }
    else
    {
        *image_index = WGUI_IMAGE_CREATE_GDI_FAIL;
    }
    return result;
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_create_from_mem
 * DESCRIPTION
 *  Create API of image component, it will return valid image_index if success.
 *  The API will return GDI_RESULT.
 *  REMARK: gdi_image_type can be avatar, BMP, GIF, JPG, PNG, etc.
 *  Avatar can only use this API to create image component.
 *  If user use GDI_IMAGE_TYPE_INVALID in image_type, we will decode image type
 *  at first. But if use valid image type, we will just use this given type.
 * PARAMETERS
 *  image_index [IN/OUT]  index of image component, returned by wgui_image_create
 *  x           [IN]      x position of image component
 *  y           [IN]      y position of image component
 *  width       [IN]      width of image component
 *  height      [IN]      height of image component
 *  image_type  [IN]      gdi image type of image
 *  image_data  [IN]      buffer of image raw data
 *  flags       [IN]      flags
 *  target_layer[IN]      
 * RETURNS
 *  
 *****************************************************************************/
GDI_RESULT wgui_image_create_from_mem(
            S32 *image_index,
            S32 x,
            S32 y,
            S32 width,
            S32 height,
            U32 image_type,
            const PU8 image_data,
            U32 flags,
            gdi_handle target_layer)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    GDI_RESULT result = GDI_FAILED;
    U32 index;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    if (wgui_image_count >= WGUI_IMAGE_MAX_COUNT)
    {
        *image_index = WGUI_IMAGE_CREATE_NO_AVAILABLE_INDEX;
        return result;
    }

    wgui_image_get_available_index(&index);
    MMI_DBG_ASSERT(index < WGUI_IMAGE_MAX_COUNT);
    result = gui_image_create_from_mem(
                 &wgui_image_list[index],
                 x,
                 y,
                 width,
                 height,
                 image_type,
                 image_data,
                 flags,
                 target_layer);
    
    if (result == GDI_SUCCEED)
    {
        *image_index = (S32)index;
        wgui_image_count++;
    }
    else
    {
        *image_index = WGUI_IMAGE_CREATE_GDI_FAIL;
    }
    return result;
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_close
 * DESCRIPTION
 *  the function used to close image component
 * PARAMETERS
 *  image_index     [IN]   index of image component
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_close(S32 image_index)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    if (wgui_image_list[image_index].active == MMI_FALSE)
    {
        return;
    }
    gui_image_close(&wgui_image_list[image_index]);
    wgui_image_count--;
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_close_all
 * DESCRIPTION
 *  the function used to close all image components
 * PARAMETERS
 *  void
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_close_all(void)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    S32 i;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    if (wgui_image_count == 0)
    {
        return;
    }
    for (i = 0; i < WGUI_IMAGE_MAX_COUNT; i++)
    {
        if (wgui_image_list[i].active == MMI_FALSE)
        {
            continue;
        }
        gui_image_close(&wgui_image_list[i]);
    }
    wgui_image_count = 0;
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_move
 * DESCRIPTION
 *  the function used to move an image component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  x               [IN]
 *  y               [IN]
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_move(S32 image_index, S32 x, S32 y)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_move(&wgui_image_list[image_index], x, y);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_resize
 * DESCRIPTION
 *  the function used to resize an image component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  width           [IN]
 *  height          [IN]
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_resize(S32 image_index, S32 width, S32 height)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_resize(&wgui_image_list[image_index], width, height);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_show
 * DESCRIPTION
 *  the function used to show an image component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 * RETURNS
 *  GDI_RESULT      [OUT]   result of show
 *****************************************************************************/
GDI_RESULT wgui_image_show(S32 image_index)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    GDI_RESULT result;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    result = gui_image_show(&wgui_image_list[image_index]);
    gdi_layer_blt_previous(
        wgui_image_list[image_index].x,
        wgui_image_list[image_index].y,
        wgui_image_list[image_index].x + wgui_image_list[image_index].width - 1,
        wgui_image_list[image_index].y + wgui_image_list[image_index].height - 1);
    return result;
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_pause
 * DESCRIPTION
 *  the function used to pause the display of animated image component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_pause(S32 image_index)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    MMI_DBG_ASSERT(wgui_image_list[image_index].active == MMI_TRUE);
    gui_image_pause(&wgui_image_list[image_index]);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_resume
 * DESCRIPTION
 *  the function used to resume the display of animated image component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 * RETURNS
 *  GDI_RESULT      [OUT]   result of resume
 *****************************************************************************/
GDI_RESULT wgui_image_resume(S32 image_index)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    GDI_RESULT result;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    result = gui_image_resume(&wgui_image_list[image_index]);
    if (result == GDI_SUCCEED)
    {
        gdi_layer_blt_previous(
            wgui_image_list[image_index].x,
            wgui_image_list[image_index].y,
            wgui_image_list[image_index].x + wgui_image_list[image_index].width - 1,
            wgui_image_list[image_index].y + wgui_image_list[image_index].height - 1);
    }
    return result;
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_set_image_from_file
 * DESCRIPTION
 *  the function used to set image of component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  file_name       [IN]    name of image file
 * RETURNS
 *  GDI_RESULT      [OUT]   set success or fail
 *****************************************************************************/
GDI_RESULT wgui_image_set_image_from_file(
            S32 image_index,
            const PU8 file_name)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    MMI_DBG_ASSERT(file_name != NULL);
    return gui_image_set_image_from_file(
               &wgui_image_list[image_index],
               file_name);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_set_image_from_res
 * DESCRIPTION
 *  the function used to set image of component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  image_res       [IN]    buffer of image resource
 * RETURNS
 *  GDI_RESULT      [OUT]   set success or fail
 *****************************************************************************/
GDI_RESULT wgui_image_set_image_from_res(
            S32 image_index,
            const PU8 image_res)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    MMI_DBG_ASSERT(image_res != NULL);
    return gui_image_set_image_from_res(
               &wgui_image_list[image_index],
               image_res);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_set_image_from_mem
 * DESCRIPTION
 *  the function used to set image of component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  image_res       [IN]    buffer of image resource
 * RETURNS
 *  GDI_RESULT      [OUT]   set success or fail
 *****************************************************************************/
GDI_RESULT wgui_image_set_image_from_mem(
            S32 image_index,
            U32 image_type,
            const PU8 image_data)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    MMI_DBG_ASSERT(image_data != NULL);
    return gui_image_set_image_from_mem(
               &wgui_image_list[image_index],
               image_type,
               image_data);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_register_hide_function
 * DESCRIPTION
 *  the function used to set background of image component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  f               [IN]    hide func
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_register_hide_function(
      S32 image_index,
      void (*f) (S32 x1, S32 y1, S32 x2, S32 y2))
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_register_hide_function(&wgui_image_list[image_index], f);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_set_layer
 * DESCRIPTION
 *  the function used to set layer of image component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  target_layer    [IN]    target_layer
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_set_layer(S32 image_index, gdi_handle target_layer)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_set_layer(&wgui_image_list[image_index], target_layer);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_set_anim_start_frame
 * DESCRIPTION
 *  the function used to set start frame of image component
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  start_frame     [IN]    start frame of animation
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_set_anim_start_frame(S32 image_index, U32 start_frame)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_set_layer(&wgui_image_list[image_index], start_frame);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_set_stretch_enable
 * DESCRIPTION
 *  the function used to set whehter enable stretch of image component
 *  if enable stretch, the image will fill the whole component
 *  if disable stretch, the image will fill component in scale
 * PARAMETERS
 *  image_index     [IN]    index of image component
 *  enable_stretch  [IN]    whether enable stretch or not
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_set_stretch_enable(S32 image_index, MMI_BOOL enable_stretch)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_set_stretch_enable(&wgui_image_list[image_index], enable_stretch);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_set_align
 * DESCRIPTION
 *  the function used to set align of image component
 * PARAMETERS
 *  image_index         [IN]    index of image component
 *  image_h_align_type  [IN]    horizontal align type
 *  image_v_align_type  [IN]    vertical align type
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_set_align(
      S32 image_index, 
      gui_image_align_enum image_h_align_type,
      gui_image_align_enum image_v_align_type)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_set_align(
        &wgui_image_list[image_index], 
        image_h_align_type,
        image_v_align_type);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_get_layer
 * DESCRIPTION
 *  the function used to get target of image component
 * PARAMETERS
 *  image_index         [IN]    index of image component
 *  target_layer        [IN]    pointer of target layer
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_get_layer(S32 image_index, gdi_handle *target_layer)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_get_layer(&wgui_image_list[image_index], target_layer);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_get_position
 * DESCRIPTION
 *  the function used to get positon of image component
 * PARAMETERS
 *  image_index         [IN]    index of image component
 *  x                   [IN]
 *  y                   [IN]
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_get_position(S32 image_index, S32 *x, S32 *y)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_get_position(&wgui_image_list[image_index], x, y);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_get_dimension
 * DESCRIPTION
 *  the function used to get dimension of image, not image component
 * PARAMETERS
 *  image_index         [IN]    index of image component
 *  width               [IN]    image's width
 *  height              [IN]    image's height
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_get_dimension(
      S32 image_index,
      S32 *width,
      S32 *height,
      S32 *display_width,
      S32 *display_height)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_get_dimension(
        &wgui_image_list[image_index],
        width,
        height,
        display_width,
        display_height);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_get_start_frame
 * DESCRIPTION
 *  the function used to get start frame of image component
 * PARAMETERS
 *  image_index         [IN]    index of image component
 *  start_frame         [IN]
 * RETURNS
 *  void
 *****************************************************************************/
void wgui_image_get_anim_start_frame(S32 image_index, U32 *start_frame)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    gui_image_get_anim_start_frame(&wgui_image_list[image_index], start_frame);
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_show_nb
 * DESCRIPTION
 *  the function used to show an image component of non blocking
 * PARAMETERS
 *  image_index                 [IN]    index of image component
 *  decode_done_callback        [IN]    decode result callback function
 * RETURNS
 *  GDI_RESULT      [OUT]   result of show
 *****************************************************************************/
GDI_RESULT wgui_image_show_nb(
            S32 image_index,
            void (*decode_done_callback)(GDI_RESULT result, GDI_HANDLE handle))
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/
    GDI_RESULT result;

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    result = gui_image_show_nb(
                 &wgui_image_list[image_index],
                 decode_done_callback);
    gdi_layer_blt_previous(
        wgui_image_list[image_index].x,
        wgui_image_list[image_index].y,
        wgui_image_list[image_index].x + wgui_image_list[image_index].width - 1,
        wgui_image_list[image_index].y + wgui_image_list[image_index].height - 1);
    return result;
}


/*****************************************************************************
 * FUNCTION
 *  wgui_image_stop_nb_show
 * DESCRIPTION
 *  the function used to stop an image component of non_blocking
 * PARAMETERS
 *  image_index         [IN]    index of image component
 * RETURNS
 *  GDI_RESULT
 *****************************************************************************/
GDI_RESULT wgui_image_stop_nb_show(S32 image_index)
{
    /*----------------------------------------------------------------*/
    /* Local Variables                                                */
    /*----------------------------------------------------------------*/

    /*----------------------------------------------------------------*/
    /* Code Body                                                      */
    /*----------------------------------------------------------------*/
    MMI_DBG_ASSERT(image_index >= 0 && image_index < WGUI_IMAGE_MAX_COUNT);
    return gui_image_stop_nb_show(&wgui_image_list[image_index]);
}