h264_metadata: Add option to delete filler data
[libav.git] / libavdevice / fbdev.c
CommitLineData
c6f95144
SS
1/*
2 * Copyright (c) 2011 Stefano Sabatini
3 * Copyright (c) 2009 Giliard B. de Freitas <giliarde@gmail.com>
4 * Copyright (C) 2002 Gunnar Monell <gmo@linux.nu>
5 *
6 * This file is part of Libav.
7 *
8 * Libav is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * Libav is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with Libav; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 */
22
23/**
24 * @file
25 * Linux framebuffer input device,
26 * inspired by code from fbgrab.c by Gunnar Monell.
ad4cd0c2 27 * @see http://linux-fbdev.sourceforge.net/
c6f95144
SS
28 */
29
c6f95144
SS
30#include <unistd.h>
31#include <fcntl.h>
32#include <sys/ioctl.h>
c6f95144
SS
33#include <sys/mman.h>
34#include <time.h>
35#include <linux/fb.h>
36
71bf6b41 37#include "libavutil/internal.h"
1556186a 38#include "libavutil/log.h"
c6f95144 39#include "libavutil/mem.h"
1556186a 40#include "libavutil/opt.h"
c4ef6a3e 41#include "libavutil/time.h"
1556186a 42#include "libavutil/parseutils.h"
c6f95144
SS
43#include "libavutil/pixdesc.h"
44#include "libavformat/avformat.h"
c3f9ebf7 45#include "libavformat/internal.h"
c6f95144
SS
46
47struct rgb_pixfmt_map_entry {
48 int bits_per_pixel;
49 int red_offset, green_offset, blue_offset, alpha_offset;
716d413c 50 enum AVPixelFormat pixfmt;
c6f95144
SS
51};
52
53static struct rgb_pixfmt_map_entry rgb_pixfmt_map[] = {
54 // bpp, red_offset, green_offset, blue_offset, alpha_offset, pixfmt
716d413c
AK
55 { 32, 0, 8, 16, 24, AV_PIX_FMT_RGBA },
56 { 32, 16, 8, 0, 24, AV_PIX_FMT_BGRA },
57 { 32, 8, 16, 24, 0, AV_PIX_FMT_ARGB },
58 { 32, 3, 2, 8, 0, AV_PIX_FMT_ABGR },
59 { 24, 0, 8, 16, 0, AV_PIX_FMT_RGB24 },
60 { 24, 16, 8, 0, 0, AV_PIX_FMT_BGR24 },
87f98a2b 61 { 16, 11, 5, 0, 0, AV_PIX_FMT_RGB565 },
c6f95144
SS
62};
63
716d413c 64static enum AVPixelFormat get_pixfmt_from_fb_varinfo(struct fb_var_screeninfo *varinfo)
c6f95144
SS
65{
66 int i;
67
68 for (i = 0; i < FF_ARRAY_ELEMS(rgb_pixfmt_map); i++) {
69 struct rgb_pixfmt_map_entry *entry = &rgb_pixfmt_map[i];
70 if (entry->bits_per_pixel == varinfo->bits_per_pixel &&
71 entry->red_offset == varinfo->red.offset &&
72 entry->green_offset == varinfo->green.offset &&
73 entry->blue_offset == varinfo->blue.offset)
74 return entry->pixfmt;
75 }
76
716d413c 77 return AV_PIX_FMT_NONE;
c6f95144
SS
78}
79
c0de9159 80typedef struct FBDevContext {
1556186a 81 AVClass *class; ///< class for private options
c6f95144 82 int frame_size; ///< size in bytes of a grabbed frame
a5351720 83 AVRational framerate_q; ///< framerate
1556186a 84 char *framerate; ///< framerate string set by a private option
c6f95144
SS
85 int64_t time_frame; ///< time for the next frame to output (in 1/1000000 units)
86
87 int fd; ///< framebuffer device file descriptor
e83c2dde 88 int width, height; ///< assumed frame resolution
c6f95144
SS
89 int frame_linesize; ///< linesize of the output frame, it is assumed to be constant
90 int bytes_per_pixel;
91
92 struct fb_var_screeninfo varinfo; ///< variable info;
93 struct fb_fix_screeninfo fixinfo; ///< fixed info;
94
95 uint8_t *data; ///< framebuffer data
96} FBDevContext;
97
3dde147f 98static av_cold int fbdev_read_header(AVFormatContext *avctx)
c6f95144
SS
99{
100 FBDevContext *fbdev = avctx->priv_data;
101 AVStream *st = NULL;
716d413c 102 enum AVPixelFormat pix_fmt;
c6f95144 103 int ret, flags = O_RDONLY;
043ea6f7 104 char errbuf[128];
c6f95144 105
a5351720 106 ret = av_parse_video_rate(&fbdev->framerate_q, fbdev->framerate);
1556186a 107 if (ret < 0) {
41b68dce 108 av_log(avctx, AV_LOG_ERROR, "Could not parse framerate '%s'.\n", fbdev->framerate);
1556186a
AK
109 return ret;
110 }
1556186a 111
3b3bbdd3 112 if (!(st = avformat_new_stream(avctx, NULL)))
c6f95144 113 return AVERROR(ENOMEM);
c3f9ebf7 114 avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in microseconds */
c6f95144 115
c6f95144
SS
116 /* NONBLOCK is ignored by the fbdev driver, only set for consistency */
117 if (avctx->flags & AVFMT_FLAG_NONBLOCK)
118 flags |= O_NONBLOCK;
119
71bf6b41 120 if ((fbdev->fd = avpriv_open(avctx->filename, flags)) == -1) {
c6f95144 121 ret = AVERROR(errno);
043ea6f7 122 av_strerror(ret, errbuf, sizeof(errbuf));
c6f95144
SS
123 av_log(avctx, AV_LOG_ERROR,
124 "Could not open framebuffer device '%s': %s\n",
043ea6f7 125 avctx->filename, errbuf);
c6f95144
SS
126 return ret;
127 }
128
129 if (ioctl(fbdev->fd, FBIOGET_VSCREENINFO, &fbdev->varinfo) < 0) {
130 ret = AVERROR(errno);
043ea6f7 131 av_strerror(ret, errbuf, sizeof(errbuf));
c6f95144 132 av_log(avctx, AV_LOG_ERROR,
043ea6f7 133 "FBIOGET_VSCREENINFO: %s\n", errbuf);
c6f95144
SS
134 goto fail;
135 }
136
137 if (ioctl(fbdev->fd, FBIOGET_FSCREENINFO, &fbdev->fixinfo) < 0) {
138 ret = AVERROR(errno);
043ea6f7 139 av_strerror(ret, errbuf, sizeof(errbuf));
c6f95144 140 av_log(avctx, AV_LOG_ERROR,
043ea6f7 141 "FBIOGET_FSCREENINFO: %s\n", errbuf);
c6f95144
SS
142 goto fail;
143 }
144
145 pix_fmt = get_pixfmt_from_fb_varinfo(&fbdev->varinfo);
716d413c 146 if (pix_fmt == AV_PIX_FMT_NONE) {
c6f95144
SS
147 ret = AVERROR(EINVAL);
148 av_log(avctx, AV_LOG_ERROR,
149 "Framebuffer pixel format not supported.\n");
150 goto fail;
151 }
152
153 fbdev->width = fbdev->varinfo.xres;
e83c2dde 154 fbdev->height = fbdev->varinfo.yres;
c6f95144
SS
155 fbdev->bytes_per_pixel = (fbdev->varinfo.bits_per_pixel + 7) >> 3;
156 fbdev->frame_linesize = fbdev->width * fbdev->bytes_per_pixel;
e83c2dde 157 fbdev->frame_size = fbdev->frame_linesize * fbdev->height;
c6f95144
SS
158 fbdev->time_frame = AV_NOPTS_VALUE;
159 fbdev->data = mmap(NULL, fbdev->fixinfo.smem_len, PROT_READ, MAP_SHARED, fbdev->fd, 0);
160 if (fbdev->data == MAP_FAILED) {
161 ret = AVERROR(errno);
043ea6f7
LB
162 av_strerror(ret, errbuf, sizeof(errbuf));
163 av_log(avctx, AV_LOG_ERROR, "Error in mmap(): %s\n", errbuf);
c6f95144
SS
164 goto fail;
165 }
166
9200514a
AK
167 st->codecpar->codec_type = AVMEDIA_TYPE_VIDEO;
168 st->codecpar->codec_id = AV_CODEC_ID_RAWVIDEO;
169 st->codecpar->width = fbdev->width;
170 st->codecpar->height = fbdev->height;
171 st->codecpar->format = pix_fmt;
172 st->codecpar->bit_rate =
e83c2dde 173 fbdev->width * fbdev->height * fbdev->bytes_per_pixel * av_q2d(fbdev->framerate_q) * 8;
9200514a 174 st->avg_frame_rate = fbdev->framerate_q;
c6f95144
SS
175
176 av_log(avctx, AV_LOG_INFO,
1556186a 177 "w:%d h:%d bpp:%d pixfmt:%s fps:%d/%d bit_rate:%d\n",
e83c2dde 178 fbdev->width, fbdev->height, fbdev->varinfo.bits_per_pixel,
22c8cbc0 179 av_get_pix_fmt_name(pix_fmt),
a5351720 180 fbdev->framerate_q.num, fbdev->framerate_q.den,
9200514a 181 st->codecpar->bit_rate);
c6f95144
SS
182 return 0;
183
184fail:
185 close(fbdev->fd);
186 return ret;
187}
188
189static int fbdev_read_packet(AVFormatContext *avctx, AVPacket *pkt)
190{
191 FBDevContext *fbdev = avctx->priv_data;
192 int64_t curtime, delay;
193 struct timespec ts;
194 int i, ret;
195 uint8_t *pin, *pout;
196
197 if (fbdev->time_frame == AV_NOPTS_VALUE)
198 fbdev->time_frame = av_gettime();
199
200 /* wait based on the frame rate */
201 curtime = av_gettime();
202 delay = fbdev->time_frame - curtime;
1a3eb042 203 av_log(avctx, AV_LOG_TRACE,
c6f95144
SS
204 "time_frame:%"PRId64" curtime:%"PRId64" delay:%"PRId64"\n",
205 fbdev->time_frame, curtime, delay);
206 if (delay > 0) {
207 if (avctx->flags & AVFMT_FLAG_NONBLOCK)
208 return AVERROR(EAGAIN);
209 ts.tv_sec = delay / 1000000;
210 ts.tv_nsec = (delay % 1000000) * 1000;
211 while (nanosleep(&ts, &ts) < 0 && errno == EINTR);
212 }
213 /* compute the time of the next frame */
a5351720 214 fbdev->time_frame += INT64_C(1000000) / av_q2d(fbdev->framerate_q);
c6f95144
SS
215
216 if ((ret = av_new_packet(pkt, fbdev->frame_size)) < 0)
217 return ret;
218
219 /* refresh fbdev->varinfo, visible data position may change at each call */
043ea6f7
LB
220 if (ioctl(fbdev->fd, FBIOGET_VSCREENINFO, &fbdev->varinfo) < 0) {
221 char errbuf[128];
222 av_strerror(AVERROR(errno), errbuf, sizeof(errbuf));
c6f95144 223 av_log(avctx, AV_LOG_WARNING,
043ea6f7
LB
224 "Error refreshing variable info: %s\n", errbuf);
225 }
c6f95144
SS
226
227 pkt->pts = curtime;
228
229 /* compute visible data offset */
230 pin = fbdev->data + fbdev->bytes_per_pixel * fbdev->varinfo.xoffset +
231 fbdev->varinfo.yoffset * fbdev->fixinfo.line_length;
232 pout = pkt->data;
233
234 // TODO it'd be nice if the lines were aligned
e83c2dde 235 for (i = 0; i < fbdev->height; i++) {
c6f95144
SS
236 memcpy(pout, pin, fbdev->frame_linesize);
237 pin += fbdev->fixinfo.line_length;
238 pout += fbdev->frame_linesize;
239 }
240
241 return fbdev->frame_size;
242}
243
3dde147f 244static av_cold int fbdev_read_close(AVFormatContext *avctx)
c6f95144
SS
245{
246 FBDevContext *fbdev = avctx->priv_data;
247
248 munmap(fbdev->data, fbdev->frame_size);
249 close(fbdev->fd);
250
251 return 0;
252}
253
1556186a
AK
254#define OFFSET(x) offsetof(FBDevContext, x)
255#define DEC AV_OPT_FLAG_DECODING_PARAM
256static const AVOption options[] = {
145f741e 257 { "framerate","", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0, DEC },
1556186a
AK
258 { NULL },
259};
260
261static const AVClass fbdev_class = {
262 .class_name = "fbdev indev",
263 .item_name = av_default_item_name,
264 .option = options,
265 .version = LIBAVUTIL_VERSION_INT,
266};
267
c6f95144
SS
268AVInputFormat ff_fbdev_demuxer = {
269 .name = "fbdev",
270 .long_name = NULL_IF_CONFIG_SMALL("Linux framebuffer"),
271 .priv_data_size = sizeof(FBDevContext),
272 .read_header = fbdev_read_header,
273 .read_packet = fbdev_read_packet,
274 .read_close = fbdev_read_close,
275 .flags = AVFMT_NOFILE,
1556186a 276 .priv_class = &fbdev_class,
c6f95144 277};