1 /*****************************************************************************
2 * vmem.c: memory video driver for vlc
3 *****************************************************************************
4 * Copyright (C) 2008 the VideoLAN team
7 * Authors: Sam Hocevar <sam@zoy.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 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 General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, 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, NULL, T_WIDTH, LT_WIDTH, false)
68 add_integer("vmem-height", 200, NULL, T_HEIGHT, LT_HEIGHT, false)
70 add_integer("vmem-pitch", 640, NULL, T_PITCH, LT_PITCH, false)
72 add_string("vmem-chroma", "RV16", NULL, 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 struct vout_display_sys_t {
91 void *(*lock)(void *sys, void **plane);
92 void (*unlock)(void *sys, void *id, void *const *plane);
93 void (*display)(void *sys, void *id);
97 static picture_pool_t *Pool (vout_display_t *, unsigned);
98 static void Display(vout_display_t *, picture_t *);
99 static int Control(vout_display_t *, int, va_list);
100 static void Manage (vout_display_t *);
102 static int Lock(picture_t *);
103 static void Unlock(picture_t *);
105 /*****************************************************************************
106 * Open: allocates video thread
107 *****************************************************************************
108 * This function allocates and initializes a vout method.
109 *****************************************************************************/
110 static int Open(vlc_object_t *object)
112 vout_display_t *vd = (vout_display_t *)object;
115 char *chroma_format = var_InheritString(vd, "vmem-chroma");
116 const vlc_fourcc_t chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma_format);
119 msg_Err(vd, "vmem-chroma should be 4 characters long");
124 video_format_t fmt = vd->fmt;
126 fmt.i_chroma = chroma;
127 fmt.i_width = var_InheritInteger(vd, "vmem-width");
128 fmt.i_height = var_InheritInteger(vd, "vmem-height");
130 /* Define the bitmasks */
133 case VLC_CODEC_RGB15:
134 fmt.i_rmask = 0x001f;
135 fmt.i_gmask = 0x03e0;
136 fmt.i_bmask = 0x7c00;
138 case VLC_CODEC_RGB16:
139 fmt.i_rmask = 0x001f;
140 fmt.i_gmask = 0x07e0;
141 fmt.i_bmask = 0xf800;
143 case VLC_CODEC_RGB24:
144 fmt.i_rmask = 0xff0000;
145 fmt.i_gmask = 0x00ff00;
146 fmt.i_bmask = 0x0000ff;
148 case VLC_CODEC_RGB32:
149 fmt.i_rmask = 0xff0000;
150 fmt.i_gmask = 0x00ff00;
151 fmt.i_bmask = 0x0000ff;
161 vout_display_sys_t *sys;
162 vd->sys = sys = calloc(1, sizeof(*sys));
166 sys->lock = var_InheritAddress(vd, "vmem-lock");
167 if (sys->lock == NULL) {
168 msg_Err(vd, "Invalid lock callback");
172 sys->unlock = var_InheritAddress(vd, "vmem-unlock");
173 sys->display = var_InheritAddress(vd, "vmem-display");
174 sys->opaque = var_InheritAddress(vd, "vmem-data");
177 const int pitch = var_InheritInteger(vd, "vmem-pitch");
178 picture_resource_t rsc;
179 rsc.p_sys = malloc(sizeof(*rsc.p_sys));
180 if(unlikely(!rsc.p_sys)) {
184 rsc.p_sys->sys = sys;
185 rsc.p_sys->id = NULL;
186 for (int i = 0; i < PICTURE_PLANE_MAX; i++) {
187 /* vmem-lock is responsible for the allocation */
188 rsc.p[i].p_pixels = NULL;
189 rsc.p[i].i_lines = fmt.i_height;
190 rsc.p[i].i_pitch = pitch;
192 picture_t *picture = picture_NewFromResource(&fmt, &rsc);
200 picture_pool_configuration_t pool;
201 memset(&pool, 0, sizeof(pool));
202 pool.picture_count = 1;
203 pool.picture = &picture;
205 pool.unlock = Unlock;
206 sys->pool = picture_pool_NewExtended(&pool);
208 picture_Release(picture);
214 vout_display_info_t info = vd->info;
215 info.has_hide_mouse = true;
222 vd->display = Display;
223 vd->control = Control;
227 vout_display_SendEventFullscreen(vd, false);
228 vout_display_SendEventDisplaySize(vd, fmt.i_width, fmt.i_height, false);
232 static void Close(vlc_object_t *object)
234 vout_display_t *vd = (vout_display_t *)object;
235 vout_display_sys_t *sys = vd->sys;
237 picture_pool_Delete(sys->pool);
242 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
245 return vd->sys->pool;
248 static void Display(vout_display_t *vd, picture_t *picture)
250 vout_display_sys_t *sys = vd->sys;
252 assert(!picture_IsReferenced(picture));
253 if (sys->display != NULL)
254 sys->display(sys->opaque, picture->p_sys->id);
255 picture_Release(picture);
258 static int Control(vout_display_t *vd, int query, va_list args)
261 case VOUT_DISPLAY_CHANGE_FULLSCREEN:
262 case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
263 const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
264 if (cfg->display.width != vd->fmt.i_width ||
265 cfg->display.height != vd->fmt.i_height)
267 if (cfg->is_fullscreen)
275 static void Manage(vout_display_t *vd)
281 static int Lock(picture_t *picture)
283 picture_sys_t *picsys = picture->p_sys;
284 vout_display_sys_t *sys = picsys->sys;
285 void *planes[PICTURE_PLANE_MAX];
287 picsys->id = sys->lock(sys->opaque, planes);
289 for (int i = 0; i < picture->i_planes; i++)
290 picture->p[i].p_pixels = planes[i];
295 static void Unlock(picture_t *picture)
297 picture_sys_t *picsys = picture->p_sys;
298 vout_display_sys_t *sys = picsys->sys;
300 void *planes[PICTURE_PLANE_MAX];
302 for (int i = 0; i < picture->i_planes; i++)
303 planes[i] = picture->p[i].p_pixels;
305 if (sys->unlock != NULL)
306 sys->unlock(sys->opaque, picsys->id, planes);