lavdevice: mark v4l for removal on next major bump.
[ffmpeg.git] / libavdevice / v4l.c
1 /*
2  * Linux video grab interface
3  * Copyright (c) 2000,2001 Fabrice Bellard
4  *
5  * This file is part of Libav.
6  *
7  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21
22 #if FF_API_V4L
23
24 #undef __STRICT_ANSI__ //workaround due to broken kernel headers
25 #include "config.h"
26 #include "libavutil/rational.h"
27 #include "libavutil/imgutils.h"
28 #include "libavutil/log.h"
29 #include "libavutil/opt.h"
30 #include "libavformat/avformat.h"
31 #include "libavcodec/dsputil.h"
32 #include <unistd.h>
33 #include <fcntl.h>
34 #include <sys/ioctl.h>
35 #include <sys/mman.h>
36 #include <sys/time.h>
37 #define _LINUX_TIME_H 1
38 #include <linux/videodev.h>
39 #include <time.h>
40 #include <strings.h>
41
42 typedef struct {
43     AVClass *class;
44     int fd;
45     int frame_format; /* see VIDEO_PALETTE_xxx */
46     int use_mmap;
47     AVRational time_base;
48     int64_t time_frame;
49     int frame_size;
50     struct video_capability video_cap;
51     struct video_audio audio_saved;
52     struct video_window video_win;
53     uint8_t *video_buf;
54     struct video_mbuf gb_buffers;
55     struct video_mmap gb_buf;
56     int gb_frame;
57     int standard;
58 } VideoData;
59
60 static const struct {
61     int palette;
62     int depth;
63     enum PixelFormat pix_fmt;
64 } video_formats [] = {
65     {.palette = VIDEO_PALETTE_YUV420P, .depth = 12, .pix_fmt = PIX_FMT_YUV420P },
66     {.palette = VIDEO_PALETTE_YUV422,  .depth = 16, .pix_fmt = PIX_FMT_YUYV422 },
67     {.palette = VIDEO_PALETTE_UYVY,    .depth = 16, .pix_fmt = PIX_FMT_UYVY422 },
68     {.palette = VIDEO_PALETTE_YUYV,    .depth = 16, .pix_fmt = PIX_FMT_YUYV422 },
69     /* NOTE: v4l uses BGR24, not RGB24 */
70     {.palette = VIDEO_PALETTE_RGB24,   .depth = 24, .pix_fmt = PIX_FMT_BGR24   },
71     {.palette = VIDEO_PALETTE_RGB565,  .depth = 16, .pix_fmt = PIX_FMT_BGR565  },
72     {.palette = VIDEO_PALETTE_GREY,    .depth = 8,  .pix_fmt = PIX_FMT_GRAY8   },
73 };
74
75
76 static int grab_read_header(AVFormatContext *s1, AVFormatParameters *ap)
77 {
78     VideoData *s = s1->priv_data;
79     AVStream *st;
80     int video_fd;
81     int desired_palette, desired_depth;
82     struct video_tuner tuner;
83     struct video_audio audio;
84     struct video_picture pict;
85     int j;
86     int vformat_num = FF_ARRAY_ELEMS(video_formats);
87
88     av_log(s1, AV_LOG_WARNING, "V4L input device is deprecated and will be removed in the next release.");
89
90     if (ap->time_base.den <= 0) {
91         av_log(s1, AV_LOG_ERROR, "Wrong time base (%d)\n", ap->time_base.den);
92         return -1;
93     }
94     s->time_base = ap->time_base;
95
96     s->video_win.width = ap->width;
97     s->video_win.height = ap->height;
98
99     st = av_new_stream(s1, 0);
100     if (!st)
101         return AVERROR(ENOMEM);
102     av_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in us */
103
104     video_fd = open(s1->filename, O_RDWR);
105     if (video_fd < 0) {
106         av_log(s1, AV_LOG_ERROR, "%s: %s\n", s1->filename, strerror(errno));
107         goto fail;
108     }
109
110     if (ioctl(video_fd, VIDIOCGCAP, &s->video_cap) < 0) {
111         av_log(s1, AV_LOG_ERROR, "VIDIOCGCAP: %s\n", strerror(errno));
112         goto fail;
113     }
114
115     if (!(s->video_cap.type & VID_TYPE_CAPTURE)) {
116         av_log(s1, AV_LOG_ERROR, "Fatal: grab device does not handle capture\n");
117         goto fail;
118     }
119
120     /* no values set, autodetect them */
121     if (s->video_win.width <= 0 || s->video_win.height <= 0) {
122         if (ioctl(video_fd, VIDIOCGWIN, &s->video_win, sizeof(s->video_win)) < 0) {
123             av_log(s1, AV_LOG_ERROR, "VIDIOCGWIN: %s\n", strerror(errno));
124             goto fail;
125         }
126     }
127
128     if(av_image_check_size(s->video_win.width, s->video_win.height, 0, s1) < 0)
129         return -1;
130
131     desired_palette = -1;
132     desired_depth = -1;
133     for (j = 0; j < vformat_num; j++) {
134         if (ap->pix_fmt == video_formats[j].pix_fmt) {
135             desired_palette = video_formats[j].palette;
136             desired_depth = video_formats[j].depth;
137             break;
138         }
139     }
140
141     /* set tv standard */
142     if (!ioctl(video_fd, VIDIOCGTUNER, &tuner)) {
143 #if FF_API_FORMAT_PARAMETERS
144         if (ap->standard) {
145             if (!strcasecmp(ap->standard, "pal"))
146                 s->standard = VIDEO_MODE_PAL;
147             else if (!strcasecmp(ap->standard, "secam"))
148                 s->standard = VIDEO_MODE_SECAM;
149             else
150                 s->standard = VIDEO_MODE_NTSC;
151         }
152 #endif
153         tuner.mode = s->standard;
154         ioctl(video_fd, VIDIOCSTUNER, &tuner);
155     }
156
157     /* unmute audio */
158     audio.audio = 0;
159     ioctl(video_fd, VIDIOCGAUDIO, &audio);
160     memcpy(&s->audio_saved, &audio, sizeof(audio));
161     audio.flags &= ~VIDEO_AUDIO_MUTE;
162     ioctl(video_fd, VIDIOCSAUDIO, &audio);
163
164     ioctl(video_fd, VIDIOCGPICT, &pict);
165     av_dlog(s1, "v4l: colour=%d hue=%d brightness=%d constrast=%d whiteness=%d\n",
166             pict.colour, pict.hue, pict.brightness, pict.contrast, pict.whiteness);
167     /* try to choose a suitable video format */
168     pict.palette = desired_palette;
169     pict.depth= desired_depth;
170     if (desired_palette == -1 || ioctl(video_fd, VIDIOCSPICT, &pict) < 0) {
171         for (j = 0; j < vformat_num; j++) {
172             pict.palette = video_formats[j].palette;
173             pict.depth = video_formats[j].depth;
174             if (-1 != ioctl(video_fd, VIDIOCSPICT, &pict))
175                 break;
176         }
177         if (j >= vformat_num)
178             goto fail1;
179     }
180
181     if (ioctl(video_fd, VIDIOCGMBUF, &s->gb_buffers) < 0) {
182         /* try to use read based access */
183         int val;
184
185         s->video_win.x = 0;
186         s->video_win.y = 0;
187         s->video_win.chromakey = -1;
188         s->video_win.flags = 0;
189
190         if (ioctl(video_fd, VIDIOCSWIN, s->video_win) < 0) {
191             av_log(s1, AV_LOG_ERROR, "VIDIOCSWIN: %s\n", strerror(errno));
192             goto fail;
193         }
194
195         s->frame_format = pict.palette;
196
197         val = 1;
198         if (ioctl(video_fd, VIDIOCCAPTURE, &val) < 0) {
199             av_log(s1, AV_LOG_ERROR, "VIDIOCCAPTURE: %s\n", strerror(errno));
200             goto fail;
201         }
202
203         s->time_frame = av_gettime() * s->time_base.den / s->time_base.num;
204         s->use_mmap = 0;
205     } else {
206         s->video_buf = mmap(0, s->gb_buffers.size, PROT_READ|PROT_WRITE, MAP_SHARED, video_fd, 0);
207         if ((unsigned char*)-1 == s->video_buf) {
208             s->video_buf = mmap(0, s->gb_buffers.size, PROT_READ|PROT_WRITE, MAP_PRIVATE, video_fd, 0);
209             if ((unsigned char*)-1 == s->video_buf) {
210                 av_log(s1, AV_LOG_ERROR, "mmap: %s\n", strerror(errno));
211                 goto fail;
212             }
213         }
214         s->gb_frame = 0;
215         s->time_frame = av_gettime() * s->time_base.den / s->time_base.num;
216
217         /* start to grab the first frame */
218         s->gb_buf.frame = s->gb_frame % s->gb_buffers.frames;
219         s->gb_buf.height = s->video_win.height;
220         s->gb_buf.width = s->video_win.width;
221         s->gb_buf.format = pict.palette;
222
223         if (ioctl(video_fd, VIDIOCMCAPTURE, &s->gb_buf) < 0) {
224             if (errno != EAGAIN) {
225             fail1:
226                 av_log(s1, AV_LOG_ERROR, "VIDIOCMCAPTURE: %s\n", strerror(errno));
227             } else {
228                 av_log(s1, AV_LOG_ERROR, "Fatal: grab device does not receive any video signal\n");
229             }
230             goto fail;
231         }
232         for (j = 1; j < s->gb_buffers.frames; j++) {
233           s->gb_buf.frame = j;
234           ioctl(video_fd, VIDIOCMCAPTURE, &s->gb_buf);
235         }
236         s->frame_format = s->gb_buf.format;
237         s->use_mmap = 1;
238     }
239
240     for (j = 0; j < vformat_num; j++) {
241         if (s->frame_format == video_formats[j].palette) {
242             s->frame_size = s->video_win.width * s->video_win.height * video_formats[j].depth / 8;
243             st->codec->pix_fmt = video_formats[j].pix_fmt;
244             break;
245         }
246     }
247
248     if (j >= vformat_num)
249         goto fail;
250
251     s->fd = video_fd;
252
253     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
254     st->codec->codec_id = CODEC_ID_RAWVIDEO;
255     st->codec->width = s->video_win.width;
256     st->codec->height = s->video_win.height;
257     st->codec->time_base = s->time_base;
258     st->codec->bit_rate = s->frame_size * 1/av_q2d(st->codec->time_base) * 8;
259
260     return 0;
261  fail:
262     if (video_fd >= 0)
263         close(video_fd);
264     return AVERROR(EIO);
265 }
266
267 static int v4l_mm_read_picture(VideoData *s, uint8_t *buf)
268 {
269     uint8_t *ptr;
270
271     while (ioctl(s->fd, VIDIOCSYNC, &s->gb_frame) < 0 &&
272            (errno == EAGAIN || errno == EINTR));
273
274     ptr = s->video_buf + s->gb_buffers.offsets[s->gb_frame];
275     memcpy(buf, ptr, s->frame_size);
276
277     /* Setup to capture the next frame */
278     s->gb_buf.frame = s->gb_frame;
279     if (ioctl(s->fd, VIDIOCMCAPTURE, &s->gb_buf) < 0) {
280         if (errno == EAGAIN)
281             av_log(NULL, AV_LOG_ERROR, "Cannot Sync\n");
282         else
283             av_log(NULL, AV_LOG_ERROR, "VIDIOCMCAPTURE: %s\n", strerror(errno));
284         return AVERROR(EIO);
285     }
286
287     /* This is now the grabbing frame */
288     s->gb_frame = (s->gb_frame + 1) % s->gb_buffers.frames;
289
290     return s->frame_size;
291 }
292
293 static int grab_read_packet(AVFormatContext *s1, AVPacket *pkt)
294 {
295     VideoData *s = s1->priv_data;
296     int64_t curtime, delay;
297     struct timespec ts;
298
299     /* Calculate the time of the next frame */
300     s->time_frame += INT64_C(1000000);
301
302     /* wait based on the frame rate */
303     for(;;) {
304         curtime = av_gettime();
305         delay = s->time_frame * s->time_base.num / s->time_base.den - curtime;
306         if (delay <= 0) {
307             if (delay < INT64_C(-1000000) * s->time_base.num / s->time_base.den) {
308                 /* printf("grabbing is %d frames late (dropping)\n", (int) -(delay / 16666)); */
309                 s->time_frame += INT64_C(1000000);
310             }
311             break;
312         }
313         ts.tv_sec = delay / 1000000;
314         ts.tv_nsec = (delay % 1000000) * 1000;
315         nanosleep(&ts, NULL);
316     }
317
318     if (av_new_packet(pkt, s->frame_size) < 0)
319         return AVERROR(EIO);
320
321     pkt->pts = curtime;
322
323     /* read one frame */
324     if (s->use_mmap) {
325         return v4l_mm_read_picture(s, pkt->data);
326     } else {
327         if (read(s->fd, pkt->data, pkt->size) != pkt->size)
328             return AVERROR(EIO);
329         return s->frame_size;
330     }
331 }
332
333 static int grab_read_close(AVFormatContext *s1)
334 {
335     VideoData *s = s1->priv_data;
336
337     if (s->use_mmap)
338         munmap(s->video_buf, s->gb_buffers.size);
339
340     /* mute audio. we must force it because the BTTV driver does not
341        return its state correctly */
342     s->audio_saved.flags |= VIDEO_AUDIO_MUTE;
343     ioctl(s->fd, VIDIOCSAUDIO, &s->audio_saved);
344
345     close(s->fd);
346     return 0;
347 }
348
349 static const AVOption options[] = {
350     { "standard", "", offsetof(VideoData, standard), FF_OPT_TYPE_INT, {.dbl = VIDEO_MODE_NTSC}, VIDEO_MODE_PAL, VIDEO_MODE_NTSC, AV_OPT_FLAG_DECODING_PARAM, "standard" },
351     { "PAL",   "", 0, FF_OPT_TYPE_CONST, {.dbl = VIDEO_MODE_PAL},   0, 0, AV_OPT_FLAG_DECODING_PARAM, "standard" },
352     { "SECAM", "", 0, FF_OPT_TYPE_CONST, {.dbl = VIDEO_MODE_SECAM}, 0, 0, AV_OPT_FLAG_DECODING_PARAM, "standard" },
353     { "NTSC",  "", 0, FF_OPT_TYPE_CONST, {.dbl = VIDEO_MODE_NTSC},  0, 0, AV_OPT_FLAG_DECODING_PARAM, "standard" },
354     { NULL },
355 };
356
357 static const AVClass v4l_class = {
358     .class_name = "V4L indev",
359     .item_name  = av_default_item_name,
360     .option     = options,
361     .version    = LIBAVUTIL_VERSION_INT,
362 };
363
364 AVInputFormat ff_v4l_demuxer = {
365     "video4linux",
366     NULL_IF_CONFIG_SMALL("Video4Linux device grab"),
367     sizeof(VideoData),
368     NULL,
369     grab_read_header,
370     grab_read_packet,
371     grab_read_close,
372     .flags = AVFMT_NOFILE,
373     .priv_class = &v4l_class,
374 };
375 #endif  /* FF_API_V4L */