Remove unused stuff.
[ffmpeg.git] / libavdevice / x11grab.c
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 };
69
70 /**
71  * Initializes the x11 grab device demuxer (public device demuxer API).
72  *
73  * @param s1 Context from avformat core
74  * @param ap Parameters from avformat core
75  * @return <ul>
76  *          <li>AVERROR(ENOMEM) no memory left</li>
77  *          <li>AVERROR(EIO) other failure case</li>
78  *          <li>0 success</li>
79  *         </ul>
80  */
81 static int
82 x11grab_read_header(AVFormatContext *s1, AVFormatParameters *ap)
83 {
84     struct x11_grab *x11grab = s1->priv_data;
85     Display *dpy;
86     AVStream *st = NULL;
87     int input_pixfmt;
88     XImage *image;
89     int x_off = 0;
90     int y_off = 0;
91     int use_shm;
92     char *param, *offset;
93
94     param = av_strdup(s1->filename);
95     offset = strchr(param, '+');
96     if (offset) {
97         sscanf(offset, "%d,%d", &x_off, &y_off);
98         *offset= 0;
99     }
100
101     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);
102
103     dpy = XOpenDisplay(param);
104     if(!dpy) {
105         av_log(s1, AV_LOG_ERROR, "Could not open X display.\n");
106         return AVERROR(EIO);
107     }
108
109     if (!ap || ap->width <= 0 || ap->height <= 0 || ap->time_base.den <= 0) {
110         av_log(s1, AV_LOG_ERROR, "AVParameters don't have video size and/or rate. Use -s and -r.\n");
111         return AVERROR(EIO);
112     }
113
114     st = av_new_stream(s1, 0);
115     if (!st) {
116         return AVERROR(ENOMEM);
117     }
118     av_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
119
120     use_shm = XShmQueryExtension(dpy);
121     av_log(s1, AV_LOG_INFO, "shared memory extension %s found\n", use_shm ? "" : "not");
122
123     if(use_shm) {
124         int scr = XDefaultScreen(dpy);
125         image = XShmCreateImage(dpy,
126                                 DefaultVisual(dpy, scr),
127                                 DefaultDepth(dpy, scr),
128                                 ZPixmap,
129                                 NULL,
130                                 &x11grab->shminfo,
131                                 ap->width, ap->height);
132         x11grab->shminfo.shmid = shmget(IPC_PRIVATE,
133                                         image->bytes_per_line * image->height,
134                                         IPC_CREAT|0777);
135         if (x11grab->shminfo.shmid == -1) {
136             av_log(s1, AV_LOG_ERROR, "Fatal: Can't get shared memory!\n");
137             return AVERROR(ENOMEM);
138         }
139         x11grab->shminfo.shmaddr = image->data = shmat(x11grab->shminfo.shmid, 0, 0);
140         x11grab->shminfo.readOnly = False;
141
142         if (!XShmAttach(dpy, &x11grab->shminfo)) {
143             av_log(s1, AV_LOG_ERROR, "Fatal: Failed to attach shared memory!\n");
144             /* needs some better error subroutine :) */
145             return AVERROR(EIO);
146         }
147     } else {
148         image = XGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)),
149                           x_off,y_off,
150                           ap->width,ap->height,
151                           AllPlanes, ZPixmap);
152     }
153
154     switch (image->bits_per_pixel) {
155     case 8:
156         av_log (s1, AV_LOG_DEBUG, "8 bit palette\n");
157         input_pixfmt = PIX_FMT_PAL8;
158         break;
159     case 16:
160         if (       image->red_mask   == 0xf800 &&
161                    image->green_mask == 0x07e0 &&
162                    image->blue_mask  == 0x001f ) {
163             av_log (s1, AV_LOG_DEBUG, "16 bit RGB565\n");
164             input_pixfmt = PIX_FMT_RGB565;
165         } else if (image->red_mask   == 0x7c00 &&
166                    image->green_mask == 0x03e0 &&
167                    image->blue_mask  == 0x001f ) {
168             av_log(s1, AV_LOG_DEBUG, "16 bit RGB555\n");
169             input_pixfmt = PIX_FMT_RGB555;
170         } else {
171             av_log(s1, AV_LOG_ERROR, "RGB ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
172             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);
173             return AVERROR(EIO);
174         }
175         break;
176     case 24:
177         if (        image->red_mask   == 0xff0000 &&
178                     image->green_mask == 0x00ff00 &&
179                     image->blue_mask  == 0x0000ff ) {
180             input_pixfmt = PIX_FMT_BGR24;
181         } else if ( image->red_mask   == 0x0000ff &&
182                     image->green_mask == 0x00ff00 &&
183                     image->blue_mask  == 0xff0000 ) {
184             input_pixfmt = PIX_FMT_RGB24;
185         } else {
186             av_log(s1, AV_LOG_ERROR,"rgb ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
187             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);
188             return AVERROR(EIO);
189         }
190         break;
191     case 32:
192 #if 0
193         GetColorInfo (image, &c_info);
194         if ( c_info.alpha_mask == 0xff000000 && image->green_mask == 0x0000ff00) {
195             /* byte order is relevant here, not endianness
196              * endianness is handled by avcodec, but atm no such thing
197              * as having ABGR, instead of ARGB in a word. Since we
198              * need this for Solaris/SPARC, but need to do the conversion
199              * for every frame we do it outside of this loop, cf. below
200              * this matches both ARGB32 and ABGR32 */
201             input_pixfmt = PIX_FMT_ARGB32;
202         }  else {
203             av_log(s1, AV_LOG_ERROR,"image depth %i not supported ... aborting\n", image->bits_per_pixel);
204             return AVERROR(EIO);
205         }
206 #endif
207         input_pixfmt = PIX_FMT_RGB32;
208         break;
209     default:
210         av_log(s1, AV_LOG_ERROR, "image depth %i not supported ... aborting\n", image->bits_per_pixel);
211         return -1;
212     }
213
214     x11grab->frame_size = ap->width * ap->height * image->bits_per_pixel/8;
215     x11grab->dpy = dpy;
216     x11grab->width = ap->width;
217     x11grab->height = ap->height;
218     x11grab->time_base  = ap->time_base;
219     x11grab->time_frame = av_gettime() / av_q2d(ap->time_base);
220     x11grab->x_off = x_off;
221     x11grab->y_off = y_off;
222     x11grab->image = image;
223     x11grab->use_shm = use_shm;
224
225     st->codec->codec_type = CODEC_TYPE_VIDEO;
226     st->codec->codec_id = CODEC_ID_RAWVIDEO;
227     st->codec->width = ap->width;
228     st->codec->height = ap->height;
229     st->codec->pix_fmt = input_pixfmt;
230     st->codec->time_base = ap->time_base;
231     st->codec->bit_rate = x11grab->frame_size * 1/av_q2d(ap->time_base) * 8;
232
233     return 0;
234 }
235
236 /**
237  * Paints a mouse pointer in an X11 image.
238  *
239  * @param image image to paint the mouse pointer to
240  * @param s context used to retrieve original grabbing rectangle
241  *          coordinates
242  * @param x Mouse pointer coordinate
243  * @param y Mouse pointer coordinate
244  */
245 static void
246 paint_mouse_pointer(XImage *image, struct x11_grab *s)
247 {
248     int x_off = s->x_off;
249     int y_off = s->y_off;
250     int width = s->width;
251     int height = s->height;
252     Display *dpy = s->dpy;
253     XFixesCursorImage *xcim;
254     int x, y;
255     int line, column;
256     int to_line, to_column;
257     int image_addr, xcim_addr;
258
259     xcim = XFixesGetCursorImage(dpy);;
260
261     x = xcim->x - xcim->xhot;
262     y = xcim->y - xcim->yhot;
263
264     to_line = FFMIN((y + xcim->height), (height + y_off));
265     to_column = FFMIN((x + xcim->width), (width + x_off));
266
267     for (line = FFMAX(y, y_off); line < to_line; line++) {
268         for (column = FFMAX(x, x_off); column < to_column; column++) {
269             xcim_addr = (line - y) * xcim->width + column - x;
270
271             if ((unsigned char)(xcim->pixels[xcim_addr] >> 24) != 0) { // skip fully transparent pixel
272                 image_addr = ((line - y_off) * width + column - x_off) * 4;
273
274                 image->data[image_addr] = (unsigned char)(xcim->pixels[xcim_addr] >> 0);
275                 image->data[image_addr+1] = (unsigned char)(xcim->pixels[xcim_addr] >> 8);
276                 image->data[image_addr+2] = (unsigned char)(xcim->pixels[xcim_addr] >> 16);
277             }
278         }
279     }
280
281     XFree(xcim);
282     xcim = NULL;
283 }
284
285
286 /**
287  * Reads new data in the image structure.
288  *
289  * @param dpy X11 display to grab from
290  * @param d
291  * @param image Image where the grab will be put
292  * @param x Top-Left grabbing rectangle horizontal coordinate
293  * @param y Top-Left grabbing rectangle vertical coordinate
294  * @return 0 if error, !0 if successful
295  */
296 static int
297 xget_zpixmap(Display *dpy, Drawable d, XImage *image, int x, int y)
298 {
299     xGetImageReply rep;
300     xGetImageReq *req;
301     long nbytes;
302
303     if (!image) {
304         return 0;
305     }
306
307     LockDisplay(dpy);
308     GetReq(GetImage, req);
309
310     /* First set up the standard stuff in the request */
311     req->drawable = d;
312     req->x = x;
313     req->y = y;
314     req->width = image->width;
315     req->height = image->height;
316     req->planeMask = (unsigned int)AllPlanes;
317     req->format = ZPixmap;
318
319     if (!_XReply(dpy, (xReply *)&rep, 0, xFalse) || !rep.length) {
320         UnlockDisplay(dpy);
321         SyncHandle();
322         return 0;
323     }
324
325     nbytes = (long)rep.length << 2;
326     _XReadPad(dpy, image->data, nbytes);
327
328     UnlockDisplay(dpy);
329     SyncHandle();
330     return 1;
331 }
332
333 /**
334  * Grabs a frame from x11 (public device demuxer API).
335  *
336  * @param s1 Context from avformat core
337  * @param pkt Packet holding the brabbed frame
338  * @return frame size in bytes
339  */
340 static int
341 x11grab_read_packet(AVFormatContext *s1, AVPacket *pkt)
342 {
343     struct x11_grab *s = s1->priv_data;
344     Display *dpy = s->dpy;
345     XImage *image = s->image;
346     int x_off = s->x_off;
347     int y_off = s->y_off;
348
349     int64_t curtime, delay;
350     struct timespec ts;
351
352     /* Calculate the time of the next frame */
353     s->time_frame += INT64_C(1000000);
354
355     /* wait based on the frame rate */
356     for(;;) {
357         curtime = av_gettime();
358         delay = s->time_frame * av_q2d(s->time_base) - curtime;
359         if (delay <= 0) {
360             if (delay < INT64_C(-1000000) * av_q2d(s->time_base)) {
361                 s->time_frame += INT64_C(1000000);
362             }
363             break;
364         }
365         ts.tv_sec = delay / 1000000;
366         ts.tv_nsec = (delay % 1000000) * 1000;
367         nanosleep(&ts, NULL);
368     }
369
370     if (av_new_packet(pkt, s->frame_size) < 0) {
371         return AVERROR(EIO);
372     }
373
374     pkt->pts = curtime;
375
376     if(s->use_shm) {
377         if (!XShmGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off, AllPlanes)) {
378             av_log (s1, AV_LOG_INFO, "XShmGetImage() failed\n");
379         }
380     } else {
381         if (!xget_zpixmap(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off)) {
382             av_log (s1, AV_LOG_INFO, "XGetZPixmap() failed\n");
383         }
384     }
385
386     {
387         paint_mouse_pointer(image, s);
388     }
389
390
391     /* XXX: avoid memcpy */
392     memcpy(pkt->data, image->data, s->frame_size);
393     return s->frame_size;
394 }
395
396 /**
397  * Closes x11 frame grabber (public device demuxer API).
398  *
399  * @param s1 Context from avformat core
400  * @return 0 success, !0 failure
401  */
402 static int
403 x11grab_read_close(AVFormatContext *s1)
404 {
405     struct x11_grab *x11grab = s1->priv_data;
406
407     /* Detach cleanly from shared mem */
408     if (x11grab->use_shm) {
409         XShmDetach(x11grab->dpy, &x11grab->shminfo);
410         shmdt(x11grab->shminfo.shmaddr);
411         shmctl(x11grab->shminfo.shmid, IPC_RMID, NULL);
412     }
413
414     /* Destroy X11 image */
415     if (x11grab->image) {
416         XDestroyImage(x11grab->image);
417         x11grab->image = NULL;
418     }
419
420     /* Free X11 display */
421     XCloseDisplay(x11grab->dpy);
422     return 0;
423 }
424
425 /** x11 grabber device demuxer declaration */
426 AVInputFormat x11_grab_device_demuxer =
427 {
428     "x11grab",
429     NULL_IF_CONFIG_SMALL("X11grab"),
430     sizeof(struct x11_grab),
431     NULL,
432     x11grab_read_header,
433     x11grab_read_packet,
434     x11grab_read_close,
435     .flags = AVFMT_NOFILE,
436 };