libavdevice/fbdev.c

   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 FFmpeg.
   7  *
   8  * FFmpeg 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  * FFmpeg 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 FFmpeg; 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.
  27  * @see http://linux-fbdev.sourceforge.net/
  28  */
  29
  30 /* #define DEBUG */
  31
  32 #include <unistd.h>
  33 #include <fcntl.h>
  34 #include <sys/ioctl.h>
  35 #include <sys/time.h>
  36 #include <sys/mman.h>
  37 #include <time.h>
  38 #include <linux/fb.h>
  39
  40 #include "libavutil/log.h"
  41 #include "libavutil/mem.h"
  42 #include "libavutil/opt.h"
  43 #include "libavutil/parseutils.h"
  44 #include "libavutil/pixdesc.h"
  45 #include "avdevice.h"
  46
  47 struct rgb_pixfmt_map_entry {
  48     int bits_per_pixel;
  49     int red_offset, green_offset, blue_offset, alpha_offset;
  50     enum PixelFormat pixfmt;
  51 };
  52
  53 static struct rgb_pixfmt_map_entry rgb_pixfmt_map[] = {
  54     // bpp, red_offset,  green_offset, blue_offset, alpha_offset, pixfmt
  55     {  32,       0,           8,          16,           24,   PIX_FMT_RGBA  },
  56     {  32,      16,           8,           0,           24,   PIX_FMT_BGRA  },
  57     {  32,       8,          16,          24,            0,   PIX_FMT_ARGB  },
  58     {  32,       3,           2,           8,            0,   PIX_FMT_ABGR  },
  59     {  24,       0,           8,          16,            0,   PIX_FMT_RGB24 },
  60     {  24,      16,           8,           0,            0,   PIX_FMT_BGR24 },
  61 };
  62
  63 static enum PixelFormat 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 PIX_FMT_NONE;
  77 }
  78
  79 typedef struct {
  80     AVClass *class;          ///< class for private options
  81     int frame_size;          ///< size in bytes of a grabbed frame
  82     AVRational framerate_q;  ///< framerate
  83     char *framerate;         ///< framerate string set by a private option
  84     int64_t time_frame;      ///< time for the next frame to output (in 1/1000000 units)
  85
  86     int fd;                  ///< framebuffer device file descriptor
  87     int width, heigth;       ///< assumed frame resolution
  88     int frame_linesize;      ///< linesize of the output frame, it is assumed to be constant
  89     int bytes_per_pixel;
  90
  91     struct fb_var_screeninfo varinfo; ///< variable info;
  92     struct fb_fix_screeninfo fixinfo; ///< fixed    info;
  93
  94     uint8_t *data;           ///< framebuffer data
  95 } FBDevContext;
  96
  97 av_cold static int fbdev_read_header(AVFormatContext *avctx,
  98                                      AVFormatParameters *ap)
  99 {
 100     FBDevContext *fbdev = avctx->priv_data;
 101     AVStream *st = NULL;
 102     enum PixelFormat pix_fmt;
 103     int ret, flags = O_RDONLY;
 104
 105     ret = av_parse_video_rate(&fbdev->framerate_q, fbdev->framerate);
 106     if (ret < 0) {
 107         av_log(avctx, AV_LOG_ERROR, "Could not parse framerate '%s'.\n", fbdev->framerate);
 108         return ret;
 109     }
 110 #if FF_API_FORMAT_PARAMETERS
 111     if (ap->time_base.num)
 112         fbdev->framerate_q = (AVRational){ap->time_base.den, ap->time_base.num};
 113 #endif
 114
 115     if (!(st = av_new_stream(avctx, 0)))
 116         return AVERROR(ENOMEM);
 117     av_set_pts_info(st, 64, 1, 1000000); /* 64 bits pts in microseconds */
 118
 119     /* NONBLOCK is ignored by the fbdev driver, only set for consistency */
 120     if (avctx->flags & AVFMT_FLAG_NONBLOCK)
 121         flags |= O_NONBLOCK;
 122
 123     if ((fbdev->fd = open(avctx->filename, flags)) == -1) {
 124         ret = AVERROR(errno);
 125         av_log(avctx, AV_LOG_ERROR,
 126                "Could not open framebuffer device '%s': %s\n",
 127                avctx->filename, strerror(ret));
 128         return ret;
 129     }
 130
 131     if (ioctl(fbdev->fd, FBIOGET_VSCREENINFO, &fbdev->varinfo) < 0) {
 132         ret = AVERROR(errno);
 133         av_log(avctx, AV_LOG_ERROR,
 134                "FBIOGET_VSCREENINFO: %s\n", strerror(errno));
 135         goto fail;
 136     }
 137
 138     if (ioctl(fbdev->fd, FBIOGET_FSCREENINFO, &fbdev->fixinfo) < 0) {
 139         ret = AVERROR(errno);
 140         av_log(avctx, AV_LOG_ERROR,
 141                "FBIOGET_FSCREENINFO: %s\n", strerror(errno));
 142         goto fail;
 143     }
 144
 145     pix_fmt = get_pixfmt_from_fb_varinfo(&fbdev->varinfo);
 146     if (pix_fmt == PIX_FMT_NONE) {
 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;
 154     fbdev->heigth          = fbdev->varinfo.yres;
 155     fbdev->bytes_per_pixel = (fbdev->varinfo.bits_per_pixel + 7) >> 3;
 156     fbdev->frame_linesize  = fbdev->width * fbdev->bytes_per_pixel;
 157     fbdev->frame_size      = fbdev->frame_linesize * fbdev->heigth;
 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);
 162         av_log(avctx, AV_LOG_ERROR, "Error in mmap(): %s\n", strerror(errno));
 163         goto fail;
 164     }
 165
 166     st->codec->codec_type = AVMEDIA_TYPE_VIDEO;
 167     st->codec->codec_id   = CODEC_ID_RAWVIDEO;
 168     st->codec->width      = fbdev->width;
 169     st->codec->height     = fbdev->heigth;
 170     st->codec->pix_fmt    = pix_fmt;
 171     st->codec->time_base  = (AVRational){fbdev->framerate_q.den, fbdev->framerate_q.num};
 172     st->codec->bit_rate   =
 173         fbdev->width * fbdev->heigth * fbdev->bytes_per_pixel * av_q2d(fbdev->framerate_q) * 8;
 174
 175     av_log(avctx, AV_LOG_INFO,
 176            "w:%d h:%d bpp:%d pixfmt:%s fps:%d/%d bit_rate:%d\n",
 177            fbdev->width, fbdev->heigth, fbdev->varinfo.bits_per_pixel,
 178            av_pix_fmt_descriptors[pix_fmt].name,
 179            fbdev->framerate_q.num, fbdev->framerate_q.den,
 180            st->codec->bit_rate);
 181     return 0;
 182
 183 fail:
 184     close(fbdev->fd);
 185     return ret;
 186 }
 187
 188 static int fbdev_read_packet(AVFormatContext *avctx, AVPacket *pkt)
 189 {
 190     FBDevContext *fbdev = avctx->priv_data;
 191     int64_t curtime, delay;
 192     struct timespec ts;
 193     int i, ret;
 194     uint8_t *pin, *pout;
 195
 196     if (fbdev->time_frame == AV_NOPTS_VALUE)
 197         fbdev->time_frame = av_gettime();
 198
 199     /* wait based on the frame rate */
 200     while (1) {
 201         curtime = av_gettime();
 202         delay = fbdev->time_frame - curtime;
 203         av_dlog(avctx,
 204                 "time_frame:%"PRId64" curtime:%"PRId64" delay:%"PRId64"\n",
 205                 fbdev->time_frame, curtime, delay);
 206         if (delay <= 0) {
 207             fbdev->time_frame += INT64_C(1000000) / av_q2d(fbdev->framerate_q);
 208             break;
 209         }
 210         if (avctx->flags & AVFMT_FLAG_NONBLOCK)
 211             return AVERROR(EAGAIN);
 212         ts.tv_sec  =  delay / 1000000;
 213         ts.tv_nsec = (delay % 1000000) * 1000;
 214         while (nanosleep(&ts, &ts) < 0 && errno == EINTR);
 215     }
 216
 217     if ((ret = av_new_packet(pkt, fbdev->frame_size)) < 0)
 218         return ret;
 219
 220     /* refresh fbdev->varinfo, visible data position may change at each call */
 221     if (ioctl(fbdev->fd, FBIOGET_VSCREENINFO, &fbdev->varinfo) < 0)
 222         av_log(avctx, AV_LOG_WARNING,
 223                "Error refreshing variable info: %s\n", strerror(errno));
 224
 225     pkt->pts = curtime;
 226
 227     /* compute visible data offset */
 228     pin = fbdev->data + fbdev->bytes_per_pixel * fbdev->varinfo.xoffset +
 229                         fbdev->varinfo.yoffset * fbdev->fixinfo.line_length;
 230     pout = pkt->data;
 231
 232     for (i = 0; i < fbdev->heigth; i++) {
 233         memcpy(pout, pin, fbdev->frame_linesize);
 234         pin  += fbdev->fixinfo.line_length;
 235         pout += fbdev->frame_linesize;
 236     }
 237
 238     return fbdev->frame_size;
 239 }
 240
 241 av_cold static int fbdev_read_close(AVFormatContext *avctx)
 242 {
 243     FBDevContext *fbdev = avctx->priv_data;
 244
 245     munmap(fbdev->data, fbdev->frame_size);
 246     close(fbdev->fd);
 247
 248     return 0;
 249 }
 250
 251 #define OFFSET(x) offsetof(FBDevContext, x)
 252 #define DEC AV_OPT_FLAG_DECODING_PARAM
 253 static const AVOption options[] = {
 254     { "framerate","", OFFSET(framerate), FF_OPT_TYPE_STRING, {.str = "25"}, 0, 0, DEC },
 255     { NULL },
 256 };
 257
 258 static const AVClass fbdev_class = {
 259     .class_name = "fbdev indev",
 260     .item_name  = av_default_item_name,
 261     .option     = options,
 262     .version    = LIBAVUTIL_VERSION_INT,
 263 };
 264
 265 AVInputFormat ff_fbdev_demuxer = {
 266     .name           = "fbdev",
 267     .long_name      = NULL_IF_CONFIG_SMALL("Linux framebuffer"),
 268     .priv_data_size = sizeof(FBDevContext),
 269     .read_header    = fbdev_read_header,
 270     .read_packet    = fbdev_read_packet,
 271     .read_close     = fbdev_read_close,
 272     .flags          = AVFMT_NOFILE,
 273     .priv_class     = &fbdev_class,
 274 };