Libav
fbdev.c
Go to the documentation of this file.
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 
30 #include <unistd.h>
31 #include <fcntl.h>
32 #include <sys/ioctl.h>
33 #include <sys/mman.h>
34 #include <time.h>
35 #include <linux/fb.h>
36 
37 #include "libavutil/internal.h"
38 #include "libavutil/log.h"
39 #include "libavutil/mem.h"
40 #include "libavutil/opt.h"
41 #include "libavutil/time.h"
42 #include "libavutil/parseutils.h"
43 #include "libavutil/pixdesc.h"
44 #include "libavformat/avformat.h"
45 #include "libavformat/internal.h"
46 
51 };
52 
54  // bpp, red_offset, green_offset, blue_offset, alpha_offset, pixfmt
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 },
61 };
62 
63 static enum AVPixelFormat get_pixfmt_from_fb_varinfo(struct fb_var_screeninfo *varinfo)
64 {
65  int i;
66 
67  for (i = 0; i < FF_ARRAY_ELEMS(rgb_pixfmt_map); i++) {
68  struct rgb_pixfmt_map_entry *entry = &rgb_pixfmt_map[i];
69  if (entry->bits_per_pixel == varinfo->bits_per_pixel &&
70  entry->red_offset == varinfo->red.offset &&
71  entry->green_offset == varinfo->green.offset &&
72  entry->blue_offset == varinfo->blue.offset)
73  return entry->pixfmt;
74  }
75 
76  return AV_PIX_FMT_NONE;
77 }
78 
79 typedef struct FBDevContext {
80  AVClass *class;
81  int frame_size;
83  char *framerate;
84  int64_t time_frame;
85 
86  int fd;
87  int width, height;
90 
91  struct fb_var_screeninfo varinfo;
92  struct fb_fix_screeninfo fixinfo;
93 
95 } FBDevContext;
96 
98 {
99  FBDevContext *fbdev = avctx->priv_data;
100  AVStream *st = NULL;
101  enum AVPixelFormat pix_fmt;
102  int ret, flags = O_RDONLY;
103 
104  ret = av_parse_video_rate(&fbdev->framerate_q, fbdev->framerate);
105  if (ret < 0) {
106  av_log(avctx, AV_LOG_ERROR, "Could not parse framerate '%s'.\n", fbdev->framerate);
107  return ret;
108  }
109 
110  if (!(st = avformat_new_stream(avctx, NULL)))
111  return AVERROR(ENOMEM);
112  avpriv_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in microseconds */
113 
114  /* NONBLOCK is ignored by the fbdev driver, only set for consistency */
115  if (avctx->flags & AVFMT_FLAG_NONBLOCK)
116  flags |= O_NONBLOCK;
117 
118  if ((fbdev->fd = avpriv_open(avctx->filename, flags)) == -1) {
119  ret = AVERROR(errno);
120  av_log(avctx, AV_LOG_ERROR,
121  "Could not open framebuffer device '%s': %s\n",
122  avctx->filename, strerror(ret));
123  return ret;
124  }
125 
126  if (ioctl(fbdev->fd, FBIOGET_VSCREENINFO, &fbdev->varinfo) < 0) {
127  ret = AVERROR(errno);
128  av_log(avctx, AV_LOG_ERROR,
129  "FBIOGET_VSCREENINFO: %s\n", strerror(errno));
130  goto fail;
131  }
132 
133  if (ioctl(fbdev->fd, FBIOGET_FSCREENINFO, &fbdev->fixinfo) < 0) {
134  ret = AVERROR(errno);
135  av_log(avctx, AV_LOG_ERROR,
136  "FBIOGET_FSCREENINFO: %s\n", strerror(errno));
137  goto fail;
138  }
139 
140  pix_fmt = get_pixfmt_from_fb_varinfo(&fbdev->varinfo);
141  if (pix_fmt == AV_PIX_FMT_NONE) {
142  ret = AVERROR(EINVAL);
143  av_log(avctx, AV_LOG_ERROR,
144  "Framebuffer pixel format not supported.\n");
145  goto fail;
146  }
147 
148  fbdev->width = fbdev->varinfo.xres;
149  fbdev->height = fbdev->varinfo.yres;
150  fbdev->bytes_per_pixel = (fbdev->varinfo.bits_per_pixel + 7) >> 3;
151  fbdev->frame_linesize = fbdev->width * fbdev->bytes_per_pixel;
152  fbdev->frame_size = fbdev->frame_linesize * fbdev->height;
153  fbdev->time_frame = AV_NOPTS_VALUE;
154  fbdev->data = mmap(NULL, fbdev->fixinfo.smem_len, PROT_READ, MAP_SHARED, fbdev->fd, 0);
155  if (fbdev->data == MAP_FAILED) {
156  ret = AVERROR(errno);
157  av_log(avctx, AV_LOG_ERROR, "Error in mmap(): %s\n", strerror(errno));
158  goto fail;
159  }
160 
163  st->codec->width = fbdev->width;
164  st->codec->height = fbdev->height;
165  st->codec->pix_fmt = pix_fmt;
166  st->codec->time_base = (AVRational){fbdev->framerate_q.den, fbdev->framerate_q.num};
167  st->codec->bit_rate =
168  fbdev->width * fbdev->height * fbdev->bytes_per_pixel * av_q2d(fbdev->framerate_q) * 8;
169 
170  av_log(avctx, AV_LOG_INFO,
171  "w:%d h:%d bpp:%d pixfmt:%s fps:%d/%d bit_rate:%d\n",
172  fbdev->width, fbdev->height, fbdev->varinfo.bits_per_pixel,
173  av_get_pix_fmt_name(pix_fmt),
174  fbdev->framerate_q.num, fbdev->framerate_q.den,
175  st->codec->bit_rate);
176  return 0;
177 
178 fail:
179  close(fbdev->fd);
180  return ret;
181 }
182 
184 {
185  FBDevContext *fbdev = avctx->priv_data;
186  int64_t curtime, delay;
187  struct timespec ts;
188  int i, ret;
189  uint8_t *pin, *pout;
190 
191  if (fbdev->time_frame == AV_NOPTS_VALUE)
192  fbdev->time_frame = av_gettime();
193 
194  /* wait based on the frame rate */
195  curtime = av_gettime();
196  delay = fbdev->time_frame - curtime;
197  av_dlog(avctx,
198  "time_frame:%"PRId64" curtime:%"PRId64" delay:%"PRId64"\n",
199  fbdev->time_frame, curtime, delay);
200  if (delay > 0) {
201  if (avctx->flags & AVFMT_FLAG_NONBLOCK)
202  return AVERROR(EAGAIN);
203  ts.tv_sec = delay / 1000000;
204  ts.tv_nsec = (delay % 1000000) * 1000;
205  while (nanosleep(&ts, &ts) < 0 && errno == EINTR);
206  }
207  /* compute the time of the next frame */
208  fbdev->time_frame += INT64_C(1000000) / av_q2d(fbdev->framerate_q);
209 
210  if ((ret = av_new_packet(pkt, fbdev->frame_size)) < 0)
211  return ret;
212 
213  /* refresh fbdev->varinfo, visible data position may change at each call */
214  if (ioctl(fbdev->fd, FBIOGET_VSCREENINFO, &fbdev->varinfo) < 0)
215  av_log(avctx, AV_LOG_WARNING,
216  "Error refreshing variable info: %s\n", strerror(errno));
217 
218  pkt->pts = curtime;
219 
220  /* compute visible data offset */
221  pin = fbdev->data + fbdev->bytes_per_pixel * fbdev->varinfo.xoffset +
222  fbdev->varinfo.yoffset * fbdev->fixinfo.line_length;
223  pout = pkt->data;
224 
225  // TODO it'd be nice if the lines were aligned
226  for (i = 0; i < fbdev->height; i++) {
227  memcpy(pout, pin, fbdev->frame_linesize);
228  pin += fbdev->fixinfo.line_length;
229  pout += fbdev->frame_linesize;
230  }
231 
232  return fbdev->frame_size;
233 }
234 
236 {
237  FBDevContext *fbdev = avctx->priv_data;
238 
239  munmap(fbdev->data, fbdev->frame_size);
240  close(fbdev->fd);
241 
242  return 0;
243 }
244 
245 #define OFFSET(x) offsetof(FBDevContext, x)
246 #define DEC AV_OPT_FLAG_DECODING_PARAM
247 static const AVOption options[] = {
248  { "framerate","", OFFSET(framerate), AV_OPT_TYPE_STRING, {.str = "25"}, 0, 0, DEC },
249  { NULL },
250 };
251 
252 static const AVClass fbdev_class = {
253  .class_name = "fbdev indev",
254  .item_name = av_default_item_name,
255  .option = options,
256  .version = LIBAVUTIL_VERSION_INT,
257 };
258 
260  .name = "fbdev",
261  .long_name = NULL_IF_CONFIG_SMALL("Linux framebuffer"),
262  .priv_data_size = sizeof(FBDevContext),
266  .flags = AVFMT_NOFILE,
267  .priv_class = &fbdev_class,
268 };
#define DEC
Definition: fbdev.c:246
int height
assumed frame resolution
Definition: fbdev.c:87
int av_parse_video_rate(AVRational *rate, const char *arg)
Parse str and store the detected values in *rate.
Definition: parseutils.c:122
AVOption.
Definition: opt.h:234
int blue_offset
Definition: fbdev.c:49
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:129
char * framerate
framerate string set by a private option
Definition: fbdev.c:83
packed RGB 8:8:8, 24bpp, RGBRGB...
Definition: pixfmt.h:67
memory handling functions
void avpriv_set_pts_info(AVStream *s, int pts_wrap_bits, unsigned int pts_num, unsigned int pts_den)
Set the time base and wrapping info for a given stream.
Definition: utils.c:2829
int alpha_offset
Definition: fbdev.c:49
int num
numerator
Definition: rational.h:44
enum AVPixelFormat pix_fmt
Pixel format, see AV_PIX_FMT_xxx.
Definition: avcodec.h:1254
AVInputFormat ff_fbdev_demuxer
Definition: fbdev.c:259
#define FF_ARRAY_ELEMS(a)
av_dlog(ac->avr,"%d samples - audio_convert: %s to %s (%s)\n", len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt), use_generic?ac->func_descr_generic:ac->func_descr)
int frame_linesize
linesize of the output frame, it is assumed to be constant
Definition: fbdev.c:88
AVRational time_base
This is the fundamental unit of time (in seconds) in terms of which frame timestamps are represented...
Definition: avcodec.h:1175
int frame_size
size in bytes of a grabbed frame
Definition: fbdev.c:81
Format I/O context.
Definition: avformat.h:922
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:38
#define AVFMT_FLAG_NONBLOCK
Do not block when reading packets from input.
Definition: avformat.h:1036
uint8_t
#define av_cold
Definition: attributes.h:66
AVOptions.
struct fb_var_screeninfo varinfo
variable info;
Definition: fbdev.c:91
AVStream * avformat_new_stream(AVFormatContext *s, const AVCodec *c)
Add a new stream to a media file.
Definition: utils.c:2521
packed ABGR 8:8:8:8, 32bpp, ABGRABGR...
Definition: pixfmt.h:97
int avpriv_open(const char *filename, int flags,...)
A wrapper for open() setting O_CLOEXEC.
Definition: file_open.c:71
int64_t time_frame
time for the next frame to output (in 1/1000000 units)
Definition: fbdev.c:84
static double av_q2d(AVRational a)
Convert rational to double.
Definition: rational.h:69
int flags
Flags modifying the (de)muxer behaviour.
Definition: avformat.h:1033
uint8_t * data
Definition: avcodec.h:973
static int flags
Definition: log.c:44
static av_cold int read_close(AVFormatContext *ctx)
Definition: libcdio.c:145
Definition: fbdev.c:47
int av_new_packet(AVPacket *pkt, int size)
Allocate the payload of a packet and initialize its fields with default values.
Definition: avpacket.c:81
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:123
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:150
packed BGRA 8:8:8:8, 32bpp, BGRABGRA...
Definition: pixfmt.h:98
enum AVPixelFormat pixfmt
Definition: fbdev.c:50
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:168
packed ARGB 8:8:8:8, 32bpp, ARGBARGB...
Definition: pixfmt.h:95
int green_offset
Definition: fbdev.c:49
packed RGBA 8:8:8:8, 32bpp, RGBARGBA...
Definition: pixfmt.h:96
struct fb_fix_screeninfo fixinfo
fixed info;
Definition: fbdev.c:92
AVCodecContext * codec
Codec context associated with this stream.
Definition: avformat.h:718
common internal API header
int bit_rate
the average bitrate
Definition: avcodec.h:1114
char filename[1024]
input or output filename
Definition: avformat.h:998
int width
picture width / height.
Definition: avcodec.h:1224
packed RGB 8:8:8, 24bpp, BGRBGR...
Definition: pixfmt.h:68
enum AVPixelFormat pix_fmt
Definition: movenc.c:843
AVRational framerate_q
framerate
Definition: fbdev.c:82
LIBAVUTIL_VERSION_INT
Definition: eval.c:55
static int read_header(FFV1Context *f)
Definition: ffv1dec.c:544
int64_t av_gettime(void)
Get the current time in microseconds.
Definition: time.c:37
Stream structure.
Definition: avformat.h:699
NULL
Definition: eval.c:55
#define AV_LOG_INFO
Standard information.
Definition: log.h:134
enum AVMediaType codec_type
Definition: avcodec.h:1058
static av_cold int fbdev_read_header(AVFormatContext *avctx)
Definition: fbdev.c:97
enum AVCodecID codec_id
Definition: avcodec.h:1067
static int fbdev_read_packet(AVFormatContext *avctx, AVPacket *pkt)
Definition: fbdev.c:183
av_default_item_name
Definition: dnxhdenc.c:52
int width
Definition: fbdev.c:87
static void close(AVCodecParserContext *s)
Definition: h264_parser.c:490
int bytes_per_pixel
Definition: fbdev.c:89
static int read_packet(AVFormatContext *ctx, AVPacket *pkt)
Definition: libcdio.c:114
static av_cold int fbdev_read_close(AVFormatContext *avctx)
Definition: fbdev.c:235
Describe the class of an AVClass context structure.
Definition: log.h:33
rational number numerator/denominator
Definition: rational.h:43
misc parsing utilities
Main libavformat public API header.
#define AVFMT_NOFILE
Demuxer will use avio_open, no opened file should be provided by the caller.
Definition: avformat.h:409
uint8_t * data
framebuffer data
Definition: fbdev.c:94
static enum AVPixelFormat get_pixfmt_from_fb_varinfo(struct fb_var_screeninfo *varinfo)
Definition: fbdev.c:63
int den
denominator
Definition: rational.h:45
int red_offset
Definition: fbdev.c:49
static struct rgb_pixfmt_map_entry rgb_pixfmt_map[]
Definition: fbdev.c:53
void * priv_data
Format private data.
Definition: avformat.h:950
static const AVClass fbdev_class
Definition: fbdev.c:252
const char * name
A comma separated list of short names for the format.
Definition: avformat.h:525
static const AVOption options[]
Definition: fbdev.c:247
#define OFFSET(x)
Definition: fbdev.c:245
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:1540
AVPixelFormat
Pixel format.
Definition: pixfmt.h:63
This structure stores compressed data.
Definition: avcodec.h:950
int fd
framebuffer device file descriptor
Definition: fbdev.c:86
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:966
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:228
int bits_per_pixel
Definition: fbdev.c:48