76f7c4ed1e1640c471d7dc6c97b6f1a6c0575640
[ffmpeg.git] / libavdevice / v4l2.c
1 /*
2  * Copyright (c) 2000,2001 Fabrice Bellard
3  * Copyright (c) 2006 Luca Abeni
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 /**
23  * @file
24  * Video4Linux2 grab interface
25  *
26  * Part of this file is based on the V4L2 video capture example
27  * (http://linuxtv.org/downloads/v4l-dvb-apis/capture-example.html)
28  *
29  * Thanks to Michael Niedermayer for providing the mapping between
30  * V4L2_PIX_FMT_* and AV_PIX_FMT_*
31  */
32
33 #include "v4l2-common.h"
34 #include <dirent.h>
35
36 #if CONFIG_LIBV4L2
37 #include <libv4l2.h>
38 #endif
39
40 static const int desired_video_buffers = 256;
41
42 #define V4L_ALLFORMATS  3
43 #define V4L_RAWFORMATS  1
44 #define V4L_COMPFORMATS 2
45
46 /**
47  * Return timestamps to the user exactly as returned by the kernel
48  */
49 #define V4L_TS_DEFAULT  0
50 /**
51  * Autodetect the kind of timestamps returned by the kernel and convert to
52  * absolute (wall clock) timestamps.
53  */
54 #define V4L_TS_ABS      1
55 /**
56  * Assume kernel timestamps are from the monotonic clock and convert to
57  * absolute timestamps.
58  */
59 #define V4L_TS_MONO2ABS 2
60
61 /**
62  * Once the kind of timestamps returned by the kernel have been detected,
63  * the value of the timefilter (NULL or not) determines whether a conversion
64  * takes place.
65  */
66 #define V4L_TS_CONVERT_READY V4L_TS_DEFAULT
67
68 struct video_data {
69     AVClass *class;
70     int fd;
71     int pixelformat; /* V4L2_PIX_FMT_* */
72     int width, height;
73     int frame_size;
74     int interlaced;
75     int top_field_first;
76     int ts_mode;
77     TimeFilter *timefilter;
78     int64_t last_time_m;
79
80     int buffers;
81     volatile int buffers_queued;
82     void **buf_start;
83     unsigned int *buf_len;
84     char *standard;
85     v4l2_std_id std_id;
86     int channel;
87     char *pixel_format; /**< Set by a private option. */
88     int list_format;    /**< Set by a private option. */
89     int list_standard;  /**< Set by a private option. */
90     char *framerate;    /**< Set by a private option. */
91
92     int use_libv4l2;
93     int (*open_f)(const char *file, int oflag, ...);
94     int (*close_f)(int fd);
95     int (*dup_f)(int fd);
96     int (*ioctl_f)(int fd, unsigned long int request, ...);
97     ssize_t (*read_f)(int fd, void *buffer, size_t n);
98     void *(*mmap_f)(void *start, size_t length, int prot, int flags, int fd, int64_t offset);
99     int (*munmap_f)(void *_start, size_t length);
100 };
101
102 struct buff_data {
103     struct video_data *s;
104     int index;
105 };
106
107 static int device_open(AVFormatContext *ctx)
108 {
109     struct video_data *s = ctx->priv_data;
110     struct v4l2_capability cap;
111     int fd;
112     int err;
113     int flags = O_RDWR;
114
115 #define SET_WRAPPERS(prefix) do {       \
116     s->open_f   = prefix ## open;       \
117     s->close_f  = prefix ## close;      \
118     s->dup_f    = prefix ## dup;        \
119     s->ioctl_f  = prefix ## ioctl;      \
120     s->read_f   = prefix ## read;       \
121     s->mmap_f   = prefix ## mmap;       \
122     s->munmap_f = prefix ## munmap;     \
123 } while (0)
124
125     if (s->use_libv4l2) {
126 #if CONFIG_LIBV4L2
127         SET_WRAPPERS(v4l2_);
128 #else
129         av_log(ctx, AV_LOG_ERROR, "libavdevice is not build with libv4l2 support.\n");
130         return AVERROR(EINVAL);
131 #endif
132     } else {
133         SET_WRAPPERS();
134     }
135
136 #define v4l2_open   s->open_f
137 #define v4l2_close  s->close_f
138 #define v4l2_dup    s->dup_f
139 #define v4l2_ioctl  s->ioctl_f
140 #define v4l2_read   s->read_f
141 #define v4l2_mmap   s->mmap_f
142 #define v4l2_munmap s->munmap_f
143
144     if (ctx->flags & AVFMT_FLAG_NONBLOCK) {
145         flags |= O_NONBLOCK;
146     }
147
148     fd = v4l2_open(ctx->filename, flags, 0);
149     if (fd < 0) {
150         err = AVERROR(errno);
151         av_log(ctx, AV_LOG_ERROR, "Cannot open video device %s: %s\n",
152                ctx->filename, av_err2str(err));
153         return err;
154     }
155
156     if (v4l2_ioctl(fd, VIDIOC_QUERYCAP, &cap) < 0) {
157         err = AVERROR(errno);
158         av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_QUERYCAP): %s\n",
159                av_err2str(err));
160         goto fail;
161     }
162
163     av_log(ctx, AV_LOG_VERBOSE, "fd:%d capabilities:%x\n",
164            fd, cap.capabilities);
165
166     if (!(cap.capabilities & V4L2_CAP_VIDEO_CAPTURE)) {
167         av_log(ctx, AV_LOG_ERROR, "Not a video capture device.\n");
168         err = AVERROR(ENODEV);
169         goto fail;
170     }
171
172     if (!(cap.capabilities & V4L2_CAP_STREAMING)) {
173         av_log(ctx, AV_LOG_ERROR,
174                "The device does not support the streaming I/O method.\n");
175         err = AVERROR(ENOSYS);
176         goto fail;
177     }
178
179     return fd;
180
181 fail:
182     v4l2_close(fd);
183     return err;
184 }
185
186 static int device_init(AVFormatContext *ctx, int *width, int *height,
187                        uint32_t pixelformat)
188 {
189     struct video_data *s = ctx->priv_data;
190     struct v4l2_format fmt = { .type = V4L2_BUF_TYPE_VIDEO_CAPTURE };
191     int res = 0;
192
193     fmt.fmt.pix.width = *width;
194     fmt.fmt.pix.height = *height;
195     fmt.fmt.pix.pixelformat = pixelformat;
196     fmt.fmt.pix.field = V4L2_FIELD_ANY;
197
198     /* Some drivers will fail and return EINVAL when the pixelformat
199        is not supported (even if type field is valid and supported) */
200     if (v4l2_ioctl(s->fd, VIDIOC_S_FMT, &fmt) < 0)
201         res = AVERROR(errno);
202
203     if ((*width != fmt.fmt.pix.width) || (*height != fmt.fmt.pix.height)) {
204         av_log(ctx, AV_LOG_INFO,
205                "The V4L2 driver changed the video from %dx%d to %dx%d\n",
206                *width, *height, fmt.fmt.pix.width, fmt.fmt.pix.height);
207         *width = fmt.fmt.pix.width;
208         *height = fmt.fmt.pix.height;
209     }
210
211     if (pixelformat != fmt.fmt.pix.pixelformat) {
212         av_log(ctx, AV_LOG_DEBUG,
213                "The V4L2 driver changed the pixel format "
214                "from 0x%08X to 0x%08X\n",
215                pixelformat, fmt.fmt.pix.pixelformat);
216         res = AVERROR(EINVAL);
217     }
218
219     if (fmt.fmt.pix.field == V4L2_FIELD_INTERLACED) {
220         av_log(ctx, AV_LOG_DEBUG,
221                "The V4L2 driver is using the interlaced mode\n");
222         s->interlaced = 1;
223     }
224
225     return res;
226 }
227
228 static int first_field(const struct video_data *s)
229 {
230     int res;
231     v4l2_std_id std;
232
233     res = v4l2_ioctl(s->fd, VIDIOC_G_STD, &std);
234     if (res < 0)
235         return 0;
236     if (std & V4L2_STD_NTSC)
237         return 0;
238
239     return 1;
240 }
241
242 #if HAVE_STRUCT_V4L2_FRMIVALENUM_DISCRETE
243 static void list_framesizes(AVFormatContext *ctx, uint32_t pixelformat)
244 {
245     const struct video_data *s = ctx->priv_data;
246     struct v4l2_frmsizeenum vfse = { .pixel_format = pixelformat };
247
248     while(!v4l2_ioctl(s->fd, VIDIOC_ENUM_FRAMESIZES, &vfse)) {
249         switch (vfse.type) {
250         case V4L2_FRMSIZE_TYPE_DISCRETE:
251             av_log(ctx, AV_LOG_INFO, " %ux%u",
252                    vfse.discrete.width, vfse.discrete.height);
253         break;
254         case V4L2_FRMSIZE_TYPE_CONTINUOUS:
255         case V4L2_FRMSIZE_TYPE_STEPWISE:
256             av_log(ctx, AV_LOG_INFO, " {%u-%u, %u}x{%u-%u, %u}",
257                    vfse.stepwise.min_width,
258                    vfse.stepwise.max_width,
259                    vfse.stepwise.step_width,
260                    vfse.stepwise.min_height,
261                    vfse.stepwise.max_height,
262                    vfse.stepwise.step_height);
263         }
264         vfse.index++;
265     }
266 }
267 #endif
268
269 static void list_formats(AVFormatContext *ctx, int type)
270 {
271     const struct video_data *s = ctx->priv_data;
272     struct v4l2_fmtdesc vfd = { .type = V4L2_BUF_TYPE_VIDEO_CAPTURE };
273
274     while(!v4l2_ioctl(s->fd, VIDIOC_ENUM_FMT, &vfd)) {
275         enum AVCodecID codec_id = ff_fmt_v4l2codec(vfd.pixelformat);
276         enum AVPixelFormat pix_fmt = ff_fmt_v4l2ff(vfd.pixelformat, codec_id);
277
278         vfd.index++;
279
280         if (!(vfd.flags & V4L2_FMT_FLAG_COMPRESSED) &&
281             type & V4L_RAWFORMATS) {
282             const char *fmt_name = av_get_pix_fmt_name(pix_fmt);
283             av_log(ctx, AV_LOG_INFO, "Raw       : %9s : %20s :",
284                    fmt_name ? fmt_name : "Unsupported",
285                    vfd.description);
286         } else if (vfd.flags & V4L2_FMT_FLAG_COMPRESSED &&
287                    type & V4L_COMPFORMATS) {
288             const AVCodecDescriptor *desc = avcodec_descriptor_get(codec_id);
289             av_log(ctx, AV_LOG_INFO, "Compressed: %9s : %20s :",
290                    desc ? desc->name : "Unsupported",
291                    vfd.description);
292         } else {
293             continue;
294         }
295
296 #ifdef V4L2_FMT_FLAG_EMULATED
297         if (vfd.flags & V4L2_FMT_FLAG_EMULATED)
298             av_log(ctx, AV_LOG_INFO, " Emulated :");
299 #endif
300 #if HAVE_STRUCT_V4L2_FRMIVALENUM_DISCRETE
301         list_framesizes(ctx, vfd.pixelformat);
302 #endif
303         av_log(ctx, AV_LOG_INFO, "\n");
304     }
305 }
306
307 static void list_standards(AVFormatContext *ctx)
308 {
309     int ret;
310     struct video_data *s = ctx->priv_data;
311     struct v4l2_standard standard;
312
313     if (s->std_id == 0)
314         return;
315
316     for (standard.index = 0; ; standard.index++) {
317         if (v4l2_ioctl(s->fd, VIDIOC_ENUMSTD, &standard) < 0) {
318             ret = AVERROR(errno);
319             if (ret == AVERROR(EINVAL)) {
320                 break;
321             } else {
322                 av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_ENUMSTD): %s\n", av_err2str(ret));
323                 return;
324             }
325         }
326         av_log(ctx, AV_LOG_INFO, "%2d, %16"PRIx64", %s\n",
327                standard.index, (uint64_t)standard.id, standard.name);
328     }
329 }
330
331 static int mmap_init(AVFormatContext *ctx)
332 {
333     int i, res;
334     struct video_data *s = ctx->priv_data;
335     struct v4l2_requestbuffers req = {
336         .type   = V4L2_BUF_TYPE_VIDEO_CAPTURE,
337         .count  = desired_video_buffers,
338         .memory = V4L2_MEMORY_MMAP
339     };
340
341     if (v4l2_ioctl(s->fd, VIDIOC_REQBUFS, &req) < 0) {
342         res = AVERROR(errno);
343         av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_REQBUFS): %s\n", av_err2str(res));
344         return res;
345     }
346
347     if (req.count < 2) {
348         av_log(ctx, AV_LOG_ERROR, "Insufficient buffer memory\n");
349         return AVERROR(ENOMEM);
350     }
351     s->buffers = req.count;
352     s->buf_start = av_malloc_array(s->buffers, sizeof(void *));
353     if (!s->buf_start) {
354         av_log(ctx, AV_LOG_ERROR, "Cannot allocate buffer pointers\n");
355         return AVERROR(ENOMEM);
356     }
357     s->buf_len = av_malloc_array(s->buffers, sizeof(unsigned int));
358     if (!s->buf_len) {
359         av_log(ctx, AV_LOG_ERROR, "Cannot allocate buffer sizes\n");
360         av_freep(&s->buf_start);
361         return AVERROR(ENOMEM);
362     }
363
364     for (i = 0; i < req.count; i++) {
365         struct v4l2_buffer buf = {
366             .type   = V4L2_BUF_TYPE_VIDEO_CAPTURE,
367             .index  = i,
368             .memory = V4L2_MEMORY_MMAP
369         };
370         if (v4l2_ioctl(s->fd, VIDIOC_QUERYBUF, &buf) < 0) {
371             res = AVERROR(errno);
372             av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_QUERYBUF): %s\n", av_err2str(res));
373             return res;
374         }
375
376         s->buf_len[i] = buf.length;
377         if (s->frame_size > 0 && s->buf_len[i] < s->frame_size) {
378             av_log(ctx, AV_LOG_ERROR,
379                    "buf_len[%d] = %d < expected frame size %d\n",
380                    i, s->buf_len[i], s->frame_size);
381             return AVERROR(ENOMEM);
382         }
383         s->buf_start[i] = v4l2_mmap(NULL, buf.length,
384                                PROT_READ | PROT_WRITE, MAP_SHARED,
385                                s->fd, buf.m.offset);
386
387         if (s->buf_start[i] == MAP_FAILED) {
388             res = AVERROR(errno);
389             av_log(ctx, AV_LOG_ERROR, "mmap: %s\n", av_err2str(res));
390             return res;
391         }
392     }
393
394     return 0;
395 }
396
397 #if FF_API_DESTRUCT_PACKET
398 static void dummy_release_buffer(AVPacket *pkt)
399 {
400     av_assert0(0);
401 }
402 #endif
403
404 static int enqueue_buffer(struct video_data *s, struct v4l2_buffer *buf)
405 {
406     int res = 0;
407
408     if (v4l2_ioctl(s->fd, VIDIOC_QBUF, buf) < 0) {
409         res = AVERROR(errno);
410         av_log(NULL, AV_LOG_ERROR, "ioctl(VIDIOC_QBUF): %s\n", av_err2str(res));
411     } else {
412         avpriv_atomic_int_add_and_fetch(&s->buffers_queued, 1);
413     }
414
415     return res;
416 }
417
418 static void mmap_release_buffer(void *opaque, uint8_t *data)
419 {
420     struct v4l2_buffer buf = { 0 };
421     struct buff_data *buf_descriptor = opaque;
422     struct video_data *s = buf_descriptor->s;
423
424     buf.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
425     buf.memory = V4L2_MEMORY_MMAP;
426     buf.index = buf_descriptor->index;
427     av_free(buf_descriptor);
428
429     enqueue_buffer(s, &buf);
430 }
431
432 #if HAVE_CLOCK_GETTIME && defined(CLOCK_MONOTONIC)
433 static int64_t av_gettime_monotonic(void)
434 {
435     return av_gettime_relative();
436 }
437 #endif
438
439 static int init_convert_timestamp(AVFormatContext *ctx, int64_t ts)
440 {
441     struct video_data *s = ctx->priv_data;
442     int64_t now;
443
444     now = av_gettime();
445     if (s->ts_mode == V4L_TS_ABS &&
446         ts <= now + 1 * AV_TIME_BASE && ts >= now - 10 * AV_TIME_BASE) {
447         av_log(ctx, AV_LOG_INFO, "Detected absolute timestamps\n");
448         s->ts_mode = V4L_TS_CONVERT_READY;
449         return 0;
450     }
451 #if HAVE_CLOCK_GETTIME && defined(CLOCK_MONOTONIC)
452     if (ctx->streams[0]->avg_frame_rate.num) {
453         now = av_gettime_monotonic();
454         if (s->ts_mode == V4L_TS_MONO2ABS ||
455             (ts <= now + 1 * AV_TIME_BASE && ts >= now - 10 * AV_TIME_BASE)) {
456             AVRational tb = {AV_TIME_BASE, 1};
457             int64_t period = av_rescale_q(1, tb, ctx->streams[0]->avg_frame_rate);
458             av_log(ctx, AV_LOG_INFO, "Detected monotonic timestamps, converting\n");
459             /* microseconds instead of seconds, MHz instead of Hz */
460             s->timefilter = ff_timefilter_new(1, period, 1.0E-6);
461             if (!s->timefilter)
462                 return AVERROR(ENOMEM);
463             s->ts_mode = V4L_TS_CONVERT_READY;
464             return 0;
465         }
466     }
467 #endif
468     av_log(ctx, AV_LOG_ERROR, "Unknown timestamps\n");
469     return AVERROR(EIO);
470 }
471
472 static int convert_timestamp(AVFormatContext *ctx, int64_t *ts)
473 {
474     struct video_data *s = ctx->priv_data;
475
476     if (s->ts_mode) {
477         int r = init_convert_timestamp(ctx, *ts);
478         if (r < 0)
479             return r;
480     }
481 #if HAVE_CLOCK_GETTIME && defined(CLOCK_MONOTONIC)
482     if (s->timefilter) {
483         int64_t nowa = av_gettime();
484         int64_t nowm = av_gettime_monotonic();
485         ff_timefilter_update(s->timefilter, nowa, nowm - s->last_time_m);
486         s->last_time_m = nowm;
487         *ts = ff_timefilter_eval(s->timefilter, *ts - nowm);
488     }
489 #endif
490     return 0;
491 }
492
493 static int mmap_read_frame(AVFormatContext *ctx, AVPacket *pkt)
494 {
495     struct video_data *s = ctx->priv_data;
496     struct v4l2_buffer buf = {
497         .type   = V4L2_BUF_TYPE_VIDEO_CAPTURE,
498         .memory = V4L2_MEMORY_MMAP
499     };
500     int res;
501
502     pkt->size = 0;
503
504     /* FIXME: Some special treatment might be needed in case of loss of signal... */
505     while ((res = v4l2_ioctl(s->fd, VIDIOC_DQBUF, &buf)) < 0 && (errno == EINTR));
506     if (res < 0) {
507         if (errno == EAGAIN)
508             return AVERROR(EAGAIN);
509
510         res = AVERROR(errno);
511         av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_DQBUF): %s\n",
512                av_err2str(res));
513         return res;
514     }
515
516     if (buf.index >= s->buffers) {
517         av_log(ctx, AV_LOG_ERROR, "Invalid buffer index received.\n");
518         return AVERROR(EINVAL);
519     }
520     avpriv_atomic_int_add_and_fetch(&s->buffers_queued, -1);
521     // always keep at least one buffer queued
522     av_assert0(avpriv_atomic_int_get(&s->buffers_queued) >= 1);
523
524     if (buf.flags & V4L2_BUF_FLAG_ERROR) {
525         av_log(ctx, AV_LOG_WARNING,
526                "Dequeued v4l2 buffer contains corrupted data (%d bytes).\n",
527                buf.bytesused);
528         buf.bytesused = 0;
529     } else {
530         /* CPIA is a compressed format and we don't know the exact number of bytes
531          * used by a frame, so set it here as the driver announces it. */
532         if (ctx->video_codec_id == AV_CODEC_ID_CPIA)
533             s->frame_size = buf.bytesused;
534
535         if (s->frame_size > 0 && buf.bytesused != s->frame_size) {
536             av_log(ctx, AV_LOG_ERROR,
537                    "Dequeued v4l2 buffer contains %d bytes, but %d were expected. Flags: 0x%08X.\n",
538                    buf.bytesused, s->frame_size, buf.flags);
539             enqueue_buffer(s, &buf);
540             return AVERROR_INVALIDDATA;
541         }
542     }
543
544     /* Image is at s->buff_start[buf.index] */
545     if (avpriv_atomic_int_get(&s->buffers_queued) == FFMAX(s->buffers / 8, 1)) {
546         /* when we start getting low on queued buffers, fall back on copying data */
547         res = av_new_packet(pkt, buf.bytesused);
548         if (res < 0) {
549             av_log(ctx, AV_LOG_ERROR, "Error allocating a packet.\n");
550             enqueue_buffer(s, &buf);
551             return res;
552         }
553         memcpy(pkt->data, s->buf_start[buf.index], buf.bytesused);
554
555         res = enqueue_buffer(s, &buf);
556         if (res) {
557             av_free_packet(pkt);
558             return res;
559         }
560     } else {
561         struct buff_data *buf_descriptor;
562
563         pkt->data     = s->buf_start[buf.index];
564         pkt->size     = buf.bytesused;
565 #if FF_API_DESTRUCT_PACKET
566 FF_DISABLE_DEPRECATION_WARNINGS
567         pkt->destruct = dummy_release_buffer;
568 FF_ENABLE_DEPRECATION_WARNINGS
569 #endif
570
571         buf_descriptor = av_malloc(sizeof(struct buff_data));
572         if (!buf_descriptor) {
573             /* Something went wrong... Since av_malloc() failed, we cannot even
574              * allocate a buffer for memcpying into it
575              */
576             av_log(ctx, AV_LOG_ERROR, "Failed to allocate a buffer descriptor\n");
577             enqueue_buffer(s, &buf);
578
579             return AVERROR(ENOMEM);
580         }
581         buf_descriptor->index = buf.index;
582         buf_descriptor->s     = s;
583
584         pkt->buf = av_buffer_create(pkt->data, pkt->size, mmap_release_buffer,
585                                     buf_descriptor, 0);
586         if (!pkt->buf) {
587             av_log(ctx, AV_LOG_ERROR, "Failed to create a buffer\n");
588             enqueue_buffer(s, &buf);
589             av_freep(&buf_descriptor);
590             return AVERROR(ENOMEM);
591         }
592     }
593     pkt->pts = buf.timestamp.tv_sec * INT64_C(1000000) + buf.timestamp.tv_usec;
594     convert_timestamp(ctx, &pkt->pts);
595
596     return pkt->size;
597 }
598
599 static int mmap_start(AVFormatContext *ctx)
600 {
601     struct video_data *s = ctx->priv_data;
602     enum v4l2_buf_type type;
603     int i, res;
604
605     for (i = 0; i < s->buffers; i++) {
606         struct v4l2_buffer buf = {
607             .type   = V4L2_BUF_TYPE_VIDEO_CAPTURE,
608             .index  = i,
609             .memory = V4L2_MEMORY_MMAP
610         };
611
612         if (v4l2_ioctl(s->fd, VIDIOC_QBUF, &buf) < 0) {
613             res = AVERROR(errno);
614             av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_QBUF): %s\n",
615                    av_err2str(res));
616             return res;
617         }
618     }
619     s->buffers_queued = s->buffers;
620
621     type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
622     if (v4l2_ioctl(s->fd, VIDIOC_STREAMON, &type) < 0) {
623         res = AVERROR(errno);
624         av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_STREAMON): %s\n",
625                av_err2str(res));
626         return res;
627     }
628
629     return 0;
630 }
631
632 static void mmap_close(struct video_data *s)
633 {
634     enum v4l2_buf_type type;
635     int i;
636
637     type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
638     /* We do not check for the result, because we could
639      * not do anything about it anyway...
640      */
641     v4l2_ioctl(s->fd, VIDIOC_STREAMOFF, &type);
642     for (i = 0; i < s->buffers; i++) {
643         v4l2_munmap(s->buf_start[i], s->buf_len[i]);
644     }
645     av_freep(&s->buf_start);
646     av_freep(&s->buf_len);
647 }
648
649 static int v4l2_set_parameters(AVFormatContext *ctx)
650 {
651     struct video_data *s = ctx->priv_data;
652     struct v4l2_standard standard = { 0 };
653     struct v4l2_streamparm streamparm = { 0 };
654     struct v4l2_fract *tpf;
655     AVRational framerate_q = { 0 };
656     int i, ret;
657
658     if (s->framerate &&
659         (ret = av_parse_video_rate(&framerate_q, s->framerate)) < 0) {
660         av_log(ctx, AV_LOG_ERROR, "Could not parse framerate '%s'.\n",
661                s->framerate);
662         return ret;
663     }
664
665     if (s->standard) {
666         if (s->std_id) {
667             ret = 0;
668             av_log(ctx, AV_LOG_DEBUG, "Setting standard: %s\n", s->standard);
669             /* set tv standard */
670             for (i = 0; ; i++) {
671                 standard.index = i;
672                 if (v4l2_ioctl(s->fd, VIDIOC_ENUMSTD, &standard) < 0) {
673                     ret = AVERROR(errno);
674                     break;
675                 }
676                 if (!av_strcasecmp(standard.name, s->standard))
677                     break;
678             }
679             if (ret < 0) {
680                 av_log(ctx, AV_LOG_ERROR, "Unknown or unsupported standard '%s'\n", s->standard);
681                 return ret;
682             }
683
684             if (v4l2_ioctl(s->fd, VIDIOC_S_STD, &standard.id) < 0) {
685                 ret = AVERROR(errno);
686                 av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_S_STD): %s\n", av_err2str(ret));
687                 return ret;
688             }
689         } else {
690             av_log(ctx, AV_LOG_WARNING,
691                    "This device does not support any standard\n");
692         }
693     }
694
695     /* get standard */
696     if (v4l2_ioctl(s->fd, VIDIOC_G_STD, &s->std_id) == 0) {
697         tpf = &standard.frameperiod;
698         for (i = 0; ; i++) {
699             standard.index = i;
700             if (v4l2_ioctl(s->fd, VIDIOC_ENUMSTD, &standard) < 0) {
701                 ret = AVERROR(errno);
702                 if (ret == AVERROR(EINVAL)
703 #ifdef ENODATA
704                     || ret == AVERROR(ENODATA)
705 #endif
706                 ) {
707                     tpf = &streamparm.parm.capture.timeperframe;
708                     break;
709                 }
710                 av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_ENUMSTD): %s\n", av_err2str(ret));
711                 return ret;
712             }
713             if (standard.id == s->std_id) {
714                 av_log(ctx, AV_LOG_DEBUG,
715                        "Current standard: %s, id: %"PRIx64", frameperiod: %d/%d\n",
716                        standard.name, (uint64_t)standard.id, tpf->numerator, tpf->denominator);
717                 break;
718             }
719         }
720     } else {
721         tpf = &streamparm.parm.capture.timeperframe;
722     }
723
724     streamparm.type = V4L2_BUF_TYPE_VIDEO_CAPTURE;
725     if (v4l2_ioctl(s->fd, VIDIOC_G_PARM, &streamparm) < 0) {
726         ret = AVERROR(errno);
727         av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_G_PARM): %s\n", av_err2str(ret));
728         return ret;
729     }
730
731     if (framerate_q.num && framerate_q.den) {
732         if (streamparm.parm.capture.capability & V4L2_CAP_TIMEPERFRAME) {
733             tpf = &streamparm.parm.capture.timeperframe;
734
735             av_log(ctx, AV_LOG_DEBUG, "Setting time per frame to %d/%d\n",
736                    framerate_q.den, framerate_q.num);
737             tpf->numerator   = framerate_q.den;
738             tpf->denominator = framerate_q.num;
739
740             if (v4l2_ioctl(s->fd, VIDIOC_S_PARM, &streamparm) < 0) {
741                 ret = AVERROR(errno);
742                 av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_S_PARM): %s\n",
743                        av_err2str(ret));
744                 return ret;
745             }
746
747             if (framerate_q.num != tpf->denominator ||
748                 framerate_q.den != tpf->numerator) {
749                 av_log(ctx, AV_LOG_INFO,
750                        "The driver changed the time per frame from "
751                        "%d/%d to %d/%d\n",
752                        framerate_q.den, framerate_q.num,
753                        tpf->numerator, tpf->denominator);
754             }
755         } else {
756             av_log(ctx, AV_LOG_WARNING,
757                    "The driver does not permit changing the time per frame\n");
758         }
759     }
760     if (tpf->denominator > 0 && tpf->numerator > 0) {
761         ctx->streams[0]->avg_frame_rate.num = tpf->denominator;
762         ctx->streams[0]->avg_frame_rate.den = tpf->numerator;
763         ctx->streams[0]->r_frame_rate = ctx->streams[0]->avg_frame_rate;
764     } else
765         av_log(ctx, AV_LOG_WARNING, "Time per frame unknown\n");
766
767     return 0;
768 }
769
770 static int device_try_init(AVFormatContext *ctx,
771                            enum AVPixelFormat pix_fmt,
772                            int *width,
773                            int *height,
774                            uint32_t *desired_format,
775                            enum AVCodecID *codec_id)
776 {
777     int ret, i;
778
779     *desired_format = ff_fmt_ff2v4l(pix_fmt, ctx->video_codec_id);
780
781     if (*desired_format) {
782         ret = device_init(ctx, width, height, *desired_format);
783         if (ret < 0) {
784             *desired_format = 0;
785             if (ret != AVERROR(EINVAL))
786                 return ret;
787         }
788     }
789
790     if (!*desired_format) {
791         for (i = 0; ff_fmt_conversion_table[i].codec_id != AV_CODEC_ID_NONE; i++) {
792             if (ctx->video_codec_id == AV_CODEC_ID_NONE ||
793                 ff_fmt_conversion_table[i].codec_id == ctx->video_codec_id) {
794                 av_log(ctx, AV_LOG_DEBUG, "Trying to set codec:%s pix_fmt:%s\n",
795                        avcodec_get_name(ff_fmt_conversion_table[i].codec_id),
796                        (char *)av_x_if_null(av_get_pix_fmt_name(ff_fmt_conversion_table[i].ff_fmt), "none"));
797
798                 *desired_format = ff_fmt_conversion_table[i].v4l2_fmt;
799                 ret = device_init(ctx, width, height, *desired_format);
800                 if (ret >= 0)
801                     break;
802                 else if (ret != AVERROR(EINVAL))
803                     return ret;
804                 *desired_format = 0;
805             }
806         }
807
808         if (*desired_format == 0) {
809             av_log(ctx, AV_LOG_ERROR, "Cannot find a proper format for "
810                    "codec '%s' (id %d), pixel format '%s' (id %d)\n",
811                    avcodec_get_name(ctx->video_codec_id), ctx->video_codec_id,
812                    (char *)av_x_if_null(av_get_pix_fmt_name(pix_fmt), "none"), pix_fmt);
813             ret = AVERROR(EINVAL);
814         }
815     }
816
817     *codec_id = ff_fmt_v4l2codec(*desired_format);
818     av_assert0(*codec_id != AV_CODEC_ID_NONE);
819     return ret;
820 }
821
822 static int v4l2_read_probe(AVProbeData *p)
823 {
824     if (av_strstart(p->filename, "/dev/video", NULL))
825         return AVPROBE_SCORE_MAX - 1;
826     return 0;
827 }
828
829 static int v4l2_read_header(AVFormatContext *ctx)
830 {
831     struct video_data *s = ctx->priv_data;
832     AVStream *st;
833     int res = 0;
834     uint32_t desired_format;
835     enum AVCodecID codec_id = AV_CODEC_ID_NONE;
836     enum AVPixelFormat pix_fmt = AV_PIX_FMT_NONE;
837     struct v4l2_input input = { 0 };
838
839     st = avformat_new_stream(ctx, NULL);
840     if (!st)
841         return AVERROR(ENOMEM);
842
843 #if CONFIG_LIBV4L2
844     /* silence libv4l2 logging. if fopen() fails v4l2_log_file will be NULL
845        and errors will get sent to stderr */
846     if (s->use_libv4l2)
847         v4l2_log_file = fopen("/dev/null", "w");
848 #endif
849
850     s->fd = device_open(ctx);
851     if (s->fd < 0)
852         return s->fd;
853
854     if (s->channel != -1) {
855         /* set video input */
856         av_log(ctx, AV_LOG_DEBUG, "Selecting input_channel: %d\n", s->channel);
857         if (v4l2_ioctl(s->fd, VIDIOC_S_INPUT, &s->channel) < 0) {
858             res = AVERROR(errno);
859             av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_S_INPUT): %s\n", av_err2str(res));
860             goto fail;
861         }
862     } else {
863         /* get current video input */
864         if (v4l2_ioctl(s->fd, VIDIOC_G_INPUT, &s->channel) < 0) {
865             res = AVERROR(errno);
866             av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_G_INPUT): %s\n", av_err2str(res));
867             goto fail;
868         }
869     }
870
871     /* enum input */
872     input.index = s->channel;
873     if (v4l2_ioctl(s->fd, VIDIOC_ENUMINPUT, &input) < 0) {
874         res = AVERROR(errno);
875         av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_ENUMINPUT): %s\n", av_err2str(res));
876         goto fail;
877     }
878     s->std_id = input.std;
879     av_log(ctx, AV_LOG_DEBUG, "Current input_channel: %d, input_name: %s, input_std: %"PRIx64"\n",
880            s->channel, input.name, (uint64_t)input.std);
881
882     if (s->list_format) {
883         list_formats(ctx, s->list_format);
884         res = AVERROR_EXIT;
885         goto fail;
886     }
887
888     if (s->list_standard) {
889         list_standards(ctx);
890         res = AVERROR_EXIT;
891         goto fail;
892     }
893
894     avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
895
896     if (s->pixel_format) {
897         AVCodec *codec = avcodec_find_decoder_by_name(s->pixel_format);
898
899         if (codec)
900             ctx->video_codec_id = codec->id;
901
902         pix_fmt = av_get_pix_fmt(s->pixel_format);
903
904         if (pix_fmt == AV_PIX_FMT_NONE && !codec) {
905             av_log(ctx, AV_LOG_ERROR, "No such input format: %s.\n",
906                    s->pixel_format);
907
908             res = AVERROR(EINVAL);
909             goto fail;
910         }
911     }
912
913     if (!s->width && !s->height) {
914         struct v4l2_format fmt = { .type = V4L2_BUF_TYPE_VIDEO_CAPTURE };
915
916         av_log(ctx, AV_LOG_VERBOSE,
917                "Querying the device for the current frame size\n");
918         if (v4l2_ioctl(s->fd, VIDIOC_G_FMT, &fmt) < 0) {
919             res = AVERROR(errno);
920             av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_G_FMT): %s\n",
921                    av_err2str(res));
922             goto fail;
923         }
924
925         s->width  = fmt.fmt.pix.width;
926         s->height = fmt.fmt.pix.height;
927         av_log(ctx, AV_LOG_VERBOSE,
928                "Setting frame size to %dx%d\n", s->width, s->height);
929     }
930
931     res = device_try_init(ctx, pix_fmt, &s->width, &s->height, &desired_format, &codec_id);
932     if (res < 0)
933         goto fail;
934
935     /* If no pixel_format was specified, the codec_id was not known up
936      * until now. Set video_codec_id in the context, as codec_id will
937      * not be available outside this function
938      */
939     if (codec_id != AV_CODEC_ID_NONE && ctx->video_codec_id == AV_CODEC_ID_NONE)
940         ctx->video_codec_id = codec_id;
941
942     if ((res = av_image_check_size(s->width, s->height, 0, ctx)) < 0)
943         goto fail;
944
945     s->pixelformat = desired_format;
946
947     if ((res = v4l2_set_parameters(ctx)) < 0)
948         goto fail;
949
950     st->codec->pix_fmt = ff_fmt_v4l2ff(desired_format, codec_id);
951     s->frame_size =
952         avpicture_get_size(st->codec->pix_fmt, s->width, s->height);
953
954     if ((res = mmap_init(ctx)) ||
955         (res = mmap_start(ctx)) < 0)
956             goto fail;
957
958     s->top_field_first = first_field(s);
959
960     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
961     st->codec->codec_id = codec_id;
962     if (codec_id == AV_CODEC_ID_RAWVIDEO)
963         st->codec->codec_tag =
964             avcodec_pix_fmt_to_codec_tag(st->codec->pix_fmt);
965     else if (codec_id == AV_CODEC_ID_H264) {
966         st->need_parsing = AVSTREAM_PARSE_HEADERS;
967     }
968     if (desired_format == V4L2_PIX_FMT_YVU420)
969         st->codec->codec_tag = MKTAG('Y', 'V', '1', '2');
970     else if (desired_format == V4L2_PIX_FMT_YVU410)
971         st->codec->codec_tag = MKTAG('Y', 'V', 'U', '9');
972     st->codec->width = s->width;
973     st->codec->height = s->height;
974     if (st->avg_frame_rate.den)
975         st->codec->bit_rate = s->frame_size * av_q2d(st->avg_frame_rate) * 8;
976
977     return 0;
978
979 fail:
980     v4l2_close(s->fd);
981     return res;
982 }
983
984 static int v4l2_read_packet(AVFormatContext *ctx, AVPacket *pkt)
985 {
986     struct video_data *s = ctx->priv_data;
987     AVFrame *frame = ctx->streams[0]->codec->coded_frame;
988     int res;
989
990     av_init_packet(pkt);
991     if ((res = mmap_read_frame(ctx, pkt)) < 0) {
992         return res;
993     }
994
995     if (frame && s->interlaced) {
996         frame->interlaced_frame = 1;
997         frame->top_field_first = s->top_field_first;
998     }
999
1000     return pkt->size;
1001 }
1002
1003 static int v4l2_read_close(AVFormatContext *ctx)
1004 {
1005     struct video_data *s = ctx->priv_data;
1006
1007     if (avpriv_atomic_int_get(&s->buffers_queued) != s->buffers)
1008         av_log(ctx, AV_LOG_WARNING, "Some buffers are still owned by the caller on "
1009                "close.\n");
1010
1011     mmap_close(s);
1012
1013     v4l2_close(s->fd);
1014     return 0;
1015 }
1016
1017 static int v4l2_is_v4l_dev(const char *name)
1018 {
1019     return !strncmp(name, "video", 5) ||
1020            !strncmp(name, "radio", 5) ||
1021            !strncmp(name, "vbi", 3) ||
1022            !strncmp(name, "v4l-subdev", 10);
1023 }
1024
1025 static int v4l2_get_device_list(AVFormatContext *ctx, AVDeviceInfoList *device_list)
1026 {
1027     struct video_data *s = ctx->priv_data;
1028     DIR *dir;
1029     struct dirent *entry;
1030     AVDeviceInfo *device = NULL;
1031     struct v4l2_capability cap;
1032     int ret = 0;
1033
1034     if (!device_list)
1035         return AVERROR(EINVAL);
1036
1037     dir = opendir("/dev");
1038     if (!dir) {
1039         ret = AVERROR(errno);
1040         av_log(ctx, AV_LOG_ERROR, "Couldn't open the directory: %s\n", av_err2str(ret));
1041         return ret;
1042     }
1043     while ((entry = readdir(dir))) {
1044         if (!v4l2_is_v4l_dev(entry->d_name))
1045             continue;
1046
1047         snprintf(ctx->filename, sizeof(ctx->filename), "/dev/%s", entry->d_name);
1048         if ((s->fd = device_open(ctx)) < 0)
1049             continue;
1050
1051         if (v4l2_ioctl(s->fd, VIDIOC_QUERYCAP, &cap) < 0) {
1052             ret = AVERROR(errno);
1053             av_log(ctx, AV_LOG_ERROR, "ioctl(VIDIOC_QUERYCAP): %s\n", av_err2str(ret));
1054             goto fail;
1055         }
1056
1057         device = av_mallocz(sizeof(AVDeviceInfo));
1058         if (!device) {
1059             ret = AVERROR(ENOMEM);
1060             goto fail;
1061         }
1062         device->device_name = av_strdup(ctx->filename);
1063         device->device_description = av_strdup(cap.card);
1064         if (!device->device_name || !device->device_description) {
1065             ret = AVERROR(ENOMEM);
1066             goto fail;
1067         }
1068
1069         if ((ret = av_dynarray_add_nofree(&device_list->devices,
1070                                           &device_list->nb_devices, device)) < 0)
1071             goto fail;
1072
1073         v4l2_close(s->fd);
1074         s->fd = -1;
1075         continue;
1076
1077       fail:
1078         if (device) {
1079             av_freep(&device->device_name);
1080             av_freep(&device->device_description);
1081             av_freep(&device);
1082         }
1083         if (s->fd >= 0)
1084             v4l2_close(s->fd);
1085         s->fd = -1;
1086         break;
1087     }
1088     closedir(dir);
1089     return ret;
1090 }
1091
1092 #define OFFSET(x) offsetof(struct video_data, x)
1093 #define DEC AV_OPT_FLAG_DECODING_PARAM
1094
1095 static const AVOption options[] = {
1096     { "standard",     "set TV standard, used only by analog frame grabber",       OFFSET(standard),     AV_OPT_TYPE_STRING, {.str = NULL }, 0, 0,       DEC },
1097     { "channel",      "set TV channel, used only by frame grabber",               OFFSET(channel),      AV_OPT_TYPE_INT,    {.i64 = -1 },  -1, INT_MAX, DEC },
1098     { "video_size",   "set frame size",                                           OFFSET(width),        AV_OPT_TYPE_IMAGE_SIZE, {.str = NULL},  0, 0,   DEC },
1099     { "pixel_format", "set preferred pixel format",                               OFFSET(pixel_format), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       DEC },
1100     { "input_format", "set preferred pixel format (for raw video) or codec name", OFFSET(pixel_format), AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       DEC },
1101     { "framerate",    "set frame rate",                                           OFFSET(framerate),    AV_OPT_TYPE_STRING, {.str = NULL},  0, 0,       DEC },
1102
1103     { "list_formats", "list available formats and exit",                          OFFSET(list_format),  AV_OPT_TYPE_INT,    {.i64 = 0 },  0, INT_MAX, DEC, "list_formats" },
1104     { "all",          "show all available formats",                               OFFSET(list_format),  AV_OPT_TYPE_CONST,  {.i64 = V4L_ALLFORMATS  },    0, INT_MAX, DEC, "list_formats" },
1105     { "raw",          "show only non-compressed formats",                         OFFSET(list_format),  AV_OPT_TYPE_CONST,  {.i64 = V4L_RAWFORMATS  },    0, INT_MAX, DEC, "list_formats" },
1106     { "compressed",   "show only compressed formats",                             OFFSET(list_format),  AV_OPT_TYPE_CONST,  {.i64 = V4L_COMPFORMATS },    0, INT_MAX, DEC, "list_formats" },
1107
1108     { "list_standards", "list supported standards and exit",                      OFFSET(list_standard), AV_OPT_TYPE_INT,   {.i64 = 0 },  0, 1, DEC, "list_standards" },
1109     { "all",            "show all supported standards",                           OFFSET(list_standard), AV_OPT_TYPE_CONST, {.i64 = 1 },  0, 0, DEC, "list_standards" },
1110
1111     { "timestamps",   "set type of timestamps for grabbed frames",                OFFSET(ts_mode),      AV_OPT_TYPE_INT,    {.i64 = 0 }, 0, 2, DEC, "timestamps" },
1112     { "ts",           "set type of timestamps for grabbed frames",                OFFSET(ts_mode),      AV_OPT_TYPE_INT,    {.i64 = 0 }, 0, 2, DEC, "timestamps" },
1113     { "default",      "use timestamps from the kernel",                           OFFSET(ts_mode),      AV_OPT_TYPE_CONST,  {.i64 = V4L_TS_DEFAULT  }, 0, 2, DEC, "timestamps" },
1114     { "abs",          "use absolute timestamps (wall clock)",                     OFFSET(ts_mode),      AV_OPT_TYPE_CONST,  {.i64 = V4L_TS_ABS      }, 0, 2, DEC, "timestamps" },
1115     { "mono2abs",     "force conversion from monotonic to absolute timestamps",   OFFSET(ts_mode),      AV_OPT_TYPE_CONST,  {.i64 = V4L_TS_MONO2ABS }, 0, 2, DEC, "timestamps" },
1116     { "use_libv4l2",  "use libv4l2 (v4l-utils) conversion functions",             OFFSET(use_libv4l2),  AV_OPT_TYPE_INT,    {.i64 = 0}, 0, 1, DEC },
1117     { NULL },
1118 };
1119
1120 static const AVClass v4l2_class = {
1121     .class_name = "V4L2 indev",
1122     .item_name  = av_default_item_name,
1123     .option     = options,
1124     .version    = LIBAVUTIL_VERSION_INT,
1125     .category   = AV_CLASS_CATEGORY_DEVICE_VIDEO_INPUT,
1126 };
1127
1128 AVInputFormat ff_v4l2_demuxer = {
1129     .name           = "video4linux2,v4l2",
1130     .long_name      = NULL_IF_CONFIG_SMALL("Video4Linux2 device grab"),
1131     .priv_data_size = sizeof(struct video_data),
1132     .read_probe     = v4l2_read_probe,
1133     .read_header    = v4l2_read_header,
1134     .read_packet    = v4l2_read_packet,
1135     .read_close     = v4l2_read_close,
1136     .get_device_list = v4l2_get_device_list,
1137     .flags          = AVFMT_NOFILE,
1138     .priv_class     = &v4l2_class,
1139 };