Wayland - ポインタデバイス入力

ポインタデバイス入力
ここでは、ウィンドウ内でのポインタデバイス (マウスなど) の動作を取得します。

$ cc -o test 07_pointer.c client.c imagebuf.c -lwayland-client -lrt

07_pointer.c
/******************************
 * ポインタデバイス入力
 ******************************/

#include <stdio.h>
#include <string.h>
#include <linux/input.h>

#include <wayland-client.h>

#include "client.h"
#include "imagebuf.h"


//-------------

typedef struct
{
    Client b;

    struct wl_seat *seat;
    struct wl_pointer *pointer;
    uint32_t seat_ver;
}ClientEx;

#define _FLUSH   fflush(stdout)

//-------------


/* wl_pointer 解放 */

static void _pointer_release(ClientEx *p)
{
    if(p->seat_ver >= WL_POINTER_RELEASE_SINCE_VERSION)
        wl_pointer_release(p->pointer);
    else
        wl_pointer_destroy(p->pointer);

    p->pointer = NULL;
}


//------------------------
// wl_pointer
//------------------------


/* ポインタがサーフェス内に入った時 */

static void _pointer_enter(void *data, struct wl_pointer *pointer,
    uint32_t serial, struct wl_surface *surface, wl_fixed_t x, wl_fixed_t y)
{
    printf("enter | (%.2f, %.2f)\n", x / 256.0, y / 256.0);
    _FLUSH;
}

/* ポインタがサーフェス外に出た時 */

static void _pointer_leave(void *data, struct wl_pointer *pointer,
    uint32_t serial, struct wl_surface *surface)
{
    printf("leave\n");
    _FLUSH;
}

/* サーフェス内でポインタが移動した時 */

static void _pointer_motion(void *data, struct wl_pointer *pointer,
    uint32_t time, wl_fixed_t x, wl_fixed_t y)
{
    printf("motion | (%.2f, %.2f), time:%u\n",
        x / 256.0, y / 256.0, time);

    _FLUSH;
}

/* ボタンが押された時と離された時 */

static void _pointer_button(void *data, struct wl_pointer *pointer,
    uint32_t serial, uint32_t time, uint32_t button, uint32_t state)
{
    printf("button | %s, bttno:0x%X, time:%u\n",
        (state == WL_POINTER_BUTTON_STATE_PRESSED)? "press": "release",
        button, time);

    _FLUSH;

    //中ボタンで終了

    if(button == BTN_MIDDLE)
        ((Client *)data)->finish_loop = 1;
}

/* ホイールスクロール、または他の軸 */

static void _pointer_axis(void *data, struct wl_pointer *pointer,
    uint32_t time, uint32_t axis, wl_fixed_t value)
{
    printf("axis | %s, value:%.2f, time:%u\n",
        (axis == WL_POINTER_AXIS_VERTICAL_SCROLL)? "vert": "horz",
        value / 256.0, time);

    _FLUSH;
}

//===== 以下は、ver 5 から

/* 属している一連のイベントの終了時 */

static void _pointer_frame(void *data, struct wl_pointer *pointer)
{
    printf("frame\n");
    _FLUSH;
}

/* 軸のソース情報 (frame イベントの前) */

static void _pointer_axis_source(void *data, struct wl_pointer *pointer, uint32_t axis_source)
{
    printf("axis_source | %u\n", axis_source);
    _FLUSH;
}

/* 軸の通知の停止 */

static void _pointer_axis_stop(void *data, struct wl_pointer *pointer, uint32_t time, uint32_t axis)
{
    printf("axis_stop | axis:%u, time:%u\n", axis, time);
    _FLUSH;
}

/* 軸のステップ情報 */

static void _pointer_axis_discrete(void *data, struct wl_pointer *pointer, uint32_t axis, int32_t discrete)
{
    printf("axis_discrete | axis:%u, discrete:%d\n", axis, discrete);
    _FLUSH;
}

static const struct wl_pointer_listener g_pointer_listener = {
    _pointer_enter, _pointer_leave, _pointer_motion, _pointer_button,
    _pointer_axis, _pointer_frame, _pointer_axis_source,
    _pointer_axis_stop, _pointer_axis_discrete
};


