modules/video_output/vmem.c

   1 /*****************************************************************************
   2  * vmem.c: memory video driver for vlc
   3  *****************************************************************************
   4  * Copyright (C) 2008 VLC authors and VideoLAN
   5  * Copyright (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 typedef struct
  85 {
  86     void *id;
  87 } picture_sys_t;
  88
  89 /* NOTE: the callback prototypes must match those of LibVLC */
  90 struct vout_display_sys_t {
  91     picture_pool_t *pool;
  92
  93     void *opaque;
  94     void *pic_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 *, vlc_tick_t);
 109 static void           Display(vout_display_t *, picture_t *, subpicture_t *);
 110 static int            Control(vout_display_t *, int, va_list);
 111
 112 /*****************************************************************************
 113  * Open: allocates video thread
 114  *****************************************************************************
 115  * This function allocates and initializes a vout method.
 116  *****************************************************************************/
 117 static int Open(vlc_object_t *object)
 118 {
 119     vout_display_t *vd = (vout_display_t *)object;
 120     vout_display_sys_t *sys = malloc(sizeof(*sys));
 121     if (unlikely(!sys))
 122         return VLC_ENOMEM;
 123
 124     /* Get the callbacks */
 125     vlc_format_cb setup = var_InheritAddress(vd, "vmem-setup");
 126
 127     sys->lock = var_InheritAddress(vd, "vmem-lock");
 128     if (sys->lock == NULL) {
 129         msg_Err(vd, "missing lock callback");
 130         free(sys);
 131         return VLC_EGENERIC;
 132     }
 133     sys->unlock = var_InheritAddress(vd, "vmem-unlock");
 134     sys->display = var_InheritAddress(vd, "vmem-display");
 135     sys->cleanup = var_InheritAddress(vd, "vmem-cleanup");
 136     sys->opaque = var_InheritAddress(vd, "vmem-data");
 137     sys->pool = NULL;
 138
 139     /* Define the video format */
 140     video_format_t fmt;
 141     video_format_ApplyRotation(&fmt, &vd->fmt);
 142
 143     if (setup != NULL) {
 144         char chroma[5];
 145
 146         memcpy(chroma, &fmt.i_chroma, 4);
 147         chroma[4] = '\0';
 148         memset(sys->pitches, 0, sizeof(sys->pitches));
 149         memset(sys->lines, 0, sizeof(sys->lines));
 150
 151         if (setup(&sys->opaque, chroma, &fmt.i_width, &fmt.i_height,
 152                            sys->pitches, sys->lines) == 0) {
 153             msg_Err(vd, "video format setup failure (no pictures)");
 154             free(sys);
 155             return VLC_EGENERIC;
 156         }
 157         fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
 158
 159     } else {
 160         char *chroma = var_InheritString(vd, "vmem-chroma");
 161         fmt.i_chroma = vlc_fourcc_GetCodecFromString(VIDEO_ES, chroma);
 162         free(chroma);
 163
 164         fmt.i_width  = var_InheritInteger(vd, "vmem-width");
 165         fmt.i_height = var_InheritInteger(vd, "vmem-height");
 166         sys->pitches[0] = var_InheritInteger(vd, "vmem-pitch");
 167         sys->lines[0] = fmt.i_height;
 168         for (size_t i = 1; i < PICTURE_PLANE_MAX; i++)
 169         {
 170             sys->pitches[i] = sys->pitches[0];
 171             sys->lines[i] = sys->lines[0];
 172         }
 173         sys->cleanup = NULL;
 174     }
 175     fmt.i_x_offset = fmt.i_y_offset = 0;
 176     fmt.i_visible_width = fmt.i_width;
 177     fmt.i_visible_height = fmt.i_height;
 178
 179     if (!fmt.i_chroma) {
 180         msg_Err(vd, "vmem-chroma should be 4 characters long");
 181         free(sys);
 182         return VLC_EGENERIC;
 183     }
 184
 185     /* Define the bitmasks */
 186     switch (fmt.i_chroma)
 187     {
 188     case VLC_CODEC_RGB15:
 189         fmt.i_rmask = 0x001f;
 190         fmt.i_gmask = 0x03e0;
 191         fmt.i_bmask = 0x7c00;
 192         break;
 193     case VLC_CODEC_RGB16:
 194         fmt.i_rmask = 0x001f;
 195         fmt.i_gmask = 0x07e0;
 196         fmt.i_bmask = 0xf800;
 197         break;
 198     case VLC_CODEC_RGB24:
 199     case VLC_CODEC_RGB32:
 200         fmt.i_rmask = 0xff0000;
 201         fmt.i_gmask = 0x00ff00;
 202         fmt.i_bmask = 0x0000ff;
 203         break;
 204     default:
 205         fmt.i_rmask = 0;
 206         fmt.i_gmask = 0;
 207         fmt.i_bmask = 0;
 208         break;
 209     }
 210
 211     /* */
 212     vd->sys     = sys;
 213     vd->fmt     = fmt;
 214     vd->pool    = Pool;
 215     vd->prepare = Prepare;
 216     vd->display = Display;
 217     vd->control = Control;
 218
 219     return VLC_SUCCESS;
 220 }
 221
 222 static void Close(vlc_object_t *object)
 223 {
 224     vout_display_t *vd = (vout_display_t *)object;
 225     vout_display_sys_t *sys = vd->sys;
 226
 227     if (sys->cleanup)
 228         sys->cleanup(sys->opaque);
 229     if (sys->pool)
 230         picture_pool_Release(sys->pool);
 231     free(sys);
 232 }
 233
 234 static picture_pool_t *Pool(vout_display_t *vd, unsigned count)
 235 {
 236     vout_display_sys_t *sys = vd->sys;
 237
 238     if (sys->pool == NULL)
 239         sys->pool = picture_pool_NewFromFormat(&vd->fmt, count);
 240     return sys->pool;
 241 }
 242
 243 static void Prepare(vout_display_t *vd, picture_t *pic, subpicture_t *subpic,
 244                     vlc_tick_t date)
 245 {
 246     VLC_UNUSED(date);
 247     vout_display_sys_t *sys = vd->sys;
 248     picture_resource_t rsc = { .p_sys = NULL };
 249     void *planes[PICTURE_PLANE_MAX];
 250
 251     sys->pic_opaque = sys->lock(sys->opaque, planes);
 252
 253     for (unsigned i = 0; i < PICTURE_PLANE_MAX; i++) {
 254         rsc.p[i].p_pixels = planes[i];
 255         rsc.p[i].i_lines  = sys->lines[i];
 256         rsc.p[i].i_pitch  = sys->pitches[i];
 257     }
 258
 259     picture_t *locked = picture_NewFromResource(&vd->fmt, &rsc);
 260     if (likely(locked != NULL)) {
 261         picture_CopyPixels(locked, pic);
 262         picture_Release(locked);
 263     }
 264
 265     if (sys->unlock != NULL)
 266         sys->unlock(sys->opaque, sys->pic_opaque, planes);
 267
 268     (void) subpic;
 269 }
 270
 271 static void Display(vout_display_t *vd, picture_t *pic, subpicture_t *subpic)
 272 {
 273     vout_display_sys_t *sys = vd->sys;
 274
 275     if (sys->display != NULL)
 276         sys->display(sys->opaque, sys->pic_opaque);
 277
 278     picture_Release(pic);
 279     VLC_UNUSED(subpic);
 280 }
 281
 282 static int Control(vout_display_t *vd, int query, va_list args)
 283 {
 284     (void) vd; (void) query; (void) args;
 285     return VLC_EGENERIC;
 286 }