4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 #include <drm_fourcc.h>
28 #include <xf86drmMode.h>
30 // Required for compatibility when building against libdrm < 2.4.83.
31 #ifndef DRM_FORMAT_MOD_INVALID
32 #define DRM_FORMAT_MOD_INVALID ((1ULL << 56) - 1)
35 #include "libavutil/hwcontext.h"
36 #include "libavutil/hwcontext_drm.h"
37 #include "libavutil/internal.h"
38 #include "libavutil/mathematics.h"
39 #include "libavutil/opt.h"
40 #include "libavutil/pixfmt.h"
41 #include "libavutil/pixdesc.h"
42 #include "libavutil/time.h"
44 #include "libavformat/avformat.h"
45 #include "libavformat/internal.h"
47 typedef struct KMSGrabContext {
50 AVBufferRef *device_ref;
51 AVHWDeviceContext *device;
52 AVDRMDeviceContext *hwctx;
55 AVBufferRef *frames_ref;
56 AVHWFramesContext *frames;
66 const char *device_path;
67 enum AVPixelFormat format;
68 int64_t drm_format_modifier;
74 static void kmsgrab_free_desc(void *opaque, uint8_t *data)
76 AVDRMFrameDescriptor *desc = (AVDRMFrameDescriptor*)data;
79 for (i = 0; i < desc->nb_objects; i++)
80 close(desc->objects[i].fd);
85 static void kmsgrab_free_frame(void *opaque, uint8_t *data)
87 AVFrame *frame = (AVFrame*)data;
89 av_frame_free(&frame);
92 static int kmsgrab_get_fb(AVFormatContext *avctx,
94 AVDRMFrameDescriptor *desc)
96 KMSGrabContext *ctx = avctx->priv_data;
100 fb = drmModeGetFB(ctx->hwctx->fd, plane->fb_id);
103 av_log(avctx, AV_LOG_ERROR, "Failed to get framebuffer "
104 "%"PRIu32": %s.\n", plane->fb_id, strerror(err));
108 if (fb->width != ctx->width || fb->height != ctx->height) {
109 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" framebuffer "
110 "dimensions changed: now %"PRIu32"x%"PRIu32".\n",
111 ctx->plane_id, fb->width, fb->height);
116 av_log(avctx, AV_LOG_ERROR, "No handle set on framebuffer.\n");
121 err = drmPrimeHandleToFD(ctx->hwctx->fd, fb->handle, O_RDONLY, &fd);
124 av_log(avctx, AV_LOG_ERROR, "Failed to get PRIME fd from "
125 "framebuffer handle: %s.\n", strerror(err));
130 *desc = (AVDRMFrameDescriptor) {
134 .size = fb->height * fb->pitch,
135 .format_modifier = ctx->drm_format_modifier,
139 .format = ctx->drm_format,
155 #if HAVE_LIBDRM_GETFB2
156 static int kmsgrab_get_fb2(AVFormatContext *avctx,
158 AVDRMFrameDescriptor *desc)
160 KMSGrabContext *ctx = avctx->priv_data;
162 int err, i, nb_objects;
163 uint64_t modifier = ctx->drm_format_modifier;
165 fb = drmModeGetFB2(ctx->hwctx->fd, plane->fb_id);
168 av_log(avctx, AV_LOG_ERROR, "Failed to get framebuffer "
169 "%"PRIu32": %s.\n", plane->fb_id, strerror(err));
172 if (fb->pixel_format != ctx->drm_format) {
173 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" framebuffer "
174 "format changed: now %"PRIx32".\n",
175 ctx->plane_id, fb->pixel_format);
179 if (fb->modifier != ctx->drm_format_modifier) {
180 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" framebuffer "
181 "format modifier changed: now %"PRIx64".\n",
182 ctx->plane_id, fb->modifier);
186 if (fb->width != ctx->width || fb->height != ctx->height) {
187 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" framebuffer "
188 "dimensions changed: now %"PRIu32"x%"PRIu32".\n",
189 ctx->plane_id, fb->width, fb->height);
193 if (!fb->handles[0]) {
194 av_log(avctx, AV_LOG_ERROR, "No handle set on framebuffer.\n");
199 if (fb->flags & DRM_MODE_FB_MODIFIERS)
200 modifier = fb->modifier;
202 *desc = (AVDRMFrameDescriptor) {
205 .format = ctx->drm_format,
210 for (i = 0; i < 4 && fb->handles[i]; i++) {
214 size = fb->offsets[i] + fb->height * fb->pitches[i];
216 for (j = 0; j < i; j++) {
217 if (fb->handles[i] == fb->handles[j]) {
223 obj = desc->layers[0].planes[j].object_index;
225 if (desc->objects[j].size < size)
226 desc->objects[j].size = size;
228 desc->layers[0].planes[i] = (AVDRMPlaneDescriptor) {
230 .offset = fb->offsets[i],
231 .pitch = fb->pitches[i],
236 err = drmPrimeHandleToFD(ctx->hwctx->fd, fb->handles[i],
240 av_log(avctx, AV_LOG_ERROR, "Failed to get PRIME fd from "
241 "framebuffer handle: %s.\n", strerror(err));
247 desc->objects[obj] = (AVDRMObjectDescriptor) {
250 .format_modifier = modifier,
252 desc->layers[0].planes[i] = (AVDRMPlaneDescriptor) {
254 .offset = fb->offsets[i],
255 .pitch = fb->pitches[i],
259 desc->nb_objects = nb_objects;
260 desc->layers[0].nb_planes = i;
269 static int kmsgrab_read_packet(AVFormatContext *avctx, AVPacket *pkt)
271 KMSGrabContext *ctx = avctx->priv_data;
272 drmModePlane *plane = NULL;
273 AVDRMFrameDescriptor *desc = NULL;
274 AVFrame *frame = NULL;
279 if (ctx->frame_last) {
282 delay = ctx->frame_last + ctx->frame_delay - now;
289 ctx->frame_last = now;
291 plane = drmModeGetPlane(ctx->hwctx->fd, ctx->plane_id);
294 av_log(avctx, AV_LOG_ERROR, "Failed to get plane "
295 "%"PRIu32": %s.\n", ctx->plane_id, strerror(err));
300 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" no longer has "
301 "an associated framebuffer.\n", ctx->plane_id);
306 desc = av_mallocz(sizeof(*desc));
308 err = AVERROR(ENOMEM);
312 #if HAVE_LIBDRM_GETFB2
313 if (ctx->fb2_available)
314 err = kmsgrab_get_fb2(avctx, plane, desc);
317 err = kmsgrab_get_fb(avctx, plane, desc);
321 frame = av_frame_alloc();
323 err = AVERROR(ENOMEM);
327 frame->hw_frames_ctx = av_buffer_ref(ctx->frames_ref);
328 if (!frame->hw_frames_ctx) {
329 err = AVERROR(ENOMEM);
333 frame->buf[0] = av_buffer_create((uint8_t*)desc, sizeof(*desc),
334 &kmsgrab_free_desc, avctx, 0);
335 if (!frame->buf[0]) {
336 err = AVERROR(ENOMEM);
340 frame->data[0] = (uint8_t*)desc;
341 frame->format = AV_PIX_FMT_DRM_PRIME;
342 frame->width = ctx->width;
343 frame->height = ctx->height;
345 drmModeFreePlane(plane);
349 pkt->buf = av_buffer_create((uint8_t*)frame, sizeof(*frame),
350 &kmsgrab_free_frame, avctx, 0);
352 err = AVERROR(ENOMEM);
356 pkt->data = (uint8_t*)frame;
357 pkt->size = sizeof(*frame);
359 pkt->flags |= AV_PKT_FLAG_TRUSTED;
364 drmModeFreePlane(plane);
366 av_frame_free(&frame);
370 static const struct {
371 enum AVPixelFormat pixfmt;
373 } kmsgrab_formats[] = {
376 { AV_PIX_FMT_GRAY8, DRM_FORMAT_R8 },
378 #ifdef DRM_FORMAT_R16
379 { AV_PIX_FMT_GRAY16LE, DRM_FORMAT_R16 },
380 { AV_PIX_FMT_GRAY16BE, DRM_FORMAT_R16 | DRM_FORMAT_BIG_ENDIAN },
383 { AV_PIX_FMT_BGR8, DRM_FORMAT_BGR233 },
384 { AV_PIX_FMT_RGB555LE, DRM_FORMAT_XRGB1555 },
385 { AV_PIX_FMT_RGB555BE, DRM_FORMAT_XRGB1555 | DRM_FORMAT_BIG_ENDIAN },
386 { AV_PIX_FMT_BGR555LE, DRM_FORMAT_XBGR1555 },
387 { AV_PIX_FMT_BGR555BE, DRM_FORMAT_XBGR1555 | DRM_FORMAT_BIG_ENDIAN },
388 { AV_PIX_FMT_RGB565LE, DRM_FORMAT_RGB565 },
389 { AV_PIX_FMT_RGB565BE, DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN },
390 { AV_PIX_FMT_BGR565LE, DRM_FORMAT_BGR565 },
391 { AV_PIX_FMT_BGR565BE, DRM_FORMAT_BGR565 | DRM_FORMAT_BIG_ENDIAN },
393 { AV_PIX_FMT_RGB24, DRM_FORMAT_RGB888 },
394 { AV_PIX_FMT_BGR24, DRM_FORMAT_BGR888 },
395 { AV_PIX_FMT_0RGB, DRM_FORMAT_BGRX8888 },
396 { AV_PIX_FMT_0BGR, DRM_FORMAT_RGBX8888 },
397 { AV_PIX_FMT_RGB0, DRM_FORMAT_XBGR8888 },
398 { AV_PIX_FMT_BGR0, DRM_FORMAT_XRGB8888 },
399 { AV_PIX_FMT_ARGB, DRM_FORMAT_BGRA8888 },
400 { AV_PIX_FMT_ABGR, DRM_FORMAT_RGBA8888 },
401 { AV_PIX_FMT_RGBA, DRM_FORMAT_ABGR8888 },
402 { AV_PIX_FMT_BGRA, DRM_FORMAT_ARGB8888 },
404 { AV_PIX_FMT_X2RGB10LE, DRM_FORMAT_XRGB2101010 },
405 { AV_PIX_FMT_X2RGB10BE, DRM_FORMAT_XRGB2101010 | DRM_FORMAT_BIG_ENDIAN },
407 { AV_PIX_FMT_NV12, DRM_FORMAT_NV12 },
409 { AV_PIX_FMT_YUYV422, DRM_FORMAT_YUYV },
410 { AV_PIX_FMT_YVYU422, DRM_FORMAT_YVYU },
411 { AV_PIX_FMT_UYVY422, DRM_FORMAT_UYVY },
414 static av_cold int kmsgrab_read_header(AVFormatContext *avctx)
416 KMSGrabContext *ctx = avctx->priv_data;
417 drmModePlaneRes *plane_res = NULL;
418 drmModePlane *plane = NULL;
419 drmModeFB *fb = NULL;
420 #if HAVE_LIBDRM_GETFB2
421 drmModeFB2 *fb2 = NULL;
426 err = av_hwdevice_ctx_create(&ctx->device_ref, AV_HWDEVICE_TYPE_DRM,
427 ctx->device_path, NULL, 0);
429 av_log(avctx, AV_LOG_ERROR, "Failed to open DRM device.\n");
432 ctx->device = (AVHWDeviceContext*) ctx->device_ref->data;
433 ctx->hwctx = (AVDRMDeviceContext*)ctx->device->hwctx;
435 err = drmSetClientCap(ctx->hwctx->fd,
436 DRM_CLIENT_CAP_UNIVERSAL_PLANES, 1);
438 av_log(avctx, AV_LOG_WARNING, "Failed to set universal planes "
439 "capability: primary planes will not be usable.\n");
442 if (ctx->source_plane > 0) {
443 plane = drmModeGetPlane(ctx->hwctx->fd, ctx->source_plane);
446 av_log(avctx, AV_LOG_ERROR, "Failed to get plane %"PRId64": "
447 "%s.\n", ctx->source_plane, strerror(err));
452 if (plane->fb_id == 0) {
453 av_log(avctx, AV_LOG_ERROR, "Plane %"PRId64" does not have "
454 "an attached framebuffer.\n", ctx->source_plane);
455 err = AVERROR(EINVAL);
459 plane_res = drmModeGetPlaneResources(ctx->hwctx->fd);
462 av_log(avctx, AV_LOG_ERROR, "Failed to get plane "
463 "resources: %s.\n", strerror(err));
468 for (i = 0; i < plane_res->count_planes; i++) {
469 plane = drmModeGetPlane(ctx->hwctx->fd,
470 plane_res->planes[i]);
473 av_log(avctx, AV_LOG_VERBOSE, "Failed to get "
474 "plane %"PRIu32": %s.\n",
475 plane_res->planes[i], strerror(err));
479 av_log(avctx, AV_LOG_DEBUG, "Plane %"PRIu32": "
480 "CRTC %"PRIu32" FB %"PRIu32".\n",
481 plane->plane_id, plane->crtc_id, plane->fb_id);
483 if ((ctx->source_crtc > 0 &&
484 plane->crtc_id != ctx->source_crtc) ||
486 // Either not connected to the target source CRTC
488 drmModeFreePlane(plane);
496 if (i == plane_res->count_planes) {
497 if (ctx->source_crtc > 0) {
498 av_log(avctx, AV_LOG_ERROR, "No usable planes found on "
499 "CRTC %"PRId64".\n", ctx->source_crtc);
501 av_log(avctx, AV_LOG_ERROR, "No usable planes found.\n");
503 err = AVERROR(EINVAL);
507 av_log(avctx, AV_LOG_INFO, "Using plane %"PRIu32" to "
508 "locate framebuffers.\n", plane->plane_id);
511 ctx->plane_id = plane->plane_id;
513 #if HAVE_LIBDRM_GETFB2
514 fb2 = drmModeGetFB2(ctx->hwctx->fd, plane->fb_id);
515 if (!fb2 && errno == ENOSYS) {
516 av_log(avctx, AV_LOG_INFO, "GETFB2 not supported, "
517 "will try to use GETFB instead.\n");
520 av_log(avctx, AV_LOG_ERROR, "Failed to get "
521 "framebuffer %"PRIu32": %s.\n",
522 plane->fb_id, strerror(err));
526 av_log(avctx, AV_LOG_INFO, "Template framebuffer is "
527 "%"PRIu32": %"PRIu32"x%"PRIu32" "
528 "format %"PRIx32" modifier %"PRIx64" flags %"PRIx32".\n",
529 fb2->fb_id, fb2->width, fb2->height,
530 fb2->pixel_format, fb2->modifier, fb2->flags);
532 ctx->width = fb2->width;
533 ctx->height = fb2->height;
535 if (!fb2->handles[0]) {
536 av_log(avctx, AV_LOG_ERROR, "No handle set on framebuffer: "
537 "maybe you need some additional capabilities?\n");
538 err = AVERROR(EINVAL);
542 for (i = 0; i < FF_ARRAY_ELEMS(kmsgrab_formats); i++) {
543 if (kmsgrab_formats[i].drm_format == fb2->pixel_format) {
544 if (ctx->format != AV_PIX_FMT_NONE &&
545 ctx->format != kmsgrab_formats[i].pixfmt) {
546 av_log(avctx, AV_LOG_ERROR, "Framebuffer pixel format "
547 "%"PRIx32" does not match expected format.\n",
549 err = AVERROR(EINVAL);
552 ctx->drm_format = fb2->pixel_format;
553 ctx->format = kmsgrab_formats[i].pixfmt;
557 if (i == FF_ARRAY_ELEMS(kmsgrab_formats)) {
558 av_log(avctx, AV_LOG_ERROR, "Framebuffer pixel format "
559 "%"PRIx32" is not a known supported format.\n",
561 err = AVERROR(EINVAL);
565 if (fb2->flags & DRM_MODE_FB_MODIFIERS) {
566 if (ctx->drm_format_modifier != DRM_FORMAT_MOD_INVALID &&
567 ctx->drm_format_modifier != fb2->modifier) {
568 av_log(avctx, AV_LOG_ERROR, "Framebuffer format modifier "
569 "%"PRIx64" does not match expected modifier.\n",
571 err = AVERROR(EINVAL);
574 ctx->drm_format_modifier = fb2->modifier;
577 av_log(avctx, AV_LOG_VERBOSE, "Format is %s, from "
578 "DRM format %"PRIx32" modifier %"PRIx64".\n",
579 av_get_pix_fmt_name(ctx->format),
580 ctx->drm_format, ctx->drm_format_modifier);
582 ctx->fb2_available = 1;
586 if (!ctx->fb2_available) {
587 if (ctx->format == AV_PIX_FMT_NONE) {
588 // Backward compatibility: assume BGR0 if no format supplied.
589 ctx->format = AV_PIX_FMT_BGR0;
591 for (i = 0; i < FF_ARRAY_ELEMS(kmsgrab_formats); i++) {
592 if (kmsgrab_formats[i].pixfmt == ctx->format) {
593 ctx->drm_format = kmsgrab_formats[i].drm_format;
597 if (i >= FF_ARRAY_ELEMS(kmsgrab_formats)) {
598 av_log(avctx, AV_LOG_ERROR, "Unsupported format %s.\n",
599 av_get_pix_fmt_name(ctx->format));
600 return AVERROR(EINVAL);
603 fb = drmModeGetFB(ctx->hwctx->fd, plane->fb_id);
606 av_log(avctx, AV_LOG_ERROR, "Failed to get "
607 "framebuffer %"PRIu32": %s.\n",
608 plane->fb_id, strerror(err));
613 av_log(avctx, AV_LOG_INFO, "Template framebuffer is %"PRIu32": "
614 "%"PRIu32"x%"PRIu32" %"PRIu32"bpp %"PRIu32"b depth.\n",
615 fb->fb_id, fb->width, fb->height, fb->bpp, fb->depth);
617 ctx->width = fb->width;
618 ctx->height = fb->height;
621 av_log(avctx, AV_LOG_ERROR, "No handle set on framebuffer: "
622 "maybe you need some additional capabilities?\n");
623 err = AVERROR(EINVAL);
628 stream = avformat_new_stream(avctx, NULL);
630 err = AVERROR(ENOMEM);
634 stream->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
635 stream->codecpar->codec_id = AV_CODEC_ID_WRAPPED_AVFRAME;
636 stream->codecpar->width = ctx->width;
637 stream->codecpar->height = ctx->height;
638 stream->codecpar->format = AV_PIX_FMT_DRM_PRIME;
640 avpriv_set_pts_info(stream, 64, 1, 1000000);
642 ctx->frames_ref = av_hwframe_ctx_alloc(ctx->device_ref);
643 if (!ctx->frames_ref) {
644 err = AVERROR(ENOMEM);
647 ctx->frames = (AVHWFramesContext*)ctx->frames_ref->data;
649 ctx->frames->format = AV_PIX_FMT_DRM_PRIME;
650 ctx->frames->sw_format = ctx->format,
651 ctx->frames->width = ctx->width;
652 ctx->frames->height = ctx->height;
654 err = av_hwframe_ctx_init(ctx->frames_ref);
656 av_log(avctx, AV_LOG_ERROR, "Failed to initialise "
657 "hardware frames context: %d.\n", err);
661 ctx->frame_delay = av_rescale_q(1, (AVRational) { ctx->framerate.den,
662 ctx->framerate.num }, AV_TIME_BASE_Q);
666 drmModeFreePlaneResources(plane_res);
667 drmModeFreePlane(plane);
669 #if HAVE_LIBDRM_GETFB2
675 static av_cold int kmsgrab_read_close(AVFormatContext *avctx)
677 KMSGrabContext *ctx = avctx->priv_data;
679 av_buffer_unref(&ctx->frames_ref);
680 av_buffer_unref(&ctx->device_ref);
685 #define OFFSET(x) offsetof(KMSGrabContext, x)
686 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
687 static const AVOption options[] = {
688 { "device", "DRM device path",
689 OFFSET(device_path), AV_OPT_TYPE_STRING,
690 { .str = "/dev/dri/card0" }, 0, 0, FLAGS },
691 { "format", "Pixel format for framebuffer",
692 OFFSET(format), AV_OPT_TYPE_PIXEL_FMT,
693 { .i64 = AV_PIX_FMT_NONE }, -1, INT32_MAX, FLAGS },
694 { "format_modifier", "DRM format modifier for framebuffer",
695 OFFSET(drm_format_modifier), AV_OPT_TYPE_INT64,
696 { .i64 = DRM_FORMAT_MOD_INVALID }, 0, INT64_MAX, FLAGS },
697 { "crtc_id", "CRTC ID to define capture source",
698 OFFSET(source_crtc), AV_OPT_TYPE_INT64,
699 { .i64 = 0 }, 0, UINT32_MAX, FLAGS },
700 { "plane_id", "Plane ID to define capture source",
701 OFFSET(source_plane), AV_OPT_TYPE_INT64,
702 { .i64 = 0 }, 0, UINT32_MAX, FLAGS },
703 { "framerate", "Framerate to capture at",
704 OFFSET(framerate), AV_OPT_TYPE_RATIONAL,
705 { .dbl = 30.0 }, 0, 1000, FLAGS },
709 static const AVClass kmsgrab_class = {
710 .class_name = "kmsgrab indev",
711 .item_name = av_default_item_name,
713 .version = LIBAVUTIL_VERSION_INT,
714 .category = AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT,
717 AVInputFormat ff_kmsgrab_demuxer = {
719 .long_name = NULL_IF_CONFIG_SMALL("KMS screen capture"),
720 .priv_data_size = sizeof(KMSGrabContext),
721 .read_header = &kmsgrab_read_header,
722 .read_packet = &kmsgrab_read_packet,
723 .read_close = &kmsgrab_read_close,
724 .flags = AVFMT_NOFILE,
725 .priv_class = &kmsgrab_class,