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
|
/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Floating on-screen display
*
* Copyright (C) 2012 Michael Sevakis
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef OSD_H
#define OSD_H
/* At this time: assumes use of the default viewport for normal drawing */
/* Callback implemented by user. Paramters are OSD vp-relative coordinates */
typedef void (* osd_draw_cb_fn_t)(int x, int y, int width, int height);
/* Initialize the OSD, set its backbuffer, update callback and enable it if
* the call succeeded. */
bool osd_init(void *backbuf, size_t backbuf_size,
osd_draw_cb_fn_t draw_cb);
enum
{
OSD_HIDE = 0x0, /* Hide from view */
OSD_SHOW = 0x1, /* Bring into view, updating if needed */
OSD_UPDATENOW = 0x2, /* Force update even if nothing changed */
};
/* Show/Hide the OSD on screen returning previous status */
bool osd_show(unsigned flags);
/* Redraw the entire OSD returning true if screen update occurred */
bool osd_update(void);
/* Redraw part of the OSD (OSD viewport-relative coordinates) returning true
if any screen update occurred */
bool osd_update_rect(int x, int y, int width, int height);
/* Set a new screen location and size (screen coordinates) */
bool osd_update_pos(int x, int y, int width, int height);
/* Call periodically to have the OSD timeout and hide itself */
void osd_monitor_timeout(void);
/* Set the OSD timeout value. 'timeout' <= 0 == never timeout */
void osd_set_timeout(long timeout);
/* Use the OSD viewport context */
struct viewport * osd_get_viewport(void);
/* Get the maximum buffer dimensions calculated by osd_init() */
void osd_get_max_dims(int *maxwidth, int *maxheight);
/* Is the OSD enabled? */
bool osd_enabled(void);
/** Functions that must be used in lieu of regular LCD functions for this
** to work.
**
** To be efficient, as much drawing as possible should be combined between
** *prepare and *update.
**
** osd_lcd_update_prepare();
** <draw stuff using lcd_* routines>
** osd_lcd_update[_rect]();
**
** TODO: Make it work seamlessly with greylib and regular LCD functions.
**/
/* Prepare LCD frambuffer for regular drawing - call before any other LCD
function */
void osd_lcd_update_prepare(void);
/* Update the whole screen and restore OSD if it is visible */
void osd_lcd_update(void);
/* Update a part of the screen and restore OSD if it is visible */
void osd_lcd_update_rect(int x, int y, int width, int height);
#endif /* OSD_H */
|
