git.sesse.net Git - vlc/blob - 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           Prepare(vout_display_t *, picture_t *, subpicture_t *);
 109 static void           Display(vout_display_t *, picture_t *, subpicture_t *);
 110 static int            Control(vout_display_t *, int, va_list);
 111
 112 static void Lock(void *data, picture_t *pic)
 113 {
 114     vout_display_sys_t *sys = data;
 115     picture_sys_t *picsys = pic->p_sys;
 116     void *planes[PICTURE_PLANE_MAX];
 117
 118     picsys->id = sys->lock(sys->opaque, planes);
 119
 120     for (int i = 0; i < pic->i_planes; i++)
 121         pic->p[i].p_pixels = planes[i];
 122 }
 123
 124 static void Unlock(void *data, picture_t *pic)
 125 {
 126     vout_display_sys_t *sys = data;
 127     picture_sys_t *picsys = pic->p_sys;
 128     void *planes[PICTURE_PLANE_MAX];
 129
 130     assert(!picture_IsReferenced(pic));
 131
 132     for (int i = 0; i < pic->i_planes; i++)
 133         planes[i] = pic->p[i].p_pixels;
 134
 135     if (sys->unlock != NULL)
 136         sys->unlock(sys->opaque, picsys->id, planes);
 137
 138 }
 139
 140 /*****************************************************************************
 141  * Open: allocates video thread
 142  *****************************************************************************
 143  * This function allocates and initializes a vout method.
 144  *****************************************************************************/
 145 static int Open(vlc_object_t *object)
 146 {
 147     vout_display_t *vd = (vout_display_t *)object;
 148     vout_display_sys_t *sys = malloc(sizeof(*sys));
 149     if (unlikely(!sys))
 150         return VLC_ENOMEM;
 151
 152     /* Get the callbacks */
 153     vlc_format_cb setup = var_InheritAddress(vd, "vmem-setup");
 154
 155     sys->lock = var_InheritAddress(vd, "vmem-lock");
 156     if (sys->lock == NULL) {
 157         msg_Err(vd, "missing lock callback");
 158         free(sys);
 159         return VLC_EGENERIC;
 160     }
 161     sys->unlock = var_InheritAddress(vd, "vmem-unlock");
 162     sys->display = var_InheritAddress(vd, "vmem-display");
 163     sys->cleanup = var_InheritAddress(vd, "vmem-cleanup");
 164     sys->opaque = var_InheritAddress(vd, "vmem-data");
 165     sys->pool = NULL;
 166
 167     /* Define the video format */
 168     video_format_t fmt;
 169     video_format_ApplyRotation(&fmt, &vd->fmt);
 170
 171     if (setup != NULL) {
 172         char chroma[5];
 173
 174         memcpy(chroma, &fmt.i_chroma, 4);
 175         chroma[4] = '\0';
 176         memset(sys->pitches, 0, sizeof(sys->pitches));
 177         memset(sys->lines, 0, sizeof(sys->lines));
 178
 179         sys->count = setup(&sys->opaque, chroma, &fmt.i_width, &fmt.i_height,
 180                            sys->pitches, sys->lines);
 181         if (sys->count == 0) {
 182             msg_Err(vd, "video format setup failure (no pictures)");
 183             free(sys);
 184             return VLC_EGENERIC;
 185         }
 186         fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
 187
 188     } else {
 189         char *chroma = var_InheritString(vd, "vmem-chroma");
 190         fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
 191         free(chroma);
 192
 193         fmt.i_width  = var_InheritInteger(vd, "vmem-width");
 194         fmt.i_height = var_InheritInteger(vd, "vmem-height");
 195         sys->pitches[0] = var_InheritInteger(vd, "vmem-pitch");
 196         sys->lines[0] = fmt.i_height;
 197         for (size_t i = 1; i < PICTURE_PLANE_MAX; i++)
 198         {
 199             sys->pitches[i] = sys->pitches[0];
 200             sys->lines[i] = sys->lines[0];
 201         }
 202         sys->count = 1;
 203         sys->cleanup = NULL;
 204     }
 205     fmt.i_x_offset = fmt.i_y_offset = 0;
 206     fmt.i_visible_width = fmt.i_width;
 207     fmt.i_visible_height = fmt.i_height;
 208
 209     if (!fmt.i_chroma) {
 210         msg_Err(vd, "vmem-chroma should be 4 characters long");
 211         free(sys);
 212         return VLC_EGENERIC;
 213     }
 214
 215     /* Define the bitmasks */
 216     switch (fmt.i_chroma)
 217     {
 218     case VLC_CODEC_RGB15:
 219         fmt.i_rmask = 0x001f;
 220         fmt.i_gmask = 0x03e0;
 221         fmt.i_bmask = 0x7c00;
 222         break;
 223     case VLC_CODEC_RGB16:
 224         fmt.i_rmask = 0x001f;
 225         fmt.i_gmask = 0x07e0;
 226         fmt.i_bmask = 0xf800;
 227         break;
 228     case VLC_CODEC_RGB24:
 229     case VLC_CODEC_RGB32:
 230         fmt.i_rmask = 0xff0000;
 231         fmt.i_gmask = 0x00ff00;
 232         fmt.i_bmask = 0x0000ff;
 233         break;
 234     default:
 235         fmt.i_rmask = 0;
 236         fmt.i_gmask = 0;
 237         fmt.i_bmask = 0;
 238         break;
 239     }
 240
 241     /* */
 242     vout_display_info_t info = vd->info;
 243     info.has_hide_mouse = true;
 244
 245     /* */
 246     vd->sys     = sys;
 247     vd->fmt     = fmt;
 248     vd->info    = info;
 249     vd->pool    = Pool;
 250     vd->prepare = Prepare;
 251     vd->display = Display;
 252     vd->control = Control;
 253     vd->manage  = NULL;
 254
 255     /* */
 256     vout_display_SendEventFullscreen(vd, false);
 257     vout_display_SendEventDisplaySize(vd, fmt.i_width, fmt.i_height);
 258     vout_display_DeleteWindow(vd, NULL);
 259     return VLC_SUCCESS;
 260 }
 261
 262 static void Close(vlc_object_t *object)
 263 {
 264     vout_display_t *vd = (vout_display_t *)object;
 265     vout_display_sys_t *sys = vd->sys;
 266
 267     if (sys->cleanup)
 268         sys->cleanup(sys->opaque);
 269
 270     picture_pool_Enum(sys->pool, Unlock, sys);
 271     picture_pool_Release(sys->pool);
 272     free(sys);
 273 }
 274
 275 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
 276 {
 277     vout_display_sys_t *sys = vd->sys;
 278
 279     if (sys->pool)
 280         return sys->pool;
 281
 282     if (count > sys->count)
 283         count = sys->count;
 284
 285     picture_t *pictures[count];
 286
 287     for (unsigned i = 0; i < count; i++) {
 288         picture_sys_t *picsys = malloc(sizeof (*picsys));
 289         if (unlikely(picsys == NULL))
 290         {
 291             count = i;
 292             break;
 293         }
 294         picsys->sys = sys;
 295         picsys->id = NULL;
 296
 297         picture_resource_t rsc = { .p_sys = picsys };
 298
 299         for (unsigned i = 0; i < PICTURE_PLANE_MAX; i++) {
 300             /* vmem-lock is responsible for the allocation */
 301             rsc.p[i].p_pixels = NULL;
 302             rsc.p[i].i_lines  = sys->lines[i];
 303             rsc.p[i].i_pitch  = sys->pitches[i];
 304         }
 305
 306         pictures[i] = picture_NewFromResource(&vd->fmt, &rsc);
 307         if (!pictures[i]) {
 308             free(rsc.p_sys);
 309             count = i;
 310             break;
 311         }
 312     }
 313
 314     /* */
 315     sys->pool = picture_pool_New(count, pictures);
 316     if (!sys->pool) {
 317         for (unsigned i = 0; i < count; i++)
 318             picture_Release(pictures[i]);
 319     }
 320
 321     picture_pool_Enum(sys->pool, Lock, sys);
 322     return sys->pool;
 323 }
 324
 325 static void Prepare(vout_display_t *vd, picture_t *pic, subpicture_t *subpic)
 326 {
 327     Unlock(vd->sys, pic);
 328     VLC_UNUSED(subpic);
 329 }
 330
 331
 332 static void Display(vout_display_t *vd, picture_t *pic, subpicture_t *subpic)
 333 {
 334     vout_display_sys_t *sys = vd->sys;
 335
 336     if (sys->display != NULL)
 337         sys->display(sys->opaque, pic->p_sys->id);
 338
 339     Lock(sys, pic);
 340     picture_Release(pic);
 341     VLC_UNUSED(subpic);
 342 }
 343
 344 static int Control(vout_display_t *vd, int query, va_list args)
 345 {
 346     (void) vd; (void) query; (void) args;
 347     return VLC_EGENERIC;
 348 }