source: libcaca/trunk/caca/driver/gl.c @ 4096

Last change on this file since 4096 was 4096, checked in by Sam Hocevar, 10 years ago

Don't enter glutCheckLoop() from gl_get_event() if there is already an
event available. This increases the framerate when using OpenGL.

  • Property svn:keywords set to Id
File size: 17.6 KB
Line 
1/*
2 *  libcaca       Colour ASCII-Art library
3 *  Copyright (c) 2002-2006 Sam Hocevar <sam@hocevar.net>
4 *                2006 Jean-Yves Lamoureux <jylam@lnxscene.org>
5 *                2007 Ben Wiley Sittler <bsittler@gmail.com>
6 *                All Rights Reserved
7 *
8 *  $Id: gl.c 4096 2009-12-07 01:30:19Z sam $
9 *
10 *  This library is free software. It comes without any warranty, to
11 *  the extent permitted by applicable law. You can redistribute it
12 *  and/or modify it under the terms of the Do What The Fuck You Want
13 *  To Public License, Version 2, as published by Sam Hocevar. See
14 *  http://sam.zoy.org/wtfpl/COPYING for more details.
15 */
16
17/*
18 *  This file contains the libcaca OpenGL input and output driver
19 */
20
21#include "config.h"
22
23#if defined(USE_GL)
24
25#ifdef HAVE_OPENGL_GL_H
26#   include <OpenGL/gl.h>
27#   include <GLUT/glut.h>
28#else
29#   include <GL/gl.h>
30#   include <GL/glut.h>
31#   include <GL/freeglut_ext.h>
32#endif
33
34#include <string.h>
35#include <stdlib.h>
36#include <stdio.h>
37
38#include "caca.h"
39#include "caca_internals.h"
40
41/*
42 * Global variables
43 */
44
45static int glut_init;
46static caca_display_t *gl_d; /* FIXME: we ought to get rid of this */
47
48/*
49 * Local functions
50 */
51static int gl_get_event_inner(caca_display_t *, caca_privevent_t *);
52static void gl_handle_keyboard(unsigned char, int, int);
53static void gl_handle_special_key(int, int, int);
54static void gl_handle_reshape(int, int);
55static void gl_handle_mouse(int, int, int, int);
56static void gl_handle_mouse_motion(int, int);
57#ifdef HAVE_GLUTCLOSEFUNC
58static void gl_handle_close(void);
59#endif
60static void _display(void);
61static void gl_compute_font(caca_display_t *);
62
63struct driver_private
64{
65    int window;
66    int width, height;
67    int new_width, new_height;
68    caca_font_t *f;
69    float font_width, font_height;
70    float incx, incy;
71    uint32_t const *blocks;
72    int *txid;
73    uint8_t close;
74    uint8_t bit;
75    uint8_t mouse_changed, mouse_clicked;
76    int mouse_x, mouse_y;
77    int mouse_button, mouse_state;
78
79    uint8_t key;
80    int special_key;
81
82    float sw, sh;
83};
84
85static int gl_init_graphics(caca_display_t *dp)
86{
87    char const *geometry;
88    char *argv[2] = { "", NULL };
89    char const * const * fonts;
90    int width = caca_get_canvas_width(dp->cv);
91    int height = caca_get_canvas_height(dp->cv);
92    int argc = 1;
93
94    dp->drv.p = malloc(sizeof(struct driver_private));
95
96    gl_d = dp;
97
98#if defined(HAVE_GETENV)
99    geometry = getenv("CACA_GEOMETRY");
100    if(geometry && *geometry)
101        sscanf(geometry, "%ux%u", &width, &height);
102#endif
103
104    dp->resize.allow = 1;
105    caca_set_canvas_size(dp->cv, width ? width : 80, height ? height : 32);
106    dp->resize.allow = 0;
107
108    /* Load a libcaca internal font */
109    fonts = caca_get_font_list();
110    if(fonts[0] == NULL)
111    {
112        fprintf(stderr, "error: libcaca was compiled without any fonts\n");
113        return -1;
114    }
115    dp->drv.p->f = caca_load_font(fonts[0], 0);
116    if(dp->drv.p->f == NULL)
117    {
118        fprintf(stderr, "error: could not load font \"%s\"\n", fonts[0]);
119        return -1;
120    }
121
122    dp->drv.p->font_width = caca_get_font_width(dp->drv.p->f);
123    dp->drv.p->font_height = caca_get_font_height(dp->drv.p->f);
124
125    dp->drv.p->width = caca_get_canvas_width(dp->cv) * dp->drv.p->font_width;
126    dp->drv.p->height = caca_get_canvas_height(dp->cv) * dp->drv.p->font_height;
127
128#ifdef HAVE_GLUTCLOSEFUNC
129    dp->drv.p->close = 0;
130#endif
131    dp->drv.p->bit = 0;
132
133    dp->drv.p->mouse_changed = dp->drv.p->mouse_clicked = 0;
134    dp->drv.p->mouse_button = dp->drv.p->mouse_state = 0;
135
136    dp->drv.p->key = 0;
137    dp->drv.p->special_key = 0;
138
139    dp->drv.p->sw = ((float)dp->drv.p->font_width) / 16.0f;
140    dp->drv.p->sh = ((float)dp->drv.p->font_height) / 16.0f;
141
142    if(!glut_init)
143    {
144        glut_init = 1;
145        glutInit(&argc, argv);
146    }
147
148    glutInitDisplayMode(GLUT_RGBA | GLUT_DOUBLE);
149    glutInitWindowSize(dp->drv.p->width, dp->drv.p->height);
150    dp->drv.p->window = glutCreateWindow("caca for GL");
151
152    gluOrtho2D(0, dp->drv.p->width, dp->drv.p->height, 0);
153
154    glDisable(GL_CULL_FACE);
155    glDisable(GL_DEPTH_TEST);
156
157    glutKeyboardFunc(gl_handle_keyboard);
158    glutSpecialFunc(gl_handle_special_key);
159    glutReshapeFunc(gl_handle_reshape);
160    glutDisplayFunc(_display);
161
162#ifdef HAVE_GLUTCLOSEFUNC
163    glutCloseFunc(gl_handle_close);
164#endif
165
166    glutMouseFunc(gl_handle_mouse);
167    glutMotionFunc(gl_handle_mouse_motion);
168    glutPassiveMotionFunc(gl_handle_mouse_motion);
169
170    glLoadIdentity();
171
172    glMatrixMode(GL_PROJECTION);
173    glPushMatrix();
174    glLoadIdentity();
175    gluOrtho2D(0, dp->drv.p->width, dp->drv.p->height, 0);
176
177    glMatrixMode(GL_MODELVIEW);
178
179    glClear(GL_COLOR_BUFFER_BIT);
180    glEnable(GL_TEXTURE_2D);
181    glEnable(GL_BLEND);
182    glBlendFunc(GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
183
184    glEnable(GL_TEXTURE_2D);
185
186    gl_compute_font(dp);
187
188    return 0;
189}
190
191static int gl_end_graphics(caca_display_t *dp)
192{
193    glutHideWindow();
194    glutDestroyWindow(dp->drv.p->window);
195    caca_free_font(dp->drv.p->f);
196    free(dp->drv.p->txid);
197    free(dp->drv.p);
198    return 0;
199}
200
201static int gl_set_display_title(caca_display_t *dp, char const *title)
202{
203    glutSetWindowTitle(title);
204    return 0;
205}
206
207static int gl_get_display_width(caca_display_t const *dp)
208{
209    return dp->drv.p->width;
210}
211
212static int gl_get_display_height(caca_display_t const *dp)
213{
214    return dp->drv.p->height;
215}
216
217static void gl_display(caca_display_t *dp)
218{
219    uint32_t const *cvchars = (uint32_t const *)caca_get_canvas_chars(dp->cv);
220    uint32_t const *cvattrs = (uint32_t const *)caca_get_canvas_attrs(dp->cv);
221    int width = caca_get_canvas_width(dp->cv);
222    int x, y, line;
223
224    glClear(GL_COLOR_BUFFER_BIT);
225    glDisable(GL_TEXTURE_2D);
226    glDisable(GL_BLEND);
227    line = 0;
228    for(y = 0; y < dp->drv.p->height; y += dp->drv.p->font_height)
229    {
230        uint32_t const *attrs = cvattrs + line * width;
231
232        /* FIXME: optimise using stride */
233        for(x = 0; x < dp->drv.p->width; x += dp->drv.p->font_width)
234        {
235            uint16_t bg = caca_attr_to_rgb12_bg(*attrs++);
236
237            glColor4b(((bg & 0xf00) >> 8) * 8,
238                      ((bg & 0x0f0) >> 4) * 8,
239                      (bg & 0x00f) * 8,
240                      0xff);
241            glBegin(GL_QUADS);
242            glVertex2f(x, y);
243            glVertex2f(x + dp->drv.p->font_width, y);
244            glVertex2f(x + dp->drv.p->font_width,
245                       y + dp->drv.p->font_height);
246            glVertex2f(x, y + dp->drv.p->font_height);
247            glEnd();
248        }
249
250        line++;
251    }
252
253    /* 2nd pass, avoids changing render state too much */
254    glEnable(GL_TEXTURE_2D);
255    glEnable(GL_BLEND);
256
257    line = 0;
258    for(y = 0; y < dp->drv.p->height; y += dp->drv.p->font_height, line++)
259    {
260        uint32_t const *attrs = cvattrs + line * width;
261        uint32_t const *chars = cvchars + line * width;
262
263        for(x = 0; x < dp->drv.p->width; x += dp->drv.p->font_width, attrs++)
264        {
265            uint32_t ch = *chars++;
266            uint16_t fg;
267            int i, b, fullwidth;
268
269            fullwidth = caca_utf32_is_fullwidth(ch);
270
271            for(b = 0, i = 0; dp->drv.p->blocks[i + 1]; i += 2)
272            {
273                if(ch < (uint32_t)dp->drv.p->blocks[i])
274                     break;
275
276                if(ch >= (uint32_t)dp->drv.p->blocks[i + 1])
277                {
278                    b += (uint32_t)(dp->drv.p->blocks[i + 1]
279                                     - dp->drv.p->blocks[i]);
280                    continue;
281                }
282
283                glBindTexture(GL_TEXTURE_2D,
284                              dp->drv.p->txid[b + ch
285                                        - (uint32_t)dp->drv.p->blocks[i]]);
286
287                fg = caca_attr_to_rgb12_fg(*attrs);
288                glColor3b(((fg & 0xf00) >> 8) * 8,
289                          ((fg & 0x0f0) >> 4) * 8,
290                          (fg & 0x00f) * 8);
291                /* FIXME: handle fullwidth glyphs here */
292                glBegin(GL_QUADS);
293                glTexCoord2f(0, dp->drv.p->sh);
294                glVertex2f(x, y);
295                glTexCoord2f(dp->drv.p->sw, dp->drv.p->sh);
296                glVertex2f(x + dp->drv.p->font_width * (fullwidth ? 2 : 1), y);
297                glTexCoord2f(dp->drv.p->sw, 0);
298                glVertex2f(x + dp->drv.p->font_width * (fullwidth ? 2 : 1),
299                           y + dp->drv.p->font_height);
300                glTexCoord2f(0, 0);
301                glVertex2f(x, y + dp->drv.p->font_height);
302                glEnd();
303            }
304
305            if(fullwidth)
306            {
307                chars++; attrs++; x += dp->drv.p->font_width;
308            }
309        }
310    }
311
312#ifdef HAVE_GLUTCHECKLOOP
313    glutCheckLoop();
314#else
315    glutMainLoopEvent();
316#endif
317    glutSwapBuffers();
318    glutPostRedisplay();
319}
320
321static void gl_handle_resize(caca_display_t *dp)
322{
323    dp->drv.p->width = dp->drv.p->new_width;
324    dp->drv.p->height = dp->drv.p->new_height;
325
326    glMatrixMode(GL_PROJECTION);
327    glPushMatrix();
328    glLoadIdentity();
329
330    glViewport(0, 0, dp->drv.p->width, dp->drv.p->height);
331    gluOrtho2D(0, dp->drv.p->width, dp->drv.p->height, 0);
332    glMatrixMode(GL_MODELVIEW);
333}
334
335static int gl_get_event(caca_display_t *dp, caca_privevent_t *ev)
336{
337    int ret = gl_get_event_inner(dp, ev);
338
339    if (ret)
340        return ret;
341
342#ifdef HAVE_GLUTCHECKLOOP
343    glutCheckLoop();
344#else
345    glutMainLoopEvent();
346#endif
347
348    return gl_get_event_inner(dp, ev);
349}
350
351static int gl_get_event_inner(caca_display_t *dp, caca_privevent_t *ev)
352{
353#ifdef HAVE_GLUTCLOSEFUNC
354    if(dp->drv.p->close)
355    {
356        dp->drv.p->close = 0;
357        ev->type = CACA_EVENT_QUIT;
358        return 1;
359    }
360#endif
361
362    if(dp->resize.resized)
363    {
364        ev->type = CACA_EVENT_RESIZE;
365        ev->data.resize.w = caca_get_canvas_width(dp->cv);
366        ev->data.resize.h = caca_get_canvas_height(dp->cv);
367        return 1;
368    }
369
370    if(dp->drv.p->mouse_changed)
371    {
372        ev->type = CACA_EVENT_MOUSE_MOTION;
373        ev->data.mouse.x = dp->mouse.x;
374        ev->data.mouse.y = dp->mouse.y;
375        dp->drv.p->mouse_changed = 0;
376
377        if(dp->drv.p->mouse_clicked)
378        {
379            _push_event(dp, ev);
380            ev->type = CACA_EVENT_MOUSE_PRESS;
381            ev->data.mouse.button = dp->drv.p->mouse_button;
382            dp->drv.p->mouse_clicked = 0;
383        }
384
385        return 1;
386    }
387
388    if(dp->drv.p->key != 0)
389    {
390        ev->type = CACA_EVENT_KEY_PRESS;
391        ev->data.key.ch = dp->drv.p->key;
392        ev->data.key.utf32 = (uint32_t)dp->drv.p->key;
393        ev->data.key.utf8[0] = dp->drv.p->key;
394        ev->data.key.utf8[1] = '\0';
395        dp->drv.p->key = 0;
396        return 1;
397    }
398
399    if(dp->drv.p->special_key != 0)
400    {
401        switch(dp->drv.p->special_key)
402        {
403            case GLUT_KEY_F1 : ev->data.key.ch = CACA_KEY_F1; break;
404            case GLUT_KEY_F2 : ev->data.key.ch = CACA_KEY_F2; break;
405            case GLUT_KEY_F3 : ev->data.key.ch = CACA_KEY_F3; break;
406            case GLUT_KEY_F4 : ev->data.key.ch = CACA_KEY_F4; break;
407            case GLUT_KEY_F5 : ev->data.key.ch = CACA_KEY_F5; break;
408            case GLUT_KEY_F6 : ev->data.key.ch = CACA_KEY_F6; break;
409            case GLUT_KEY_F7 : ev->data.key.ch = CACA_KEY_F7; break;
410            case GLUT_KEY_F8 : ev->data.key.ch = CACA_KEY_F8; break;
411            case GLUT_KEY_F9 : ev->data.key.ch = CACA_KEY_F9; break;
412            case GLUT_KEY_F10: ev->data.key.ch = CACA_KEY_F10; break;
413            case GLUT_KEY_F11: ev->data.key.ch = CACA_KEY_F11; break;
414            case GLUT_KEY_F12: ev->data.key.ch = CACA_KEY_F12; break;
415            case GLUT_KEY_LEFT : ev->data.key.ch = CACA_KEY_LEFT; break;
416            case GLUT_KEY_RIGHT: ev->data.key.ch = CACA_KEY_RIGHT; break;
417            case GLUT_KEY_UP   : ev->data.key.ch = CACA_KEY_UP; break;
418            case GLUT_KEY_DOWN : ev->data.key.ch = CACA_KEY_DOWN; break;
419            case GLUT_KEY_PAGE_UP : ev->data.key.ch = CACA_KEY_PAGEUP; break;
420            case GLUT_KEY_PAGE_DOWN  : ev->data.key.ch = CACA_KEY_PAGEDOWN;
421                break;
422            case GLUT_KEY_HOME : ev->data.key.ch = CACA_KEY_HOME; break;
423            case GLUT_KEY_END : ev->data.key.ch = CACA_KEY_END; break;
424            case GLUT_KEY_INSERT : ev->data.key.ch = CACA_KEY_INSERT; break;
425
426            default: ev->type = CACA_EVENT_NONE; return 0;
427        }
428
429        ev->type = CACA_EVENT_KEY_PRESS;
430        ev->data.key.utf32 = 0;
431        ev->data.key.utf8[0] = '\0';
432
433        dp->drv.p->special_key = 0;
434        return 1;
435    }
436
437    ev->type = CACA_EVENT_NONE;
438    return 0;
439}
440
441
442static void gl_set_mouse(caca_display_t *dp, int flag)
443{
444    if(flag)
445        glutSetCursor(GLUT_CURSOR_RIGHT_ARROW);
446    else
447        glutSetCursor(GLUT_CURSOR_NONE);
448}
449
450/*
451 * XXX: following functions are local
452 */
453
454static void gl_handle_keyboard(unsigned char key, int x, int y)
455{
456    caca_display_t *dp = gl_d;
457
458    dp->drv.p->key = key;
459}
460
461static void gl_handle_special_key(int key, int x, int y)
462{
463    caca_display_t *dp = gl_d;
464
465    dp->drv.p->special_key = key;
466}
467
468static void gl_handle_reshape(int w, int h)
469{
470    caca_display_t *dp = gl_d;
471
472    if(dp->drv.p->bit) /* Do not handle reshaping at the first time */
473    {
474        dp->drv.p->new_width = w;
475        dp->drv.p->new_height = h;
476
477        dp->resize.w = w / dp->drv.p->font_width;
478        dp->resize.h = (h / dp->drv.p->font_height) + 1;
479
480        dp->resize.resized = 1;
481    }
482    else
483        dp->drv.p->bit = 1;
484}
485
486static void gl_handle_mouse(int button, int state, int x, int y)
487{
488    caca_display_t *dp = gl_d;
489
490    dp->drv.p->mouse_clicked = 1;
491    dp->drv.p->mouse_button = button;
492    dp->drv.p->mouse_state = state;
493    dp->drv.p->mouse_x = x / dp->drv.p->font_width;
494    dp->drv.p->mouse_y = y / dp->drv.p->font_height;
495    dp->mouse.x = dp->drv.p->mouse_x;
496    dp->mouse.y = dp->drv.p->mouse_y;
497    dp->drv.p->mouse_changed = 1;
498}
499
500static void gl_handle_mouse_motion(int x, int y)
501{
502    caca_display_t *dp = gl_d;
503    dp->drv.p->mouse_x = x / dp->drv.p->font_width;
504    dp->drv.p->mouse_y = y / dp->drv.p->font_height;
505    dp->mouse.x = dp->drv.p->mouse_x;
506    dp->mouse.y = dp->drv.p->mouse_y;
507    dp->drv.p->mouse_changed = 1;
508}
509
510#ifdef HAVE_GLUTCLOSEFUNC
511static void gl_handle_close(void)
512{
513    caca_display_t *dp = gl_d;
514    dp->drv.p->close = 1;
515}
516#endif
517
518static void _display(void)
519{
520    caca_display_t *dp = gl_d;
521    gl_display(dp);
522}
523
524static void gl_compute_font(caca_display_t *dp)
525{
526    caca_canvas_t *cv;
527    uint32_t *image;
528    int i, b, w, h, x, y;
529
530    /* Count how many glyphs this font has */
531    dp->drv.p->blocks = caca_get_font_blocks(dp->drv.p->f);
532
533    for(b = 0, i = 0; dp->drv.p->blocks[i + 1]; i += 2)
534        b += (int)(dp->drv.p->blocks[i + 1] - dp->drv.p->blocks[i]);
535
536    /* Allocate a libcaca canvas and print all the glyphs on it */
537    cv = caca_create_canvas(2, b);
538    caca_set_color_ansi(cv, CACA_WHITE, CACA_BLACK);
539
540    for(b = 0, i = 0; dp->drv.p->blocks[i + 1]; i += 2)
541    {
542        int j, n = (int)(dp->drv.p->blocks[i + 1] - dp->drv.p->blocks[i]);
543
544        for(j = 0; j < n; j++)
545            caca_put_char(cv, 0, b + j, dp->drv.p->blocks[i] + j);
546
547        b += n;
548    }
549
550    /* Draw the caca canvas onto an image buffer */
551    image = malloc(b * dp->drv.p->font_height *
552                   2 * dp->drv.p->font_width * sizeof(uint32_t));
553    caca_render_canvas(cv, dp->drv.p->f, image, 2 * dp->drv.p->font_width,
554                        b * dp->drv.p->font_height, 8 * dp->drv.p->font_width);
555    caca_free_canvas(cv);
556
557    /* Convert all glyphs in the image buffer to GL textures */
558    dp->drv.p->txid = malloc(b * sizeof(int));
559
560    w = dp->drv.p->font_width <= 16 ? dp->drv.p->font_width : 16;
561    h = dp->drv.p->font_height <= 16 ? dp->drv.p->font_height : 16;
562
563    for(b = 0, i = 0; dp->drv.p->blocks[i + 1]; i += 2)
564    {
565        int j, n = (int)(dp->drv.p->blocks[i + 1] - dp->drv.p->blocks[i]);
566
567        for(j = 0; j < n; j++)
568        {
569            uint8_t tmp[16 * 8 * 16];
570            uint32_t *glyph = image + (int)((b + j) * dp->drv.p->font_width * 2
571                                            * dp->drv.p->font_height);
572            int fullwidth =
573                    caca_utf32_is_fullwidth(dp->drv.p->blocks[i] + j);
574
575            memset(tmp, 0, 16 * 8 * 16);
576
577            for(y = 0; y < h; y++)
578            {
579                for(x = 0; x < w * (fullwidth ? 2 : 1); x++)
580                {
581                    int offset = x + (15 - y) * (fullwidth ? 32 : 16);
582                    uint8_t c = glyph[x + y * 2 * (int)dp->drv.p->font_width]
583                                 >> 8;
584                    tmp[offset * 4] = c;
585                    tmp[offset * 4 + 1] = c;
586                    tmp[offset * 4 + 2] = c;
587                    tmp[offset * 4 + 3] = c;
588                }
589            }
590
591            glGenTextures(1, (GLuint*)&dp->drv.p->txid[b + j]);
592            glBindTexture(GL_TEXTURE_2D, dp->drv.p->txid[b + j]);
593            glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR);
594            glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR);
595            glTexImage2D(GL_TEXTURE_2D, 0, 4, (fullwidth ? 32 : 16), 16, 0,
596                         GL_RGBA, GL_UNSIGNED_BYTE, tmp);
597        }
598
599        b += n;
600    }
601
602    free(image);
603}
604
605/*
606 * Driver initialisation
607 */
608
609int gl_install(caca_display_t *dp)
610{
611#if defined(HAVE_GETENV) && defined(GLUT_XLIB_IMPLEMENTATION)
612    if(!getenv("DISPLAY") || !*(getenv("DISPLAY")))
613        return -1;
614#endif
615
616    dp->drv.id = CACA_DRIVER_GL;
617    dp->drv.driver = "gl";
618
619    dp->drv.init_graphics = gl_init_graphics;
620    dp->drv.end_graphics = gl_end_graphics;
621    dp->drv.set_display_title = gl_set_display_title;
622    dp->drv.get_display_width = gl_get_display_width;
623    dp->drv.get_display_height = gl_get_display_height;
624    dp->drv.display = gl_display;
625    dp->drv.handle_resize = gl_handle_resize;
626    dp->drv.get_event = gl_get_event;
627    dp->drv.set_mouse = gl_set_mouse;
628    dp->drv.set_cursor = NULL;
629
630    return 0;
631}
632
633#endif /* USE_GL */
634
Note: See TracBrowser for help on using the repository browser.