apps/screen_access.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2005 by Kevin Ferrare
  11  *
  12  * All files in this archive are subject to the GNU General Public License.
  13  * See the file COPYING in the source tree root for full license agreement.
  14  *
  15  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  16  * KIND, either express or implied.
  17  *
  18  ****************************************************************************/
  19
  20 #ifndef _SCREEN_ACCESS_H_
  21 #define _SCREEN_ACCESS_H_
  22
  23 #include "lcd.h"
  24 #include "buttonbar.h"
  25
  26 enum screen_type {
  27     SCREEN_MAIN
  28 #ifdef HAVE_REMOTE_LCD
  29     ,SCREEN_REMOTE
  30 #endif
  31 };
  32
  33 #if defined(HAVE_REMOTE_LCD) && !defined (ROCKBOX_HAS_LOGF)
  34 #define NB_SCREENS 2
  35 #else
  36 #define NB_SCREENS 1
  37 #endif
  38
  39 #if NB_SCREENS == 1
  40 #define FOR_NB_SCREENS(i) i = 0;
  41 #else
  42 #define FOR_NB_SCREENS(i) for(i = 0; i < NB_SCREENS; i++)
  43 #endif
  44
  45 #ifdef HAVE_LCD_CHARCELLS
  46 #define MAX_LINES_ON_SCREEN 2
  47 #endif
  48
  49 typedef void screen_bitmap_part_func(const void *src, int src_x, int src_y,
  50                               int stride, int x, int y, int width, int height);
  51 typedef void screen_bitmap_func(const void *src, int x, int y, int width,
  52                               int height);
  53
  54 /* if this struct is changed the plugin api may break so bump the api
  55    versions in plugin.h */
  56 struct screen
  57 {
  58     enum screen_type screen_type;
  59     int width, height;
  60     int depth;
  61     int nb_lines;
  62 #ifdef HAVE_LCD_BITMAP
  63     int pixel_format;
  64 #endif
  65     int char_width;
  66     int char_height;
  67     bool is_color;
  68 #if (CONFIG_LED == LED_VIRTUAL) || defined(HAVE_REMOTE_LCD)
  69     bool has_disk_led;
  70 #endif
  71 #ifdef HAS_BUTTONBAR
  72     bool has_buttonbar;
  73 #endif
  74     void (*set_viewport)(struct viewport* vp);
  75     void (*setmargins)(int x, int y);
  76     int (*getwidth)(void);
  77     int (*getheight)(void);
  78     int (*getxmargin)(void);
  79     int (*getymargin)(void);
  80     int (*getstringsize)(const unsigned char *str, int *w, int *h);
  81 #if defined(HAVE_LCD_BITMAP) || defined(HAVE_REMOTE_LCD) /* always bitmap */
  82     void (*setfont)(int newfont);
  83     int (*getfont)(void);
  84
  85     void (*scroll_step)(int pixels);
  86     void (*puts_style_offset)(int x, int y, const unsigned char *str,
  87                               int style, int offset);
  88     void (*puts_scroll_style)(int x, int y, const unsigned char *string,
  89                                  int style);
  90     void (*puts_scroll_style_offset)(int x, int y, const unsigned char *string,
  91                                      int style, int offset);
  92     void (*mono_bitmap)(const unsigned char *src,
  93                         int x, int y, int width, int height);
  94     void (*mono_bitmap_part)(const unsigned char *src, int src_x, int src_y,
  95                           int stride, int x, int y, int width, int height);
  96     void (*bitmap)(const void *src,
  97                    int x, int y, int width, int height);
  98     void (*bitmap_part)(const void *src, int src_x, int src_y,
  99                           int stride, int x, int y, int width, int height);
 100     void (*transparent_bitmap)(const void *src,
 101                                int x, int y, int width, int height);
 102     void (*transparent_bitmap_part)(const void *src, int src_x, int src_y,
 103                                     int stride, int x, int y, int width, int height);
 104     void (*set_drawmode)(int mode);
 105 #if defined(HAVE_LCD_COLOR) && defined(LCD_REMOTE_DEPTH) && LCD_REMOTE_DEPTH > 1
 106     unsigned (*color_to_native)(unsigned color);
 107 #endif
 108 #if (LCD_DEPTH > 1) || (defined(LCD_REMOTE_DEPTH) && (LCD_REMOTE_DEPTH > 1))
 109     unsigned (*get_background)(void);
 110     unsigned (*get_foreground)(void);
 111     void (*set_background)(unsigned background);
 112     void (*set_foreground)(unsigned foreground);
 113 #endif /* (LCD_DEPTH > 1) || (LCD_REMOTE_DEPTH > 1) */
 114 #if defined(HAVE_LCD_COLOR)
 115     void (*set_selector_start)(unsigned selector);
 116     void (*set_selector_end)(unsigned selector);
 117     void (*set_selector_text)(unsigned selector_text);
 118 #endif
 119     void (*update_rect)(int x, int y, int width, int height);
 120     void (*update_viewport_rect)(int x, int y, int width, int height);
 121     void (*fillrect)(int x, int y, int width, int height);
 122     void (*drawrect)(int x, int y, int width, int height);
 123     void (*drawpixel)(int x, int y);
 124     void (*drawline)(int x1, int y1, int x2, int y2);
 125     void (*vline)(int x, int y1, int y2);
 126     void (*hline)(int x1, int x2, int y);
 127 #endif /* HAVE_LCD_BITMAP || HAVE_REMOTE_LCD */
 128
 129 #ifdef HAVE_LCD_CHARCELLS  /* no charcell remote LCDs so far */
 130     void (*double_height)(bool on);
 131     void (*putc)(int x, int y, unsigned long ucs);
 132     void (*icon)(int icon, bool enable);
 133     unsigned long (*get_locked_pattern)(void);
 134     void (*define_pattern)(unsigned long ucs, const char *pattern);
 135     void (*unlock_pattern)(unsigned long ucs);
 136 #endif
 137     void (*putsxy)(int x, int y, const unsigned char *str);
 138     void (*puts)(int x, int y, const unsigned char *str);
 139     void (*puts_offset)(int x, int y, const unsigned char *str, int offset);
 140     void (*puts_scroll)(int x, int y, const unsigned char *string);
 141     void (*puts_scroll_offset)(int x, int y, const unsigned char *string,
 142                                  int offset);
 143     void (*scroll_speed)(int speed);
 144     void (*scroll_delay)(int ms);
 145     void (*stop_scroll)(void);
 146     void (*clear_display)(void);
 147     void (*clear_viewport)(void);
 148     void (*scroll_stop)(struct viewport* vp);
 149     void (*scroll_stop_line)(struct viewport* vp, int y);
 150     void (*update)(void);
 151     void (*update_viewport)(void);
 152     void (*backlight_on)(void);
 153     void (*backlight_off)(void);
 154     bool (*is_backlight_on)(bool ignore_always_off);
 155     void (*backlight_set_timeout)(int index);
 156 };
 157
 158 #ifdef HAS_BUTTONBAR
 159 /*
 160  * Sets if the given screen has a buttonbar or not
 161  * - screen : the screen structure
 162  * - has : a boolean telling wether the current screen will have a buttonbar or not
 163  */
 164 #define screen_has_buttonbar(screen, has_btnb) \
 165     (screen)->has_buttonbar=has_btnb;
 166 #endif
 167
 168 /*
 169  * Sets the x margin in pixels for the given screen
 170  * - screen : the screen structure
 171  * - xmargin : the number of pixels to the left of the screen
 172  */
 173 #define screen_set_xmargin(screen, xmargin) \
 174     (screen)->setmargins(xmargin, (screen)->getymargin());
 175
 176 /*
 177  * Sets the y margin in pixels for the given screen
 178  * - screen : the screen structure
 179  * - xmargin : the number of pixels to the top of the screen
 180  */
 181 #define screen_set_ymargin(screen, ymargin) \
 182     (screen)->setmargins((screen)->getxmargin(), ymargin);
 183
 184 #if defined(HAVE_LCD_BITMAP) || defined(HAVE_REMOTE_LCD)
 185 /*
 186  * Clear only a given area of the screen
 187  * - screen : the screen structure
 188  * - xstart, ystart : where the area starts
 189  * - width, height : size of the area
 190  */
 191 void screen_clear_area(struct screen * display, int xstart, int ystart,
 192                        int width, int height);
 193 #endif
 194
 195 /*
 196  * Initializes the whole screen_access api
 197  */
 198 extern void screen_access_init(void);
 199
 200 /*
 201  * exported screens array that should be used
 202  * by each app that wants to write to access display
 203  */
 204 extern struct screen screens[NB_SCREENS];
 205
 206 #endif /*_SCREEN_ACCESS_H_*/