//------------------------
// wl_seat
//------------------------


/* デバイスの利用状態が変更された時 */

static void _seat_capabilities(void *data, struct wl_seat *seat, uint32_t cap)
{
    ClientEx *p = (ClientEx *)data;

    printf("wl_seat # capabilities | cap:0x%X\n", cap);

    if((cap & WL_SEAT_CAPABILITY_POINTER) && !p->pointer)
    {
        //wl_pointer 作成

        p->pointer = wl_seat_get_pointer(seat);

        wl_pointer_add_listener(p->pointer, &g_pointer_listener, p);

    }
    else if(!(cap & WL_SEAT_CAPABILITY_POINTER) && p->pointer)
    {
        //wl_pointer 解放

        _pointer_release(p);
    }
}

static void _seat_name(void *data, struct wl_seat *wl_seat, const char *name)
{
    printf("wl_seat # name: \"%s\"\n", name);
}

static const struct wl_seat_listener g_seat_listener = {
    _seat_capabilities, _seat_name
};


//------------------------


static void _registry_global(
    void *data,struct wl_registry *reg,uint32_t id,const char *name,uint32_t ver)
{
    ClientEx *p = (ClientEx *)data;

    if(strcmp(name, "wl_seat") == 0)
    {
        if(ver >= 5) ver = 5;

        p->seat = wl_registry_bind(reg, id, &wl_seat_interface, ver);
        p->seat_ver = ver;

        wl_seat_add_listener(p->seat, &g_seat_listener, p);
    }
}

/* ClientEx 解放 */

static void _clientex_destroy(Client *cl)
{
    ClientEx *p = (ClientEx *)cl;

    //wl_pointer

    _pointer_release(p);

    //wl_seat

    if(p->seat_ver >= WL_SEAT_RELEASE_SINCE_VERSION)
        wl_seat_release(p->seat);
    else
        wl_seat_destroy(p->seat);
}


//---------------


int main(void)
{
    ClientEx *p;
    Window *win;

    p = (ClientEx *)Client_new(sizeof(ClientEx));

    p->b.destroy = _clientex_destroy;
    p->b.registry_global = _registry_global;
    
    Client_init(CLIENT(p));

    //ウィンドウ

    win = Window_create(CLIENT(p), 256, 256, NULL);

    ImageBuf_fill(win->img, 0xffff0000);
    Window_update(win);

    //

    Client_loop_simple(CLIENT(p));

    //解放

    Window_destroy(win);

    Client_destroy(CLIENT(p));

    return 0;
}

ウィンドウ内で中ボタンを押すと、プログラムが終了します。
wl_seat
入力デバイス (ポインタ、キーボード、タッチ) の操作を行うには、wl_seat が必要です。
まずは wl_seat をバインドします。

if(strcmp(name, "wl_seat") == 0)
{
    if(ver >= 5) ver = 5;

    p->seat = wl_registry_bind(reg, id, &wl_seat_interface, ver);
    p->seat_ver = ver;

    wl_seat_add_listener(p->seat, &g_seat_listener, p);
}

使用する最大のバージョンは「5」としています。
また、wl_seat・wl_pointer の解放時に必要となるので、使用している wl_seat のバージョンを記録しておきます。
capabilities イベント
static void _seat_capabilities(void *data, struct wl_seat *seat, uint32_t cap)
{
    ClientEx *p = (ClientEx *)data;

    printf("wl_seat # capabilities | cap:0x%X\n", cap);

    if((cap & WL_SEAT_CAPABILITY_POINTER) && !p->pointer)
    {
        //wl_pointer 作成

        p->pointer = wl_seat_get_pointer(seat);

        wl_pointer_add_listener(p->pointer, &g_pointer_listener, p);

    }
    else if(!(cap & WL_SEAT_CAPABILITY_POINTER) && p->pointer)
    {
        //wl_pointer 解放

        _pointer_release(p);
    }
}

wl_seat が対応している各デバイスが、「使用できるようになった」時と、「使用できなくなった」時に呼ばれます。

