libvo/video_out.h

   1 /*
   2  * Copyright (C) Aaron Holtzman - Aug 1999
   3  * Strongly modified, most parts rewritten: A'rpi/ESP-team - 2000-2001
   4  * (C) MPlayer developers
   5  *
   6  * This file is part of MPlayer.
   7  *
   8  * MPlayer is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * MPlayer is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21  */
  22
  23 #ifndef MPLAYER_VIDEO_OUT_H
  24 #define MPLAYER_VIDEO_OUT_H
  25
  26 #include <inttypes.h>
  27 #include <stdbool.h>
  28
  29 //#include "font_load.h"
  30 #include "libmpcodecs/img_format.h"
  31 //#include "vidix/vidix.h"
  32
  33 #define MP_NOPTS_VALUE (-1LL<<63)
  34
  35 #define VO_EVENT_EXPOSE 1
  36 #define VO_EVENT_RESIZE 2
  37 #define VO_EVENT_KEYPRESS 4
  38 #define VO_EVENT_REINIT 8
  39
  40 /* Obsolete: VOCTRL_QUERY_VAA 1 */
  41 /* does the device support the required format */
  42 #define VOCTRL_QUERY_FORMAT 2
  43 /* signal a device reset seek */
  44 #define VOCTRL_RESET 3
  45 /* used to switch to fullscreen */
  46 #define VOCTRL_FULLSCREEN 5
  47 /* signal a device pause */
  48 #define VOCTRL_PAUSE 7
  49 /* start/resume playback */
  50 #define VOCTRL_RESUME 8
  51 /* libmpcodecs direct rendering: */
  52 #define VOCTRL_GET_IMAGE 9
  53 #define VOCTRL_DRAW_IMAGE 13
  54 #define VOCTRL_SET_SPU_PALETTE 14
  55 /* decoding ahead: */
  56 #define VOCTRL_GET_NUM_FRAMES 10
  57 #define VOCTRL_GET_FRAME_NUM  11
  58 #define VOCTRL_SET_FRAME_NUM  12
  59 #define VOCTRL_GET_PANSCAN 15
  60 #define VOCTRL_SET_PANSCAN 16
  61 /* equalizer controls */
  62 #define VOCTRL_SET_EQUALIZER 17
  63 struct voctrl_set_equalizer_args {
  64     const char *name;
  65     int value;
  66 };
  67 #define VOCTRL_GET_EQUALIZER 18
  68 struct voctrl_get_equalizer_args {
  69     const char *name;
  70     int *valueptr;
  71 };
  72 /* Frame duplication */
  73 #define VOCTRL_DUPLICATE_FRAME 20
  74 // ... 21
  75 #define VOCTRL_START_SLICE 21
  76
  77 #define VOCTRL_ONTOP 25
  78 #define VOCTRL_ROOTWIN 26
  79 #define VOCTRL_BORDER 27
  80 #define VOCTRL_DRAW_EOSD 28
  81 #define VOCTRL_GET_EOSD_RES 29
  82 typedef struct {
  83   int w, h; // screen dimensions, including black borders
  84   int mt, mb, ml, mr; // borders (top, bottom, left, right)
  85 } mp_eosd_res_t;
  86
  87 #define VOCTRL_SET_DEINTERLACE 30
  88 #define VOCTRL_GET_DEINTERLACE 31
  89
  90 #define VOCTRL_UPDATE_SCREENINFO 32
  91
  92 #define VOCTRL_SET_YUV_COLORSPACE 33
  93 #define VOCTRL_GET_YUV_COLORSPACE 34
  94
  95 // Vo can be used by xover
  96 #define VOCTRL_XOVERLAY_SUPPORT 22
  97
  98 #define VOCTRL_XOVERLAY_SET_COLORKEY 24
  99 typedef struct {
 100   uint32_t x11; // The raw x11 color
 101   uint16_t r,g,b;
 102 } mp_colorkey_t;
 103
 104 #define VOCTRL_XOVERLAY_SET_WIN 23
 105 #define VOCTRL_REDRAW_OSD 24
 106
 107 typedef struct {
 108   int x,y;
 109   int w,h;
 110 } mp_win_t;
 111
 112 #define VO_TRUE         1
 113 #define VO_FALSE        0
 114 #define VO_ERROR        -1
 115 #define VO_NOTAVAIL     -2
 116 #define VO_NOTIMPL      -3
 117
 118 #define VOFLAG_FULLSCREEN       0x01
 119 #define VOFLAG_MODESWITCHING    0x02
 120 #define VOFLAG_SWSCALE          0x04
 121 #define VOFLAG_FLIPPING         0x08
 122 #define VOFLAG_HIDDEN           0x10  //< Use to create a hidden window
 123 #define VOFLAG_XOVERLAY_SUB_VO  0x10000
 124
 125 typedef struct vo_info_s
 126 {
 127     /* driver name ("Matrox Millennium G200/G400" */
 128     const char *name;
 129     /* short name (for config strings) ("mga") */
 130     const char *short_name;
 131     /* author ("Aaron Holtzman <aholtzma@ess.engr.uvic.ca>") */
 132     const char *author;
 133     /* any additional comments */
 134     const char *comment;
 135 } vo_info_t;
 136
 137 struct vo;
 138 struct osd_state;
 139 struct mp_image;
 140
 141 struct vo_driver {
 142     // Driver uses new API
 143     bool is_new;
 144     // Driver buffers or adds (deinterlace) frames and will keep track
 145     // of pts values itself
 146     bool buffer_frames;
 147
 148     // This is set if the driver is not new and contains pointers to
 149     // old-API functions to be used instead of the ones below.
 150     struct vo_old_functions *old_functions;
 151
 152     const vo_info_t *info;
 153     /*
 154      * Preinitializes driver (real INITIALIZATION)
 155      *   arg - currently it's vo_subdevice
 156      *   returns: zero on successful initialization, non-zero on error.
 157      */
 158     int (*preinit)(struct vo *vo, const char *arg);
 159     /*
 160      * Initialize (means CONFIGURE) the display driver.
 161      * params:
 162      *   width,height: image source size
 163      *   d_width,d_height: size of the requested window size, just a hint
 164      *   fullscreen: flag, 0=windowd 1=fullscreen, just a hint
 165      *   title: window title, if available
 166      *   format: fourcc of pixel format
 167      * returns : zero on successful initialization, non-zero on error.
 168      */
 169     int (*config)(struct vo *vo, uint32_t width, uint32_t height,
 170                   uint32_t d_width, uint32_t d_height, uint32_t fullscreen,
 171                   char *title, uint32_t format);
 172
 173     /*
 174      * Control interface
 175      */
 176     int (*control)(struct vo *vo, uint32_t request, void *data);
 177
 178     void (*draw_image)(struct vo *vo, struct mp_image *mpi, double pts);
 179
 180     /*
 181      * Get extra frames from the VO, such as those added by VDPAU
 182      * deinterlace. Preparing the next such frame if any could be done
 183      * automatically by the VO after a previous flip_page(), but having
 184      * it as a separate step seems to allow making code more robust.
 185      */
 186     void (*get_buffered_frame)(struct vo *vo, bool eof);
 187
 188     /*
 189      * Draw a planar YUV slice to the buffer:
 190      * params:
 191      *   src[3] = source image planes (Y,U,V)
 192      *   stride[3] = source image planes line widths (in bytes)
 193      *   w,h = width*height of area to be copied (in Y pixels)
 194      *   x,y = position at the destination image (in Y pixels)
 195      */
 196     int (*draw_slice)(struct vo *vo, uint8_t *src[], int stride[], int w,
 197                       int h, int x, int y);
 198
 199     /*
 200      * Draws OSD to the screen buffer
 201      */
 202     void (*draw_osd)(struct vo *vo, struct osd_state *osd);
 203
 204     /*
 205      * Blit/Flip buffer to the screen. Must be called after each frame!
 206      */
 207     void (*flip_page)(struct vo *vo);
 208     void (*flip_page_timed)(struct vo *vo, unsigned int pts_us, int duration);
 209
 210     /*
 211      * This func is called after every frames to handle keyboard and
 212      * other events. It's called in PAUSE mode too!
 213      */
 214     void (*check_events)(struct vo *vo);
 215
 216     /*
 217      * Closes driver. Should restore the original state of the system.
 218      */
 219     void (*uninit)(struct vo *vo);
 220 };
 221
 222 struct vo_old_functions {
 223     int (*preinit)(const char *arg);
 224     int (*config)(uint32_t width, uint32_t height, uint32_t d_width,
 225                   uint32_t d_height, uint32_t fullscreen, char *title,
 226                   uint32_t format);
 227     int (*control)(uint32_t request, void *data);
 228     int (*draw_frame)(uint8_t *src[]);
 229     int (*draw_slice)(uint8_t *src[], int stride[], int w,int h, int x,int y);
 230     void (*draw_osd)(void);
 231     void (*flip_page)(void);
 232     void (*check_events)(void);
 233     void (*uninit)(void);
 234 };
 235
 236 struct vo {
 237     int config_ok;  // Last config call was successful?
 238     int config_count;  // Total number of successful config calls
 239
 240     bool frame_loaded;  // Is there a next frame the VO could flip to?
 241     double next_pts;    // pts value of the next frame if any
 242     double next_pts2;   // optional pts of frame after that
 243
 244     double flip_queue_offset; // queue flip events at most this much in advance
 245
 246     const struct vo_driver *driver;
 247     void *priv;
 248     struct MPOpts *opts;
 249     struct vo_x11_state *x11;
 250     struct mp_fifo *key_fifo;
 251     struct input_ctx *input_ctx;
 252
 253     // requested position/resolution
 254     int dx;
 255     int dy;
 256     int dwidth;
 257     int dheight;
 258
 259     int panscan_x;
 260     int panscan_y;
 261     float panscan_amount;
 262     float monitor_aspect;
 263     struct aspect_data {
 264         int orgw; // real width
 265         int orgh; // real height
 266         int prew; // prescaled width
 267         int preh; // prescaled height
 268         int scrw; // horizontal resolution
 269         int scrh; // vertical resolution
 270         float asp;
 271     } aspdat;
 272 };
 273
 274 struct vo *init_best_video_out(struct MPOpts *opts, struct vo_x11_state *x11,
 275                                struct mp_fifo *key_fifo,
 276                                struct input_ctx *input_ctx);
 277 int vo_config(struct vo *vo, uint32_t width, uint32_t height,
 278                      uint32_t d_width, uint32_t d_height, uint32_t flags,
 279                      char *title, uint32_t format);
 280 void list_video_out(void);
 281
 282 int vo_control(struct vo *vo, uint32_t request, void *data);
 283 int vo_draw_image(struct vo *vo, struct mp_image *mpi, double pts);
 284 int vo_get_buffered_frame(struct vo *vo, bool eof);
 285 int vo_draw_frame(struct vo *vo, uint8_t *src[]);
 286 int vo_draw_slice(struct vo *vo, uint8_t *src[], int stride[], int w, int h, int x, int y);
 287 void vo_draw_osd(struct vo *vo, struct osd_state *osd);
 288 void vo_flip_page(struct vo *vo, unsigned int pts_us, int duration);
 289 void vo_check_events(struct vo *vo);
 290 void vo_seek_reset(struct vo *vo);
 291 void vo_destroy(struct vo *vo);
 292
 293
 294 // NULL terminated array of all drivers
 295 extern const struct vo_driver *video_out_drivers[];
 296
 297 extern int xinerama_screen;
 298 extern int xinerama_x;
 299 extern int xinerama_y;
 300
 301 extern int vo_grabpointer;
 302 extern int vo_doublebuffering;
 303 extern int vo_directrendering;
 304 extern int vo_vsync;
 305 extern int vo_fs;
 306 extern int vo_fsmode;
 307 extern float vo_panscan;
 308 extern int vo_adapter_num;
 309 extern int vo_refresh_rate;
 310 extern int vo_keepaspect;
 311 extern int vo_rootwin;
 312 extern int vo_border;
 313
 314 extern int vo_nomouse_input;
 315 extern int enable_mouse_movements;
 316
 317 extern int vo_pts;
 318 extern float vo_fps;
 319
 320 extern char *vo_subdevice;
 321
 322 extern int vo_colorkey;
 323
 324 extern char *vo_winname;
 325 extern char *vo_wintitle;
 326
 327 extern int64_t WinID;
 328
 329 typedef struct {
 330         float min;
 331         float max;
 332         } range_t;
 333
 334 float range_max(range_t *r);
 335 int in_range(range_t *r, float f);
 336 range_t *str2range(char *s);
 337 extern char *monitor_hfreq_str;
 338 extern char *monitor_vfreq_str;
 339 extern char *monitor_dotclock_str;
 340
 341 struct mp_keymap {
 342   int from;
 343   int to;
 344 };
 345 int lookup_keymap_table(const struct mp_keymap *map, int key);
 346 struct vo_rect {
 347   int left, right, top, bottom, width, height;
 348 };
 349 void calc_src_dst_rects(struct vo *vo, int src_width, int src_height,
 350                         struct vo_rect *src, struct vo_rect *dst,
 351                         struct vo_rect *borders, const struct vo_rect *crop);
 352 struct input_ctx;
 353 void vo_mouse_movement(struct vo *vo, int posx, int posy);
 354
 355 static inline int aspect_scaling(void)
 356 {
 357   return vo_keepaspect || vo_fs;
 358 }
 359
 360 #endif /* MPLAYER_VIDEO_OUT_H */