Statistics
| Branch: | Revision:

ffmpeg / libavdevice / x11grab.c @ 1f15747f

History | View | Annotate | Download (13.7 KB)

1
/*
2
 * X11 video grab interface
3
 *
4
 * This file is part of FFmpeg.
5
 *
6
 * FFmpeg integration:
7
 * Copyright (C) 2006 Clemens Fruhwirth <clemens@endorphin.org>
8
 *                    Edouard Gomez <ed.gomez@free.fr>
9
 *
10
 * This file contains code from grab.c:
11
 * Copyright (c) 2000-2001 Fabrice Bellard
12
 *
13
 * This file contains code from the xvidcap project:
14
 * Copyright (C) 1997-1998 Rasca, Berlin
15
 *               2003-2004 Karl H. Beckers, Frankfurt
16
 *
17
 * FFmpeg is free software; you can redistribute it and/or modify
18
 * it under the terms of the GNU General Public License as published by
19
 * the Free Software Foundation; either version 2 of the License, or
20
 * (at your option) any later version.
21
 *
22
 * FFmpeg is distributed in the hope that it will be useful,
23
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25
 * GNU General Public License for more details.
26
 *
27
 * You should have received a copy of the GNU General Public License
28
 * along with FFmpeg; if not, write to the Free Software
29
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
30
 */
31

    
32
/**
33
 * @file libavdevice/x11grab.c
34
 * X11 frame device demuxer by Clemens Fruhwirth <clemens@endorphin.org>
35
 * and Edouard Gomez <ed.gomez@free.fr>.
36
 */
37

    
38
#include "config.h"
39
#include "libavformat/avformat.h"
40
#include <time.h>
41
#include <X11/X.h>
42
#include <X11/Xlib.h>
43
#include <X11/Xlibint.h>
44
#include <X11/Xproto.h>
45
#include <X11/Xutil.h>
46
#include <sys/shm.h>
47
#include <X11/extensions/XShm.h>
48
#include <X11/extensions/Xfixes.h>
49

    
50
/**
51
 * X11 Device Demuxer context
52
 */
53
struct x11_grab
54
{
55
    int frame_size;          /**< Size in bytes of a grabbed frame */
56
    AVRational time_base;    /**< Time base */
57
    int64_t time_frame;      /**< Current time */
58

    
59
    int height;              /**< Height of the grab frame */
60
    int width;               /**< Width of the grab frame */
61
    int x_off;               /**< Horizontal top-left corner coordinate */
62
    int y_off;               /**< Vertical top-left corner coordinate */
63

    
64
    Display *dpy;            /**< X11 display from which x11grab grabs frames */
65
    XImage *image;           /**< X11 image holding the grab */
66
    int use_shm;             /**< !0 when using XShm extension */
67
    XShmSegmentInfo shminfo; /**< When using XShm, keeps track of XShm infos */
68
    int nomouse;
69
};
70

    
71
/**
72
 * Initializes the x11 grab device demuxer (public device demuxer API).
73
 *
74
 * @param s1 Context from avformat core
75
 * @param ap Parameters from avformat core
76
 * @return <ul>
77
 *          <li>AVERROR(ENOMEM) no memory left</li>
78
 *          <li>AVERROR(EIO) other failure case</li>
79
 *          <li>0 success</li>
80
 *         </ul>
81
 */
