1 /*****************************************************************************
2 * vmem.c: memory video driver for vlc
3 *****************************************************************************
4 * Copyright (C) 2008 VLC authors and VideoLAN
5 * Copyrgiht (C) 2010 RĂ©mi Denis-Courmont
7 * Authors: Sam Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 of the License, or
12 * (at your option) any later version.
14 * This program 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
17 * GNU Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_vout_display.h>
37 #include <vlc_picture_pool.h>
39 /*****************************************************************************
41 *****************************************************************************/
42 #define T_WIDTH N_("Width")
43 #define LT_WIDTH N_("Video memory buffer width.")
45 #define T_HEIGHT N_("Height")
46 #define LT_HEIGHT N_("Video memory buffer height.")
48 #define T_PITCH N_("Pitch")
49 #define LT_PITCH N_("Video memory buffer pitch in bytes.")
51 #define T_CHROMA N_("Chroma")
52 #define LT_CHROMA N_("Output chroma for the memory image as a 4-character " \
53 "string, eg. \"RV32\".")
55 static int Open (vlc_object_t *);
56 static void Close(vlc_object_t *);
59 set_description(N_("Video memory output"))
60 set_shortname(N_("Video memory"))
62 set_category(CAT_VIDEO)
63 set_subcategory(SUBCAT_VIDEO_VOUT)
64 set_capability("vout display", 0)
66 add_integer("vmem-width", 320, T_WIDTH, LT_WIDTH, false)
68 add_integer("vmem-height", 200, T_HEIGHT, LT_HEIGHT, false)
70 add_integer("vmem-pitch", 640, T_PITCH, LT_PITCH, false)
72 add_string("vmem-chroma", "RV16", T_CHROMA, LT_CHROMA, true)
74 add_obsolete_string("vmem-lock") /* obsoleted since 1.1.1 */
75 add_obsolete_string("vmem-unlock") /* obsoleted since 1.1.1 */
76 add_obsolete_string("vmem-data") /* obsoleted since 1.1.1 */
78 set_callbacks(Open, Close)
81 /*****************************************************************************
83 *****************************************************************************/
84 struct picture_sys_t {
85 vout_display_sys_t *sys;
89 /* NOTE: the callback prototypes must match those of LibVLC */
90 struct vout_display_sys_t {
95 void *(*lock)(void *sys, void **plane);
96 void (*unlock)(void *sys, void *id, void *const *plane);
97 void (*display)(void *sys, void *id);
98 void (*cleanup)(void *sys);
100 unsigned pitches[PICTURE_PLANE_MAX];
101 unsigned lines[PICTURE_PLANE_MAX];
104 typedef unsigned (*vlc_format_cb)(void **, char *, unsigned *, unsigned *,
105 unsigned *, unsigned *);
107 static picture_pool_t *Pool (vout_display_t *, unsigned);
108 static void Display(vout_display_t *, picture_t *, subpicture_t *);
109 static int Control(vout_display_t *, int, va_list);
111 static int Lock(picture_t *);
112 static void Unlock(picture_t *);
114 /*****************************************************************************
115 * Open: allocates video thread
116 *****************************************************************************
117 * This function allocates and initializes a vout method.
118 *****************************************************************************/
119 static int Open(vlc_object_t *object)
121 vout_display_t *vd = (vout_display_t *)object;
122 vout_display_sys_t *sys = malloc(sizeof(*sys));
126 /* Get the callbacks */
127 vlc_format_cb setup = var_InheritAddress(vd, "vmem-setup");
129 sys->lock = var_InheritAddress(vd, "vmem-lock");
130 if (sys->lock == NULL) {
131 msg_Err(vd, "missing lock callback");
135 sys->unlock = var_InheritAddress(vd, "vmem-unlock");
136 sys->display = var_InheritAddress(vd, "vmem-display");
137 sys->cleanup = var_InheritAddress(vd, "vmem-cleanup");
138 sys->opaque = var_InheritAddress(vd, "vmem-data");
141 /* Define the video format */
143 video_format_ApplyRotation(&fmt, &vd->fmt);
148 memcpy(chroma, &fmt.i_chroma, 4);
150 memset(sys->pitches, 0, sizeof(sys->pitches));
151 memset(sys->lines, 0, sizeof(sys->lines));
153 sys->count = setup(&sys->opaque, chroma, &fmt.i_width, &fmt.i_height,
154 sys->pitches, sys->lines);
155 if (sys->count == 0) {
156 msg_Err(vd, "video format setup failure (no pictures)");
160 fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
163 char *chroma = var_InheritString(vd, "vmem-chroma");
164 fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
167 fmt.i_width = var_InheritInteger(vd, "vmem-width");
168 fmt.i_height = var_InheritInteger(vd, "vmem-height");
169 sys->pitches[0] = var_InheritInteger(vd, "vmem-pitch");
170 sys->lines[0] = fmt.i_height;
171 for (size_t i = 1; i < PICTURE_PLANE_MAX; i++)
173 sys->pitches[i] = sys->pitches[0];
174 sys->lines[i] = sys->lines[0];
179 fmt.i_x_offset = fmt.i_y_offset = 0;
180 fmt.i_visible_width = fmt.i_width;
181 fmt.i_visible_height = fmt.i_height;
184 msg_Err(vd, "vmem-chroma should be 4 characters long");
189 /* Define the bitmasks */
190 switch (fmt.i_chroma)
192 case VLC_CODEC_RGB15:
193 fmt.i_rmask = 0x001f;
194 fmt.i_gmask = 0x03e0;
195 fmt.i_bmask = 0x7c00;
197 case VLC_CODEC_RGB16:
198 fmt.i_rmask = 0x001f;
199 fmt.i_gmask = 0x07e0;
200 fmt.i_bmask = 0xf800;
202 case VLC_CODEC_RGB24:
203 case VLC_CODEC_RGB32:
204 fmt.i_rmask = 0xff0000;
205 fmt.i_gmask = 0x00ff00;
206 fmt.i_bmask = 0x0000ff;
216 vout_display_info_t info = vd->info;
217 info.has_hide_mouse = true;
225 vd->display = Display;
226 vd->control = Control;
230 vout_display_SendEventFullscreen(vd, false);
231 vout_display_SendEventDisplaySize(vd, fmt.i_width, fmt.i_height);
232 vout_display_DeleteWindow(vd, NULL);
236 static void Close(vlc_object_t *object)
238 vout_display_t *vd = (vout_display_t *)object;
239 vout_display_sys_t *sys = vd->sys;
242 sys->cleanup(sys->opaque);
243 picture_pool_Delete(sys->pool);
248 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
250 vout_display_sys_t *sys = vd->sys;
255 if (count > sys->count)
258 picture_t *pictures[count];
260 for (unsigned i = 0; i < count; i++) {
261 picture_sys_t *picsys = malloc(sizeof (*picsys));
262 if (unlikely(picsys == NULL))
270 picture_resource_t rsc = { .p_sys = picsys };
272 for (unsigned i = 0; i < PICTURE_PLANE_MAX; i++) {
273 /* vmem-lock is responsible for the allocation */
274 rsc.p[i].p_pixels = NULL;
275 rsc.p[i].i_lines = sys->lines[i];
276 rsc.p[i].i_pitch = sys->pitches[i];
279 pictures[i] = picture_NewFromResource(&vd->fmt, &rsc);
288 picture_pool_configuration_t pool;
289 memset(&pool, 0, sizeof(pool));
290 pool.picture_count = count;
291 pool.picture = pictures;
293 pool.unlock = Unlock;
294 sys->pool = picture_pool_NewExtended(&pool);
296 for (unsigned i = 0; i < count; i++)
297 picture_Release(pictures[i]);
303 static void Display(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
305 vout_display_sys_t *sys = vd->sys;
307 assert(!picture_IsReferenced(picture));
308 if (sys->display != NULL)
309 sys->display(sys->opaque, picture->p_sys->id);
310 picture_Release(picture);
311 VLC_UNUSED(subpicture);
314 static int Control(vout_display_t *vd, int query, va_list args)
316 (void) vd; (void) query; (void) args;
321 static int Lock(picture_t *picture)
323 picture_sys_t *picsys = picture->p_sys;
324 vout_display_sys_t *sys = picsys->sys;
325 void *planes[PICTURE_PLANE_MAX];
327 picsys->id = sys->lock(sys->opaque, planes);
329 for (int i = 0; i < picture->i_planes; i++)
330 picture->p[i].p_pixels = planes[i];
335 static void Unlock(picture_t *picture)
337 picture_sys_t *picsys = picture->p_sys;
338 vout_display_sys_t *sys = picsys->sys;
340 void *planes[PICTURE_PLANE_MAX];
342 for (int i = 0; i < picture->i_planes; i++)
343 planes[i] = picture->p[i].p_pixels;
345 if (sys->unlock != NULL)
346 sys->unlock(sys->opaque, picsys->id, planes);