git.sesse.net Git - ffmpeg/blob - libavcodec/v4l2_buffers.h

   1 /*
   2  * V4L2 buffer helper functions.
   3  *
   4  * Copyright (C) 2017 Alexis Ballier <aballier@gentoo.org>
   5  * Copyright (C) 2017 Jorge Ramirez <jorge.ramirez-ortiz@linaro.org>
   6  *
   7  * This file is part of FFmpeg.
   8  *
   9  * FFmpeg is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * FFmpeg is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with FFmpeg; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  22  */
  23
  24 #ifndef AVCODEC_V4L2_BUFFERS_H
  25 #define AVCODEC_V4L2_BUFFERS_H
  26
  27 #include <linux/videodev2.h>
  28
  29 enum V4L2Buffer_status {
  30     V4L2BUF_AVAILABLE,
  31     V4L2BUF_IN_DRIVER,
  32     V4L2BUF_RET_USER,
  33 };
  34
  35 /**
  36  * V4L2Buffer (wrapper for v4l2_buffer management)
  37  */
  38 typedef struct V4L2Buffer {
  39     /* each buffer needs to have a reference to its context */
  40     struct V4L2Context *context;
  41
  42     /* keep track of the mmap address and mmap length */
  43     struct V4L2Plane_info {
  44         int bytesperline;
  45         void * mm_addr;
  46         size_t length;
  47     } plane_info[VIDEO_MAX_PLANES];
  48
  49     int num_planes;
  50
  51     /* the v4l2_buffer buf.m.planes pointer uses the planes[] mem */
  52     struct v4l2_buffer buf;
  53     struct v4l2_plane planes[VIDEO_MAX_PLANES];
  54
  55     int flags;
  56     enum V4L2Buffer_status status;
  57
  58 } V4L2Buffer;
  59
  60 /**
  61  * Extracts the data from a V4L2Buffer to an AVFrame
  62  *
  63  * @param[in] frame The AVFRame to push the information to
  64  * @param[in] buf The V4L2Buffer to get the information from
  65  *
  66  * @returns 0 in case of success, EINVAL if the number of planes is incorrect,
  67  * ENOMEM if the AVBufferRef cant be created.
  68  */
  69 int ff_v4l2_buffer_buf_to_avframe(AVFrame *frame, V4L2Buffer *buf);
  70
  71 /**
  72  * Extracts the data from a V4L2Buffer to an AVPacket
  73  *
  74  * @param[in] pkt The AVPacket to push the information to
  75  * @param[in] buf The V4L2Buffer to get the information from
  76  *
  77  * @returns 0 in case of success, EINVAL if the number of planes is incorrect,
  78  * ENOMEM if the AVBufferRef cant be created.
  79  *
  80  */
  81 int ff_v4l2_buffer_buf_to_avpkt(AVPacket *pkt, V4L2Buffer *buf);
  82
  83 /**
  84  * Extracts the data from an AVPacket to a V4L2Buffer
  85  *
  86  * @param[in]  frame AVPacket to get the data from
  87  * @param[in]  avbuf V4L2Bfuffer to push the information to
  88  *
  89  * @returns 0 in case of success, negative otherwise
  90  */
  91 int ff_v4l2_buffer_avpkt_to_buf(const AVPacket *pkt, V4L2Buffer *out);
  92
  93 /**
  94  * Extracts the data from an AVFrame to a V4L2Buffer
  95  *
  96  * @param[in]  frame AVFrame to get the data from
  97  * @param[in]  avbuf V4L2Bfuffer to push the information to
  98  *
  99  * @returns 0 in case of success, negative otherwise
 100  */
 101 int ff_v4l2_buffer_avframe_to_buf(const AVFrame *frame, V4L2Buffer* out);
 102
 103 /**
 104  * Initializes a V4L2Buffer
 105  *
 106  * @param[in]  avbuf V4L2Bfuffer to initialize
 107  * @param[in]  index v4l2 buffer id
 108  *
 109  * @returns 0 in case of success, negative otherwise
 110  */
 111 int ff_v4l2_buffer_initialize(V4L2Buffer* avbuf, int index);
 112
 113 /**
 114  * Enqueues a V4L2Buffer
 115  *
 116  * @param[in] avbuf V4L2Bfuffer to push to the driver
 117  *
 118  * @returns 0 in case of success, negative otherwise
 119  */
 120 int ff_v4l2_buffer_enqueue(V4L2Buffer* avbuf);
 121
 122
 123 #endif // AVCODEC_V4L2_BUFFERS_H