82
static int
83
x11grab_read_header(AVFormatContext *s1, AVFormatParameters *ap)
84
{
85
    struct x11_grab *x11grab = s1->priv_data;
86
    Display *dpy;
87
    AVStream *st = NULL;
88
    enum PixelFormat input_pixfmt;
89
    XImage *image;
90
    int x_off = 0;
91
    int y_off = 0;
92
    int use_shm;
93
    char *param, *offset;
94

    
95
    param = av_strdup(s1->filename);
96
    offset = strchr(param, '+');
97
    if (offset) {
98
        sscanf(offset, "%d,%d", &x_off, &y_off);
99
        x11grab->nomouse= strstr(offset, "nomouse");
100
        *offset= 0;
101
    }
102

    
103
    av_log(s1, AV_LOG_INFO, "device: %s -> display: %s x: %d y: %d width: %d height: %d\n", s1->filename, param, x_off, y_off, ap->width, ap->height);
104

    
105
    dpy = XOpenDisplay(param);
106
    if(!dpy) {
107
        av_log(s1, AV_LOG_ERROR, "Could not open X display.\n");
108
        return AVERROR(EIO);
109
    }
110

    
111
    if (!ap || ap->width <= 0 || ap->height <= 0 || ap->time_base.den <= 0) {
112
        av_log(s1, AV_LOG_ERROR, "AVParameters don't have video size and/or rate. Use -s and -r.\n");
113
        return AVERROR(EIO);
114
    }
115

    
116
    st = av_new_stream(s1, 0);
117
    if (!st) {
118
        return AVERROR(ENOMEM);
119
    }
120
    av_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
121

    
122
    use_shm = XShmQueryExtension(dpy);
123
    av_log(s1, AV_LOG_INFO, "shared memory extension %s found\n", use_shm ? "" : "not");
124

    
125
    if(use_shm) {
126
        int scr = XDefaultScreen(dpy);
127
        image = XShmCreateImage(dpy,
128
                                DefaultVisual(dpy, scr),
129
                                DefaultDepth(dpy, scr),
130
                                ZPixmap,
131
                                NULL,
132
                                &x11grab->shminfo,
133
                                ap->width, ap->height);
134
        x11grab->shminfo.shmid = shmget(IPC_PRIVATE,
135
                                        image->bytes_per_line * image->height,
136
                                        IPC_CREAT|0777);
137
        if (x11grab->shminfo.shmid == -1) {
138
            av_log(s1, AV_LOG_ERROR, "Fatal: Can't get shared memory!\n");
139
            return AVERROR(ENOMEM);
140
        }
141
        x11grab->shminfo.shmaddr = image->data = shmat(x11grab->shminfo.shmid, 0, 0);
142
        x11grab->shminfo.readOnly = False;
143

    
144
        if (!XShmAttach(dpy, &x11grab->shminfo)) {
145
            av_log(s1, AV_LOG_ERROR, "Fatal: Failed to attach shared memory!\n");
146
            /* needs some better error subroutine :) */
147
            return AVERROR(EIO);
148
        }
149
    } else {
150
        image = XGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)),
151
                          x_off,y_off,
152
                          ap->width,ap->height,
153
                          AllPlanes, ZPixmap);
154
    }
