FFmpeg
hwcontext_drm.c
Go to the documentation of this file.
1 /*
2  * This file is part of FFmpeg.
3  *
4  * FFmpeg is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * FFmpeg is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with FFmpeg; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18 
19 #include "config.h"
20 
21 #include <fcntl.h>
22 #include <sys/mman.h>
23 #include <unistd.h>
24 
25 /* This was introduced in version 4.6. And may not exist all without an
26  * optional package. So to prevent a hard dependency on needing the Linux
27  * kernel headers to compile, make this optional. */
28 #if HAVE_LINUX_DMA_BUF_H
29 #include <linux/dma-buf.h>
30 #include <sys/ioctl.h>
31 #endif
32 
33 #include <drm.h>
34 #include <xf86drm.h>
35 
36 #include "avassert.h"
37 #include "hwcontext.h"
38 #include "hwcontext_drm.h"
39 #include "hwcontext_internal.h"
40 #include "imgutils.h"
41 
42 
44 {
45  AVDRMDeviceContext *hwctx = hwdev->hwctx;
46 
47  close(hwctx->fd);
48 }
49 
50 static int drm_device_create(AVHWDeviceContext *hwdev, const char *device,
51  AVDictionary *opts, int flags)
52 {
53  AVDRMDeviceContext *hwctx = hwdev->hwctx;
54  drmVersionPtr version;
55 
56  hwctx->fd = open(device, O_RDWR);
57  if (hwctx->fd < 0)
58  return AVERROR(errno);
59 
60  version = drmGetVersion(hwctx->fd);
61  if (!version) {
62  av_log(hwdev, AV_LOG_ERROR, "Failed to get version information "
63  "from %s: probably not a DRM device?\n", device);
64  close(hwctx->fd);
65  return AVERROR(EINVAL);
66  }
67 
68  av_log(hwdev, AV_LOG_VERBOSE, "Opened DRM device %s: driver %s "
69  "version %d.%d.%d.\n", device, version->name,
70  version->version_major, version->version_minor,
71  version->version_patchlevel);
72 
73  drmFreeVersion(version);
74 
75  hwdev->free = &drm_device_free;
76 
77  return 0;
78 }
79 
81 {
82  frame->buf[0] = av_buffer_pool_get(hwfc->pool);
83  if (!frame->buf[0])
84  return AVERROR(ENOMEM);
85 
86  frame->data[0] = (uint8_t*)frame->buf[0]->data;
87 
88  frame->format = AV_PIX_FMT_DRM_PRIME;
89  frame->width = hwfc->width;
90  frame->height = hwfc->height;
91 
92  return 0;
93 }
94 
95 typedef struct DRMMapping {
96  // Address and length of each mmap()ed region.
99  int object[AV_DRM_MAX_PLANES];
102 } DRMMapping;
103 
105  HWMapDescriptor *hwmap)
106 {
107  DRMMapping *map = hwmap->priv;
108 
109  for (int i = 0; i < map->nb_regions; i++) {
110 #if HAVE_LINUX_DMA_BUF_H
111  struct dma_buf_sync sync = { .flags = DMA_BUF_SYNC_END | map->sync_flags };
112  ioctl(map->object[i], DMA_BUF_IOCTL_SYNC, &sync);
113 #endif
114  munmap(map->address[i], map->length[i]);
115  }
116 
117  av_free(map);
118 }
119 
121  AVFrame *dst, const AVFrame *src, int flags)
122 {
124 #if HAVE_LINUX_DMA_BUF_H
125  struct dma_buf_sync sync_start = { 0 };
126 #endif
127  DRMMapping *map;
128  int err, i, p, plane;
129  int mmap_prot;
130  void *addr;
131 
132  map = av_mallocz(sizeof(*map));
133  if (!map)
134  return AVERROR(ENOMEM);
135 
136  mmap_prot = 0;
138  mmap_prot |= PROT_READ;
140  mmap_prot |= PROT_WRITE;
141 
142 #if HAVE_LINUX_DMA_BUF_H
144  map->sync_flags |= DMA_BUF_SYNC_READ;
146  map->sync_flags |= DMA_BUF_SYNC_WRITE;
147  sync_start.flags = DMA_BUF_SYNC_START | map->sync_flags;
148 #endif
149 
150  av_assert0(desc->nb_objects <= AV_DRM_MAX_PLANES);
151  for (i = 0; i < desc->nb_objects; i++) {
152  addr = mmap(NULL, desc->objects[i].size, mmap_prot, MAP_SHARED,
153  desc->objects[i].fd, 0);
154  if (addr == MAP_FAILED) {
155  err = AVERROR(errno);
156  av_log(hwfc, AV_LOG_ERROR, "Failed to map DRM object %d to "
157  "memory: %d.\n", desc->objects[i].fd, errno);
158  goto fail;
159  }
160 
161  map->address[i] = addr;
162  map->length[i] = desc->objects[i].size;
163  map->object[i] = desc->objects[i].fd;
164 
165 #if HAVE_LINUX_DMA_BUF_H
166  /* We're not checking for errors here because the kernel may not
167  * support the ioctl, in which case its okay to carry on */
168  ioctl(desc->objects[i].fd, DMA_BUF_IOCTL_SYNC, &sync_start);
169 #endif
170  }
171  map->nb_regions = i;
172 
173  plane = 0;
174  for (i = 0; i < desc->nb_layers; i++) {
175  const AVDRMLayerDescriptor *layer = &desc->layers[i];
176  for (p = 0; p < layer->nb_planes; p++) {
177  dst->data[plane] =
178  (uint8_t*)map->address[layer->planes[p].object_index] +
179  layer->planes[p].offset;
180  dst->linesize[plane] = layer->planes[p].pitch;
181  ++plane;
182  }
183  }
184  av_assert0(plane <= AV_DRM_MAX_PLANES);
185 
186  dst->width = src->width;
187  dst->height = src->height;
188 
189  err = ff_hwframe_map_create(src->hw_frames_ctx, dst, src,
190  &drm_unmap_frame, map);
191  if (err < 0)
192  goto fail;
193 
194  return 0;
195 
196 fail:
197  for (i = 0; i < desc->nb_objects; i++) {
198  if (map->address[i])
199  munmap(map->address[i], map->length[i]);
200  }
201  av_free(map);
202  return err;
203 }
204 
207  enum AVPixelFormat **formats)
208 {
209  enum AVPixelFormat *pix_fmts;
210 
211  pix_fmts = av_malloc_array(2, sizeof(*pix_fmts));
212  if (!pix_fmts)
213  return AVERROR(ENOMEM);
214 
215  pix_fmts[0] = ctx->sw_format;
217 
218  *formats = pix_fmts;
219  return 0;
220 }
221 
223  AVFrame *dst, const AVFrame *src)
224 {
225  AVFrame *map;
226  int err;
227 
228  if (dst->width > hwfc->width || dst->height > hwfc->height)
229  return AVERROR(EINVAL);
230 
231  map = av_frame_alloc();
232  if (!map)
233  return AVERROR(ENOMEM);
234  map->format = dst->format;
235 
236  err = drm_map_frame(hwfc, map, src, AV_HWFRAME_MAP_READ);
237  if (err)
238  goto fail;
239 
240  map->width = dst->width;
241  map->height = dst->height;
242 
243  err = av_frame_copy(dst, map);
244  if (err)
245  goto fail;
246 
247  err = 0;
248 fail:
249  av_frame_free(&map);
250  return err;
251 }
252 
254  AVFrame *dst, const AVFrame *src)
255 {
256  AVFrame *map;
257  int err;
258 
259  if (src->width > hwfc->width || src->height > hwfc->height)
260  return AVERROR(EINVAL);
261 
262  map = av_frame_alloc();
263  if (!map)
264  return AVERROR(ENOMEM);
265  map->format = src->format;
266 
267  err = drm_map_frame(hwfc, map, dst, AV_HWFRAME_MAP_WRITE |
269  if (err)
270  goto fail;
271 
272  map->width = src->width;
273  map->height = src->height;
274 
275  err = av_frame_copy(map, src);
276  if (err)
277  goto fail;
278 
279  err = 0;
280 fail:
281  av_frame_free(&map);
282  return err;
283 }
284 
285 static int drm_map_from(AVHWFramesContext *hwfc, AVFrame *dst,
286  const AVFrame *src, int flags)
287 {
288  int err;
289 
290  if (hwfc->sw_format != dst->format)
291  return AVERROR(ENOSYS);
292 
293  err = drm_map_frame(hwfc, dst, src, flags);
294  if (err)
295  return err;
296 
297  err = av_frame_copy_props(dst, src);
298  if (err)
299  return err;
300 
301  return 0;
302 }
303 
306  .name = "DRM",
307 
308  .device_hwctx_size = sizeof(AVDRMDeviceContext),
309 
310  .device_create = &drm_device_create,
311 
312  .frames_get_buffer = &drm_get_buffer,
313 
314  .transfer_get_formats = &drm_transfer_get_formats,
315  .transfer_data_to = &drm_transfer_data_to,
316  .transfer_data_from = &drm_transfer_data_from,
317  .map_from = &drm_map_from,
318 
319  .pix_fmts = (const enum AVPixelFormat[]) {
322  },
323 };
formats
formats
Definition: signature.h:48
AVHWDeviceContext::hwctx
void * hwctx
The format-specific data, allocated and freed by libavutil along with this context.
Definition: hwcontext.h:92
AVPixelFormat
AVPixelFormat
Pixel format.
Definition: pixfmt.h:64
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
AV_HWFRAME_MAP_READ
@ AV_HWFRAME_MAP_READ
The mapping must be readable.
Definition: hwcontext.h:524
drm_device_create
static int drm_device_create(AVHWDeviceContext *hwdev, const char *device, AVDictionary *opts, int flags)
Definition: hwcontext_drm.c:50
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:112
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:303
AVFrame::width
int width
Definition: frame.h:361
AV_PIX_FMT_DRM_PRIME
@ AV_PIX_FMT_DRM_PRIME
DRM-managed buffers exposed through PRIME buffer sharing.
Definition: pixfmt.h:318
ff_hwcontext_type_drm
const HWContextType ff_hwcontext_type_drm
Definition: hwcontext_drm.c:304
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:196
AVDictionary
Definition: dict.c:30
ff_hwframe_map_create
int ff_hwframe_map_create(AVBufferRef *hwframe_ref, AVFrame *dst, const AVFrame *src, void(*unmap)(AVHWFramesContext *ctx, HWMapDescriptor *hwmap), void *priv)
Definition: hwcontext.c:737
HWMapDescriptor::priv
void * priv
Hardware-specific private data associated with the mapping.
Definition: hwcontext_internal.h:151
AVDRMFrameDescriptor
DRM frame descriptor.
Definition: hwcontext_drm.h:133
AVHWFramesContext::width
int width
The allocated dimensions of the frames in this pool.
Definition: hwcontext.h:229
drm_transfer_get_formats
static int drm_transfer_get_formats(AVHWFramesContext *ctx, enum AVHWFrameTransferDirection dir, enum AVPixelFormat **formats)
Definition: hwcontext_drm.c:205
drm_transfer_data_to
static int drm_transfer_data_to(AVHWFramesContext *hwfc, AVFrame *dst, const AVFrame *src)
Definition: hwcontext_drm.c:253
AVDRMDeviceContext::fd
int fd
File descriptor of DRM device.
Definition: hwcontext_drm.h:166
AVHWDeviceContext::free
void(* free)(struct AVHWDeviceContext *ctx)
This field may be set by the caller before calling av_hwdevice_ctx_init().
Definition: hwcontext.h:104
fail
#define fail()
Definition: checkasm.h:127
AVDRMLayerDescriptor::nb_planes
int nb_planes
Number of planes in the layer.
Definition: hwcontext_drm.h:106
AVDRMLayerDescriptor::planes
AVDRMPlaneDescriptor planes[AV_DRM_MAX_PLANES]
Array of planes in this layer.
Definition: hwcontext_drm.h:110
drm_device_free
static void drm_device_free(AVHWDeviceContext *hwdev)
Definition: hwcontext_drm.c:43
DRMMapping
Definition: hwcontext_drm.c:95
AVDRMPlaneDescriptor::offset
ptrdiff_t offset
Offset within that object of this plane.
Definition: hwcontext_drm.h:83
AVDRMLayerDescriptor
DRM layer descriptor.
Definition: hwcontext_drm.h:96
AVHWDeviceContext
This struct aggregates all the (hardware/vendor-specific) "high-level" state, i.e.
Definition: hwcontext.h:61
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:99
avassert.h
HWContextType::type
enum AVHWDeviceType type
Definition: hwcontext_internal.h:30
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
AVHWFramesContext::height
int height
Definition: hwcontext.h:229
av_buffer_pool_get
AVBufferRef * av_buffer_pool_get(AVBufferPool *pool)
Allocate a new AVBuffer, reusing an old buffer from the pool when available.
Definition: buffer.c:387
AVHWFramesContext::pool
AVBufferPool * pool
A pool from which the frames are allocated by av_hwframe_get_buffer().
Definition: hwcontext.h:190
av_assert0
#define av_assert0(cond)
assert() equivalent, that is always enabled.
Definition: avassert.h:37
pix_fmts
static enum AVPixelFormat pix_fmts[]
Definition: libkvazaar.c:290
ctx
AVFormatContext * ctx
Definition: movenc.c:48
drm_get_buffer
static int drm_get_buffer(AVHWFramesContext *hwfc, AVFrame *frame)
Definition: hwcontext_drm.c:80
opts
AVDictionary * opts
Definition: movenc.c:50
NULL
#define NULL
Definition: coverity.c:32
AVHWFramesContext::sw_format
enum AVPixelFormat sw_format
The pixel format identifying the actual data layout of the hardware frames.
Definition: hwcontext.h:222
av_frame_copy_props
int av_frame_copy_props(AVFrame *dst, const AVFrame *src)
Copy only "metadata" fields from src to dst.
Definition: frame.c:537
AV_HWFRAME_MAP_OVERWRITE
@ AV_HWFRAME_MAP_OVERWRITE
The mapped frame will be overwritten completely in subsequent operations, so the current frame data n...
Definition: hwcontext.h:534
src
#define src
Definition: vp8dsp.c:255
drm_map_from
static int drm_map_from(AVHWFramesContext *hwfc, AVFrame *dst, const AVFrame *src, int flags)
Definition: hwcontext_drm.c:285
drm_map_frame
static int drm_map_frame(AVHWFramesContext *hwfc, AVFrame *dst, const AVFrame *src, int flags)
Definition: hwcontext_drm.c:120
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:678
AV_HWFRAME_MAP_WRITE
@ AV_HWFRAME_MAP_WRITE
The mapping must be writeable.
Definition: hwcontext.h:528
AV_DRM_MAX_PLANES
@ AV_DRM_MAX_PLANES
The maximum number of layers/planes in a DRM frame.
Definition: hwcontext_drm.h:39
AVFrame::format
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
Definition: frame.h:376
version
version
Definition: libkvazaar.c:307
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:271
av_malloc_array
#define av_malloc_array(a, b)
Definition: tableprint_vlc.h:32
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:263
hwcontext_drm.h
AVDRMPlaneDescriptor::object_index
int object_index
Index of the object containing this plane in the objects array of the enclosing frame descriptor.
Definition: hwcontext_drm.h:79
DRMMapping::sync_flags
int sync_flags
Definition: hwcontext_drm.c:98
AVHWFrameTransferDirection
AVHWFrameTransferDirection
Definition: hwcontext.h:415
AVHWFramesContext
This struct describes a set or pool of "hardware" frames (i.e.
Definition: hwcontext.h:124
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AVFrame::height
int height
Definition: frame.h:361
drm_unmap_frame
static void drm_unmap_frame(AVHWFramesContext *hwfc, HWMapDescriptor *hwmap)
Definition: hwcontext_drm.c:104
DRMMapping::length
size_t length[AV_DRM_MAX_PLANES]
Definition: hwcontext_drm.c:101
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
DRMMapping::nb_regions
int nb_regions
Definition: hwcontext_drm.c:97
desc
const char * desc
Definition: libsvtav1.c:79
DRMMapping::address
void * address[AV_DRM_MAX_PLANES]
Definition: hwcontext_drm.c:100
hwcontext_internal.h
drm_transfer_data_from
static int drm_transfer_data_from(AVHWFramesContext *hwfc, AVFrame *dst, const AVFrame *src)
Definition: hwcontext_drm.c:222
map
const VDPAUPixFmtMap * map
Definition: hwcontext_vdpau.c:71
av_free
#define av_free(p)
Definition: tableprint_vlc.h:34
imgutils.h
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:561
hwcontext.h
AVDRMPlaneDescriptor::pitch
ptrdiff_t pitch
Pitch (linesize) of this plane.
Definition: hwcontext_drm.h:87
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:28
HWContextType
Definition: hwcontext_internal.h:29
AVDRMDeviceContext
DRM device.
Definition: hwcontext_drm.h:157
HWMapDescriptor
Definition: hwcontext_internal.h:132
AV_HWDEVICE_TYPE_DRM
@ AV_HWDEVICE_TYPE_DRM
Definition: hwcontext.h:36