Quelle  caca.c   Sprache: C

/*****************************************************************************
 * caca.c: Color ASCII Art "vout display" module using libcaca
 *****************************************************************************
 * Copyright (C) 2003-2009 VLC authors and VideoLAN
 *
 * Authors: Sam Hocevar <sam@zoy.org>
 *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

/*****************************************************************************
 * Preamble
 *****************************************************************************/

#ifdef HAVE_CONFIG_H
# include "config.h"
#endif

#include <stdbool.h>
#include <stdint.h>
#include <stdlib.h>
#include <string.h>
#include <vlc_common.h>
#include <vlc_queue.h>
#include <vlc_plugin.h>
#include <vlc_vout_display.h>
#include <vlc_actions.h>
#if defined(_WIN32)
#include <windows.h>
#elif !defined(__APPLE__)
# ifdef X_DISPLAY_MISSING
#  error Xlib required due to XInitThreads
# endif
# include <vlc_xlib.h>
#endif

#include <caca.h>

/* */
typedef struct vout_display_sys_t {
    caca_canvas_t *cv;
    caca_display_t *dp;
    caca_dither_t *dither;
    unsigned      dither_width, dither_height;
    int           dither_pitch;
    bool          update_dither;

    bool dead;
    vlc_queue_t q;
    vlc_thread_t thread;
    vout_display_place_t place;

    vlc_tick_t cursor_timeout;
    vlc_tick_t cursor_deadline;
} vout_display_sys_t;

typedef struct vlc_caca_event {
    struct vlc_caca_event *next;
    int key;
} vlc_caca_event_t;

static void *VoutDisplayEventKeyDispatch(void *data)
{
    vlc_thread_set_name("vlc-caca");

    vout_display_t *vd = data;
    vout_display_sys_t *sys = vd->sys;
    vlc_caca_event_t *event;

    while ((event = vlc_queue_DequeueKillable(&sys->q, &sys->dead)) != NULL) {
        vlc_window_ReportKeyPress(vd->cfg->window, event->key);
        free(event);
    }

    return NULL;
}

static void VoutDisplayEventKey(vout_display_sys_t *sys, int key)
{
    vlc_caca_event_t *event = malloc(sizeof (*event));

    if (likely(event != NULL)) {
        event->next = NULL;
        event->key = key;
        vlc_queue_Enqueue(&sys->q, event);
    }
}

/**
 * Compute the place in canvas unit.
 */
static void Place(vout_display_t *vd)
{
    vout_display_sys_t *sys = vd->sys;

    const int canvas_width   = caca_get_canvas_width(sys->cv);
    const int canvas_height  = caca_get_canvas_height(sys->cv);
    const int display_width  = caca_get_display_width(sys->dp);
    const int display_height = caca_get_display_height(sys->dp);

    if (display_width > 0 && display_height > 0) {
        sys->place.x      =  sys->place.x      * canvas_width  / display_width;
        sys->place.y      =  sys->place.y      * canvas_height / display_height;
        sys->place.width  = (sys->place.width  * canvas_width  + display_width/2)  / display_width;
        sys->place.height = (sys->place.height * canvas_height + display_height/2) / display_height;
    } else {
        sys->place.x = 0;
        sys->place.y = 0;
        sys->place.width  = canvas_width;
        sys->place.height = display_height;
    }
}

static void Manage(vout_display_t *vd);

/**
 * Prepare a picture for display */
static void Prepare(vout_display_t *vd, picture_t *picture,
                    const struct vlc_render_subpicture *subpicture, vlc_tick_t date)
{
    Manage(vd);
    VLC_UNUSED(date);

    vout_display_sys_t *sys = vd->sys;

    if (!sys->dither || (sys->update_dither && (
          sys->dither_width  != vd->source->i_visible_width ||
          sys->dither_height != vd->source->i_visible_height ||
          sys->dither_pitch  != picture->p[0].i_pitch
        ) ) ) {
        if (sys->dither)
            caca_free_dither(sys->dither);

        /* Create the libcaca dither object */
        sys->dither = caca_create_dither(32,
                                            vd->source->i_visible_width,
                                            vd->source->i_visible_height,
                                            picture->p[0].i_pitch,
                                            0x00ff0000,
                                            0x0000ff00,
                                            0x000000ff,
                                            0x00000000);

        if (!sys->dither) {
            msg_Err(vd, "could not create libcaca dither object");
            return;
        }
        sys->dither_width  = vd->source->i_visible_width;
        sys->dither_height = vd->source->i_visible_height;
        sys->dither_pitch  = picture->p[0].i_pitch;
        sys->update_dither = false;
    }

    caca_set_color_ansi(sys->cv, CACA_DEFAULT, CACA_BLACK);
    caca_clear_canvas(sys->cv);

    const int crop_offset = vd->source->i_y_offset * picture->p->i_pitch +
                            vd->source->i_x_offset * picture->p->i_pixel_pitch;
    caca_dither_bitmap(sys->cv, sys->place.x, sys->place.y,
                        sys->place.width, sys->place.height,
                        sys->dither,
                        &picture->p->p_pixels[crop_offset]);
    VLC_UNUSED(subpicture);
}

