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;
164 fb = drmModeGetFB2(ctx->hwctx->fd, plane->fb_id);
167 av_log(avctx, AV_LOG_ERROR, "Failed to get framebuffer "
168 "%"PRIu32": %s.\n", plane->fb_id, strerror(err));
171 if (fb->pixel_format != ctx->drm_format) {
172 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" framebuffer "
173 "format changed: now %"PRIx32".\n",
174 ctx->plane_id, fb->pixel_format);
178 if (fb->modifier != ctx->drm_format_modifier) {
179 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" framebuffer "
180 "format modifier changed: now %"PRIx64".\n",
181 ctx->plane_id, fb->modifier);
185 if (fb->width != ctx->width || fb->height != ctx->height) {
186 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" framebuffer "
187 "dimensions changed: now %"PRIu32"x%"PRIu32".\n",
188 ctx->plane_id, fb->width, fb->height);
192 if (!fb->handles[0]) {
193 av_log(avctx, AV_LOG_ERROR, "No handle set on framebuffer.\n");
198 *desc = (AVDRMFrameDescriptor) {
201 .format = ctx->drm_format,
206 for (i = 0; i < 4 && fb->handles[i]; i++) {
210 size = fb->offsets[i] + fb->height * fb->pitches[i];
212 for (j = 0; j < i; j++) {
213 if (fb->handles[i] == fb->handles[j]) {
219 obj = desc->layers[0].planes[j].object_index;
221 if (desc->objects[j].size < size)
222 desc->objects[j].size = size;
224 desc->layers[0].planes[i] = (AVDRMPlaneDescriptor) {
226 .offset = fb->offsets[i],
227 .pitch = fb->pitches[i],
232 err = drmPrimeHandleToFD(ctx->hwctx->fd, fb->handles[i],
236 av_log(avctx, AV_LOG_ERROR, "Failed to get PRIME fd from "
237 "framebuffer handle: %s.\n", strerror(err));
243 desc->objects[obj] = (AVDRMObjectDescriptor) {
246 .format_modifier = fb->modifier,
248 desc->layers[0].planes[i] = (AVDRMPlaneDescriptor) {
250 .offset = fb->offsets[i],
251 .pitch = fb->pitches[i],
255 desc->nb_objects = nb_objects;
256 desc->layers[0].nb_planes = i;
265 static int kmsgrab_read_packet(AVFormatContext *avctx, AVPacket *pkt)
267 KMSGrabContext *ctx = avctx->priv_data;
268 drmModePlane *plane = NULL;
269 AVDRMFrameDescriptor *desc = NULL;
270 AVFrame *frame = NULL;
275 if (ctx->frame_last) {
278 delay = ctx->frame_last + ctx->frame_delay - now;
285 ctx->frame_last = now;
287 plane = drmModeGetPlane(ctx->hwctx->fd, ctx->plane_id);
290 av_log(avctx, AV_LOG_ERROR, "Failed to get plane "
291 "%"PRIu32": %s.\n", ctx->plane_id, strerror(err));
296 av_log(avctx, AV_LOG_ERROR, "Plane %"PRIu32" no longer has "
297 "an associated framebuffer.\n", ctx->plane_id);
302 desc = av_mallocz(sizeof(*desc));
304 err = AVERROR(ENOMEM);
308 #if HAVE_LIBDRM_GETFB2
309 if (ctx->fb2_available)
310 err = kmsgrab_get_fb2(avctx, plane, desc);
313 err = kmsgrab_get_fb(avctx, plane, desc);
317 frame = av_frame_alloc();
319 err = AVERROR(ENOMEM);
323 frame->hw_frames_ctx = av_buffer_ref(ctx->frames_ref);
324 if (!frame->hw_frames_ctx) {
325 err = AVERROR(ENOMEM);
329 frame->buf[0] = av_buffer_create((uint8_t*)desc, sizeof(*desc),
330 &kmsgrab_free_desc, avctx, 0);
331 if (!frame->buf[0]) {
332 err = AVERROR(ENOMEM);
336 frame->data[0] = (uint8_t*)desc;
337 frame->format = AV_PIX_FMT_DRM_PRIME;
338 frame->width = ctx->width;
339 frame->height = ctx->height;
341 drmModeFreePlane(plane);
345 pkt->buf = av_buffer_create((uint8_t*)frame, sizeof(*frame),
346 &kmsgrab_free_frame, avctx, 0);
348 err = AVERROR(ENOMEM);
352 pkt->data = (uint8_t*)frame;
353 pkt->size = sizeof(*frame);
355 pkt->flags |= AV_PKT_FLAG_TRUSTED;
360 drmModeFreePlane(plane);
362 av_frame_free(&frame);
366 static const struct {
367 enum AVPixelFormat pixfmt;
369 } kmsgrab_formats[] = {
372 { AV_PIX_FMT_GRAY8, DRM_FORMAT_R8 },
374 #ifdef DRM_FORMAT_R16
375 { AV_PIX_FMT_GRAY16LE, DRM_FORMAT_R16 },
376 { AV_PIX_FMT_GRAY16BE, DRM_FORMAT_R16 | DRM_FORMAT_BIG_ENDIAN },
379 { AV_PIX_FMT_BGR8, DRM_FORMAT_BGR233 },
380 { AV_PIX_FMT_RGB555LE, DRM_FORMAT_XRGB1555 },
381 { AV_PIX_FMT_RGB555BE, DRM_FORMAT_XRGB1555 | DRM_FORMAT_BIG_ENDIAN },
382 { AV_PIX_FMT_BGR555LE, DRM_FORMAT_XBGR1555 },
383 { AV_PIX_FMT_BGR555BE, DRM_FORMAT_XBGR1555 | DRM_FORMAT_BIG_ENDIAN },
384 { AV_PIX_FMT_RGB565LE, DRM_FORMAT_RGB565 },
385 { AV_PIX_FMT_RGB565BE, DRM_FORMAT_RGB565 | DRM_FORMAT_BIG_ENDIAN },
386 { AV_PIX_FMT_BGR565LE, DRM_FORMAT_BGR565 },
387 { AV_PIX_FMT_BGR565BE, DRM_FORMAT_BGR565 | DRM_FORMAT_BIG_ENDIAN },
389 { AV_PIX_FMT_RGB24, DRM_FORMAT_RGB888 },
390 { AV_PIX_FMT_BGR24, DRM_FORMAT_BGR888 },
391 { AV_PIX_FMT_0RGB, DRM_FORMAT_BGRX8888 },
392 { AV_PIX_FMT_0BGR, DRM_FORMAT_RGBX8888 },
393 { AV_PIX_FMT_RGB0, DRM_FORMAT_XBGR8888 },
394 { AV_PIX_FMT_BGR0, DRM_FORMAT_XRGB8888 },
395 { AV_PIX_FMT_ARGB, DRM_FORMAT_BGRA8888 },
396 { AV_PIX_FMT_ABGR, DRM_FORMAT_RGBA8888 },
397 { AV_PIX_FMT_RGBA, DRM_FORMAT_ABGR8888 },
398 { AV_PIX_FMT_BGRA, DRM_FORMAT_ARGB8888 },
400 { AV_PIX_FMT_X2RGB10LE, DRM_FORMAT_XRGB2101010 },
401 { AV_PIX_FMT_X2RGB10BE, DRM_FORMAT_XRGB2101010 | DRM_FORMAT_BIG_ENDIAN },
403 { AV_PIX_FMT_NV12, DRM_FORMAT_NV12 },
405 { AV_PIX_FMT_YUYV422, DRM_FORMAT_YUYV },
406 { AV_PIX_FMT_YVYU422, DRM_FORMAT_YVYU },
407 { AV_PIX_FMT_UYVY422, DRM_FORMAT_UYVY },
410 static av_cold int kmsgrab_read_header(AVFormatContext *avctx)
412 KMSGrabContext *ctx = avctx->priv_data;
413 drmModePlaneRes *plane_res = NULL;
414 drmModePlane *plane = NULL;
415 drmModeFB *fb = NULL;
416 #if HAVE_LIBDRM_GETFB2
417 drmModeFB2 *fb2 = NULL;
422 err = av_hwdevice_ctx_create(&ctx->device_ref, AV_HWDEVICE_TYPE_DRM,
423 ctx->device_path, NULL, 0);
425 av_log(avctx, AV_LOG_ERROR, "Failed to open DRM device.\n");
428 ctx->device = (AVHWDeviceContext*) ctx->device_ref->data;
429 ctx->hwctx = (AVDRMDeviceContext*)ctx->device->hwctx;
431 err = drmSetClientCap(ctx->hwctx->fd,
432 DRM_CLIENT_CAP_UNIVERSAL_PLANES, 1);
434 av_log(avctx, AV_LOG_WARNING, "Failed to set universal planes "
435 "capability: primary planes will not be usable.\n");
438 if (ctx->source_plane > 0) {
439 plane = drmModeGetPlane(ctx->hwctx->fd, ctx->source_plane);
442 av_log(avctx, AV_LOG_ERROR, "Failed to get plane %"PRId64": "
443 "%s.\n", ctx->source_plane, strerror(err));
448 if (plane->fb_id == 0) {
449 av_log(avctx, AV_LOG_ERROR, "Plane %"PRId64" does not have "
450 "an attached framebuffer.\n", ctx->source_plane);
451 err = AVERROR(EINVAL);
455 plane_res = drmModeGetPlaneResources(ctx->hwctx->fd);
458 av_log(avctx, AV_LOG_ERROR, "Failed to get plane "
459 "resources: %s.\n", strerror(err));
464 for (i = 0; i < plane_res->count_planes; i++) {
465 plane = drmModeGetPlane(ctx->hwctx->fd,
466 plane_res->planes[i]);
469 av_log(avctx, AV_LOG_VERBOSE, "Failed to get "
470 "plane %"PRIu32": %s.\n",
471 plane_res->planes[i], strerror(err));
475 av_log(avctx, AV_LOG_DEBUG, "Plane %"PRIu32": "
476 "CRTC %"PRIu32" FB %"PRIu32".\n",
477 plane->plane_id, plane->crtc_id, plane->fb_id);
479 if ((ctx->source_crtc > 0 &&
480 plane->crtc_id != ctx->source_crtc) ||
482 // Either not connected to the target source CRTC
484 drmModeFreePlane(plane);
492 if (i == plane_res->count_planes) {
493 if (ctx->source_crtc > 0) {
494 av_log(avctx, AV_LOG_ERROR, "No usable planes found on "
495 "CRTC %"PRId64".\n", ctx->source_crtc);
497 av_log(avctx, AV_LOG_ERROR, "No usable planes found.\n");
499 err = AVERROR(EINVAL);
503 av_log(avctx, AV_LOG_INFO, "Using plane %"PRIu32" to "
504 "locate framebuffers.\n", plane->plane_id);
507 ctx->plane_id = plane->plane_id;
509 #if HAVE_LIBDRM_GETFB2
510 fb2 = drmModeGetFB2(ctx->hwctx->fd, plane->fb_id);
511 if (!fb2 && errno == ENOSYS) {
512 av_log(avctx, AV_LOG_INFO, "GETFB2 not supported, "
513 "will try to use GETFB instead.\n");
516 av_log(avctx, AV_LOG_ERROR, "Failed to get "
517 "framebuffer %"PRIu32": %s.\n",
518 plane->fb_id, strerror(err));
522 av_log(avctx, AV_LOG_INFO, "Template framebuffer is "
523 "%"PRIu32": %"PRIu32"x%"PRIu32" "
524 "format %"PRIx32" modifier %"PRIx64" flags %"PRIx32".\n",
525 fb2->fb_id, fb2->width, fb2->height,
526 fb2->pixel_format, fb2->modifier, fb2->flags);
528 ctx->width = fb2->width;
529 ctx->height = fb2->height;
531 if (!fb2->handles[0]) {
532 av_log(avctx, AV_LOG_ERROR, "No handle set on framebuffer: "
533 "maybe you need some additional capabilities?\n");
534 err = AVERROR(EINVAL);
538 for (i = 0; i < FF_ARRAY_ELEMS(kmsgrab_formats); i++) {
539 if (kmsgrab_formats[i].drm_format == fb2->pixel_format) {
540 if (ctx->format != AV_PIX_FMT_NONE &&
541 ctx->format != kmsgrab_formats[i].pixfmt) {
542 av_log(avctx, AV_LOG_ERROR, "Framebuffer pixel format "
543 "%"PRIx32" does not match expected format.\n",
545 err = AVERROR(EINVAL);
548 ctx->drm_format = fb2->pixel_format;
549 ctx->format = kmsgrab_formats[i].pixfmt;
553 if (i == FF_ARRAY_ELEMS(kmsgrab_formats)) {
554 av_log(avctx, AV_LOG_ERROR, "Framebuffer pixel format "
555 "%"PRIx32" is not a known supported format.\n",
557 err = AVERROR(EINVAL);
560 if (ctx->drm_format_modifier != DRM_FORMAT_MOD_INVALID &&
561 ctx->drm_format_modifier != fb2->modifier) {
562 av_log(avctx, AV_LOG_ERROR, "Framebuffer format modifier "
563 "%"PRIx64" does not match expected modifier.\n",
565 err = AVERROR(EINVAL);
568 ctx->drm_format_modifier = fb2->modifier;
570 av_log(avctx, AV_LOG_VERBOSE, "Format is %s, from "
571 "DRM format %"PRIx32" modifier %"PRIx64".\n",
572 av_get_pix_fmt_name(ctx->format),
573 ctx->drm_format, ctx->drm_format_modifier);
575 ctx->fb2_available = 1;
579 if (!ctx->fb2_available) {
580 if (ctx->format == AV_PIX_FMT_NONE) {
581 // Backward compatibility: assume BGR0 if no format supplied.
582 ctx->format = AV_PIX_FMT_BGR0;
584 for (i = 0; i < FF_ARRAY_ELEMS(kmsgrab_formats); i++) {
585 if (kmsgrab_formats[i].pixfmt == ctx->format) {
586 ctx->drm_format = kmsgrab_formats[i].drm_format;
590 if (i >= FF_ARRAY_ELEMS(kmsgrab_formats)) {
591 av_log(avctx, AV_LOG_ERROR, "Unsupported format %s.\n",
592 av_get_pix_fmt_name(ctx->format));
593 return AVERROR(EINVAL);
596 fb = drmModeGetFB(ctx->hwctx->fd, plane->fb_id);
599 av_log(avctx, AV_LOG_ERROR, "Failed to get "
600 "framebuffer %"PRIu32": %s.\n",
601 plane->fb_id, strerror(err));
606 av_log(avctx, AV_LOG_INFO, "Template framebuffer is %"PRIu32": "
607 "%"PRIu32"x%"PRIu32" %"PRIu32"bpp %"PRIu32"b depth.\n",
608 fb->fb_id, fb->width, fb->height, fb->bpp, fb->depth);
610 ctx->width = fb->width;
611 ctx->height = fb->height;
614 av_log(avctx, AV_LOG_ERROR, "No handle set on framebuffer: "
615 "maybe you need some additional capabilities?\n");
616 err = AVERROR(EINVAL);
621 stream = avformat_new_stream(avctx, NULL);
623 err = AVERROR(ENOMEM);
627 stream->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
628 stream->codecpar->codec_id = AV_CODEC_ID_WRAPPED_AVFRAME;
629 stream->codecpar->width = ctx->width;
630 stream->codecpar->height = ctx->height;
631 stream->codecpar->format = AV_PIX_FMT_DRM_PRIME;
633 avpriv_set_pts_info(stream, 64, 1, 1000000);
635 ctx->frames_ref = av_hwframe_ctx_alloc(ctx->device_ref);
636 if (!ctx->frames_ref) {
637 err = AVERROR(ENOMEM);
640 ctx->frames = (AVHWFramesContext*)ctx->frames_ref->data;
642 ctx->frames->format = AV_PIX_FMT_DRM_PRIME;
643 ctx->frames->sw_format = ctx->format,
644 ctx->frames->width = ctx->width;
645 ctx->frames->height = ctx->height;
647 err = av_hwframe_ctx_init(ctx->frames_ref);
649 av_log(avctx, AV_LOG_ERROR, "Failed to initialise "
650 "hardware frames context: %d.\n", err);
654 ctx->frame_delay = av_rescale_q(1, (AVRational) { ctx->framerate.den,
655 ctx->framerate.num }, AV_TIME_BASE_Q);
659 drmModeFreePlaneResources(plane_res);
660 drmModeFreePlane(plane);
662 #if HAVE_LIBDRM_GETFB2
668 static av_cold int kmsgrab_read_close(AVFormatContext *avctx)
670 KMSGrabContext *ctx = avctx->priv_data;
672 av_buffer_unref(&ctx->frames_ref);
673 av_buffer_unref(&ctx->device_ref);
678 #define OFFSET(x) offsetof(KMSGrabContext, x)
679 #define FLAGS AV_OPT_FLAG_DECODING_PARAM
680 static const AVOption options[] = {
681 { "device", "DRM device path",
682 OFFSET(device_path), AV_OPT_TYPE_STRING,
683 { .str = "/dev/dri/card0" }, 0, 0, FLAGS },
684 { "format", "Pixel format for framebuffer",
685 OFFSET(format), AV_OPT_TYPE_PIXEL_FMT,
686 { .i64 = AV_PIX_FMT_NONE }, -1, INT32_MAX, FLAGS },
687 { "format_modifier", "DRM format modifier for framebuffer",
688 OFFSET(drm_format_modifier), AV_OPT_TYPE_INT64,
689 { .i64 = DRM_FORMAT_MOD_INVALID }, 0, INT64_MAX, FLAGS },
690 { "crtc_id", "CRTC ID to define capture source",
691 OFFSET(source_crtc), AV_OPT_TYPE_INT64,
692 { .i64 = 0 }, 0, UINT32_MAX, FLAGS },
693 { "plane_id", "Plane ID to define capture source",
694 OFFSET(source_plane), AV_OPT_TYPE_INT64,
695 { .i64 = 0 }, 0, UINT32_MAX, FLAGS },
696 { "framerate", "Framerate to capture at",
697 OFFSET(framerate), AV_OPT_TYPE_RATIONAL,
698 { .dbl = 30.0 }, 0, 1000, FLAGS },
702 static const AVClass kmsgrab_class = {
703 .class_name = "kmsgrab indev",
704 .item_name = av_default_item_name,
706 .version = LIBAVUTIL_VERSION_INT,
707 .category = AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT,
710 AVInputFormat ff_kmsgrab_demuxer = {
712 .long_name = NULL_IF_CONFIG_SMALL("KMS screen capture"),
713 .priv_data_size = sizeof(KMSGrabContext),
714 .read_header = &kmsgrab_read_header,
715 .read_packet = &kmsgrab_read_packet,
716 .read_close = &kmsgrab_read_close,
717 .flags = AVFMT_NOFILE,
718 .priv_class = &kmsgrab_class,