Add optional viewport clipping, can be enabled with HAVE_VIEWPORT_CLIP. A simulator check is also added to set_viewport that will show an error/note when DEBUGF is enabled.

git-svn-id: svn://svn.rockbox.org/rockbox/trunk@23551 a1c6a512-1295-4272-9138-f99709370657

1 files changed, 152 insertions, 13 deletions

diff --git a/firmware/drivers/lcd-2bit-horz.c b/firmware/drivers/lcd-2bit-horz.c
index f9a53ee20c..2e965b35fa 100644
--- a/firmware/drivers/lcd-2bit-horz.c
+++ b/firmware/drivers/lcd-2bit-horz.c
@@ -87,6 +87,28 @@ void lcd_set_viewport(struct viewport* vp)
 
     fg_pattern = 0x55 * (~current_vp->fg_pattern & 3);
     bg_pattern = 0x55 * (~current_vp->bg_pattern & 3);
+    
+#if defined(SIMULATOR)
+    /* Force the viewport to be within bounds.  If this happens it should
+     *  be considered an error - the viewport will not draw as it might be
+     *  expected.
+     */
+    if((unsigned) current_vp->x > (unsigned) LCD_WIDTH 
+        || (unsigned) current_vp->y > (unsigned) LCD_HEIGHT 
+        || current_vp->x + current_vp->width > LCD_WIDTH
+        || current_vp->y + current_vp->height > LCD_HEIGHT)
+    {
+#if !defined(HAVE_VIEWPORT_CLIP)
+        DEBUGF("ERROR: "
+#else
+        DEBUGF("NOTE: "
+#endif
+            "set_viewport out of bounds: x: %d y: %d width: %d height:%d\n", 
+            current_vp->x, current_vp->y, 
+            current_vp->width, current_vp->height);
+    }
+    
+#endif
 }
 
 void lcd_update_viewport(void)
@@ -415,8 +437,13 @@ void lcd_clear_viewport(void)
 /* Set a single pixel */
 void lcd_drawpixel(int x, int y)
 {
-    if (((unsigned)x < (unsigned)current_vp->width) &&
-        ((unsigned)y < (unsigned)current_vp->height))
+    if (   ((unsigned)x < (unsigned)current_vp->width)
+        && ((unsigned)y < (unsigned)current_vp->height)
+#if defined(HAVE_VIEWPORT_CLIP)
+        && ((unsigned)x < (unsigned)LCD_WIDTH)
+        && ((unsigned)y < (unsigned)LCD_HEIGHT)
+#endif
+        )
         lcd_pixelfuncs[current_vp->drawmode](current_vp->x + x, current_vp->y + y);
 }
 
@@ -485,8 +512,13 @@ void lcd_drawline(int x1, int y1, int x2, int y2)
 
     for (i = 0; i < numpixels; i++)
     {
-        if (((unsigned)x < (unsigned)current_vp->width) &&
-            ((unsigned)y < (unsigned)current_vp->height))
+        if (   ((unsigned)x < (unsigned)current_vp->width) 
+            && ((unsigned)y < (unsigned)current_vp->height)
+#if defined(HAVE_VIEWPORT_CLIP)
+            && ((unsigned)x < (unsigned)LCD_WIDTH)
+            && ((unsigned)y < (unsigned)LCD_HEIGHT)
+#endif
+            )
             pfunc(current_vp->x + x, current_vp->y + y);
 
         if (d < 0)
@@ -520,12 +552,12 @@ void lcd_hline(int x1, int x2, int y)
         x2 = nx;
     }
     
+    /******************** In viewport clipping **********************/
     /* nothing to draw? */
     if (((unsigned)y >= (unsigned)current_vp->height) || (x1 >= current_vp->width) 
         || (x2 < 0))
         return;  
-    
-    /* clipping */
+        
     if (x1 < 0)
         x1 = 0;
     if (x2 >= current_vp->width)
@@ -535,6 +567,20 @@ void lcd_hline(int x1, int x2, int y)
     x1 += current_vp->x;
     x2 += current_vp->x;
     y += current_vp->y;
+    
+#if defined(HAVE_VIEWPORT_CLIP)
+    /********************* Viewport on screen clipping ********************/
+    /* nothing to draw? */
+    if (((unsigned)y >= (unsigned) LCD_HEIGHT) || (x1 >= LCD_WIDTH)
+        || (x2 < 0))
+        return;  
+    
+    /* clipping */
+    if (x1 < 0)
+        x1 = 0;
+    if (x2 >= LCD_WIDTH)
+        x2 = LCD_WIDTH-1;
+#endif
 
     bfunc = lcd_blockfuncs[current_vp->drawmode];
     dst   = &lcd_framebuffer[y][x1>>2];
@@ -567,12 +613,12 @@ void lcd_vline(int x, int y1, int y2)
         y2 = y;
     }
 
+    /******************** In viewport clipping **********************/
     /* nothing to draw? */
     if (((unsigned)x >= (unsigned)current_vp->width) || (y1 >= current_vp->height)
         || (y2 < 0))
         return;  
-    
-    /* clipping */
+        
     if (y1 < 0)
         y1 = 0;
     if (y2 >= current_vp->height)
@@ -582,6 +628,20 @@ void lcd_vline(int x, int y1, int y2)
     y1 += current_vp->y;
     y2 += current_vp->y;
     x += current_vp->x;