/**
 * Display a picture
 */
static void PictureDisplay(vout_display_t *vd, picture_t *picture)
{
    vout_display_sys_t *sys = vd->sys;

    caca_refresh_display(sys->dp);
    VLC_UNUSED(picture);
}

static int PlacementChanged(vout_display_t *vd, const vout_display_place_t *place)
{
    vout_display_sys_t *sys = vd->sys;
    VLC_UNUSED(place);
    sys->update_dither = true;
    return VLC_SUCCESS;
}

static int CropChanged(vout_display_t *vd, const video_format_t *source)
{
    VLC_UNUSED(source);
    return PlacementChanged(vd, NULL);
}

/* */
static const struct {
    int caca;
    int vlc;
} keys[] = {

    { CACA_KEY_CTRL_A,  KEY_MODIFIER_CTRL | 'a' },
    { CACA_KEY_CTRL_B,  KEY_MODIFIER_CTRL | 'b' },
    { CACA_KEY_CTRL_C,  KEY_MODIFIER_CTRL | 'c' },
    { CACA_KEY_CTRL_D,  KEY_MODIFIER_CTRL | 'd' },
    { CACA_KEY_CTRL_E,  KEY_MODIFIER_CTRL | 'e' },
    { CACA_KEY_CTRL_F,  KEY_MODIFIER_CTRL | 'f' },
    { CACA_KEY_CTRL_G,  KEY_MODIFIER_CTRL | 'g' },
    { CACA_KEY_BACKSPACE, KEY_BACKSPACE },
    { CACA_KEY_TAB,     KEY_TAB },
    { CACA_KEY_CTRL_J,  KEY_MODIFIER_CTRL | 'j' },
    { CACA_KEY_CTRL_K,  KEY_MODIFIER_CTRL | 'k' },
    { CACA_KEY_CTRL_L,  KEY_MODIFIER_CTRL | 'l' },
    { CACA_KEY_RETURN,  KEY_ENTER },

    { CACA_KEY_CTRL_N,  KEY_MODIFIER_CTRL | 'n' },
    { CACA_KEY_CTRL_O,  KEY_MODIFIER_CTRL | 'o' },
    { CACA_KEY_CTRL_P,  KEY_MODIFIER_CTRL | 'p' },
    { CACA_KEY_CTRL_Q,  KEY_MODIFIER_CTRL | 'q' },
    { CACA_KEY_CTRL_R,  KEY_MODIFIER_CTRL | 'r' },

    { CACA_KEY_PAUSE,   -1 },
    { CACA_KEY_CTRL_T,  KEY_MODIFIER_CTRL | 't' },
    { CACA_KEY_CTRL_U,  KEY_MODIFIER_CTRL | 'u' },
    { CACA_KEY_CTRL_V,  KEY_MODIFIER_CTRL | 'v' },
    { CACA_KEY_CTRL_W,  KEY_MODIFIER_CTRL | 'w' },
    { CACA_KEY_CTRL_X,  KEY_MODIFIER_CTRL | 'x' },
    { CACA_KEY_CTRL_Y,  KEY_MODIFIER_CTRL | 'y' },
    { CACA_KEY_CTRL_Z,  KEY_MODIFIER_CTRL | 'z' },

    { CACA_KEY_ESCAPE,  KEY_ESC },
    { CACA_KEY_DELETE,  KEY_DELETE },

    { CACA_KEY_F1,      KEY_F1 },
    { CACA_KEY_F2,      KEY_F2 },
    { CACA_KEY_F3,      KEY_F3 },
    { CACA_KEY_F4,      KEY_F4 },
    { CACA_KEY_F5,      KEY_F5 },
    { CACA_KEY_F6,      KEY_F6 },
    { CACA_KEY_F7,      KEY_F7 },
    { CACA_KEY_F8,      KEY_F8 },
    { CACA_KEY_F9,      KEY_F9 },
    { CACA_KEY_F10,     KEY_F10 },
    { CACA_KEY_F11,     KEY_F11 },
    { CACA_KEY_F12,     KEY_F12 },
    { CACA_KEY_F13,     KEY_F(13) },
    { CACA_KEY_F14,     KEY_F(14) },
    { CACA_KEY_F15,     KEY_F(15) },

    { CACA_KEY_UP,      KEY_UP },
    { CACA_KEY_DOWN,    KEY_DOWN },
    { CACA_KEY_LEFT,    KEY_LEFT },
    { CACA_KEY_RIGHT,   KEY_RIGHT },

    { CACA_KEY_INSERT,  KEY_INSERT },
    { CACA_KEY_HOME,    KEY_HOME },
    { CACA_KEY_END,     KEY_END },
    { CACA_KEY_PAGEUP,  KEY_PAGEUP },
    { CACA_KEY_PAGEDOWN,KEY_PAGEDOWN },

    /* */
    { -1, -1 }
};

