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_SET_PROPERTY_OSD,
  94   MP_CMD_GET_PROPERTY,
  95   MP_CMD_OSD_SHOW_PROPERTY_TEXT,
  96   MP_CMD_OSD_SHOW_PROGRESSION,
  97   MP_CMD_SEEK_CHAPTER,
  98   MP_CMD_FILE_FILTER,
  99   MP_CMD_GET_FILENAME,
 100   MP_CMD_GET_VIDEO_CODEC,
 101   MP_CMD_GET_VIDEO_BITRATE,
 102   MP_CMD_GET_VIDEO_RESOLUTION,
 103   MP_CMD_GET_AUDIO_CODEC,
 104   MP_CMD_GET_AUDIO_BITRATE,
 105   MP_CMD_GET_AUDIO_SAMPLES,
 106   MP_CMD_GET_META_TITLE,
 107   MP_CMD_GET_META_ARTIST,
 108   MP_CMD_GET_META_ALBUM,
 109   MP_CMD_GET_META_YEAR,
 110   MP_CMD_GET_META_COMMENT,
 111   MP_CMD_GET_META_TRACK,
 112   MP_CMD_GET_META_GENRE,
 113   MP_CMD_RADIO_STEP_CHANNEL,
 114   MP_CMD_RADIO_SET_CHANNEL,
 115   MP_CMD_RADIO_SET_FREQ,
 116   MP_CMD_SET_MOUSE_POS,
 117   MP_CMD_STEP_PROPERTY,
 118   MP_CMD_STEP_PROPERTY_OSD,
 119   MP_CMD_RADIO_STEP_FREQ,
 120   MP_CMD_TV_STEP_FREQ,
 121   MP_CMD_LOOP,
 122   MP_CMD_BALANCE,
 123   MP_CMD_SUB_SCALE,
 124   MP_CMD_TV_TELETEXT_ADD_DEC,
 125   MP_CMD_TV_TELETEXT_GO_LINK,
 126   MP_CMD_TV_START_SCAN,
 127   MP_CMD_SUB_SOURCE,
 128   MP_CMD_SUB_FILE,
 129   MP_CMD_SUB_VOB,
 130   MP_CMD_SUB_DEMUX,
 131   MP_CMD_SWITCH_ANGLE,
 132   MP_CMD_ASS_USE_MARGINS,
 133   MP_CMD_SWITCH_TITLE,
 134   MP_CMD_STOP,
 135
 136   /// DVDNAV commands
 137   MP_CMD_DVDNAV_UP = 1000,
 138   MP_CMD_DVDNAV_DOWN,
 139   MP_CMD_DVDNAV_LEFT,
 140   MP_CMD_DVDNAV_RIGHT,
 141   MP_CMD_DVDNAV_MENU,
 142   MP_CMD_DVDNAV_SELECT,
 143   MP_CMD_DVDNAV_PREVMENU,
 144   MP_CMD_DVDNAV_MOUSECLICK,
 145
 146   /// DVB commands
 147   MP_CMD_DVB_SET_CHANNEL = 5101,
 148
 149   /// Console commands
 150   MP_CMD_CHELP = 7000,
 151   MP_CMD_CEXIT,
 152   MP_CMD_CHIDE,
 153
 154   /// Audio Filter commands
 155   MP_CMD_AF_SWITCH,
 156   MP_CMD_AF_ADD,
 157   MP_CMD_AF_DEL,
 158   MP_CMD_AF_CLR,
 159
 160 } mp_command_type;
 161
 162 // The arg types
 163 #define MP_CMD_ARG_INT 0
 164 #define MP_CMD_ARG_FLOAT 1
 165 #define MP_CMD_ARG_STRING 2
 166 #define MP_CMD_ARG_VOID 3
 167
 168 #ifndef MP_CMD_MAX_ARGS
 169 #define MP_CMD_MAX_ARGS 10
 170 #endif
 171
 172 // Error codes for the drivers
 173
 174 // An error occurred but we can continue
 175 #define MP_INPUT_ERROR -1
 176 // A fatal error occurred, this driver should be removed
 177 #define MP_INPUT_DEAD -2
 178 // No input was available
 179 #define MP_INPUT_NOTHING -3
 180 //! Input will be available if you try again
 181 #define MP_INPUT_RETRY -4
 182
 183 // For the key's drivers, if possible you can send key up and key down
 184 // events. Key up is the default, to send a key down you must use the
 185 // OR operator between the key code and MP_KEY_DOWN.
 186 #define MP_KEY_DOWN (1<<29)
 187 // Use this when the key shouldn't be auto-repeated (like mouse buttons)
 188 #define MP_NO_REPEAT_KEY (1<<28)
 189
 190 #ifndef MP_MAX_KEY_DOWN
 191 #define MP_MAX_KEY_DOWN 32
 192 #endif
 193
 194 struct input_ctx;
 195
 196 typedef union mp_cmd_arg_value {
 197   int i;
 198   float f;
 199   char* s;
 200   void* v;
 201 } mp_cmd_arg_value_t;
 202
 203 typedef struct mp_cmd_arg {
 204   int type;
 205   mp_cmd_arg_value_t v;
 206 } mp_cmd_arg_t;
 207
 208 typedef struct mp_cmd {
 209   int id;
 210   char* name;
 211   int nargs;
 212   mp_cmd_arg_t args[MP_CMD_MAX_ARGS];
 213   int pausing;
 214 } mp_cmd_t;
 215
 216
 217 // These typedefs are for the drivers. They are the functions used to retrieve
 218 // the next key code or command.
 219
 220 // These functions should return the key code or one of the error codes
 221 typedef int (*mp_key_func_t)(void *ctx, int fd);
 222 // These functions should act like read but they must use our error code (if needed ;-)
 223 typedef int (*mp_cmd_func_t)(int fd,char* dest,int size);
 224 // These are used to close the driver
 225 typedef void (*mp_close_func_t)(int fd);
 226
 227 // Set this to grab all incoming key codes
 228 extern int (*mp_input_key_cb)(int code);
 229 // Should return 1 if the command was processed
 230 typedef int (*mp_input_cmd_filter)(mp_cmd_t *cmd, void *ctx);
 231
 232 // This function adds a new key driver.
 233 // The first arg is a file descriptor (use a negative value if you don't use any fd)
 234 // The second arg tells if we use select on the fd to know if something is available.
 235 // The third arg is optional. If null a default function wich reads an int from the
 236 // fd will be used.
 237 // The last arg can be NULL if nothing is needed to close the driver. The close
 238 // function can be used
 239 int mp_input_add_cmd_fd(struct input_ctx *ictx, int fd, int select,
 240                         mp_cmd_func_t read_func, mp_close_func_t close_func);
 241
 242 // This removes a cmd driver, you usually don't need to use it.
 243 void mp_input_rm_cmd_fd(struct input_ctx *ictx, int fd);
 244
 245 // The args are the same as for the key's drivers. If you don't use any valid fd you MUST
 246 // give a read_func.
 247 int mp_input_add_key_fd(struct input_ctx *ictx, int fd, int select,
 248                         mp_key_func_t read_func, mp_close_func_t close_func,
 249                         void *ctx);
 250
 251 // As for the cmd one you usually don't need this function.
 252 void mp_input_rm_key_fd(struct input_ctx *ictx, int fd);
 253
 254 /// Get input key from its name.
 255 int mp_input_get_key_from_name(const char *name);
 256
 257 // This function can be used to put a command in the system again. It's used by libmpdemux
 258 // when it performs a blocking operation to resend the command it received to the main
 259 // loop.
 260 int mp_input_queue_cmd(struct input_ctx *ictx, mp_cmd_t* cmd);
 261
 262 // This function retrieves the next available command waiting no more than time msec.
 263 // If pause is true, the next input will always return a pause command.
 264 mp_cmd_t*
 265 mp_input_get_cmd(struct input_ctx *ictx, int time, int peek_only);
 266
 267 mp_cmd_t*
 268 mp_input_parse_cmd(char* str);
 269
 270 /**
 271  * Parse and queue commands separated by '\n'.
 272  * @return count of commands new queued.
 273  */
 274 int mp_input_parse_and_queue_cmds(struct input_ctx *ictx, const char *str);
 275
 276 /// These filters allow you to process the command before MPlayer.
 277 /// If a filter returns a true value mp_input_get_cmd will return NULL.
 278 void
 279 mp_input_add_cmd_filter(mp_input_cmd_filter, void* ctx);
 280
 281 // After getting a command from mp_input_get_cmd you need to free it using this
 282 // function
 283 void
 284 mp_cmd_free(mp_cmd_t* cmd);
 285
 286 // This creates a copy of a command (used by the auto repeat stuff).
 287 mp_cmd_t*
 288 mp_cmd_clone(mp_cmd_t* cmd);
 289
 290 // Set current input section
 291 void mp_input_set_section(struct input_ctx *ictx, char *name);
 292
 293 // Get current input section
 294 char *mp_input_get_section(struct input_ctx *ictx);
 295
 296 // When you create a new driver you should add it in these 2 functions.
 297 struct input_conf;
 298 struct input_ctx *mp_input_init(struct input_conf *input_conf);
 299
 300 void mp_input_uninit(struct input_ctx *ictx);
 301
 302 struct m_config;
 303 void mp_input_register_options(struct m_config *cfg);
 304
 305 // Interruptible usleep:  (used by libmpdemux)
 306 int
 307 mp_input_check_interrupt(struct input_ctx *ictx, int time);
 308
 309 extern int async_quit_request;
 310
 311 #endif /* MPLAYER_INPUT_H */