+    
+#if defined(HAVE_VIEWPORT_CLIP)
+    /********************* Viewport on screen clipping ********************/
+    /* nothing to draw? */
+    if (( (unsigned) x >= (unsigned)LCD_WIDTH) || (y1 >= LCD_HEIGHT) 
+        || (y2 < 0))
+        return;
+    
+    /* clipping */
+    if (y1 < 0)
+        y1 = 0;
+    if (y2 >= LCD_HEIGHT)
+        y2 = LCD_HEIGHT-1;
+#endif
         
     bfunc = lcd_blockfuncs[current_vp->drawmode];
     dst   = &lcd_framebuffer[y1][x>>2];
@@ -619,12 +679,12 @@ void lcd_fillrect(int x, int y, int width, int height)
     unsigned mask, mask_right;
     lcd_blockfunc_type *bfunc;
 
+    /******************** In viewport clipping **********************/
     /* nothing to draw? */
     if ((width <= 0) || (height <= 0) || (x >= current_vp->width) || (y >= current_vp->height)
         || (x + width <= 0) || (y + height <= 0))
         return;
 
-    /* clipping */
     if (x < 0)
     {
         width += x;
@@ -643,6 +703,30 @@ void lcd_fillrect(int x, int y, int width, int height)
     /* adjust for viewport */
     x += current_vp->x;
     y += current_vp->y;
+    
+#if defined(HAVE_VIEWPORT_CLIP)
+    /********************* Viewport on screen clipping ********************/
+    /* nothing to draw? */
+    if ((x >= LCD_WIDTH) || (y >= LCD_HEIGHT) 
+        || (x + width <= 0) || (y + height <= 0))
+        return;
+    
+    /* clip image in viewport in screen */
+    if (x < 0)
+    {
+        width += x;
+        x = 0;
+    }
+    if (y < 0)
+    {
+        height += y;
+        y = 0;
+    }
+    if (x + width > LCD_WIDTH)
+        width = LCD_WIDTH - x;
+    if (y + height > LCD_HEIGHT)
+        height = LCD_HEIGHT - y;
+#endif
 
     bfunc = lcd_blockfuncs[current_vp->drawmode];
     dst   = &lcd_framebuffer[y][x>>2];
@@ -696,12 +780,12 @@ void ICODE_ATTR lcd_mono_bitmap_part(const unsigned char *src, int src_x,
     unsigned dst_mask;
     int drmode = current_vp->drawmode;
 
+    /******************** Image in viewport clipping **********************/
     /* nothing to draw? */
     if ((width <= 0) || (height <= 0) || (x >= current_vp->width) ||
         (y >= current_vp->height) || (x + width <= 0) || (y + height <= 0))
         return;
         
-    /* clipping */
     if (x < 0)
     {
         width += x;
@@ -718,12 +802,41 @@ void ICODE_ATTR lcd_mono_bitmap_part(const unsigned char *src, int src_x,
         width = current_vp->width - x;
     if (y + height > current_vp->height)
         height = current_vp->height - y;
+        
+    x += current_vp->x;          /* adjust for viewport */
+    y += current_vp->y;          /* adjust for viewport */
+    
+#if defined(HAVE_VIEWPORT_CLIP)
+    /********************* Viewport on screen clipping ********************/
+    /* nothing to draw? */
+    if ((x >= LCD_WIDTH) || (y >= LCD_HEIGHT) 
+        || (x + width <= 0) || (y + height <= 0))
+        return;
+    
+    /* clip image in viewport in screen */
+    if (x < 0)
+    {
+        width += x;
+        src_x -= x;
+        x = 0;
+    }
+    if (y < 0)
+    {
+        height += y;
+        src_y -= y;
+        y = 0;
+    }
+    if (x + width > LCD_WIDTH)
+        width = LCD_WIDTH - x;
+    if (y + height > LCD_HEIGHT)
+        height = LCD_HEIGHT - y;
+#endif
 
     src += stride * (src_y >> 3) + src_x; /* move starting point */
     src_y  &= 7;
     src_end = src + width;
-    x += current_vp->x;          /* adjust for viewport */
-    dst = &lcd_framebuffer[current_vp->y + y][x >> 2];
+    
+    dst = &lcd_framebuffer[y][x >> 2];
     dst_end = dst + height * LCD_FBWIDTH;
     dst_mask = pixmask[x & 3];
 
@@ -879,12 +992,12 @@ void ICODE_ATTR lcd_bitmap_part(const unsigned char *src, int src_x,
     unsigned char *dst, *dst_end;
     unsigned mask, mask_right;
 
+    /******************** Image in viewport clipping **********************/
     /* nothing to draw? */
     if ((width <= 0) || (height <= 0) || (x >= current_vp->width) || 
         (y >= current_vp->height) || (x + width <= 0) || (y + height <= 0))
         return;
         
-    /* clipping */
     if (x < 0)
     {
         width += x;
@@ -905,6 +1018,32 @@ void ICODE_ATTR lcd_bitmap_part(const unsigned char *src, int src_x,
     /* adjust for viewport */
     x += current_vp->x;
     y += current_vp->y;
+    
+#if defined(HAVE_VIEWPORT_CLIP)
+    /********************* Viewport on screen clipping ********************/
+    /* nothing to draw? */
+    if ((x >= LCD_WIDTH) || (y >= LCD_HEIGHT) 
+        || (x + width <= 0) || (y + height <= 0))
+        return;
+    
+    /* clip image in viewport in screen */
+    if (x < 0)
+    {
+        width += x;
+        src_x -= x;
+        x = 0;
+    }
+    if (y < 0)
+    {
+        height += y;
+        src_y -= y;
+        y = 0;
+    }
+    if (x + width > LCD_WIDTH)
+        width = LCD_WIDTH - x;
+    if (y + height > LCD_HEIGHT)
+        height = LCD_HEIGHT - y;
+#endif
 
     stride = (stride + 3) >> 2; /* convert to no. of bytes */