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