static const struct {
    int caca;
    int vlc;
} mouses[] = {
    { 1, MOUSE_BUTTON_LEFT },
    { 2, MOUSE_BUTTON_CENTER },
    { 3, MOUSE_BUTTON_RIGHT },
    { 4, MOUSE_BUTTON_WHEEL_UP },
    { 5, MOUSE_BUTTON_WHEEL_DOWN },

    /* */
    { -1, -1 }
};

#define INVALID_DEADLINE  INT64_MAX

/**
 * Process pending event
 */
static void Manage(vout_display_t *vd)
{
    vout_display_sys_t *sys = vd->sys;

    if (sys->cursor_deadline != INVALID_DEADLINE && sys->cursor_deadline < vlc_tick_now()) {
        caca_set_mouse(sys->dp, 0);
        sys->cursor_deadline = INVALID_DEADLINE;
    }

    struct caca_event ev;
    while (caca_get_event(sys->dp, CACA_EVENT_ANY, &ev, 0) > 0) {
        switch (caca_get_event_type(&ev)) {
        case CACA_EVENT_KEY_PRESS: {
            const int caca = caca_get_event_key_ch(&ev);

            for (int i = 0; keys[i].caca != -1; i++) {
                if (keys[i].caca == caca) {
                    const int vlc = keys[i].vlc;

                    if (vlc >= 0)
                        VoutDisplayEventKey(sys, vlc);
                    return;
                }
            }
            if (caca >= 0x20 && caca <= 0x7f) {
                VoutDisplayEventKey(sys, caca);
                return;
            }
            break;
        }
        case CACA_EVENT_RESIZE:
            break;
        case CACA_EVENT_MOUSE_MOTION:
            caca_set_mouse(sys->dp, 1);
            sys->cursor_deadline = vlc_tick_now() + sys->cursor_timeout;
            vlc_window_ReportMouseMoved(vd->cfg->window,
                                         caca_get_event_mouse_x(&ev),
                                         caca_get_event_mouse_y(&ev));
            break;
        case CACA_EVENT_MOUSE_PRESS:
        case CACA_EVENT_MOUSE_RELEASE: {
            caca_set_mouse(sys->dp, 1);
            sys->cursor_deadline = vlc_tick_now() + sys->cursor_timeout;

            const int caca = caca_get_event_mouse_button(&ev);
            for (int i = 0; mouses[i].caca != -1; i++) {
                if (mouses[i].caca == caca) {
                    if (caca_get_event_type(&ev) == CACA_EVENT_MOUSE_PRESS)
                        vlc_window_ReportMousePressed(vd->cfg->window,
                                                       mouses[i].vlc);
                    else
                        vlc_window_ReportMouseReleased(vd->cfg->window,
                                                        mouses[i].vlc);
                    return;
                }
            }
            break;
        }
        case CACA_EVENT_QUIT:
            vlc_window_ReportClose(vd->cfg->window);
            break;
        default:
            break;
        }
    }
}

/**
 * Close a libcaca video output
 */
static void Close(vout_display_t *vd)
{
    vout_display_sys_t *sys = vd->sys;

    vlc_queue_Kill(&sys->q, &sys->dead);
    vlc_join(sys->thread, NULL);

    if (sys->dither)
        caca_free_dither(sys->dither);
    caca_free_display(sys->dp);
    caca_free_canvas(sys->cv);

#if defined(_WIN32)
    FreeConsole();
#endif

    free(sys);
}

static const struct vlc_display_operations ops = {
    .close = Close,
    .prepare = Prepare,
    .display = PictureDisplay,
    .video_place_changed = PlacementChanged,
    .set_source_crop = CropChanged,
};

/**
 * This function initializes libcaca vout method.
 */
