display: add close "virtual" function
[glsdk/omapdrmtest.git] / 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  */
18 #ifndef UTIL_H_
19 #define UTIL_H_
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>
29 #include <omap_drm.h>
30 #include <omap_drmif.h>
32 /* align x to next highest multiple of 2^n */
33 #define ALIGN2(x,n)   (((x) + ((1 << (n)) - 1)) & ~((1 << (n)) - 1))
35 typedef enum {
36         false = 0,
37         true = 1
38 } bool;
40 #include "list.h"
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  */
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 };
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 };
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;
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         void (*close)(struct display *disp);
83         bool multiplanar;       /* True when Y and U/V are in separate buffers. */
84 };
86 /* Print display related help */
87 void disp_usage(void);
89 /* Open display.. X11 or KMS depending on cmdline args, environment,
90  * and build args
91  */
92 struct display * disp_open(int argc, char **argv);
94 /* Close display */
95 static inline void
96 disp_close(struct display *disp)
97 {
98         disp->close(disp);
99 }
101 /* Get normal RGB/UI buffers (ie. not scaled, not YUV) */
102 static inline struct buffer **
103 disp_get_buffers(struct display *disp, uint32_t n)
105         return disp->get_buffers(disp, n);
108 /* Get video/overlay buffers (ie. can be YUV, scaled, etc) */
109 struct buffer ** disp_get_vid_buffers(struct display *disp, uint32_t n,
110                 uint32_t fourcc, uint32_t w, uint32_t h);
112 /* flip to / post the specified buffer */
113 int
114 disp_post_buffer(struct display *disp, struct buffer *buf);
116 /* flip to / post the specified video buffer */
117 int
118 disp_post_vid_buffer(struct display *disp, struct buffer *buf,
119                 uint32_t x, uint32_t y, uint32_t w, uint32_t h);
121 /* allocate a buffer from pool created by disp_get_vid_buffers() */
122 struct buffer * disp_get_vid_buffer(struct display *disp);
123 /* free to video buffer pool */
124 void disp_put_vid_buffer(struct display *disp, struct buffer *buf);
126 /* helper to setup the display for apps that just need video with
127  * no flipchain on the GUI layer
128  */
129 struct buffer * disp_get_fb(struct display *disp);
132 /* V4L2 utilities:
133  */
135 struct v4l2;
137 /* Print v4l2 related help */
138 void v4l2_usage(void);
140 /* Open v4l2 (and media0??) XXX */
141 struct v4l2 * v4l2_open(int argc, char **argv, uint32_t *fourcc,
142                 uint32_t *width, uint32_t *height);
144 /* Share the buffers w/ v4l2 via dmabuf */
145 int v4l2_reqbufs(struct v4l2 *v4l2, struct buffer **bufs, uint32_t n);
147 int v4l2_streamon(struct v4l2 *v4l2);
148 int v4l2_streamoff(struct v4l2 *v4l2);
150 /* Queue a buffer to the camera */
151 int v4l2_qbuf(struct v4l2 *v4l2, struct buffer *buf);
153 /* Dequeue buffer from camera */
154 struct buffer * v4l2_dqbuf(struct v4l2 *v4l2);
156 /* Other utilities..
157  */
158 extern int debug;
160 int check_args(int argc, char **argv);
162 void fill(struct buffer *buf, int i);
164 #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 ))
165 #define FOURCC_STR(str)    FOURCC(str[0], str[1], str[2], str[3])
167 /* Dynamic debug. */
168 #define DBG(fmt, ...) \
169                 do { if (debug) fprintf(stderr, fmt "\n", ##__VA_ARGS__); } while (0)
171 #define MSG(fmt, ...) \
172                 do { fprintf(stderr, fmt "\n", ##__VA_ARGS__); } while (0)
173 #define ERROR(fmt, ...) \
174                 do { fprintf(stderr, "ERROR:%s:%d: " fmt "\n", __func__, __LINE__, ##__VA_ARGS__); } while (0)
176 #ifndef container_of
177 #define container_of(ptr, type, member) \
178     (type *)((char *)(ptr) - (char *) &((type *)0)->member)
179 #endif
181 #ifndef MIN
182 #  define MIN(a,b)     (((a) < (b)) ? (a) : (b))
183 #endif
185 #ifndef MAX
186 #  define MAX(a,b)     (((a) > (b)) ? (a) : (b))
187 #endif
189 #ifndef PAGE_SHIFT
190 #  define PAGE_SHIFT 12
191 #endif
193 #ifndef PAGE_SIZE
194 #  define PAGE_SIZE (1 << PAGE_SHIFT)
195 #endif
197 /* align x to next highest multiple of 2^n */
198 #define ALIGN2(x,n)   (((x) + ((1 << (n)) - 1)) & ~((1 << (n)) - 1))
200 #include <sys/time.h>
201 static inline long
202 mark(long *last)
204         struct timeval t;
205         gettimeofday(&t, NULL);
206         if (last) {
207                 long delta = t.tv_usec - *last;
209                 /* Handle the case, where the seconds have changed.
210                  * TODO: keep the whole timeval struct, to be able to cope with
211                  * more than one second deltas? */
212                 if (t.tv_usec < *last)
213                         delta += 1000000;
215                 *last = t.tv_usec;
216                 return delta;
217         }
218         return t.tv_usec;
221 #endif /* UTIL_H_ */