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