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 <fcntl.h>
20 #include <sys/mman.h>
21 #include <unistd.h>
22 
23 #include <drm.h>
24 #include <xf86drm.h>
25 
26 #include "avassert.h"
27 #include "hwcontext.h"
28 #include "hwcontext_drm.h"
29 #include "hwcontext_internal.h"
30 #include "imgutils.h"
31 
32 
34 {
35  AVDRMDeviceContext *hwctx = hwdev->hwctx;
36 
37  close(hwctx->fd);
38 }
39 
40 static int drm_device_create(AVHWDeviceContext *hwdev, const char *device,
41  AVDictionary *opts, int flags)
42 {
43  AVDRMDeviceContext *hwctx = hwdev->hwctx;
44  drmVersionPtr version;
45 
46  hwctx->fd = open(device, O_RDWR);
47  if (hwctx->fd < 0)
48  return AVERROR(errno);
49 
50  version = drmGetVersion(hwctx->fd);
51  if (!version) {
52  av_log(hwdev, AV_LOG_ERROR, "Failed to get version information "
53  "from %s: probably not a DRM device?\n", device);
54  close(hwctx->fd);
55  return AVERROR(EINVAL);
56  }
57 
58  av_log(hwdev, AV_LOG_VERBOSE, "Opened DRM device %s: driver %s "
59  "version %d.%d.%d.\n", device, version->name,
60  version->version_major, version->version_minor,
61  version->version_patchlevel);
62 
63  drmFreeVersion(version);
64 
65  hwdev->free = &drm_device_free;
66 
67  return 0;
68 }
69 
71 {
72  frame->buf[0] = av_buffer_pool_get(hwfc->pool);
73  if (!frame->buf[0])
74  return AVERROR(ENOMEM);
75 
76  frame->data[0] = (uint8_t*)frame->buf[0]->data;
77 
78  frame->format = AV_PIX_FMT_DRM_PRIME;
79  frame->width = hwfc->width;
80  frame->height = hwfc->height;
81 
82  return 0;
83 }
84 
85 typedef struct DRMMapping {
86  // Address and length of each mmap()ed region.
90 } DRMMapping;
91 
93  HWMapDescriptor *hwmap)
94 {
95  DRMMapping *map = hwmap->priv;
96  int i;
97 
98  for (i = 0; i < map->nb_regions; i++)
99  munmap(map->address[i], map->length[i]);
100 
101  av_free(map);
102 }
103 
105  AVFrame *dst, const AVFrame *src, int flags)
106 {
108  DRMMapping *map;
109  int err, i, p, plane;
110  int mmap_prot;
111  void *addr;
112 
113  map = av_mallocz(sizeof(*map));
114  if (!map)
115  return AVERROR(ENOMEM);
116 
117  mmap_prot = 0;
119  mmap_prot |= PROT_READ;
121  mmap_prot |= PROT_WRITE;
122 
123  av_assert0(desc->nb_objects <= AV_DRM_MAX_PLANES);
124  for (i = 0; i < desc->nb_objects; i++) {
125  addr = mmap(NULL, desc->objects[i].size, mmap_prot, MAP_SHARED,
126  desc->objects[i].fd, 0);
127  if (addr == MAP_FAILED) {
128  err = AVERROR(errno);
129  av_log(hwfc, AV_LOG_ERROR, "Failed to map DRM object %d to "
130  "memory: %d.\n", desc->objects[i].fd, errno);
131  goto fail;
132  }
133 
134  map->address[i] = addr;
135  map->length[i] = desc->objects[i].size;
136  }
137  map->nb_regions = i;
138 
139  plane = 0;
140  for (i = 0; i < desc->nb_layers; i++) {
141  const AVDRMLayerDescriptor *layer = &desc->layers[i];
142  for (p = 0; p < layer->nb_planes; p++) {
143  dst->data[plane] =
144  (uint8_t*)map->address[layer->planes[p].object_index] +
145  layer->planes[p].offset;
146  dst->linesize[plane] = layer->planes[p].pitch;
147  ++plane;
148  }
149  }
150  av_assert0(plane <= AV_DRM_MAX_PLANES);
151 
152  dst->width = src->width;
153  dst->height = src->height;
154 
155  err = ff_hwframe_map_create(src->hw_frames_ctx, dst, src,
156  &drm_unmap_frame, map);
157  if (err < 0)
158  goto fail;
159 
160  return 0;
161 
162 fail:
163  for (i = 0; i < desc->nb_objects; i++) {
164  if (map->address[i])
165  munmap(map->address[i], map->length[i]);
166  }
167  av_free(map);
168  return err;
169 }
170 
173  enum AVPixelFormat **formats)
174 {
175  enum AVPixelFormat *pix_fmts;
176 
177  pix_fmts = av_malloc_array(2, sizeof(*pix_fmts));
178  if (!pix_fmts)
179  return AVERROR(ENOMEM);
180 
181  pix_fmts[0] = ctx->sw_format;
183 
184  *formats = pix_fmts;
185  return 0;
186 }
187 
189  AVFrame *dst, const AVFrame *src)
190 {
191  AVFrame *map;
192  int err;
193 
194  if (dst->width > hwfc->width || dst->height > hwfc->height)
195  return AVERROR(EINVAL);
196 
197  map = av_frame_alloc();
198  if (!map)
199  return AVERROR(ENOMEM);
200  map->format = dst->format;
201 
202  err = drm_map_frame(hwfc, map, src, AV_HWFRAME_MAP_READ);
203  if (err)
204  goto fail;
205 
206  map->width = dst->width;
207  map->height = dst->height;
208 
209  err = av_frame_copy(dst, map);
210  if (err)
211  goto fail;
212 
213  err = 0;
214 fail:
215  av_frame_free(&map);
216  return err;
217 }
218 
220  AVFrame *dst, const AVFrame *src)
221 {
222  AVFrame *map;
223  int err;
224 
225  if (src->width > hwfc->width || src->height > hwfc->height)
226  return AVERROR(EINVAL);
227 
228  map = av_frame_alloc();
229  if (!map)
230  return AVERROR(ENOMEM);
231  map->format = src->format;
232 
233  err = drm_map_frame(hwfc, map, dst, AV_HWFRAME_MAP_WRITE |
235  if (err)
236  goto fail;
237 
238  map->width = src->width;
239  map->height = src->height;
240 
241  err = av_frame_copy(map, src);
242  if (err)
243  goto fail;
244 
245  err = 0;
246 fail:
247  av_frame_free(&map);
248  return err;
249 }
250 
251 static int drm_map_from(AVHWFramesContext *hwfc, AVFrame *dst,
252  const AVFrame *src, int flags)
253 {
254  int err;
255 
256  if (hwfc->sw_format != dst->format)
257  return AVERROR(ENOSYS);
258 
259  err = drm_map_frame(hwfc, dst, src, flags);
260  if (err)
261  return err;
262 
263  err = av_frame_copy_props(dst, src);
264  if (err)
265  return err;
266 
267  return 0;
268 }
269 
272  .name = "DRM",
273 
274  .device_hwctx_size = sizeof(AVDRMDeviceContext),
275 
276  .device_create = &drm_device_create,
277 
278  .frames_get_buffer = &drm_get_buffer,
279 
280  .transfer_get_formats = &drm_transfer_get_formats,
281  .transfer_data_to = &drm_transfer_data_to,
282  .transfer_data_from = &drm_transfer_data_from,
283  .map_from = &drm_map_from,
284 
285  .pix_fmts = (const enum AVPixelFormat[]) {
288  },
289 };
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_WRITE
@ AV_HWFRAME_MAP_WRITE
The mapping must be writeable.
Definition: hwcontext.h:528
drm_device_create
static int drm_device_create(AVHWDeviceContext *hwdev, const char *device, AVDictionary *opts, int flags)
Definition: hwcontext_drm.c:40
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:203
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:300
AVFrame::width
int width
Definition: frame.h:358
AV_PIX_FMT_DRM_PRIME
@ AV_PIX_FMT_DRM_PRIME
DRM-managed buffers exposed through PRIME buffer sharing.
Definition: pixfmt.h:328
ff_hwcontext_type_drm
const HWContextType ff_hwcontext_type_drm
Definition: hwcontext_drm.c:270
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:192
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:171
AVFrame::data
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:314
drm_transfer_data_to
static int drm_transfer_data_to(AVHWFramesContext *hwfc, AVFrame *dst, const AVFrame *src)
Definition: hwcontext_drm.c:219
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:123
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:33
DRMMapping
Definition: hwcontext_drm.c:85
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:190
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:176
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:337
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:275
ctx
AVFormatContext * ctx
Definition: movenc.c:48
drm_get_buffer
static int drm_get_buffer(AVHWFramesContext *hwfc, AVFrame *frame)
Definition: hwcontext_drm.c:70
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:659
src
#define src
Definition: vp8dsp.c:254
drm_map_from
static int drm_map_from(AVHWFramesContext *hwfc, AVFrame *dst, const AVFrame *src, int flags)
Definition: hwcontext_drm.c:251
drm_map_frame
static int drm_map_frame(AVHWFramesContext *hwfc, AVFrame *dst, const AVFrame *src, int flags)
Definition: hwcontext_drm.c:104
desc
const char * desc
Definition: nvenc.c:79
av_frame_copy
int av_frame_copy(AVFrame *dst, const AVFrame *src)
Copy the frame data from src to dst.
Definition: frame.c:800
AVFrame::format
int format
format of the frame, -1 if unknown or unset Values correspond to enum AVPixelFormat for video frames,...
Definition: frame.h:373
version
version
Definition: libkvazaar.c:292
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:269
av_malloc_array
#define av_malloc_array(a, b)
Definition: tableprint_vlc.h:32
uint8_t
uint8_t
Definition: audio_convert.c:194
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:237
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
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:358
drm_unmap_frame
static void drm_unmap_frame(AVHWFramesContext *hwfc, HWMapDescriptor *hwmap)
Definition: hwcontext_drm.c:92
AV_HWFRAME_MAP_READ
@ AV_HWFRAME_MAP_READ
The mapping must be readable.
Definition: hwcontext.h:524
DRMMapping::length
size_t length[AV_DRM_MAX_PLANES]
Definition: hwcontext_drm.c:89
AV_PIX_FMT_NONE
@ AV_PIX_FMT_NONE
Definition: pixfmt.h:65
DRMMapping::nb_regions
int nb_regions
Definition: hwcontext_drm.c:87
AV_DRM_MAX_PLANES
@ AV_DRM_MAX_PLANES
The maximum number of layers/planes in a DRM frame.
Definition: hwcontext_drm.h:39
DRMMapping::address
void * address[AV_DRM_MAX_PLANES]
Definition: hwcontext_drm.c:88
hwcontext_internal.h
drm_transfer_data_from
static int drm_transfer_data_from(AVHWFramesContext *hwfc, AVFrame *dst, const AVFrame *src)
Definition: hwcontext_drm.c:188
map
const VDPAUPixFmtMap * map
Definition: hwcontext_vdpau.c:85
av_free
#define av_free(p)
Definition: tableprint_vlc.h:34
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
imgutils.h
flags
#define flags(name, subs,...)
Definition: cbs_av1.c:565
hwcontext.h
AVDRMPlaneDescriptor::pitch
ptrdiff_t pitch
Pitch (linesize) of this plane.
Definition: hwcontext_drm.h:87
AVFrame::linesize
int linesize[AV_NUM_DATA_POINTERS]
For video, size in bytes of each picture line.
Definition: frame.h:331
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