「使用できるようになった」時は、プログラムの開始時や、USB プラグにデバイスが接続された時などです。
「使用できなくなった」時は、プラグからデバイスが外された時などです。

引数 cap は、現在使用可能なデバイスの種類のフラグになっています。

WL_SEAT_CAPABILITY_POINTER = 1
WL_SEAT_CAPABILITY_KEYBOARD = 2
WL_SEAT_CAPABILITY_TOUCH = 4

フラグが ON の場合、デバイスが使用できる状態にあるため、wl_seat_get_pointer() などの関数を使って、各デバイスに応じたオブジェクトを作成できます。

フラグが OFF に変化した場合は、各オブジェクトを破棄する必要があります。

今回はポインタデバイスしか使わないため、wl_pointer の処理しかしていませんが、キーボードなど他のデバイスも使う場合は、同じように処理してください。
name イベント
※ wl_seat の ver 2 から使用できます。

seat の名前が通知されます。

複数の seat がある場合、それを判別する時に使います。
weston では "default" でしたが、GNOME では "seat0" でした。
オブジェクトの破棄について
wl_seat の capabilities イベントでは、各デバイスが使用できない状態になった時は、作成したオブジェクトを破棄する必要があります。

ただし、バインドした時の wl_seat のバージョンにより、破棄方法が異なります。

ver 4 以下wl_<name>_destroy()
ver 5 以上wl_<name>_release()

この2つについて、wayland-client-protocol.h のインライン定義を見てみると、以下のようになっています。

static inline void wl_pointer_destroy(struct wl_pointer *wl_pointer)
{
    wl_proxy_destroy((struct wl_proxy *) wl_pointer);
}

static inline void wl_pointer_release(struct wl_pointer *wl_pointer)
{
    wl_proxy_marshal((struct wl_proxy *) wl_pointer,
             WL_POINTER_RELEASE);

    wl_proxy_destroy((struct wl_proxy *) wl_pointer);
}

最後に wl_proxy_destroy() で破棄するのは同じですが、release の場合は、破棄する前に wl_proxy_marshal() で解放処理を要求しています。

他のオブジェクトに関しても、wl_<name>_release() 関数が存在する場合は、使用しているインターフェイスのバージョンを比較して、destroy/release のいずれかを使って破棄する必要があります。

wl_seat に関しても、ver 5 から wl_seat_release() が追加されているので、ver 5 以降の wl_seat の破棄時にはそちらを使う必要があります。
wl_pointer
wl_pointer は、ポインタデバイスの管理を行います。

wl_seatcapabilities イベントで、WL_SEAT_CAPABILITY_POINTER が ON になった時に作成し、ハンドラを設定します。

wl_pointer のイベントでは、クライアントプログラム上のすべてのウィンドウにおけるポインタイベントを取得できます。

どのウィンドウ上で操作されたかは、「struct wl_surface *surface」引数で判別できます。
複数のウィンドウがある場合は、それを使って、各ウィンドウごとに処理を分ける必要があります。

ver 5 では、使用できるイベントが増えています。
(frame, axis_source, axis_stop, axis_discrete)
enter イベント
void (*enter)(void *data, struct wl_pointer *pointer,
  uint32_t serial, struct wl_surface *surface,
  wl_fixed_t x, wl_fixed_t y);

ポインタがウィンドウ内に入った時に呼ばれます。

通常、ポインタが各ウィンドウ内に入ると、その位置に応じたカーソル形状に変わりますが、Wayland サーバーは、カーソル形状を一切変更せず、現在のカーソル形状を維持します。

そのためクライアントは、カーソル形状の変更処理を、自身で判断して行う必要があります。

wl_pointer_set_cursor() を使うと、wl_surface のイメージをカーソル形状としてセットできます。

引数の wl_fixed_t 型は、int32_t 型として定義されていて、24:8 の固定少数点数となっています。

「1.0 = 1<<8 = 256」となるので、浮動小数点数に変換する場合は、256 で割ります。
整数部分だけ取得したい場合は、「>> 8」で 8 bit 分右にシフトします。

x, y は、指定サーフェス上のポインタ座標です。
leave イベント
void (*leave)(void *data, struct wl_pointer *pointer,
    uint32_t serial, struct wl_surface *surface);

