util/util.h

   1 /*
   2  * Copyright (C) 2011 Texas Instruments
   3  * Author: Rob Clark <rob.clark@linaro.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 as published by
   7  * the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  12  * more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along with
  15  * this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #ifndef UTIL_H_
  19 #define UTIL_H_
  20
  21 #include <stdio.h>
  22 #include <stdint.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <errno.h>
  26 #include <unistd.h>
  27 #include <assert.h>
  28
  29 #include <omap_drm.h>
  30 #include <omap_drmif.h>
  31
  32 /* align x to next highest multiple of 2^n */
  33 #define ALIGN2(x,n)   (((x) + ((1 << (n)) - 1)) & ~((1 << (n)) - 1))
  34
  35 typedef enum {
  36         false = 0,
  37         true = 1
  38 } bool;
  39
  40 #include "list.h"
  41
  42 /* Display Interface:
  43  *
  44  * Could be either KMS or X11 depending on build and
  45  * environment.  Some of details of opening/connecting, allocating buffers,
  46  * etc, differ.  The intention is just to provide as simple as possible
  47  * abstraction to avoid lots of duplication in each test app to handle
  48  * both cases.
  49  */
  50
  51 struct buffer {
  52         uint32_t fourcc, width, height;
  53         int nbo;
  54         struct omap_bo *bo[4];
  55         uint32_t pitches[4];
  56         struct list unlocked;
  57         bool multiplanar;       /* True when Y and U/V are in separate buffers. */
  58 };
  59
  60 /* State variables, used to maintain the playback rate. */
  61 struct rate_control {
  62         int fps;                /* When > zero, we maintain playback rate. */
  63         long last_frame_mark;   /* The time when the last frame was displayed,
  64                                  * as returned by the mark() function. */
  65         int usecs_to_sleep;     /* Number of useconds we have slep last frame. */
  66 };
  67
  68 struct display {
  69         int fd;
  70         uint32_t width, height;
  71         struct omap_device *dev;
  72         struct list unlocked;
  73         struct rate_control rtctl;
  74
  75         struct buffer ** (*get_buffers)(struct display *disp, uint32_t n);
  76         struct buffer ** (*get_vid_buffers)(struct display *disp,
  77                         uint32_t n, uint32_t fourcc, uint32_t w, uint32_t h);
  78         int (*post_buffer)(struct display *disp, struct buffer *buf);
  79         int (*post_vid_buffer)(struct display *disp, struct buffer *buf,
  80                         uint32_t x, uint32_t y, uint32_t w, uint32_t h);
  81
  82         bool multiplanar;       /* True when Y and U/V are in separate buffers. */
  83 };
  84
  85 /* Print display related help */
  86 void disp_usage(void);
  87
  88 /* Open display.. X11 or KMS depending on cmdline args, environment,
  89  * and build args
  90  */
  91 struct display * disp_open(int argc, char **argv);
  92
  93 /* Close display */
  94 void disp_close(struct display *disp);
  95
  96 /* Get normal RGB/UI buffers (ie. not scaled, not YUV) */
  97 static inline struct buffer **
  98 disp_get_buffers(struct display *disp, uint32_t n)
  99 {
 100         return disp->get_buffers(disp, n);
 101 }
 102
 103 /* Get video/overlay buffers (ie. can be YUV, scaled, etc) */
 104 struct buffer ** disp_get_vid_buffers(struct display *disp, uint32_t n,
 105                 uint32_t fourcc, uint32_t w, uint32_t h);
 106
 107 /* flip to / post the specified buffer */
 108 int
 109 disp_post_buffer(struct display *disp, struct buffer *buf);
 110
 111 /* flip to / post the specified video buffer */
 112 int
 113 disp_post_vid_buffer(struct display *disp, struct buffer *buf,
 114                 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
 115
 116 /* allocate a buffer from pool created by disp_get_vid_buffers() */
 117 struct buffer * disp_get_vid_buffer(struct display *disp);
 118 /* free to video buffer pool */
 119 void disp_put_vid_buffer(struct display *disp, struct buffer *buf);
 120
 121 /* helper to setup the display for apps that just need video with
 122  * no flipchain on the GUI layer
 123  */
 124 struct buffer * disp_get_fb(struct display *disp);
 125
 126
 127 /* V4L2 utilities:
 128  */
 129
 130 struct v4l2;
 131
 132 /* Print v4l2 related help */
 133 void v4l2_usage(void);
 134
 135 /* Open v4l2 (and media0??) XXX */
 136 struct v4l2 * v4l2_open(int argc, char **argv, uint32_t *fourcc,
 137                 uint32_t *width, uint32_t *height);
 138
 139 /* Share the buffers w/ v4l2 via dmabuf */
 140 int v4l2_reqbufs(struct v4l2 *v4l2, struct buffer **bufs, uint32_t n);
 141
 142 int v4l2_streamon(struct v4l2 *v4l2);
 143 int v4l2_streamoff(struct v4l2 *v4l2);
 144
 145 /* Queue a buffer to the camera */
 146 int v4l2_qbuf(struct v4l2 *v4l2, struct buffer *buf);
 147
 148 /* Dequeue buffer from camera */
 149 struct buffer * v4l2_dqbuf(struct v4l2 *v4l2);
 150
 151 /* Other utilities..
 152  */
 153 extern int debug;
 154
 155 int check_args(int argc, char **argv);
 156
 157 void fill(struct buffer *buf, int i);
 158
 159 #define FOURCC(a, b, c, d) ((uint32_t)(uint8_t)(a) | ((uint32_t)(uint8_t)(b) << 8) | ((uint32_t)(uint8_t)(c) << 16) | ((uint32_t)(uint8_t)(d) << 24 ))
 160 #define FOURCC_STR(str)    FOURCC(str[0], str[1], str[2], str[3])
 161
 162 /* Dynamic debug. */
 163 #define DBG(fmt, ...) \
 164                 do { if (debug) fprintf(stderr, fmt "\n", ##__VA_ARGS__); } while (0)
 165
 166 #define MSG(fmt, ...) \
 167                 do { fprintf(stderr, fmt "\n", ##__VA_ARGS__); } while (0)
 168 #define ERROR(fmt, ...) \
 169                 do { fprintf(stderr, "ERROR:%s:%d: " fmt "\n", __func__, __LINE__, ##__VA_ARGS__); } while (0)
 170
 171 #ifndef container_of
 172 #define container_of(ptr, type, member) \
 173     (type *)((char *)(ptr) - (char *) &((type *)0)->member)
 174 #endif
 175
 176 #ifndef MIN
 177 #  define MIN(a,b)     (((a) < (b)) ? (a) : (b))
 178 #endif
 179
 180 #ifndef MAX
 181 #  define MAX(a,b)     (((a) > (b)) ? (a) : (b))
 182 #endif
 183
 184 #ifndef PAGE_SHIFT
 185 #  define PAGE_SHIFT 12
 186 #endif
 187
 188 #ifndef PAGE_SIZE
 189 #  define PAGE_SIZE (1 << PAGE_SHIFT)
 190 #endif
 191
 192 /* align x to next highest multiple of 2^n */
 193 #define ALIGN2(x,n)   (((x) + ((1 << (n)) - 1)) & ~((1 << (n)) - 1))
 194
 195 #include <sys/time.h>
 196 static inline long
 197 mark(long *last)
 198 {
 199         struct timeval t;
 200         gettimeofday(&t, NULL);
 201         if (last) {
 202                 long delta = t.tv_usec - *last;
 203
 204                 /* Handle the case, where the seconds have changed.
 205                  * TODO: keep the whole timeval struct, to be able to cope with
 206                  * more than one second deltas? */
 207                 if (t.tv_usec < *last)
 208                         delta += 1000000;
 209
 210                 *last = t.tv_usec;
 211                 return delta;
 212         }
 213         return t.tv_usec;
 214 }
 215
 216 #endif /* UTIL_H_ */