155

    
156
    switch (image->bits_per_pixel) {
157
    case 8:
158
        av_log (s1, AV_LOG_DEBUG, "8 bit palette\n");
159
        input_pixfmt = PIX_FMT_PAL8;
160
        break;
161
    case 16:
162
        if (       image->red_mask   == 0xf800 &&
163
                   image->green_mask == 0x07e0 &&
164
                   image->blue_mask  == 0x001f ) {
165
            av_log (s1, AV_LOG_DEBUG, "16 bit RGB565\n");
166
            input_pixfmt = PIX_FMT_RGB565;
167
        } else if (image->red_mask   == 0x7c00 &&
168
                   image->green_mask == 0x03e0 &&
169
                   image->blue_mask  == 0x001f ) {
170
            av_log(s1, AV_LOG_DEBUG, "16 bit RGB555\n");
171
            input_pixfmt = PIX_FMT_RGB555;
172
        } else {
173
            av_log(s1, AV_LOG_ERROR, "RGB ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
174
            av_log(s1, AV_LOG_ERROR, "color masks: r 0x%.6lx g 0x%.6lx b 0x%.6lx\n", image->red_mask, image->green_mask, image->blue_mask);
175
            return AVERROR(EIO);
176
        }
177
        break;
178
    case 24:
179
        if (        image->red_mask   == 0xff0000 &&
180
                    image->green_mask == 0x00ff00 &&
181
                    image->blue_mask  == 0x0000ff ) {
182
            input_pixfmt = PIX_FMT_BGR24;
183
        } else if ( image->red_mask   == 0x0000ff &&
184
                    image->green_mask == 0x00ff00 &&
185
                    image->blue_mask  == 0xff0000 ) {
186
            input_pixfmt = PIX_FMT_RGB24;
187
        } else {
188
            av_log(s1, AV_LOG_ERROR,"rgb ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
189
            av_log(s1, AV_LOG_ERROR, "color masks: r 0x%.6lx g 0x%.6lx b 0x%.6lx\n", image->red_mask, image->green_mask, image->blue_mask);
190
            return AVERROR(EIO);
191
        }
192
        break;
193
    case 32:
194
#if 0
195
        GetColorInfo (image, &c_info);
196
        if ( c_info.alpha_mask == 0xff000000 && image->green_mask == 0x0000ff00) {
197
            /* byte order is relevant here, not endianness
198
             * endianness is handled by avcodec, but atm no such thing
199
             * as having ABGR, instead of ARGB in a word. Since we
200
             * need this for Solaris/SPARC, but need to do the conversion
201
             * for every frame we do it outside of this loop, cf. below
202
             * this matches both ARGB32 and ABGR32 */
203
            input_pixfmt = PIX_FMT_ARGB32;
204
        }  else {
205
            av_log(s1, AV_LOG_ERROR,"image depth %i not supported ... aborting\n", image->bits_per_pixel);
206
            return AVERROR(EIO);
207
        }
208
#endif
209
        input_pixfmt = PIX_FMT_RGB32;
210
        break;
211
    default:
212
        av_log(s1, AV_LOG_ERROR, "image depth %i not supported ... aborting\n", image->bits_per_pixel);
213
        return -1;
214
    }
215

    
216
    x11grab->frame_size = ap->width * ap->height * image->bits_per_pixel/8;
217
    x11grab->dpy = dpy;
218
    x11grab->width = ap->width;
219
    x11grab->height = ap->height;
220
    x11grab->time_base  = ap->time_base;
221
    x11grab->time_frame = av_gettime() / av_q2d(ap->time_base);
222
    x11grab->x_off = x_off;
223
    x11grab->y_off = y_off;
224
    x11grab->image = image;
225
    x11grab->use_shm = use_shm;
226

    
227
    st->codec->codec_type = CODEC_TYPE_VIDEO;
228
    st->codec->codec_id = CODEC_ID_RAWVIDEO;
229
    st->codec->width = ap->width;
230
    st->codec->height = ap->height;
231
    st->codec->pix_fmt = input_pixfmt;
232
    st->codec->time_base = ap->time_base;
233
    st->codec->bit_rate = x11grab->frame_size * 1/av_q2d(ap->time_base) * 8;
234

    
235
    return 0;
236
}
237

    
238
/**
239
 * Paints a mouse pointer in an X11 image.
240
 *
241
 * @param image image to paint the mouse pointer to
242
 * @param s context used to retrieve original grabbing rectangle
243
 *          coordinates
244
 * @param x Mouse pointer coordinate
245
 * @param y Mouse pointer coordinate
246
 */
247
static void
248
paint_mouse_pointer(XImage *image, struct x11_grab *s)
249
{
250
    int x_off = s->x_off;
251
    int y_off = s->y_off;
252
    int width = s->width;
253
    int height = s->height;
254
    Display *dpy = s->dpy;
255
    XFixesCursorImage *xcim;
256
    int x, y;
257
    int line, column;
258
    int to_line, to_column;
259
    int image_addr, xcim_addr;
260

    
261
    xcim = XFixesGetCursorImage(dpy);;
262

    
263
    x = xcim->x - xcim->xhot;
264
    y = xcim->y - xcim->yhot;
265

    
266
    to_line = FFMIN((y + xcim->height), (height + y_off));
267
    to_column = FFMIN((x + xcim->width), (width + x_off));
268

    
269
    for (line = FFMAX(y, y_off); line < to_line; line++) {
270
        for (column = FFMAX(x, x_off); column < to_column; column++) {
271
            xcim_addr = (line - y) * xcim->width + column - x;
272

    
273
            if ((unsigned char)(xcim->pixels[xcim_addr] >> 24) != 0) { // skip fully transparent pixel
274
                image_addr = ((line - y_off) * width + column - x_off) * 4;
275

    
276
                image->data[image_addr] = (unsigned char)(xcim->pixels[xcim_addr] >> 0);
277
                image->data[image_addr+1] = (unsigned char)(xcim->pixels[xcim_addr] >> 8);
278
                image->data[image_addr+2] = (unsigned char)(xcim->pixels[xcim_addr] >> 16);
279
            }
280
        }
281
    }
282

    
283
    XFree(xcim);
284
    xcim = NULL;
285
}
286

    
287

    
288
/**
289
 * Reads new data in the image structure.
290
 *
291
 * @param dpy X11 display to grab from
292
 * @param d
293
 * @param image Image where the grab will be put
294
 * @param x Top-Left grabbing rectangle horizontal coordinate
295
 * @param y Top-Left grabbing rectangle vertical coordinate
296
 * @return 0 if error, !0 if successful
297
 */
298
static int
299
xget_zpixmap(Display *dpy, Drawable d, XImage *image, int x, int y)
300
{
301
    xGetImageReply rep;
302
    xGetImageReq *req;
303
    long nbytes;
304

    
305
    if (!image) {
306
        return 0;
307
    }
308

    
309
    LockDisplay(dpy);
310
    GetReq(GetImage, req);
311

    
312
    /* First set up the standard stuff in the request */
313
    req->drawable = d;
314
    req->x = x;
315
    req->y = y;
316
    req->width = image->width;
317
    req->height = image->height;
318
    req->planeMask = (unsigned int)AllPlanes;
319
    req->format = ZPixmap;
320

    
321
    if (!_XReply(dpy, (xReply *)&rep, 0, xFalse) || !rep.length) {
322
        UnlockDisplay(dpy);
323
        SyncHandle();
324
        return 0;
325
    }
326

    
327
    nbytes = (long)rep.length << 2;
328
    _XReadPad(dpy, image->data, nbytes);
329

    
330
    UnlockDisplay(dpy);
331
    SyncHandle();
332
    return 1;
333
}
334

    
335
/**
336
 * Grabs a frame from x11 (public device demuxer API).
337
 *
338
 * @param s1 Context from avformat core
339
 * @param pkt Packet holding the brabbed frame
340
 * @return frame size in bytes
341
 */
342
static int
343
x11grab_read_packet(AVFormatContext *s1, AVPacket *pkt)
344
{
345
    struct x11_grab *s = s1->priv_data;
346
    Display *dpy = s->dpy;
347
    XImage *image = s->image;
348
    int x_off = s->x_off;
349
    int y_off = s->y_off;
350

    
351
    int64_t curtime, delay;
352
    struct timespec ts;
353

    
354
    /* Calculate the time of the next frame */
355
    s->time_frame += INT64_C(1000000);
356

    
357
    /* wait based on the frame rate */
358
    for(;;) {
359
        curtime = av_gettime();
360
        delay = s->time_frame * av_q2d(s->time_base) - curtime;
361
        if (delay <= 0) {
362
            if (delay < INT64_C(-1000000) * av_q2d(s->time_base)) {
363
                s->time_frame += INT64_C(1000000);
364
            }
365
            break;
366
        }
367
        ts.tv_sec = delay / 1000000;
368
        ts.tv_nsec = (delay % 1000000) * 1000;
369
        nanosleep(&ts, NULL);
370
    }
371

    
372
    if (av_new_packet(pkt, s->frame_size) < 0) {
373
        return AVERROR(EIO);
374
    }
375

    
376
    pkt->pts = curtime;
377

    
378
    if(s->use_shm) {
379
        if (!XShmGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off, AllPlanes)) {
380
            av_log (s1, AV_LOG_INFO, "XShmGetImage() failed\n");
381
        }
382
    } else {
383
        if (!xget_zpixmap(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off)) {
384
            av_log (s1, AV_LOG_INFO, "XGetZPixmap() failed\n");
385
        }
386
    }
387

    
388
    if(!s->nomouse){
389
        paint_mouse_pointer(image, s);
390
    }
391

    
392

    
393
    /* XXX: avoid memcpy */
394
    memcpy(pkt->data, image->data, s->frame_size);
395
    return s->frame_size;
396
}
397

    
398
/**
399
 * Closes x11 frame grabber (public device demuxer API).
400
 *
401
 * @param s1 Context from avformat core
402
 * @return 0 success, !0 failure
403
 */
404
static int
405
x11grab_read_close(AVFormatContext *s1)
406
{
407
    struct x11_grab *x11grab = s1->priv_data;
408

    
409
    /* Detach cleanly from shared mem */
410
    if (x11grab->use_shm) {
411
        XShmDetach(x11grab->dpy, &x11grab->shminfo);
412
        shmdt(x11grab->shminfo.shmaddr);
413
        shmctl(x11grab->shminfo.shmid, IPC_RMID, NULL);
414
    }
415

    
416
    /* Destroy X11 image */
417
    if (x11grab->image) {
418
        XDestroyImage(x11grab->image);
419
        x11grab->image = NULL;
420
    }
421

    
422
    /* Free X11 display */
423
    XCloseDisplay(x11grab->dpy);
424
    return 0;
425
}
426

    
427
/** x11 grabber device demuxer declaration */
428
AVInputFormat x11_grab_device_demuxer =
429
{
430
    "x11grab",
431
    NULL_IF_CONFIG_SMALL("X11grab"),
432
    sizeof(struct x11_grab),
433
    NULL,
434
    x11grab_read_header,
435
    x11grab_read_packet,
436
    x11grab_read_close,
437
    .flags = AVFMT_NOFILE,
438
};