firmware/export/scroll_engine.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2007 Michael Sevakis
  11  *
  12  * LCD scrolling driver and scheduler
  13  *
  14  * Much collected and combined from the various Rockbox LCD drivers.
  15  *
  16  * This program is free software; you can redistribute it and/or
  17  * modify it under the terms of the GNU General Public License
  18  * as published by the Free Software Foundation; either version 2
  19  * of the License, or (at your option) any later version.
  20  *
  21  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  22  * KIND, either express or implied.
  23  *
  24  ****************************************************************************/
  25 #ifndef __SCROLL_ENGINE_H__
  26 #define __SCROLL_ENGINE_H__
  27
  28 #include <lcd.h>
  29 #include "file.h"
  30
  31 void scroll_init(void);
  32 void lcd_scroll_stop(const struct viewport* vp);
  33 void lcd_scroll_stop_line(const struct viewport* vp, int y);
  34 void lcd_scroll_fn(void);
  35 #ifdef HAVE_REMOTE_LCD
  36 void lcd_remote_scroll_fn(void);
  37 void lcd_remote_scroll_stop(const struct viewport* vp);
  38 void lcd_remote_scroll_stop_line(const struct viewport* vp, int y);
  39 #endif
  40
  41 /* internal usage, but in multiple drivers */
  42 #define SCROLL_SPACING   3
  43 #ifdef HAVE_LCD_BITMAP
  44 #define SCROLL_LINE_SIZE (MAX_PATH + SCROLL_SPACING + 3*LCD_WIDTH/2 + 2)
  45 #else
  46 #define SCROLL_LINE_SIZE (MAX_PATH + SCROLL_SPACING + 3*LCD_WIDTH + 2)
  47 #endif
  48
  49 struct scrollinfo
  50 {
  51     struct viewport* vp;
  52     char line[SCROLL_LINE_SIZE];
  53 #ifdef HAVE_LCD_CHARCELLS
  54     int len;    /* length of line in chars */
  55 #endif
  56     int y;      /* Position of the line on the screen (char co-ordinates) */
  57     int offset;
  58     int startx;
  59 #ifdef HAVE_LCD_BITMAP
  60     int width;  /* length of line in pixels */
  61     int style; /* line style */
  62 #endif/* HAVE_LCD_BITMAP */
  63     bool backward; /* scroll presently forward or backward? */
  64     bool bidir;
  65     long start_tick;
  66 };
  67
  68 struct scroll_screen_info
  69 {
  70     struct scrollinfo * const scroll;
  71     const int num_scroll; /* number of scrollable lines (also number of scroll structs) */
  72     int lines;  /* Number of currently scrolling lines */
  73     long ticks; /* # of ticks between updates*/
  74     long delay; /* ticks delay before start */
  75     int bidir_limit;  /* percent */
  76 #ifdef HAVE_LCD_CHARCELLS
  77     long jump_scroll_delay; /* delay between jump scroll jumps */
  78     int jump_scroll; /* 0=off, 1=once, ..., JUMP_SCROLL_ALWAYS */
  79 #endif
  80 #if defined(HAVE_LCD_BITMAP) || defined(HAVE_REMOTE_LCD)
  81     int step;  /* pixels per scroll step */
  82 #endif
  83 #if defined(HAVE_REMOTE_LCD)
  84     long last_scroll;
  85 #endif
  86 };
  87
  88 /** main lcd **/
  89 #ifdef HAVE_LCD_BITMAP
  90 #define LCD_SCROLLABLE_LINES ((LCD_HEIGHT+4)/5 < 32 ? (LCD_HEIGHT+4)/5 : 32)
  91 #else
  92 #define LCD_SCROLLABLE_LINES LCD_HEIGHT * 2
  93 #endif
  94
  95 extern struct scroll_screen_info lcd_scroll_info;
  96
  97 /** remote lcd **/
  98 #ifdef HAVE_REMOTE_LCD
  99 #define LCD_REMOTE_SCROLLABLE_LINES \
 100     (((LCD_REMOTE_HEIGHT+4)/5 < 32) ? (LCD_REMOTE_HEIGHT+4)/5 : 32)
 101 extern struct scroll_screen_info lcd_remote_scroll_info;
 102 #endif
 103
 104 #endif /* __SCROLL_ENGINE_H__ */