input/input.h

   1 /*
   2  * This file is part of MPlayer.
   3  *
   4  * MPlayer is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * MPlayer is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with MPlayer; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #ifndef MPLAYER_INPUT_H
  20 #define MPLAYER_INPUT_H
  21
  22 // All command IDs
  23 typedef enum {
  24   MP_CMD_SEEK,
  25   MP_CMD_AUDIO_DELAY,
  26   MP_CMD_QUIT,
  27   MP_CMD_PAUSE,
  28   MP_CMD_GRAB_FRAMES, // deprecated: was a no-op command for years
  29   MP_CMD_PLAY_TREE_STEP,
  30   MP_CMD_PLAY_TREE_UP_STEP,
  31   MP_CMD_PLAY_ALT_SRC_STEP,
  32   MP_CMD_SUB_DELAY,
  33   MP_CMD_OSD,
  34   MP_CMD_VOLUME,
  35   MP_CMD_MIXER_USEMASTER,
  36   MP_CMD_CONTRAST,
  37   MP_CMD_BRIGHTNESS,
  38   MP_CMD_HUE,
  39   MP_CMD_SATURATION,
  40   MP_CMD_FRAMEDROPPING,
  41   MP_CMD_TV_STEP_CHANNEL,
  42   MP_CMD_TV_STEP_NORM,
  43   MP_CMD_TV_STEP_CHANNEL_LIST,
  44   MP_CMD_VO_FULLSCREEN,
  45   MP_CMD_SUB_POS,
  46   MP_CMD_DVDNAV,
  47   MP_CMD_SCREENSHOT,
  48   MP_CMD_PANSCAN,
  49   MP_CMD_MUTE,
  50   MP_CMD_LOADFILE,
  51   MP_CMD_LOADLIST,
  52   MP_CMD_VF_CHANGE_RECTANGLE,
  53   MP_CMD_GAMMA,
  54   MP_CMD_SUB_VISIBILITY,
  55   MP_CMD_VOBSUB_LANG, // deprecated: combined with SUB_SELECT
  56   MP_CMD_MENU,
  57   MP_CMD_SET_MENU,
  58   MP_CMD_GET_TIME_LENGTH,
  59   MP_CMD_GET_PERCENT_POS,
  60   MP_CMD_SUB_STEP,
  61   MP_CMD_TV_SET_CHANNEL,
  62   MP_CMD_EDL_MARK,
  63   MP_CMD_SUB_ALIGNMENT,
  64   MP_CMD_TV_LAST_CHANNEL,
  65   MP_CMD_OSD_SHOW_TEXT,
  66   MP_CMD_TV_SET_FREQ,
  67   MP_CMD_TV_SET_NORM,
  68   MP_CMD_TV_SET_BRIGHTNESS,
  69   MP_CMD_TV_SET_CONTRAST,
  70   MP_CMD_TV_SET_HUE,
  71   MP_CMD_TV_SET_SATURATION,
  72   MP_CMD_GET_VO_FULLSCREEN,
  73   MP_CMD_GET_SUB_VISIBILITY,
  74   MP_CMD_SUB_FORCED_ONLY,
  75   MP_CMD_VO_ONTOP,
  76   MP_CMD_SUB_SELECT,
  77   MP_CMD_VO_ROOTWIN,
  78   MP_CMD_SWITCH_VSYNC,
  79   MP_CMD_SWITCH_RATIO,
  80   MP_CMD_FRAME_STEP,
  81   MP_CMD_SPEED_INCR,
  82   MP_CMD_SPEED_MULT,
  83   MP_CMD_SPEED_SET,
  84   MP_CMD_RUN,
  85   MP_CMD_SUB_LOG,
  86   MP_CMD_SWITCH_AUDIO,
  87   MP_CMD_GET_TIME_POS,
  88   MP_CMD_SUB_LOAD,
  89   MP_CMD_SUB_REMOVE,
  90   MP_CMD_KEYDOWN_EVENTS,
  91   MP_CMD_VO_BORDER,
  92   MP_CMD_SET_PROPERTY,
  93   MP_CMD_GET_PROPERTY,
  94   MP_CMD_OSD_SHOW_PROPERTY_TEXT,
  95   MP_CMD_SEEK_CHAPTER,
  96   MP_CMD_FILE_FILTER,
  97   MP_CMD_GET_FILENAME,
  98   MP_CMD_GET_VIDEO_CODEC,
  99   MP_CMD_GET_VIDEO_BITRATE,
 100   MP_CMD_GET_VIDEO_RESOLUTION,
 101   MP_CMD_GET_AUDIO_CODEC,
 102   MP_CMD_GET_AUDIO_BITRATE,
 103   MP_CMD_GET_AUDIO_SAMPLES,
 104   MP_CMD_GET_META_TITLE,
 105   MP_CMD_GET_META_ARTIST,
 106   MP_CMD_GET_META_ALBUM,
 107   MP_CMD_GET_META_YEAR,
 108   MP_CMD_GET_META_COMMENT,
 109   MP_CMD_GET_META_TRACK,
 110   MP_CMD_GET_META_GENRE,
 111   MP_CMD_RADIO_STEP_CHANNEL,
 112   MP_CMD_RADIO_SET_CHANNEL,
 113   MP_CMD_RADIO_SET_FREQ,
 114   MP_CMD_SET_MOUSE_POS,
 115   MP_CMD_STEP_PROPERTY,
 116   MP_CMD_RADIO_STEP_FREQ,
 117   MP_CMD_TV_STEP_FREQ,
 118   MP_CMD_LOOP,
 119   MP_CMD_BALANCE,
 120   MP_CMD_SUB_SCALE,
 121   MP_CMD_TV_TELETEXT_ADD_DEC,
 122   MP_CMD_TV_TELETEXT_GO_LINK,
 123   MP_CMD_TV_START_SCAN,
 124   MP_CMD_SUB_SOURCE,
 125   MP_CMD_SUB_FILE,
 126   MP_CMD_SUB_VOB,
 127   MP_CMD_SUB_DEMUX,
 128   MP_CMD_SWITCH_ANGLE,
 129   MP_CMD_ASS_USE_MARGINS,
 130   MP_CMD_SWITCH_TITLE,
 131   MP_CMD_STOP,
 132
 133   /// DVDNAV commands
 134   MP_CMD_DVDNAV_UP = 1000,
 135   MP_CMD_DVDNAV_DOWN,
 136   MP_CMD_DVDNAV_LEFT,
 137   MP_CMD_DVDNAV_RIGHT,
 138   MP_CMD_DVDNAV_MENU,
 139   MP_CMD_DVDNAV_SELECT,
 140   MP_CMD_DVDNAV_PREVMENU,
 141   MP_CMD_DVDNAV_MOUSECLICK,
 142
 143   /// DVB commands
 144   MP_CMD_DVB_SET_CHANNEL = 5101,
 145
 146   /// Console commands
 147   MP_CMD_CHELP = 7000,
 148   MP_CMD_CEXIT,
 149   MP_CMD_CHIDE,
 150 } mp_command_type;
 151
 152 // The arg types
 153 #define MP_CMD_ARG_INT 0
 154 #define MP_CMD_ARG_FLOAT 1
 155 #define MP_CMD_ARG_STRING 2
 156 #define MP_CMD_ARG_VOID 3
 157
 158 #ifndef MP_CMD_MAX_ARGS
 159 #define MP_CMD_MAX_ARGS 10
 160 #endif
 161
 162 // Error codes for the drivers
 163
 164 // An error occurred but we can continue
 165 #define MP_INPUT_ERROR -1
 166 // A fatal error occurred, this driver should be removed
 167 #define MP_INPUT_DEAD -2
 168 // No input was available
 169 #define MP_INPUT_NOTHING -3
 170 //! Input will be available if you try again
 171 #define MP_INPUT_RETRY -4
 172
 173 // For the key's drivers, if possible you can send key up and key down
 174 // events. Key up is the default, to send a key down you must use the
 175 // OR operator between the key code and MP_KEY_DOWN.
 176 #define MP_KEY_DOWN (1<<29)
 177 // Use this when the key shouldn't be auto-repeated (like mouse buttons)
 178 #define MP_NO_REPEAT_KEY (1<<28)
 179
 180 #ifndef MP_MAX_KEY_DOWN
 181 #define MP_MAX_KEY_DOWN 32
 182 #endif
 183
 184 struct input_ctx;
 185
 186 typedef union mp_cmd_arg_value {
 187   int i;
 188   float f;
 189   char* s;
 190   void* v;
 191 } mp_cmd_arg_value_t;
 192
 193 typedef struct mp_cmd_arg {
 194   int type;
 195   mp_cmd_arg_value_t v;
 196 } mp_cmd_arg_t;
 197
 198 typedef struct mp_cmd {
 199   int id;
 200   char* name;
 201   int nargs;
 202   mp_cmd_arg_t args[MP_CMD_MAX_ARGS];
 203   int pausing;
 204 } mp_cmd_t;
 205
 206
 207 // These typedefs are for the drivers. They are the functions used to retrieve
 208 // the next key code or command.
 209
 210 // These functions should return the key code or one of the error codes
 211 typedef int (*mp_key_func_t)(void *ctx, int fd);
 212 // These functions should act like read but they must use our error code (if needed ;-)
 213 typedef int (*mp_cmd_func_t)(int fd,char* dest,int size);
 214 // These are used to close the driver
 215 typedef void (*mp_close_func_t)(int fd);
 216
 217 // Set this to grab all incoming key codes
 218 extern int (*mp_input_key_cb)(int code);
 219 // Should return 1 if the command was processed
 220 typedef int (*mp_input_cmd_filter)(mp_cmd_t* cmd, int paused, void* ctx);
 221
 222 // This function adds a new key driver.
 223 // The first arg is a file descriptor (use a negative value if you don't use any fd)
 224 // The second arg tells if we use select on the fd to know if something is available.
 225 // The third arg is optional. If null a default function wich reads an int from the
 226 // fd will be used.
 227 // The last arg can be NULL if nothing is needed to close the driver. The close
 228 // function can be used
 229 int mp_input_add_cmd_fd(struct input_ctx *ictx, int fd, int select,
 230                         mp_cmd_func_t read_func, mp_close_func_t close_func);
 231
 232 // This removes a cmd driver, you usually don't need to use it.
 233 void mp_input_rm_cmd_fd(struct input_ctx *ictx, int fd);
 234
 235 // The args are the same as for the key's drivers. If you don't use any valid fd you MUST
 236 // give a read_func.
 237 int mp_input_add_key_fd(struct input_ctx *ictx, int fd, int select,
 238                         mp_key_func_t read_func, mp_close_func_t close_func,
 239                         void *ctx);
 240
 241 // As for the cmd one you usually don't need this function.
 242 void mp_input_rm_key_fd(struct input_ctx *ictx, int fd);
 243
 244 /// Get input key from its name.
 245 int mp_input_get_key_from_name(const char *name);
 246
 247 // This function can be used to put a command in the system again. It's used by libmpdemux
 248 // when it performs a blocking operation to resend the command it received to the main
 249 // loop.
 250 int mp_input_queue_cmd(struct input_ctx *ictx, mp_cmd_t* cmd);
 251
 252 // This function retrieves the next available command waiting no more than time msec.
 253 // If pause is true, the next input will always return a pause command.
 254 mp_cmd_t*
 255 mp_input_get_cmd(struct input_ctx *ictx, int time, int paused, int peek_only);
 256
 257 mp_cmd_t*
 258 mp_input_parse_cmd(char* str);
 259
 260 /**
 261  * Parse and queue commands separated by '\n'.
 262  * @return count of commands new queued.
 263  */
 264 int mp_input_parse_and_queue_cmds(struct input_ctx *ictx, const char *str);
 265
 266 /// These filters allow you to process the command before MPlayer.
 267 /// If a filter returns a true value mp_input_get_cmd will return NULL.
 268 void
 269 mp_input_add_cmd_filter(mp_input_cmd_filter, void* ctx);
 270
 271 // After getting a command from mp_input_get_cmd you need to free it using this
 272 // function
 273 void
 274 mp_cmd_free(mp_cmd_t* cmd);
 275
 276 // This creates a copy of a command (used by the auto repeat stuff).
 277 mp_cmd_t*
 278 mp_cmd_clone(mp_cmd_t* cmd);
 279
 280 // Set current input section
 281 void mp_input_set_section(struct input_ctx *ictx, char *name);
 282
 283 // Get current input section
 284 char *mp_input_get_section(struct input_ctx *ictx);
 285
 286 // When you create a new driver you should add it in these 2 functions.
 287 struct input_conf;
 288 struct input_ctx *mp_input_init(struct input_conf *input_conf);
 289
 290 void mp_input_uninit(struct input_ctx *ictx);
 291
 292 struct m_config;
 293 void mp_input_register_options(struct m_config *cfg);
 294
 295 // Interruptible usleep:  (used by libmpdemux)
 296 int
 297 mp_input_check_interrupt(struct input_ctx *ictx, int time);
 298
 299 extern int async_quit_request;
 300
 301 #endif /* MPLAYER_INPUT_H */