ポインタがウィンドウ外に出た時に呼ばれます。
motion イベント
void (*motion)(void *data, struct wl_pointer *pointer,
    uint32_t time, wl_fixed_t x, wl_fixed_t y);

ウィンドウ内でポインタが移動した時に呼ばれます。
button イベント
void (*button)(void *data, struct wl_pointer *pointer,
    uint32_t serial, uint32_t time, uint32_t button, uint32_t state);

ウィンドウ内で、ボタンが押されたか、離された時に呼ばれます。

※ポインタ位置は渡されないので、最後に来た enter/motion イベントの値を使ってください。

time は、ミリ秒単位のタイムスタンプです。
ダブルクリックの判定などで使います。

button はボタン番号です。
/usr/include/linux/input-event-codes.h」で定義されている値を使います。

マウスボタンは、BTN_LEFT などの名前で定義されています。

state は、enum wl_pointer_button_state で定義された値です。
押されたか離されたかの状態を判別できます。

WL_POINTER_BUTTON_STATE_RELEASED = 0
WL_POINTER_BUTTON_STATE_PRESSED = 1

グラブについて
Wayland では、ポインタのグラブ (キャプチャ) は行う必要がありません。
というより、出来ません。

ポインタのグラブは、サーバー側が自動的に行うため、ボタンが押されている間は、ポインタがウィンドウ外に出ても、そのままイベントを受け取ることができます。

また、その場合、leave イベントは、ボタンが離された後に送られてきます。
axis イベント
void (*axis)(void *data, struct wl_pointer *pointer,
    uint32_t time, uint32_t axis, wl_fixed_t value);

マウスホイールなどのスクロール操作が行われた時に呼ばれます。

axis は、移動した軸です。
enum wl_pointer_axis で定義されています。

WL_POINTER_AXIS_VERTICAL_SCROLL = 0
WL_POINTER_AXIS_HORIZONTAL_SCROLL = 1

value は、移動した方向と量です。
weston 上でマウスホイールを動かすと、「±10.0」の値になりました。
増減幅は、サーバーによって異なります。

斜め方向などに対応したデバイスでは、複数の axis イベントが出力されます。
frame イベント
※以降のイベントは、ver 5 から使用できます。

void (*frame)(void *data, struct wl_pointer *pointer);

例えば、スクロールで斜め方向に移動した場合、複数の axis イベントが出力されますが、それらをひとかたまりのイベントとして、一連のイベントが終了した時に呼ばれます。

「axis (vert) → axis (horz) → frame」といった順で呼ばれます。
また、axis に限らず、motion や button など、全てのイベントが対象となります。

▼ 例
axis_discrete | axis:0, discrete:-1
axis | vert, value:-10.00, time:3117731904
frame

motion | (208.00, 114.00), time:3117730992
frame

leave
frame
axis_source イベント
void (*axis_source)(void *data, struct wl_pointer *pointer,
  uint32_t axis_source);

frame イベントの前にオプションとして出力され、axis の軸のソース情報が渡されます。

axis_source は、enum wl_pointer_axis_source で定義された値です。

WL_POINTER_AXIS_SOURCE_WHEEL = 0
WL_POINTER_AXIS_SOURCE_FINGER = 1
WL_POINTER_AXIS_SOURCE_CONTINUOUS = 2
# ver 6 から
WL_POINTER_AXIS_SOURCE_WHEEL_TILT = 3

WL_POINTER_AXIS_SOURCE_FINGER の場合は、ユーザーが指を離した時に axis_stop イベントが送信されます。
axis_stop
void (*axis_stop)(void *data, struct wl_pointer *pointer, uint32_t time, uint32_t axis);

axis の軸の停止が通知されます。
axis_discrete
void (*axis_discrete)(void *data, struct wl_pointer *pointer,
  uint32_t axis, int32_t discrete);

axis の軸のステップ情報です。
axis イベントと一緒に送信されます。

discrete はステップ値です。

-1 なら、負の方向に1段階ステップするという意味です。
マウスホイールの場合は、通常 ±1 の値となります。