modules/video_output/vmem.c

   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
   6  *
   7  * Authors: Sam Hocevar <sam@zoy.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 # include "config.h"
  30 #endif
  31
  32 #include <assert.h>
  33
  34 #include <vlc_common.h>
  35 #include <vlc_plugin.h>
  36 #include <vlc_vout_display.h>
  37 #include <vlc_picture_pool.h>
  38
  39 /*****************************************************************************
  40  * Module descriptor
  41  *****************************************************************************/
  42 #define T_WIDTH N_("Width")
  43 #define LT_WIDTH N_("Video memory buffer width.")
  44
  45 #define T_HEIGHT N_("Height")
  46 #define LT_HEIGHT N_("Video memory buffer height.")
  47
  48 #define T_PITCH N_("Pitch")
  49 #define LT_PITCH N_("Video memory buffer pitch in bytes.")
  50
  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\".")
  54
  55 static int  Open (vlc_object_t *);
  56 static void Close(vlc_object_t *);
  57
  58 vlc_module_begin()
  59     set_description(N_("Video memory output"))
  60     set_shortname(N_("Video memory"))
  61
  62     set_category(CAT_VIDEO)
  63     set_subcategory(SUBCAT_VIDEO_VOUT)
  64     set_capability("vout display", 0)
  65
  66     add_integer("vmem-width", 320, T_WIDTH, LT_WIDTH, false)
  67         change_private()
  68     add_integer("vmem-height", 200, T_HEIGHT, LT_HEIGHT, false)
  69         change_private()
  70     add_integer("vmem-pitch", 640, T_PITCH, LT_PITCH, false)
  71         change_private()
  72     add_string("vmem-chroma", "RV16", T_CHROMA, LT_CHROMA, true)
  73         change_private()
  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 */
  77
  78     set_callbacks(Open, Close)
  79 vlc_module_end()
  80
  81 /*****************************************************************************
  82  * Local prototypes
  83  *****************************************************************************/
  84 struct picture_sys_t {
  85     vout_display_sys_t *sys;
  86     void *id;
  87 };
  88
  89 /* NOTE: the callback prototypes must match those of LibVLC */
  90 struct vout_display_sys_t {
  91     picture_pool_t *pool;
  92     unsigned        count;
  93
  94     void *opaque;
  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);
  99
 100     unsigned pitches[PICTURE_PLANE_MAX];
 101     unsigned lines[PICTURE_PLANE_MAX];
 102 };
 103
 104 typedef unsigned (*vlc_format_cb)(void **, char *, unsigned *, unsigned *,
 105                                   unsigned *, unsigned *);
 106
 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);
 110
 111 static int            Lock(picture_t *);
 112 static void           Unlock(picture_t *);
 113
 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)
 120 {
 121     vout_display_t *vd = (vout_display_t *)object;
 122     vout_display_sys_t *sys = malloc(sizeof(*sys));
 123     if (unlikely(!sys))
 124         return VLC_ENOMEM;
 125
 126     /* Get the callbacks */
 127     vlc_format_cb setup = var_InheritAddress(vd, "vmem-setup");
 128
 129     sys->lock = var_InheritAddress(vd, "vmem-lock");
 130     if (sys->lock == NULL) {
 131         msg_Err(vd, "missing lock callback");
 132         free(sys);
 133         return VLC_EGENERIC;
 134     }
 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");
 139     sys->pool = NULL;
 140
 141     /* Define the video format */
 142     video_format_t fmt = vd->fmt;
 143
 144     if (setup != NULL) {
 145         char chroma[5];
 146
 147         memcpy(chroma, &fmt.i_chroma, 4);
 148         chroma[4] = '\0';
 149         memset(sys->pitches, 0, sizeof(sys->pitches));
 150         memset(sys->lines, 0, sizeof(sys->lines));
 151
 152         sys->count = setup(&sys->opaque, chroma, &fmt.i_width, &fmt.i_height,
 153                            sys->pitches, sys->lines);
 154         if (sys->count == 0) {
 155             msg_Err(vd, "video format setup failure (no pictures)");
 156             free(sys);
 157             return VLC_EGENERIC;
 158         }
 159         fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
 160
 161     } else {
 162         char *chroma = var_InheritString(vd, "vmem-chroma");
 163         fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
 164         free(chroma);
 165
 166         fmt.i_width  = var_InheritInteger(vd, "vmem-width");
 167         fmt.i_height = var_InheritInteger(vd, "vmem-height");
 168         sys->pitches[0] = var_InheritInteger(vd, "vmem-pitch");
 169         sys->lines[0] = fmt.i_height;
 170         for (size_t i = 1; i < PICTURE_PLANE_MAX; i++)
 171         {
 172             sys->pitches[i] = sys->pitches[0];
 173             sys->lines[i] = sys->lines[0];
 174         }
 175         sys->count = 1;
 176         sys->cleanup = NULL;
 177     }
 178     fmt.i_x_offset = fmt.i_y_offset = 0;
 179     fmt.i_visible_width = fmt.i_width;
 180     fmt.i_visible_height = fmt.i_height;
 181
 182     if (!fmt.i_chroma) {
 183         msg_Err(vd, "vmem-chroma should be 4 characters long");
 184         free(sys);
 185         return VLC_EGENERIC;
 186     }
 187
 188     /* Define the bitmasks */
 189     switch (fmt.i_chroma)
 190     {
 191     case VLC_CODEC_RGB15:
 192         fmt.i_rmask = 0x001f;
 193         fmt.i_gmask = 0x03e0;
 194         fmt.i_bmask = 0x7c00;
 195         break;
 196     case VLC_CODEC_RGB16:
 197         fmt.i_rmask = 0x001f;
 198         fmt.i_gmask = 0x07e0;
 199         fmt.i_bmask = 0xf800;
 200         break;
 201     case VLC_CODEC_RGB24:
 202     case VLC_CODEC_RGB32:
 203         fmt.i_rmask = 0xff0000;
 204         fmt.i_gmask = 0x00ff00;
 205         fmt.i_bmask = 0x0000ff;
 206         break;
 207     default:
 208         fmt.i_rmask = 0;
 209         fmt.i_gmask = 0;
 210         fmt.i_bmask = 0;
 211         break;
 212     }
 213
 214     /* */
 215     vout_display_info_t info = vd->info;
 216     info.has_hide_mouse = true;
 217
 218     /* */
 219     vd->sys     = sys;
 220     vd->fmt     = fmt;
 221     vd->info    = info;
 222     vd->pool    = Pool;
 223     vd->prepare = NULL;
 224     vd->display = Display;
 225     vd->control = Control;
 226     vd->manage  = NULL;
 227
 228     /* */
 229     vout_display_SendEventFullscreen(vd, false);
 230     vout_display_SendEventDisplaySize(vd, fmt.i_width, fmt.i_height, false);
 231     return VLC_SUCCESS;
 232 }
 233
 234 static void Close(vlc_object_t *object)
 235 {
 236     vout_display_t *vd = (vout_display_t *)object;
 237     vout_display_sys_t *sys = vd->sys;
 238
 239     if (sys->cleanup)
 240         sys->cleanup(sys->opaque);
 241     picture_pool_Delete(sys->pool);
 242     free(sys);
 243 }
 244
 245 /* */
 246 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
 247 {
 248     vout_display_sys_t *sys = vd->sys;
 249
 250     if (sys->pool)
 251         return sys->pool;
 252
 253     if (count > sys->count)
 254         count = sys->count;
 255
 256     picture_t *pictures[count];
 257
 258     for (unsigned i = 0; i < count; i++) {
 259         picture_sys_t *picsys = malloc(sizeof (*picsys));
 260         if (unlikely(picsys == NULL))
 261         {
 262             count = i;
 263             break;
 264         }
 265         picsys->sys = sys;
 266         picsys->id = NULL;
 267
 268         picture_resource_t rsc = { .p_sys = picsys };
 269
 270         for (unsigned i = 0; i < PICTURE_PLANE_MAX; i++) {
 271             /* vmem-lock is responsible for the allocation */
 272             rsc.p[i].p_pixels = NULL;
 273             rsc.p[i].i_lines  = sys->lines[i];
 274             rsc.p[i].i_pitch  = sys->pitches[i];
 275         }
 276
 277         pictures[i] = picture_NewFromResource(&vd->fmt, &rsc);
 278         if (!pictures[i]) {
 279             free(rsc.p_sys);
 280             count = i;
 281             break;
 282         }
 283     }
 284
 285     /* */
 286     picture_pool_configuration_t pool;
 287     memset(&pool, 0, sizeof(pool));
 288     pool.picture_count = count;
 289     pool.picture       = pictures;
 290     pool.lock          = Lock;
 291     pool.unlock        = Unlock;
 292     sys->pool = picture_pool_NewExtended(&pool);
 293     if (!sys->pool) {
 294         for (unsigned i = 0; i < count; i++)
 295             picture_Release(pictures[i]);
 296     }
 297
 298     return sys->pool;
 299 }
 300
 301 static void Display(vout_display_t *vd, picture_t *picture, subpicture_t *subpicture)
 302 {
 303     vout_display_sys_t *sys = vd->sys;
 304
 305     assert(!picture_IsReferenced(picture));
 306     if (sys->display != NULL)
 307         sys->display(sys->opaque, picture->p_sys->id);
 308     picture_Release(picture);
 309     VLC_UNUSED(subpicture);
 310 }
 311
 312 static int Control(vout_display_t *vd, int query, va_list args)
 313 {
 314     switch (query) {
 315     case VOUT_DISPLAY_CHANGE_FULLSCREEN:
 316     case VOUT_DISPLAY_CHANGE_DISPLAY_SIZE: {
 317         const vout_display_cfg_t *cfg = va_arg(args, const vout_display_cfg_t *);
 318         if (cfg->display.width  != vd->fmt.i_width ||
 319             cfg->display.height != vd->fmt.i_height)
 320             return VLC_EGENERIC;
 321         if (cfg->is_fullscreen)
 322             return VLC_EGENERIC;
 323         return VLC_SUCCESS;
 324     }
 325     default:
 326         return VLC_EGENERIC;
 327     }
 328 }
 329
 330 /* */
 331 static int Lock(picture_t *picture)
 332 {
 333     picture_sys_t *picsys = picture->p_sys;
 334     vout_display_sys_t *sys = picsys->sys;
 335     void *planes[PICTURE_PLANE_MAX];
 336
 337     picsys->id = sys->lock(sys->opaque, planes);
 338
 339     for (int i = 0; i < picture->i_planes; i++)
 340         picture->p[i].p_pixels = planes[i];
 341
 342     return VLC_SUCCESS;
 343 }
 344
 345 static void Unlock(picture_t *picture)
 346 {
 347     picture_sys_t *picsys = picture->p_sys;
 348     vout_display_sys_t *sys = picsys->sys;
 349
 350     void *planes[PICTURE_PLANE_MAX];
 351
 352     for (int i = 0; i < picture->i_planes; i++)
 353         planes[i] = picture->p[i].p_pixels;
 354
 355     if (sys->unlock != NULL)
 356         sys->unlock(sys->opaque, picsys->id, planes);
 357 }