git.sesse.net Git - vlc/blob - modules/video_output/wrapper.c

   1 /*****************************************************************************
   2  * vout_display.c: "vout display" -> "video output" wrapper
   3  *****************************************************************************
   4  * Copyright (C) 2009 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
   8  *
   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.
  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 General Public License for more details.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30
  31 #include <vlc_common.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_vout_display.h>
  34 #include <vlc_vout_wrapper.h>
  35 #include <vlc_vout.h>
  36 #include "../video_filter/filter_common.h"
  37 #include <assert.h>
  38
  39 /*****************************************************************************
  40  * Module descriptor
  41  *****************************************************************************/
  42 static int  Open (vlc_object_t *, const char *module);
  43 static void Close(vlc_object_t *);
  44
  45 #define DECLARE_OPEN(name) \
  46         static int Open##name(vlc_object_t *object) { return Open(object, #name); }
  47
  48 DECLARE_OPEN(aalib);
  49 DECLARE_OPEN(caca);
  50 DECLARE_OPEN(sdl);
  51 DECLARE_OPEN(xcb_x11);
  52 DECLARE_OPEN(xcb_xv);
  53 DECLARE_OPEN(dummy);
  54 DECLARE_OPEN(fb);
  55 DECLARE_OPEN(directfb);
  56 DECLARE_OPEN(yuv);
  57 DECLARE_OPEN(snapshot);
  58 DECLARE_OPEN(vmem);
  59
  60 #undef DECLARE_OPEN
  61
  62 #define DECLARE_MODULE(name, priority)                  \
  63     set_description( "Video display "#name" wrapper" )  \
  64     set_shortname( "Video display "#name" wrapper" )    \
  65     set_capability( "video output", priority )          \
  66     set_callbacks( Open##name, Close )                  \
  67     add_shortcut( #name )
  68
  69 vlc_module_begin()
  70     set_category( CAT_VIDEO )
  71     set_subcategory( SUBCAT_VIDEO_VOUT )
  72
  73     DECLARE_MODULE(aalib, 10)
  74
  75     add_submodule()
  76     DECLARE_MODULE(caca, 12)
  77
  78     add_submodule()
  79     DECLARE_MODULE(sdl, 60)
  80
  81     add_submodule()
  82     DECLARE_MODULE(xcb_x11, 75)
  83
  84     add_submodule()
  85     DECLARE_MODULE(xcb_xv, 155)
  86
  87     add_submodule()
  88     DECLARE_MODULE(dummy, 1)
  89
  90     add_submodule()
  91     DECLARE_MODULE(fb, 30)
  92
  93     add_submodule()
  94     DECLARE_MODULE(directfb, 60)
  95
  96     add_submodule()
  97     DECLARE_MODULE(yuv, 0)
  98
  99     add_submodule()
 100     DECLARE_MODULE(snapshot, 0)
 101
 102     add_submodule()
 103     DECLARE_MODULE(vmem, 0)
 104
 105 vlc_module_end()
 106
 107 #undef DECLARE_MODULE
 108
 109 /*****************************************************************************
 110  *
 111  *****************************************************************************/
 112 struct vout_sys_t {
 113     char           *title;
 114     vout_display_t *vd;
 115     bool           use_dr;
 116 };
 117
 118 struct picture_sys_t {
 119     picture_t *direct;
 120 };
 121
 122 /*****************************************************************************
 123  * Local prototypes
 124  *****************************************************************************/
 125 static int  Init   (vout_thread_t *);
 126 static void End    (vout_thread_t *);
 127 static int  Manage (vout_thread_t *);
 128 static void Render (vout_thread_t *, picture_t *);
 129 static void Display(vout_thread_t *, picture_t *);
 130
 131 static void VoutGetDisplayCfg(vout_thread_t *,
 132                               vout_display_cfg_t *, const char *title);
 133
 134 /*****************************************************************************
 135  *
 136  *****************************************************************************/
 137 static int Open(vlc_object_t *object, const char *module)
 138 {
 139     vout_thread_t *vout = (vout_thread_t *)object;
 140     vout_sys_t *sys;
 141
 142     msg_Warn(vout, "Opening vout display wrapper");
 143
 144     /* */
 145     sys = malloc(sizeof(*sys));
 146     if (!sys)
 147         return VLC_ENOMEM;
 148
 149     sys->title = var_CreateGetNonEmptyString(vout, "video-title");
 150
 151     /* */
 152     video_format_t source   = vout->fmt_render;
 153     source.i_visible_width  = source.i_width;
 154     source.i_visible_height = source.i_height;
 155     source.i_x_offset       = 0;
 156     source.i_y_offset       = 0;
 157
 158     vout_display_state_t state;
 159     VoutGetDisplayCfg(vout, &state.cfg, sys->title);
 160     state.is_on_top = var_CreateGetBool(vout, "video-on-top");
 161     state.sar.num = 0;
 162     state.sar.den = 0;
 163
 164     const mtime_t double_click_timeout = 300000;
 165     const mtime_t hide_timeout = var_CreateGetInteger(vout, "mouse-hide-timeout") * 1000;
 166
 167     sys->vd = vout_NewDisplay(vout, &source, &state, module,
 168                               double_click_timeout, hide_timeout);
 169     if (!sys->vd) {
 170         free(sys->title);
 171         free(sys);
 172         return VLC_EGENERIC;
 173     }
 174
 175     /* */
 176     vout->pf_init    = Init;
 177     vout->pf_end     = End;
 178     vout->pf_manage  = Manage;
 179     vout->pf_render  = Render;
 180     vout->pf_display = Display;
 181     vout->pf_control = NULL;
 182     vout->p_sys      = sys;
 183
 184     return VLC_SUCCESS;
 185 }
 186
 187 /*****************************************************************************
 188  *
 189  *****************************************************************************/
 190 static void Close(vlc_object_t *object)
 191 {
 192     vout_thread_t *vout = (vout_thread_t *)object;
 193     vout_sys_t *sys = vout->p_sys;
 194
 195     if (sys->vd)
 196         vout_DeleteDisplay(sys->vd, NULL);
 197     free(sys->title);
 198     free(sys );
 199 }
 200
 201 /*****************************************************************************
 202  *
 203  *****************************************************************************/
 204 static int Init(vout_thread_t *vout)
 205 {
 206     vout_sys_t *sys = vout->p_sys;
 207     vout_display_t *vd = sys->vd;
 208
 209     /* */
 210     video_format_t source = vd->source;
 211
 212     vout->output.i_chroma = source.i_chroma;
 213     vout->output.i_width  = source.i_width;
 214     vout->output.i_height = source.i_height;
 215     vout->output.i_aspect = source.i_aspect;
 216     vout->output.i_rmask  = source.i_rmask;
 217     vout->output.i_gmask  = source.i_gmask;
 218     vout->output.i_bmask  = source.i_bmask;
 219     vout->output.pf_setpalette = NULL; /* FIXME What to do ? Seems unused anyway */
 220
 221     /* also set fmt_out (completly broken API) */
 222     vout->fmt_out.i_chroma         = vout->output.i_chroma;
 223     vout->fmt_out.i_width          =
 224     vout->fmt_out.i_visible_width  = vout->output.i_width;
 225     vout->fmt_out.i_height         =
 226     vout->fmt_out.i_visible_height = vout->output.i_height;
 227     vout->fmt_out.i_aspect         = vout->output.i_aspect;
 228     vout->fmt_out.i_x_offset       = 0;
 229     vout->fmt_out.i_y_offset       = 0;
 230
 231     /* TODO */
 232 #if 0
 233     if (p_vout->fmt_render.i_visible_width  != source.i_visible_width ||
 234         p_vout->fmt_render.i_visible_height != source.i_visible_height ||
 235         p_vout->fmt_render.i_x_offset != source.i_x_offset ||
 236         p_vout->fmt_render.i_y_offset != source.i_y_offset )
 237     {
 238         p_vout->i_changes |= VOUT_CROP_CHANGE;
 239     }
 240 #endif
 241     if (vout->b_on_top)
 242         vout_SetDisplayOnTop(vd, true);
 243
 244     /* XXX For non dr case, the current vout implementation force us to
 245      * create at most 1 direct picture (otherwise the buffers will be kept
 246      * referenced even through the Init/End.
 247      */
 248     sys->use_dr = !vout_IsDisplayFiltered(vd);
 249     const bool allow_dr = !vd->info.has_pictures_invalid && sys->use_dr;
 250     const int picture_max = allow_dr ? VOUT_MAX_PICTURES : 1;
 251     for (vout->output.i_pictures = 0;
 252             vout->output.i_pictures < picture_max;
 253                 vout->output.i_pictures++) {
 254         /* Find an empty picture slot */
 255         picture_t *picture = NULL;
 256         for (int index = 0; index < VOUT_MAX_PICTURES; index++) {
 257             if (vout->p_picture[index].i_status == FREE_PICTURE) {
 258                 picture = &vout->p_picture[index];
 259                 break;
 260             }
 261         }
 262         if (!picture)
 263             break;
 264         memset(picture, 0, sizeof(*picture));
 265
 266         picture->p_sys = malloc(sizeof(*picture->p_sys));
 267
 268         if (sys->use_dr) {
 269             picture_t *direct = vout_display_Get(vd);
 270             if (!direct)
 271                 break;
 272             picture->format = direct->format;
 273             picture->i_planes = direct->i_planes;
 274             for (int i = 0; i < direct->i_planes; i++)
 275                 picture->p[i] = direct->p[i];
 276             picture->b_slow = vd->info.is_slow;
 277
 278             picture->p_sys->direct = direct;
 279         } else {
 280             vout_AllocatePicture(VLC_OBJECT(vd), picture,
 281                                  vd->source.i_chroma,
 282                                  vd->source.i_width, vd->source.i_height,
 283                                  vd->source.i_aspect);
 284             if (!picture->i_planes)
 285                 break;
 286             picture->p_sys->direct = NULL;
 287         }
 288         picture->i_status = DESTROYED_PICTURE;
 289         picture->i_type    = DIRECT_PICTURE;
 290
 291         vout->output.pp_picture[vout->output.i_pictures] = picture;
 292     }
 293     return VLC_SUCCESS;
 294 }
 295
 296 /*****************************************************************************
 297  *
 298  *****************************************************************************/
 299 static void End(vout_thread_t *vout)
 300 {
 301     vout_sys_t *sys = vout->p_sys;
 302
 303     for (int i = 0; i < VOUT_MAX_PICTURES; i++) {
 304         picture_t *picture = &vout->p_picture[i];
 305
 306         if (picture->i_type != DIRECT_PICTURE)
 307             continue;
 308
 309         if (picture->p_sys->direct)
 310             picture_Release(picture->p_sys->direct);
 311         if (!sys->use_dr)
 312             free(picture->p_data_orig);
 313         free(picture->p_sys);
 314     }
 315 }
 316
 317 /*****************************************************************************
 318  *
 319  *****************************************************************************/
 320 static int Manage(vout_thread_t *vout)
 321 {
 322     vout_sys_t *sys = vout->p_sys;
 323     vout_display_t *vd = sys->vd;
 324
 325     while (vout->i_changes & (VOUT_FULLSCREEN_CHANGE |
 326                               VOUT_ASPECT_CHANGE |
 327                               VOUT_ZOOM_CHANGE |
 328                               VOUT_SCALE_CHANGE |
 329                               VOUT_ON_TOP_CHANGE |
 330                               VOUT_CROP_CHANGE)) {
 331         /* */
 332         if (vout->i_changes & VOUT_FULLSCREEN_CHANGE) {
 333             vout->b_fullscreen = !vout->b_fullscreen;
 334
 335             var_SetBool(vout, "fullscreen", vout->b_fullscreen);
 336             vout_SetDisplayFullscreen(vd, vout->b_fullscreen);
 337             vout->i_changes &= ~VOUT_FULLSCREEN_CHANGE;
 338         }
 339         if (vout->i_changes & VOUT_ASPECT_CHANGE) {
 340             vout->output.i_aspect   =
 341             vout->fmt_out.i_aspect  = vout->fmt_in.i_aspect;
 342             vout->fmt_out.i_sar_num = vout->fmt_in.i_sar_num;
 343             vout->fmt_out.i_sar_den = vout->fmt_in.i_sar_den;
 344
 345             vout_SetDisplayAspect(vd, vout->fmt_in.i_sar_num, vout->fmt_in.i_sar_den);
 346
 347             vout->i_changes &= ~VOUT_ASPECT_CHANGE;
 348         }
 349         if (vout->i_changes & VOUT_ZOOM_CHANGE) {
 350             const float zoom = var_GetFloat(vout, "scale");
 351
 352             unsigned den = ZOOM_FP_FACTOR;
 353             unsigned num = den * zoom;
 354             if (num < (ZOOM_FP_FACTOR+9) / 10)
 355                 num = (ZOOM_FP_FACTOR+9) / 10;
 356             else if (num > ZOOM_FP_FACTOR * 10)
 357                 num = ZOOM_FP_FACTOR * 10;
 358
 359             vout_SetDisplayZoom(vd, num, den);
 360
 361             vout->i_changes &= ~VOUT_ZOOM_CHANGE;
 362         }
 363         if (vout->i_changes & VOUT_SCALE_CHANGE) {
 364             const bool is_display_filled = var_GetBool(vout, "autoscale");
 365
 366             vout_SetDisplayFilled(vd, is_display_filled);
 367
 368             vout->i_changes &= ~VOUT_SCALE_CHANGE;
 369         }
 370         if (vout->i_changes & VOUT_ON_TOP_CHANGE) {
 371             vout_SetDisplayOnTop(vd, vout->b_on_top);
 372
 373             vout->i_changes &= ~VOUT_ON_TOP_CHANGE;
 374         }
 375         if (vout->i_changes & VOUT_CROP_CHANGE) {
 376             const video_format_t crop = vout->fmt_in;
 377             const video_format_t org = vout->fmt_render;
 378             /* FIXME because of rounding errors, the reconstructed ratio is wrong */
 379             unsigned num = 0;
 380             unsigned den = 0;
 381             if (crop.i_x_offset == org.i_x_offset &&
 382                 crop.i_visible_width == org.i_visible_width &&
 383                 crop.i_y_offset == org.i_y_offset + (org.i_visible_height - crop.i_visible_height)/2) {
 384                 vlc_ureduce(&num, &den,
 385                             crop.i_visible_width * crop.i_sar_num,
 386                             crop.i_visible_height * crop.i_sar_den, 0);
 387             } else if (crop.i_y_offset == org.i_y_offset &&
 388                        crop.i_visible_height == org.i_visible_height &&
 389                        crop.i_x_offset == org.i_x_offset + (org.i_visible_width - crop.i_visible_width)/2) {
 390                 vlc_ureduce(&num, &den,
 391                             crop.i_visible_width * crop.i_sar_num,
 392                             crop.i_visible_height * crop.i_sar_den, 0);
 393             }
 394             vout_SetDisplayCrop(vd, num, den,
 395                                 crop.i_x_offset, crop.i_y_offset,
 396                                 crop.i_visible_width, crop.i_visible_height);
 397             vout->i_changes &= ~VOUT_CROP_CHANGE;
 398         }
 399
 400     }
 401
 402     if (sys->use_dr && vout_AreDisplayPicturesInvalid(vd)) {
 403         vout->i_changes |= VOUT_PICTURE_BUFFERS_CHANGE;
 404     }
 405
 406     vout_ManageDisplay(vd);
 407     return VLC_SUCCESS;
 408 }
 409
 410 /*****************************************************************************
 411  * Render
 412  *****************************************************************************/
 413 static void Render(vout_thread_t *vout, picture_t *picture)
 414 {
 415     vout_sys_t *sys = vout->p_sys;
 416     vout_display_t *vd = sys->vd;
 417
 418     assert(sys->use_dr || !picture->p_sys->direct);
 419     assert(vout_IsDisplayFiltered(vd) == !sys->use_dr);
 420
 421     if (sys->use_dr) {
 422         assert(picture->p_sys->direct);
 423         vout_display_Prepare(vd, picture->p_sys->direct);
 424     } else {
 425         picture_t *direct = picture->p_sys->direct = vout_FilterDisplay(vd, picture);
 426         if (direct) {
 427             vout_display_Prepare(vd, direct);
 428         }
 429     }
 430 }
 431
 432 /*****************************************************************************
 433  *
 434  *****************************************************************************/
 435 static void Display(vout_thread_t *vout, picture_t *picture)
 436 {
 437     vout_sys_t *sys = vout->p_sys;
 438     vout_display_t *vd = sys->vd;
 439
 440     picture_t *direct = picture->p_sys->direct;
 441     if (!direct)
 442         return;
 443
 444     /* XXX This is a hack that will work with current vout_display_t modules */
 445     if (sys->use_dr)
 446         picture_Hold(direct);
 447
 448      vout_display_Display(vd, direct);
 449
 450      if (!sys->use_dr)
 451          picture->p_sys->direct = NULL;
 452 }
 453
 454 static void VoutGetDisplayCfg(vout_thread_t *vout, vout_display_cfg_t *cfg, const char *title)
 455 {
 456     /* Load configuration */
 457     cfg->is_fullscreen = var_CreateGetBool(vout, "fullscreen");
 458     cfg->display.title = title;
 459     const int display_width = var_CreateGetInteger(vout, "width");
 460     const int display_height = var_CreateGetInteger(vout, "height");
 461     cfg->display.width   = display_width > 0  ? display_width  : 0;
 462     cfg->display.height  = display_height > 0 ? display_height : 0;
 463     cfg->is_display_filled  = var_CreateGetBool(vout, "autoscale");
 464     cfg->display.sar.num = 1; /* TODO monitor AR */
 465     cfg->display.sar.den = 1;
 466     unsigned zoom_den = 1000;
 467     unsigned zoom_num = zoom_den * var_CreateGetFloat(vout, "scale");
 468     vlc_ureduce(&zoom_num, &zoom_den, zoom_num, zoom_den, 0);
 469     cfg->zoom.num = zoom_num;
 470     cfg->zoom.den = zoom_den;
 471     cfg->align.vertical = VOUT_DISPLAY_ALIGN_CENTER;
 472     cfg->align.horizontal = VOUT_DISPLAY_ALIGN_CENTER;
 473     const int align_mask = var_CreateGetInteger(vout, "align");
 474     if (align_mask & 0x1)
 475         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_LEFT;
 476     else if (align_mask & 0x2)
 477         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_RIGHT;
 478     if (align_mask & 0x4)
 479         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_TOP;
 480     else if (align_mask & 0x8)
 481         cfg->align.horizontal = VOUT_DISPLAY_ALIGN_BOTTOM;
 482 }
 483