f58f4ce1 |
/*
* X11 video grab interface |
2909f177 |
* |
ef84bf04 |
* This file is part of FFmpeg. |
f58f4ce1 |
* |
ef84bf04 |
* FFmpeg integration:
* Copyright (C) 2006 Clemens Fruhwirth <clemens@endorphin.org>
* Edouard Gomez <ed.gomez@free.fr> |
f58f4ce1 |
* |
ef84bf04 |
* This file contains code from grab.c: |
aac105fc |
* Copyright (c) 2000-2001 Fabrice Bellard |
f58f4ce1 |
*
* This file contains code from the xvidcap project: |
ef84bf04 |
* Copyright (C) 1997-1998 Rasca, Berlin
* 2003-2004 Karl H. Beckers, Frankfurt |
f58f4ce1 |
* |
ef84bf04 |
* FFmpeg is free software; you can redistribute it and/or modify |
f58f4ce1 |
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
* |
ef84bf04 |
* FFmpeg is distributed in the hope that it will be useful, |
f58f4ce1 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
* |
e5a389a1 |
* You should have received a copy of the GNU General Public License
* along with FFmpeg; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA |
f58f4ce1 |
*/ |
2909f177 |
|
6e71a18e |
/** |
ba87f080 |
* @file |
6e71a18e |
* X11 frame device demuxer by Clemens Fruhwirth <clemens@endorphin.org>
* and Edouard Gomez <ed.gomez@free.fr>.
*/
|
b0067549 |
#include "config.h" |
724a900c |
#include "libavutil/log.h"
#include "libavutil/opt.h"
#include "libavutil/parseutils.h" |
f58f4ce1 |
#include <time.h>
#include <X11/X.h>
#include <X11/Xlib.h>
#include <X11/Xlibint.h>
#include <X11/Xproto.h> |
ef84bf04 |
#include <X11/Xutil.h> |
f58f4ce1 |
#include <sys/shm.h>
#include <X11/extensions/XShm.h> |
781c1aa6 |
#include <X11/extensions/Xfixes.h> |
6b899e16 |
#include "avdevice.h" |
f58f4ce1 |
|
6e71a18e |
/**
* X11 Device Demuxer context
*/ |
616deed2 |
struct x11_grab |
2909f177 |
{ |
724a900c |
const AVClass *class; /**< Class for private options. */ |
6e71a18e |
int frame_size; /**< Size in bytes of a grabbed frame */
AVRational time_base; /**< Time base */
int64_t time_frame; /**< Current time */
|
724a900c |
char *video_size; /**< String describing video size, set by a private option. */ |
6e71a18e |
int height; /**< Height of the grab frame */
int width; /**< Width of the grab frame */
int x_off; /**< Horizontal top-left corner coordinate */
int y_off; /**< Vertical top-left corner coordinate */
Display *dpy; /**< X11 display from which x11grab grabs frames */
XImage *image; /**< X11 image holding the grab */
int use_shm; /**< !0 when using XShm extension */
XShmSegmentInfo shminfo; /**< When using XShm, keeps track of XShm infos */ |
f6dcc937 |
int nomouse; |
ff494cbd |
char *framerate; /**< Set by a private option. */ |
616deed2 |
}; |
6e71a18e |
/** |
49bd8e4b |
* Initialize the x11 grab device demuxer (public device demuxer API). |
6e71a18e |
*
* @param s1 Context from avformat core
* @param ap Parameters from avformat core
* @return <ul> |
5632e568 |
* <li>AVERROR(ENOMEM) no memory left</li> |
6f3e0b21 |
* <li>AVERROR(EIO) other failure case</li> |
6e71a18e |
* <li>0 success</li>
* </ul>
*/ |
2909f177 |
static int
x11grab_read_header(AVFormatContext *s1, AVFormatParameters *ap) |
f58f4ce1 |
{ |
616deed2 |
struct x11_grab *x11grab = s1->priv_data; |
aac105fc |
Display *dpy;
AVStream *st = NULL; |
1f15747f |
enum PixelFormat input_pixfmt; |
aac105fc |
XImage *image; |
6e71a18e |
int x_off = 0;
int y_off = 0; |
aac105fc |
int use_shm; |
44a8b0dd |
char *dpyname, *offset; |
3102fb03 |
int ret = 0; |
ff494cbd |
AVRational framerate; |
aac105fc |
|
44a8b0dd |
dpyname = av_strdup(s1->filename);
offset = strchr(dpyname, '+'); |
0cd4faf9 |
if (offset) {
sscanf(offset, "%d,%d", &x_off, &y_off); |
f6dcc937 |
x11grab->nomouse= strstr(offset, "nomouse"); |
0cd4faf9 |
*offset= 0;
}
|
724a900c |
if ((ret = av_parse_video_size(&x11grab->width, &x11grab->height, x11grab->video_size)) < 0) {
av_log(s1, AV_LOG_ERROR, "Couldn't parse video size.\n");
goto out;
} |
ff494cbd |
if ((ret = av_parse_video_rate(&framerate, x11grab->framerate)) < 0) {
av_log(s1, AV_LOG_ERROR, "Could not parse framerate: %s.\n", x11grab->framerate);
goto out;
} |
724a900c |
#if FF_API_FORMAT_PARAMETERS
if (ap->width > 0)
x11grab->width = ap->width;
if (ap->height > 0)
x11grab->height = ap->height; |
ff494cbd |
if (ap->time_base.num)
framerate = (AVRational){ap->time_base.den, ap->time_base.num}; |
724a900c |
#endif
av_log(s1, AV_LOG_INFO, "device: %s -> display: %s x: %d y: %d width: %d height: %d\n", |
8381ab14 |
s1->filename, dpyname, x_off, y_off, x11grab->width, x11grab->height); |
0cd4faf9 |
|
44a8b0dd |
dpy = XOpenDisplay(dpyname);
av_freep(&dpyname); |
0cd4faf9 |
if(!dpy) {
av_log(s1, AV_LOG_ERROR, "Could not open X display.\n"); |
3102fb03 |
ret = AVERROR(EIO);
goto out; |
0cd4faf9 |
} |
aac105fc |
st = av_new_stream(s1, 0);
if (!st) { |
3102fb03 |
ret = AVERROR(ENOMEM);
goto out; |
aac105fc |
}
av_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
use_shm = XShmQueryExtension(dpy); |
9af20971 |
av_log(s1, AV_LOG_INFO, "shared memory extension%s found\n", use_shm ? "" : " not"); |
aac105fc |
if(use_shm) {
int scr = XDefaultScreen(dpy);
image = XShmCreateImage(dpy,
DefaultVisual(dpy, scr),
DefaultDepth(dpy, scr),
ZPixmap,
NULL,
&x11grab->shminfo, |
724a900c |
x11grab->width, x11grab->height); |
aac105fc |
x11grab->shminfo.shmid = shmget(IPC_PRIVATE,
image->bytes_per_line * image->height,
IPC_CREAT|0777);
if (x11grab->shminfo.shmid == -1) {
av_log(s1, AV_LOG_ERROR, "Fatal: Can't get shared memory!\n"); |
3102fb03 |
ret = AVERROR(ENOMEM);
goto out; |
aac105fc |
}
x11grab->shminfo.shmaddr = image->data = shmat(x11grab->shminfo.shmid, 0, 0);
x11grab->shminfo.readOnly = False;
if (!XShmAttach(dpy, &x11grab->shminfo)) {
av_log(s1, AV_LOG_ERROR, "Fatal: Failed to attach shared memory!\n");
/* needs some better error subroutine :) */ |
3102fb03 |
ret = AVERROR(EIO);
goto out; |
aac105fc |
}
} else {
image = XGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)),
x_off,y_off, |
724a900c |
x11grab->width, x11grab->height, |
aac105fc |
AllPlanes, ZPixmap);
}
switch (image->bits_per_pixel) {
case 8: |
6187b8bd |
av_log (s1, AV_LOG_DEBUG, "8 bit palette\n"); |
aac105fc |
input_pixfmt = PIX_FMT_PAL8;
break;
case 16: |
6e71a18e |
if ( image->red_mask == 0xf800 &&
image->green_mask == 0x07e0 &&
image->blue_mask == 0x001f ) { |
aac105fc |
av_log (s1, AV_LOG_DEBUG, "16 bit RGB565\n");
input_pixfmt = PIX_FMT_RGB565; |
6e71a18e |
} else if (image->red_mask == 0x7c00 &&
image->green_mask == 0x03e0 &&
image->blue_mask == 0x001f ) { |
aac105fc |
av_log(s1, AV_LOG_DEBUG, "16 bit RGB555\n");
input_pixfmt = PIX_FMT_RGB555;
} else {
av_log(s1, AV_LOG_ERROR, "RGB ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
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); |
3102fb03 |
ret = AVERROR(EIO);
goto out; |
aac105fc |
}
break;
case 24: |
6e71a18e |
if ( image->red_mask == 0xff0000 &&
image->green_mask == 0x00ff00 &&
image->blue_mask == 0x0000ff ) { |
aac105fc |
input_pixfmt = PIX_FMT_BGR24; |
6e71a18e |
} else if ( image->red_mask == 0x0000ff &&
image->green_mask == 0x00ff00 &&
image->blue_mask == 0xff0000 ) { |
aac105fc |
input_pixfmt = PIX_FMT_RGB24;
} else {
av_log(s1, AV_LOG_ERROR,"rgb ordering at image depth %i not supported ... aborting\n", image->bits_per_pixel);
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); |
3102fb03 |
ret = AVERROR(EIO);
goto out; |
aac105fc |
}
break;
case 32: |
f58f4ce1 |
#if 0 |
aac105fc |
GetColorInfo (image, &c_info); |
6e71a18e |
if ( c_info.alpha_mask == 0xff000000 && image->green_mask == 0x0000ff00) { |
aac105fc |
/* byte order is relevant here, not endianness
* endianness is handled by avcodec, but atm no such thing
* as having ABGR, instead of ARGB in a word. Since we
* need this for Solaris/SPARC, but need to do the conversion
* for every frame we do it outside of this loop, cf. below
* this matches both ARGB32 and ABGR32 */
input_pixfmt = PIX_FMT_ARGB32;
} else {
av_log(s1, AV_LOG_ERROR,"image depth %i not supported ... aborting\n", image->bits_per_pixel); |
6f3e0b21 |
return AVERROR(EIO); |
aac105fc |
} |
f58f4ce1 |
#endif |
71e445fc |
input_pixfmt = PIX_FMT_RGB32; |
aac105fc |
break;
default:
av_log(s1, AV_LOG_ERROR, "image depth %i not supported ... aborting\n", image->bits_per_pixel); |
3102fb03 |
ret = AVERROR(EINVAL);
goto out; |
aac105fc |
}
|
724a900c |
x11grab->frame_size = x11grab->width * x11grab->height * image->bits_per_pixel/8; |
aac105fc |
x11grab->dpy = dpy; |
ff494cbd |
x11grab->time_base = (AVRational){framerate.den, framerate.num};
x11grab->time_frame = av_gettime() / av_q2d(x11grab->time_base); |
aac105fc |
x11grab->x_off = x_off;
x11grab->y_off = y_off;
x11grab->image = image;
x11grab->use_shm = use_shm;
|
72415b2a |
st->codec->codec_type = AVMEDIA_TYPE_VIDEO; |
aac105fc |
st->codec->codec_id = CODEC_ID_RAWVIDEO; |
724a900c |
st->codec->width = x11grab->width;
st->codec->height = x11grab->height; |
aac105fc |
st->codec->pix_fmt = input_pixfmt; |
ff494cbd |
st->codec->time_base = x11grab->time_base;
st->codec->bit_rate = x11grab->frame_size * 1/av_q2d(x11grab->time_base) * 8; |
aac105fc |
|
3102fb03 |
out:
return ret; |
f58f4ce1 |
}
|
6e71a18e |
/** |
49bd8e4b |
* Paint a mouse pointer in an X11 image. |
6e71a18e |
* |
bd107136 |
* @param image image to paint the mouse pointer to |
6e71a18e |
* @param s context used to retrieve original grabbing rectangle
* coordinates
*/ |
2909f177 |
static void |
781c1aa6 |
paint_mouse_pointer(XImage *image, struct x11_grab *s) |
2909f177 |
{ |
aac105fc |
int x_off = s->x_off;
int y_off = s->y_off;
int width = s->width;
int height = s->height; |
781c1aa6 |
Display *dpy = s->dpy;
XFixesCursorImage *xcim;
int x, y;
int line, column;
int to_line, to_column; |
8ce803db |
int pixstride = image->bits_per_pixel >> 3;
/* Warning: in its insanity, xlib provides unsigned image data through a
* char* pointer, so we have to make it uint8_t to make things not break.
* Anyone who performs further investigation of the xlib API likely risks
* permanent brain damage. */
uint8_t *pix = image->data;
/* Code doesn't currently support 16-bit or PAL8 */
if (image->bits_per_pixel != 24 && image->bits_per_pixel != 32)
return; |
aac105fc |
|
33e7febd |
xcim = XFixesGetCursorImage(dpy); |
aac105fc |
|
781c1aa6 |
x = xcim->x - xcim->xhot;
y = xcim->y - xcim->yhot;
to_line = FFMIN((y + xcim->height), (height + y_off));
to_column = FFMIN((x + xcim->width), (width + x_off));
for (line = FFMAX(y, y_off); line < to_line; line++) {
for (column = FFMAX(x, x_off); column < to_column; column++) { |
8ce803db |
int xcim_addr = (line - y) * xcim->width + column - x;
int image_addr = ((line - y_off) * width + column - x_off) * pixstride;
int r = (uint8_t)(xcim->pixels[xcim_addr] >> 0);
int g = (uint8_t)(xcim->pixels[xcim_addr] >> 8);
int b = (uint8_t)(xcim->pixels[xcim_addr] >> 16);
int a = (uint8_t)(xcim->pixels[xcim_addr] >> 24);
if (a == 255) {
pix[image_addr+0] = r;
pix[image_addr+1] = g;
pix[image_addr+2] = b;
} else if (a) {
/* pixel values from XFixesGetCursorImage come premultiplied by alpha */
pix[image_addr+0] = r + (pix[image_addr+0]*(255-a) + 255/2) / 255;
pix[image_addr+1] = g + (pix[image_addr+1]*(255-a) + 255/2) / 255;
pix[image_addr+2] = b + (pix[image_addr+2]*(255-a) + 255/2) / 255; |
0235a311 |
} |
aac105fc |
}
} |
781c1aa6 |
XFree(xcim);
xcim = NULL; |
f58f4ce1 |
}
|
6e71a18e |
/** |
49bd8e4b |
* Read new data in the image structure. |
6e71a18e |
*
* @param dpy X11 display to grab from |
05f3b6ab |
* @param d |
6e71a18e |
* @param image Image where the grab will be put
* @param x Top-Left grabbing rectangle horizontal coordinate
* @param y Top-Left grabbing rectangle vertical coordinate
* @return 0 if error, !0 if successful |
f58f4ce1 |
*/
static int |
6e71a18e |
xget_zpixmap(Display *dpy, Drawable d, XImage *image, int x, int y) |
f58f4ce1 |
{ |
aac105fc |
xGetImageReply rep;
xGetImageReq *req;
long nbytes;
if (!image) { |
6e71a18e |
return 0; |
aac105fc |
}
LockDisplay(dpy);
GetReq(GetImage, req);
/* First set up the standard stuff in the request */
req->drawable = d;
req->x = x;
req->y = y;
req->width = image->width;
req->height = image->height;
req->planeMask = (unsigned int)AllPlanes;
req->format = ZPixmap;
|
6e71a18e |
if (!_XReply(dpy, (xReply *)&rep, 0, xFalse) || !rep.length) { |
aac105fc |
UnlockDisplay(dpy);
SyncHandle(); |
6e71a18e |
return 0; |
aac105fc |
}
nbytes = (long)rep.length << 2;
_XReadPad(dpy, image->data, nbytes);
UnlockDisplay(dpy);
SyncHandle(); |
6e71a18e |
return 1; |
f58f4ce1 |
}
|
6e71a18e |
/** |
49bd8e4b |
* Grab a frame from x11 (public device demuxer API). |
6e71a18e |
*
* @param s1 Context from avformat core
* @param pkt Packet holding the brabbed frame
* @return frame size in bytes
*/ |
0235a311 |
static int
x11grab_read_packet(AVFormatContext *s1, AVPacket *pkt) |
f58f4ce1 |
{ |
616deed2 |
struct x11_grab *s = s1->priv_data; |
aac105fc |
Display *dpy = s->dpy;
XImage *image = s->image;
int x_off = s->x_off;
int y_off = s->y_off;
int64_t curtime, delay;
struct timespec ts;
/* Calculate the time of the next frame */ |
ba78f9d4 |
s->time_frame += INT64_C(1000000); |
aac105fc |
/* wait based on the frame rate */
for(;;) {
curtime = av_gettime(); |
6e71a18e |
delay = s->time_frame * av_q2d(s->time_base) - curtime; |
aac105fc |
if (delay <= 0) { |
ba78f9d4 |
if (delay < INT64_C(-1000000) * av_q2d(s->time_base)) {
s->time_frame += INT64_C(1000000); |
aac105fc |
}
break;
}
ts.tv_sec = delay / 1000000;
ts.tv_nsec = (delay % 1000000) * 1000;
nanosleep(&ts, NULL);
}
|
39530272 |
av_init_packet(pkt);
pkt->data = image->data;
pkt->size = s->frame_size; |
6e71a18e |
pkt->pts = curtime; |
aac105fc |
if(s->use_shm) {
if (!XShmGetImage(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off, AllPlanes)) {
av_log (s1, AV_LOG_INFO, "XShmGetImage() failed\n");
}
} else { |
6e71a18e |
if (!xget_zpixmap(dpy, RootWindow(dpy, DefaultScreen(dpy)), image, x_off, y_off)) { |
aac105fc |
av_log (s1, AV_LOG_INFO, "XGetZPixmap() failed\n");
}
}
|
f6dcc937 |
if(!s->nomouse){ |
781c1aa6 |
paint_mouse_pointer(image, s); |
aac105fc |
}
return s->frame_size; |
f58f4ce1 |
}
|
6e71a18e |
/** |
49bd8e4b |
* Close x11 frame grabber (public device demuxer API). |
6e71a18e |
*
* @param s1 Context from avformat core
* @return 0 success, !0 failure
*/ |
0235a311 |
static int
x11grab_read_close(AVFormatContext *s1) |
f58f4ce1 |
{ |
616deed2 |
struct x11_grab *x11grab = s1->priv_data; |
aac105fc |
/* Detach cleanly from shared mem */
if (x11grab->use_shm) {
XShmDetach(x11grab->dpy, &x11grab->shminfo);
shmdt(x11grab->shminfo.shmaddr);
shmctl(x11grab->shminfo.shmid, IPC_RMID, NULL);
}
/* Destroy X11 image */
if (x11grab->image) {
XDestroyImage(x11grab->image);
x11grab->image = NULL;
}
/* Free X11 display */
XCloseDisplay(x11grab->dpy);
return 0; |
f58f4ce1 |
}
|
724a900c |
#define OFFSET(x) offsetof(struct x11_grab, x)
#define DEC AV_OPT_FLAG_DECODING_PARAM
static const AVOption options[] = {
{ "video_size", "A string describing frame size, such as 640x480 or hd720.", OFFSET(video_size), FF_OPT_TYPE_STRING, {.str = "vga"}, 0, 0, DEC }, |
ff494cbd |
{ "framerate", "", OFFSET(framerate), FF_OPT_TYPE_STRING, {.str = "ntsc"}, 0, 0, DEC }, |
724a900c |
{ NULL },
};
static const AVClass x11_class = {
.class_name = "X11grab indev",
.item_name = av_default_item_name,
.option = options,
.version = LIBAVUTIL_VERSION_INT,
};
|
6e71a18e |
/** x11 grabber device demuxer declaration */ |
66355be3 |
AVInputFormat ff_x11_grab_device_demuxer = |
2909f177 |
{ |
aac105fc |
"x11grab", |
bde15e74 |
NULL_IF_CONFIG_SMALL("X11grab"), |
616deed2 |
sizeof(struct x11_grab), |
aac105fc |
NULL,
x11grab_read_header,
x11grab_read_packet,
x11grab_read_close,
.flags = AVFMT_NOFILE, |
724a900c |
.priv_class = &x11_class, |
f58f4ce1 |
}; |