Implement keyboard handling, and use it to enter
[asterisk/asterisk.git] / channels / console_board.c
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright 2007-2008, Marta Carbone, Luigi Rizzo
5  *
6  * See http://www.asterisk.org for more information about
7  * the Asterisk project. Please do not directly contact
8  * any of the maintainers of this project for assistance;
9  * the project provides a web site, mailing lists and IRC
10  * channels for your use.
11  *
12  * This program is free software, distributed under the terms of
13  * the GNU General Public License Version 2. See the LICENSE file
14  * at the top of the source tree.
15  *
16  * $Revision$
17  */
18
19 /* 
20  * Message board implementation.
21  *
22  * A message board is a region of the SDL screen where
23  * messages can be printed, like on a terminal window.
24  *
25  * At the moment we support fix-size font.
26  *
27  * The text is stored in a buffer
28  * of fixed size (rows and cols). A portion of the buffer is
29  * visible on the screen, and the visible window can be moved up and
30  * down by dragging (not yet!)
31  * 
32  * TODO: font dynamic allocation
33  *
34  * The region where the text is displayed on the screen is defined
35  * as keypad element, (the name is defined in the `region' variable
36  * so the board geometry can be read from the skin or from the
37  * configuration file).
38  */
39
40 #include "asterisk.h"   /* ast_strdupa */
41 #include "asterisk/utils.h"     /* ast_strdupa */
42 #include "console_video.h"      /* ast_strdupa */
43
44 #ifdef HAVE_SDL /* we only use this code if SDL is available */
45 #include <SDL/SDL.h>
46
47 #define GUI_BUFFER_LEN 256                      /* buffer lenght used for input buffers */
48
49 /* Fonts characterization. XXX should be read from the file */
50 #define FONT_H 20                       /* char height, pixels */
51 #define FONT_W 9                        /* char width, pixels */
52
53 struct board {
54         int             kb_output;      /* identity of the board */
55         /* pointer to the destination surface (on the keypad window) */
56         SDL_Surface     *screen;        /* the main screen */
57         SDL_Rect        *p_rect;        /* where to write on the main screen */
58         SDL_Surface     *blank;         /* original content of the window */
59
60         int     v_h;    /* virtual text height, in lines */
61         int     v_w;    /* virtual text width, in lines (probably same as p_w) */
62         int     p_h;    /* physical (displayed) text height, in lines
63                          * XXX p_h * FONT_H = pixel_height */
64         int     p_w;    /* physical (displayed) text width, in characters
65                          * XXX p_w * FONT_W = pixel_width */
66
67         int     cur_col; /* print position (free character) on the last line */
68         int     cur_line;       /* first (or last ?) virtual line displayed,
69                                          * 0 is the line at the bottom, 1 is the one above,...
70                                          */
71
72         SDL_Surface     *font;          /* points to a surface in the gui structure */
73         SDL_Rect        *font_rects;    /* pointer to the font rects */
74         char            *text;
75                                 /* text buffer, v_h * v_w char.
76                                  * We make sure the buffer is always full,
77                                  * print on some position on the last line,
78                                  * and scroll up when appending new text
79                                  */
80 };
81
82 /*! \brief Initialize the board.
83  * return 0 on success, 1 on error
84  * TODO, if this is done at reload time,
85  * free resources before allocate new ones
86  * TODO: resource deallocation in case of error.
87  * TODO: move the font load at gui_initialization
88  * TODO: deallocation of the message history
89  */
90 struct board *board_setup(SDL_Surface *screen, SDL_Rect *dest,
91         SDL_Surface *font, SDL_Rect *font_rects);
92 struct board *board_setup(SDL_Surface *screen, SDL_Rect *dest,
93         SDL_Surface *font, SDL_Rect *font_rects)
94 {
95         struct board *b = ast_calloc(1, sizeof (*b));
96         SDL_Rect br;
97
98         if (b == NULL)
99                 return NULL;
100         /* font, points to the gui structure */
101         b->font = font;
102         b->font_rects = font_rects;
103
104         /* Destination rectangle on the screen - reference is the whole screen */
105         b->p_rect = dest;
106         b->screen = screen;
107
108         /* compute physical sizes */
109         b->p_h = b->p_rect->h/FONT_H;
110         b->p_w = b->p_rect->w/FONT_W;
111
112         /* virtual sizes */
113         b->v_h = b->p_h * 10; /* XXX 10 times larger */
114         b->v_w = b->p_w;        /* same width */
115
116         /* the rectangle we actually use */
117         br.h = b->p_h * FONT_H; /* pixel sizes of the background */
118         br.w = b->p_w * FONT_W;
119         br.x = br.y = 0;
120
121         /* allocate a buffer for the text */
122         b->text = ast_calloc(b->v_w*b->v_h + 1, 1);
123         if (b->text == NULL) {
124                 ast_log(LOG_WARNING, "Unable to allocate board history memory.\n");
125                 ast_free(b);
126                 return NULL;
127         }
128         memset(b->text, ' ', b->v_w * b->v_h);  /* fill with spaces */
129
130         /* make a copy of the original rectangle, for cleaning up */
131         b->blank = SDL_CreateRGBSurface(screen->flags, br.w, br.h,
132                 screen->format->BitsPerPixel,
133                 screen->format->Rmask, screen->format->Gmask,
134                 screen->format->Bmask, screen->format->Amask);
135
136         if (b->blank == NULL) { 
137                 ast_log(LOG_WARNING, "Unable to allocate board virtual screen: %s\n",
138                                 SDL_GetError());
139                 ast_free(b->text);
140                 ast_free(b);
141                 return NULL;
142         }
143         SDL_BlitSurface(screen, b->p_rect, b->blank, &br);
144
145         /* Set color key, if not alpha channel present */
146         //colorkey = SDL_MapRGB(b->board_surface->format, 0, 0, 0);
147         //SDL_SetColorKey(b->board_surface, SDL_SRCCOLORKEY, colorkey);
148
149         b->cur_col = 0;         /* current print column */
150         b->cur_line = 0;        /* last line displayed */
151
152         ast_log(LOG_WARNING, "Message board %dx%d@%d,%d successfully initialized\n",
153                 b->p_rect->w, b->p_rect->h,
154                 b->p_rect->x, b->p_rect->y);
155         return b;
156 }
157
158 /* Render the text on the board surface.
159  * The first line to render is the one at v_h - p_h - cur_line,
160  * the size is p_h * p_w.
161  * XXX we assume here that p_w = v_w.
162  */
163 static void render_board(struct board *b)
164 {
165         int first_row = b->v_h - b->p_h - b->cur_line;
166         int first_char = b->v_w * first_row;
167         int last_char = first_char + b->p_h * b->v_w;
168         int i, col;
169         SDL_Rect dst;
170
171         /* top left char on the physical surface */
172         dst.w = FONT_W;
173         dst.h = FONT_H;
174         dst.x = b->p_rect->x;
175         dst.y = b->p_rect->y;
176
177
178         /* clean the surface board */
179         SDL_BlitSurface(b->blank, NULL, b->screen, b->p_rect);
180
181         /* blit all characters */
182         for (i = first_char, col = 0; i <  last_char; i++) {
183                 int c = b->text[i] - 32;        /* XXX first 32 chars are not printable */
184                 if (c < 0) /* buffer terminator or anything else is a blank */
185                         c = 0;
186                 SDL_BlitSurface(b->font, &b->font_rects[c], b->screen, &dst);
187                 /* point dst to next char position */
188                 dst.x += dst.w;
189                 col++;
190                 if (col >= b->v_w) { /* next row */
191                         dst.x = b->p_rect->x;
192                         dst.y += dst.h;
193                         col = 0;
194                 }
195         }
196         SDL_UpdateRects(b->screen, 1, b->p_rect);       /* Update the screen */
197 }
198
199 /* return the content of a board */
200 const char *read_message(const struct board *b)
201 {
202         return b->text;
203 }
204
205 int reset_board(struct board *b)
206 {
207         memset(b->text, ' ', b->v_w * b->v_h);  /* fill with spaces */
208         b->cur_col = 0;
209         b->cur_line = 0;
210         render_board(b);
211         return 0;
212 }
213 /* Store the message on the history board
214  * and blit on screen if required.
215  * XXX now easy. only regular chars
216  */
217 int print_message(struct board *b, const char *s)
218 {
219         int i, l, row, col;
220         char *dst;
221
222         if (ast_strlen_zero(s))
223                 return 0;
224
225         l = strlen(s);
226         row = 0;
227         col = b->cur_col;
228         /* First, only check how much space we need.
229          * Starting from the current print position, we move
230          * it forward and down (if necessary) according to input
231          * characters (including newlines, tabs, backspaces...).
232          * At the end, row tells us how many rows to scroll, and
233          * col (ignored) is the final print position.
234          */
235         for (i = 0; i < l; i++) {
236                 switch (s[i]) {
237                 case '\r':
238                         col = 0;
239                         break;
240                 case '\n':
241                         col = 0;
242                         row++;
243                         break;
244                 case '\b':
245                         if (col > 0)
246                                 col--;
247                         break;
248                 default:
249                         if (s[i] < 32) /* signed, so take up to 127 */
250                                 break;
251                         col++;
252                         if (col >= b->v_w) {
253                                 col -= b->v_w;
254                                 row++;
255                         }
256                         break;
257                 }
258         }
259         /* scroll the text window */
260         if (row > 0) { /* need to scroll by 'row' rows */
261                 memcpy(b->text, b->text + row * b->v_w, b->v_w * (b->v_h - row));
262                 /* clean the destination area */
263                 dst = b->text + b->v_w * (b->v_h - row - 1) + b->cur_col;
264                 memset(dst, ' ', b->v_w - b->cur_col + b->v_w * row);
265         }
266         /* now do the actual printing. The print position is 'row' lines up
267          * from the bottom of the buffer, start at the same 'cur_col' as before.
268          * dst points to the beginning of the current line.
269          */
270         dst = b->text + b->v_w * (b->v_h - row - 1); /* start of current line */
271         col = b->cur_col;
272         for (i = 0; i < l; i++) {
273                 switch (s[i]) {
274                 case '\r':
275                         col = 0;
276                         break;
277                 case '\n':      /* move to beginning of next line */
278                         dst[col] = '\0'; /* mark the rest of the line as empty */
279                         col = 0;
280                         dst += b->v_w;
281                         break;
282                 case '\b':      /* one char back */
283                         if (col > 0)
284                                 col--;
285                         dst[col] = ' '; /* delete current char */
286                         break;
287                 default:
288                         if (s[i] < 32) /* signed, so take up to 127 */
289                                 break;  /* non printable */
290                         dst[col] = s[i];        /* store character */
291                         col++;
292                         if (col >= b->v_w) {
293                                 col -= b->v_w;
294                                 dst += b->v_w;
295                         }
296                         break;
297                 }
298         }
299         dst[col] = '\0'; /* the current position is empty */
300         b->cur_col = col;
301         /* everything is printed now, must do the rendering */
302         render_board(b);
303         return 1;
304 }
305
306 #if 0
307 /*! \brief refresh the screen, and also grab a bunch of events.
308  */
309 static int scroll_message(...)
310 {
311 if moving up, scroll text up;
312     if (gui->message_board.screen_cur > 0)
313         gui->message_board.screen_cur--;
314 otherwise scroll text down.
315     if ((b->screen_cur + b->p_line) < b->board_next) {
316         gui->message_board.screen_cur++;
317 #endif /* notyet */
318
319 #endif /* HAVE_SDL */