static int Open(vout_display_t *vd,
                video_format_t *fmtp, vlc_video_context *context)
{
    vout_display_sys_t *sys;

    (void) context;

    if (vout_display_cfg_IsWindowed(vd->cfg))
        return VLC_EGENERIC;
#if !defined(__APPLE__) && !defined(_WIN32)
# ifndef X_DISPLAY_MISSING
    if (!vlc_xlib_init(VLC_OBJECT(vd)))
        return VLC_EGENERIC;
# endif
#endif

#if defined(_WIN32)
    CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
    SMALL_RECT rect;
    COORD coord;
    HANDLE hstdout;

    if (!AllocConsole()) {
        msg_Err(vd, "cannot create console");
        return VLC_EGENERIC;
    }

    hstdout =
        CreateConsoleScreenBuffer(GENERIC_READ | GENERIC_WRITE,
                                  FILE_SHARE_READ | FILE_SHARE_WRITE,
                                  NULL, CONSOLE_TEXTMODE_BUFFER, NULL);
    if (!hstdout || hstdout == INVALID_HANDLE_VALUE) {
        msg_Err(vd, "cannot create screen buffer");
        FreeConsole();
        return VLC_EGENERIC;
    }

    if (!SetConsoleActiveScreenBuffer(hstdout)) {
        msg_Err(vd, "cannot set active screen buffer");
        FreeConsole();
        return VLC_EGENERIC;
    }

    coord = GetLargestConsoleWindowSize(hstdout);
    msg_Dbg(vd, "SetConsoleWindowInfo: %ix%i", coord.X, coord.Y);

    /* Force size for now */
    coord.X = 100;
    coord.Y = 40;

    if (!SetConsoleScreenBufferSize(hstdout, coord))
        msg_Warn(vd, "SetConsoleScreenBufferSize %i %i",
                  coord.X, coord.Y);

    /* Get the current screen buffer size and window position. */
    if (GetConsoleScreenBufferInfo(hstdout, &csbiInfo)) {
        rect.Top = 0; rect.Left = 0;
        rect.Right = csbiInfo.dwMaximumWindowSize.X - 1;
        rect.Bottom = csbiInfo.dwMaximumWindowSize.Y - 1;
        if (!SetConsoleWindowInfo(hstdout, TRUE, &rect))
            msg_Dbg(vd, "SetConsoleWindowInfo failed: %ix%i",
                     rect.Right, rect.Bottom);
    }
#endif

    /* Allocate structure */
    vd->sys = sys = calloc(1, sizeof(*sys));
    if (!sys)
        goto error;

    sys->cv = caca_create_canvas(0, 0);
    if (!sys->cv) {
        msg_Err(vd, "cannot initialize libcaca");
        goto error;
    }

    const char *driver = NULL;
#ifdef __APPLE__
    // Make sure we don't try to open a window.
    driver = "ncurses";
#endif

    sys->dp = caca_create_display_with_driver(sys->cv, driver);
    if (!sys->dp) {
        msg_Err(vd, "cannot initialize libcaca");
        goto error;
    }

    char *title = var_InheritString(vd, "video-title");
    caca_set_display_title(sys->dp,
        (title != NULL) ? title : VOUT_TITLE "(Colour AsCii Art)");
    free(title);

    sys->dead = false;
    vlc_queue_Init(&sys->q, offsetof (vlc_caca_event_t, next));

    if (vlc_clone(&sys->thread, VoutDisplayEventKeyDispatch, vd))
        goto error;

    sys->cursor_timeout = VLC_TICK_FROM_MS( var_InheritInteger(vd, "mouse-hide-timeout") );
    sys->cursor_deadline = INVALID_DEADLINE;

    fmtp->i_chroma = VLC_CODEC_XRGB;

    /* Setup vout_display now that everything is fine */
    vd->ops = &ops;

    /* Fix initial state */
    caca_refresh_display(sys->dp);

    Place(vd);

    return VLC_SUCCESS;

error:
    if (sys) {
        if (sys->dither)
            caca_free_dither(sys->dither);
        if (sys->dp)
            caca_free_display(sys->dp);
        if (sys->cv)
            caca_free_canvas(sys->cv);

        free(sys);
    }
#if defined(_WIN32)
    FreeConsole();
#endif
    return VLC_EGENERIC;
}

/*****************************************************************************
 * Module descriptor
 *****************************************************************************/
vlc_module_begin()
    set_shortname("Caca")
    set_subcategory(SUBCAT_VIDEO_VOUT)
    set_description(N_("Color ASCII art video output"))
    set_callback_display(Open, 15)
vlc_module_end()