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