FFmpeg
v4l2_m2m.c
Go to the documentation of this file.
1 /*
2  * V4L mem2mem
3  *
4  * Copyright (C) 2017 Alexis Ballier <aballier@gentoo.org>
5  * Copyright (C) 2017 Jorge Ramirez <jorge.ramirez-ortiz@linaro.org>
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23 
24 #include <linux/videodev2.h>
25 #include <sys/ioctl.h>
26 #include <sys/mman.h>
27 #include <unistd.h>
28 #include <dirent.h>
29 #include <fcntl.h>
30 #include "libavcodec/avcodec.h"
31 #include "libavutil/mem.h"
32 #include "libavutil/pixdesc.h"
33 #include "libavutil/imgutils.h"
34 #include "libavutil/pixfmt.h"
35 #include "v4l2_context.h"
36 #include "v4l2_fmt.h"
37 #include "v4l2_m2m.h"
38 
39 static inline int v4l2_splane_video(struct v4l2_capability *cap)
40 {
41  if (cap->capabilities & (V4L2_CAP_VIDEO_CAPTURE | V4L2_CAP_VIDEO_OUTPUT) &&
42  cap->capabilities & V4L2_CAP_STREAMING)
43  return 1;
44 
45  if (cap->capabilities & V4L2_CAP_VIDEO_M2M)
46  return 1;
47 
48  return 0;
49 }
50 
51 static inline int v4l2_mplane_video(struct v4l2_capability *cap)
52 {
53  if (cap->capabilities & (V4L2_CAP_VIDEO_CAPTURE_MPLANE | V4L2_CAP_VIDEO_OUTPUT_MPLANE) &&
54  cap->capabilities & V4L2_CAP_STREAMING)
55  return 1;
56 
57  if (cap->capabilities & V4L2_CAP_VIDEO_M2M_MPLANE)
58  return 1;
59 
60  return 0;
61 }
62 
64 {
65  struct v4l2_capability cap;
66  void *log_ctx = s->avctx;
67  int ret;
68 
69  s->capture.done = s->output.done = 0;
70  s->capture.name = "capture";
71  s->output.name = "output";
72  atomic_init(&s->refcount, 0);
73  sem_init(&s->refsync, 0, 0);
74 
75  memset(&cap, 0, sizeof(cap));
76  ret = ioctl(s->fd, VIDIOC_QUERYCAP, &cap);
77  if (ret < 0)
78  return ret;
79 
80  av_log(log_ctx, probe ? AV_LOG_DEBUG : AV_LOG_INFO,
81  "driver '%s' on card '%s' in %s mode\n", cap.driver, cap.card,
82  v4l2_mplane_video(&cap) ? "mplane" :
83  v4l2_splane_video(&cap) ? "splane" : "unknown");
84 
85  if (v4l2_mplane_video(&cap)) {
86  s->capture.type = V4L2_BUF_TYPE_VIDEO_CAPTURE_MPLANE;
87  s->output.type = V4L2_BUF_TYPE_VIDEO_OUTPUT_MPLANE;
88  return 0;
89  }
90 
91  if (v4l2_splane_video(&cap)) {
92  s->capture.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
93  s->output.type = V4L2_BUF_TYPE_VIDEO_OUTPUT;
94  return 0;
95  }
96 
97  return AVERROR(EINVAL);
98 }
99 
101 {
102  void *log_ctx = s->avctx;
103  int ret;
104 
105  s->fd = open(s->devname, O_RDWR | O_NONBLOCK, 0);
106  if (s->fd < 0)
107  return AVERROR(errno);
108 
110  if (ret < 0)
111  goto done;
112 
113  ret = ff_v4l2_context_get_format(&s->output, 1);
114  if (ret) {
115  av_log(log_ctx, AV_LOG_DEBUG, "v4l2 output format not supported\n");
116  goto done;
117  }
118 
119  ret = ff_v4l2_context_get_format(&s->capture, 1);
120  if (ret) {
121  av_log(log_ctx, AV_LOG_DEBUG, "v4l2 capture format not supported\n");
122  goto done;
123  }
124 
125 done:
126  if (close(s->fd) < 0) {
127  ret = AVERROR(errno);
128  av_log(log_ctx, AV_LOG_ERROR, "failure closing %s (%s)\n", s->devname, av_err2str(AVERROR(errno)));
129  }
130 
131  s->fd = -1;
132 
133  return ret;
134 }
135 
137 {
138  void *log_ctx = s->avctx;
139  int ret;
140  struct v4l2_format ofmt, cfmt;
141 
142  s->fd = open(s->devname, O_RDWR | O_NONBLOCK, 0);
143  if (s->fd < 0)
144  return AVERROR(errno);
145 
147  if (ret < 0)
148  goto error;
149 
150  ofmt = s->output.format;
151  cfmt = s->capture.format;
152  av_log(log_ctx, AV_LOG_INFO, "requesting formats: output=%s/%s capture=%s/%s\n",
153  av_fourcc2str(V4L2_TYPE_IS_MULTIPLANAR(ofmt.type) ?
154  ofmt.fmt.pix_mp.pixelformat :
155  ofmt.fmt.pix.pixelformat),
156  av_get_pix_fmt_name(s->output.av_pix_fmt) ?: "none",
157  av_fourcc2str(V4L2_TYPE_IS_MULTIPLANAR(cfmt.type) ?
158  cfmt.fmt.pix_mp.pixelformat :
159  cfmt.fmt.pix.pixelformat),
160  av_get_pix_fmt_name(s->capture.av_pix_fmt) ?: "none");
161 
162  ret = ff_v4l2_context_set_format(&s->output);
163  if (ret) {
164  av_log(log_ctx, AV_LOG_ERROR, "can't set v4l2 output format\n");
165  goto error;
166  }
167 
168  ret = ff_v4l2_context_set_format(&s->capture);
169  if (ret) {
170  av_log(log_ctx, AV_LOG_ERROR, "can't to set v4l2 capture format\n");
171  goto error;
172  }
173 
174  ret = ff_v4l2_context_init(&s->output);
175  if (ret) {
176  av_log(log_ctx, AV_LOG_ERROR, "no v4l2 output context's buffers\n");
177  goto error;
178  }
179 
180  /* decoder's buffers need to be updated at a later stage */
181  if (s->avctx && !av_codec_is_decoder(s->avctx->codec)) {
182  ret = ff_v4l2_context_init(&s->capture);
183  if (ret) {
184  av_log(log_ctx, AV_LOG_ERROR, "no v4l2 capture context's buffers\n");
185  goto error;
186  }
187  }
188 
189  return 0;
190 
191 error:
192  if (close(s->fd) < 0) {
193  ret = AVERROR(errno);
194  av_log(log_ctx, AV_LOG_ERROR, "error closing %s (%s)\n",
195  s->devname, av_err2str(AVERROR(errno)));
196  }
197  s->fd = -1;
198 
199  return ret;
200 }
201 
202 /******************************************************************************
203  *
204  * V4L2 M2M Interface
205  *
206  ******************************************************************************/
208 {
209  void *log_ctx = s->avctx;
210  int ret;
211 
212  av_log(log_ctx, AV_LOG_DEBUG, "reinit context\n");
213 
214  /* 1. streamoff */
215  ret = ff_v4l2_context_set_status(&s->capture, VIDIOC_STREAMOFF);
216  if (ret)
217  av_log(log_ctx, AV_LOG_ERROR, "capture VIDIOC_STREAMOFF\n");
218 
219  /* 2. unmap the capture buffers (v4l2 and ffmpeg):
220  * we must wait for all references to be released before being allowed
221  * to queue new buffers.
222  */
223  av_log(log_ctx, AV_LOG_DEBUG, "waiting for user to release AVBufferRefs\n");
224  if (atomic_load(&s->refcount))
225  while(sem_wait(&s->refsync) == -1 && errno == EINTR);
226 
227  ff_v4l2_context_release(&s->capture);
228 
229  /* 3. get the new capture format */
230  ret = ff_v4l2_context_get_format(&s->capture, 0);
231  if (ret) {
232  av_log(log_ctx, AV_LOG_ERROR, "query the new capture format\n");
233  return ret;
234  }
235 
236  /* 4. set the capture format */
237  ret = ff_v4l2_context_set_format(&s->capture);
238  if (ret) {
239  av_log(log_ctx, AV_LOG_ERROR, "setting capture format\n");
240  return ret;
241  }
242 
243  /* 5. complete reinit */
244  s->draining = 0;
245  s->reinit = 0;
246 
247  return 0;
248 }
249 
250 static void v4l2_m2m_destroy_context(void *opaque, uint8_t *context)
251 {
253 
254  ff_v4l2_context_release(&s->capture);
255  sem_destroy(&s->refsync);
256 
257  if (s->fd >= 0)
258  close(s->fd);
259  av_frame_free(&s->frame);
260  av_packet_unref(&s->buf_pkt);
261 
262  av_free(s);
263 }
264 
266 {
267  V4L2m2mContext *s = priv->context;
268  int ret;
269 
270  if (!s)
271  return 0;
272 
273  if (s->fd >= 0) {
274  ret = ff_v4l2_context_set_status(&s->output, VIDIOC_STREAMOFF);
275  if (ret)
276  av_log(s->avctx, AV_LOG_ERROR, "VIDIOC_STREAMOFF %s\n", s->output.name);
277 
278  ret = ff_v4l2_context_set_status(&s->capture, VIDIOC_STREAMOFF);
279  if (ret)
280  av_log(s->avctx, AV_LOG_ERROR, "VIDIOC_STREAMOFF %s\n", s->capture.name);
281  }
282 
283  ff_v4l2_context_release(&s->output);
284 
285  s->self_ref = NULL;
287 
288  return 0;
289 }
290 
292 {
293  int ret = AVERROR(EINVAL);
294  struct dirent *entry;
295  DIR *dirp;
296 
297  V4L2m2mContext *s = priv->context;
298 
299  dirp = opendir("/dev");
300  if (!dirp)
301  return AVERROR(errno);
302 
303  for (entry = readdir(dirp); entry; entry = readdir(dirp)) {
304 
305  if (strncmp(entry->d_name, "video", 5))
306  continue;
307 
308  snprintf(s->devname, sizeof(s->devname), "/dev/%s", entry->d_name);
309  av_log(s->avctx, AV_LOG_DEBUG, "probing device %s\n", s->devname);
311  if (!ret)
312  break;
313  }
314 
315  closedir(dirp);
316 
317  if (ret) {
318  av_log(s->avctx, AV_LOG_ERROR, "Could not find a valid device\n");
319  memset(s->devname, 0, sizeof(s->devname));
320 
321  return ret;
322  }
323 
324  av_log(s->avctx, AV_LOG_INFO, "Using device %s\n", s->devname);
325 
326  return v4l2_configure_contexts(s);
327 }
328 
330 {
331  *s = av_mallocz(sizeof(V4L2m2mContext));
332  if (!*s)
333  return AVERROR(ENOMEM);
334 
335  priv->context_ref = av_buffer_create((uint8_t *) *s, sizeof(V4L2m2mContext),
337  if (!priv->context_ref) {
338  av_freep(s);
339  return AVERROR(ENOMEM);
340  }
341 
342  /* assign the context */
343  priv->context = *s;
344  (*s)->priv = priv;
345 
346  /* populate it */
349  priv->context->self_ref = priv->context_ref;
350  priv->context->fd = -1;
351 
352  priv->context->frame = av_frame_alloc();
353  if (!priv->context->frame) {
355  *s = NULL; /* freed when unreferencing context_ref */
356  return AVERROR(ENOMEM);
357  }
358 
359  return 0;
360 }
error
static void error(const char *err)
Definition: target_bsf_fuzzer.c:32
ff_v4l2_context_init
int ff_v4l2_context_init(V4L2Context *ctx)
Initializes a V4L2Context.
Definition: v4l2_context.c:713
av_packet_unref
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
Definition: packet.c:427
entry
#define entry
Definition: aom_film_grain_template.c:66
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
ff_v4l2_m2m_codec_reinit
int ff_v4l2_m2m_codec_reinit(V4L2m2mContext *s)
Reinitializes the V4L2m2mContext when the driver cannot continue processing with the capture paramete...
Definition: v4l2_m2m.c:207
V4L2m2mContext
Definition: v4l2_m2m.h:43
av_frame_free
void av_frame_free(AVFrame **frame)
Free the frame and any dynamically allocated objects in it, e.g.
Definition: frame.c:160
pixdesc.h
v4l2_mplane_video
static int v4l2_mplane_video(struct v4l2_capability *cap)
Definition: v4l2_m2m.c:51
ff_v4l2_context_release
void ff_v4l2_context_release(V4L2Context *ctx)
Releases a V4L2Context.
Definition: v4l2_context.c:699
v4l2_probe_driver
static int v4l2_probe_driver(V4L2m2mContext *s)
Definition: v4l2_m2m.c:100
V4L2m2mPriv::context
V4L2m2mContext * context
Definition: v4l2_m2m.h:74
av_frame_alloc
AVFrame * av_frame_alloc(void)
Allocate an AVFrame and set its fields to default values.
Definition: frame.c:148
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:180
ff_v4l2_context_set_format
int ff_v4l2_context_set_format(V4L2Context *ctx)
Sets the V4L2Context format in the v4l2 driver.
Definition: v4l2_context.c:694
v4l2_splane_video
static int v4l2_splane_video(struct v4l2_capability *cap)
Definition: v4l2_m2m.c:39
ff_v4l2_context_get_format
int ff_v4l2_context_get_format(V4L2Context *ctx, int probe)
Queries the driver for a valid v4l2 format and copies it to the context.
Definition: v4l2_context.c:667
v4l2_fmt.h
s
#define s(width, name)
Definition: cbs_vp9.c:198
V4L2m2mContext::capture
V4L2Context capture
Definition: v4l2_m2m.h:48
AV_LOG_DEBUG
#define AV_LOG_DEBUG
Stuff which is only useful for libav* developers.
Definition: log.h:201
v4l2_m2m_destroy_context
static void v4l2_m2m_destroy_context(void *opaque, uint8_t *context)
Definition: v4l2_m2m.c:250
ff_v4l2_m2m_codec_init
int ff_v4l2_m2m_codec_init(V4L2m2mPriv *priv)
Probes the video nodes looking for the required codec capabilities.
Definition: v4l2_m2m.c:291
atomic_load
#define atomic_load(object)
Definition: stdatomic.h:93
context
it s the only field you need to keep assuming you have a context There is some magic you don t need to care about around this just let it vf default minimum maximum flags name is the option keep it simple and lowercase description are in without and describe what they for example set the foo of the bar offset is the offset of the field in your context
Definition: writing_filters.txt:91
NULL
#define NULL
Definition: coverity.c:32
av_buffer_unref
void av_buffer_unref(AVBufferRef **buf)
Free a given reference and automatically free the buffer if there are no more references to it.
Definition: buffer.c:139
v4l2_configure_contexts
static int v4l2_configure_contexts(V4L2m2mContext *s)
Definition: v4l2_m2m.c:136
v4l2_prepare_contexts
static int v4l2_prepare_contexts(V4L2m2mContext *s, int probe)
Definition: v4l2_m2m.c:63
ff_v4l2_m2m_create_context
int ff_v4l2_m2m_create_context(V4L2m2mPriv *priv, V4L2m2mContext **s)
Allocate a new context and references for a V4L2 M2M instance.
Definition: v4l2_m2m.c:329
V4L2m2mPriv::num_output_buffers
int num_output_buffers
Definition: v4l2_m2m.h:77
V4L2m2mContext::output
V4L2Context output
Definition: v4l2_m2m.h:49
av_buffer_create
AVBufferRef * av_buffer_create(uint8_t *data, size_t size, void(*free)(void *opaque, uint8_t *data), void *opaque, int flags)
Create an AVBuffer from an existing array.
Definition: buffer.c:55
av_codec_is_decoder
int av_codec_is_decoder(const AVCodec *codec)
Definition: utils.c:86
ff_v4l2_m2m_codec_end
int ff_v4l2_m2m_codec_end(V4L2m2mPriv *priv)
Releases all the codec resources if all AVBufferRefs have been returned to the ctx.
Definition: v4l2_m2m.c:265
sem_wait
#define sem_wait(psem)
Definition: semaphore.h:27
av_err2str
#define av_err2str(errnum)
Convenience macro, the return value should be used only directly in function arguments but never stan...
Definition: error.h:121
AV_LOG_INFO
#define AV_LOG_INFO
Standard information.
Definition: log.h:191
ff_v4l2_context_set_status
int ff_v4l2_context_set_status(V4L2Context *ctx, uint32_t cmd)
Sets the status of a V4L2Context.
Definition: v4l2_context.c:563
V4L2Context::num_buffers
int num_buffers
Readonly after init.
Definition: v4l2_context.h:83
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:256
V4L2m2mPriv::context_ref
AVBufferRef * context_ref
Definition: v4l2_m2m.h:75
v4l2_context.h
avcodec.h
sem_destroy
#define sem_destroy(psem)
Definition: semaphore.h:29
ret
ret
Definition: filter_design.txt:187
pixfmt.h
probe
static int probe(const AVProbeData *p)
Definition: act.c:39
V4L2m2mPriv::num_capture_buffers
int num_capture_buffers
Definition: v4l2_m2m.h:78
V4L2m2mPriv
Definition: v4l2_m2m.h:71
V4L2m2mContext::fd
int fd
Definition: v4l2_m2m.h:45
mem.h
av_free
#define av_free(p)
Definition: tableprint_vlc.h:33
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
v4l2_m2m.h
imgutils.h
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
V4L2m2mContext::self_ref
AVBufferRef * self_ref
Definition: v4l2_m2m.h:65
atomic_init
#define atomic_init(obj, value)
Definition: stdatomic.h:33
snprintf
#define snprintf
Definition: snprintf.h:34
V4L2m2mContext::frame
AVFrame * frame
Definition: v4l2_m2m.h:62
sem_init
#define sem_init
Definition: semaphore.h:40
av_get_pix_fmt_name
const char * av_get_pix_fmt_name(enum AVPixelFormat pix_fmt)
Return the short name for a pixel format, NULL in case pix_fmt is unknown.
Definition: pixdesc.c:2885
av_fourcc2str
#define av_fourcc2str(fourcc)
Definition: avutil.h:345