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 enum mp_command_type {
  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_CAPTURING,
  45     MP_CMD_VO_FULLSCREEN,
  46     MP_CMD_SUB_POS,
  47     MP_CMD_DVDNAV,
  48     MP_CMD_SCREENSHOT,
  49     MP_CMD_PANSCAN,
  50     MP_CMD_MUTE,
  51     MP_CMD_LOADFILE,
  52     MP_CMD_LOADLIST,
  53     MP_CMD_VF_CHANGE_RECTANGLE,
  54     MP_CMD_GAMMA,
  55     MP_CMD_SUB_VISIBILITY,
  56     MP_CMD_VOBSUB_LANG, // deprecated: combined with SUB_SELECT
  57     MP_CMD_MENU,
  58     MP_CMD_SET_MENU,
  59     MP_CMD_GET_TIME_LENGTH,
  60     MP_CMD_GET_PERCENT_POS,
  61     MP_CMD_SUB_STEP,
  62     MP_CMD_TV_SET_CHANNEL,
  63     MP_CMD_EDL_MARK,
  64     MP_CMD_SUB_ALIGNMENT,
  65     MP_CMD_TV_LAST_CHANNEL,
  66     MP_CMD_OSD_SHOW_TEXT,
  67     MP_CMD_TV_SET_FREQ,
  68     MP_CMD_TV_SET_NORM,
  69     MP_CMD_TV_SET_BRIGHTNESS,
  70     MP_CMD_TV_SET_CONTRAST,
  71     MP_CMD_TV_SET_HUE,
  72     MP_CMD_TV_SET_SATURATION,
  73     MP_CMD_GET_VO_FULLSCREEN,
  74     MP_CMD_GET_SUB_VISIBILITY,
  75     MP_CMD_SUB_FORCED_ONLY,
  76     MP_CMD_VO_ONTOP,
  77     MP_CMD_SUB_SELECT,
  78     MP_CMD_VO_ROOTWIN,
  79     MP_CMD_SWITCH_VSYNC,
  80     MP_CMD_SWITCH_RATIO,
  81     MP_CMD_FRAME_STEP,
  82     MP_CMD_SPEED_INCR,
  83     MP_CMD_SPEED_MULT,
  84     MP_CMD_SPEED_SET,
  85     MP_CMD_RUN,
  86     MP_CMD_SUB_LOG,
  87     MP_CMD_SWITCH_AUDIO,
  88     MP_CMD_GET_TIME_POS,
  89     MP_CMD_SUB_LOAD,
  90     MP_CMD_SUB_REMOVE,
  91     MP_CMD_KEYDOWN_EVENTS,
  92     MP_CMD_VO_BORDER,
  93     MP_CMD_SET_PROPERTY,
  94     MP_CMD_SET_PROPERTY_OSD,
  95     MP_CMD_GET_PROPERTY,
  96     MP_CMD_OSD_SHOW_PROPERTY_TEXT,
  97     MP_CMD_OSD_SHOW_PROGRESSION,
  98     MP_CMD_SEEK_CHAPTER,
  99     MP_CMD_FILE_FILTER,
 100     MP_CMD_GET_FILENAME,
 101     MP_CMD_GET_VIDEO_CODEC,
 102     MP_CMD_GET_VIDEO_BITRATE,
 103     MP_CMD_GET_VIDEO_RESOLUTION,
 104     MP_CMD_GET_AUDIO_CODEC,
 105     MP_CMD_GET_AUDIO_BITRATE,
 106     MP_CMD_GET_AUDIO_SAMPLES,
 107     MP_CMD_GET_META_TITLE,
 108     MP_CMD_GET_META_ARTIST,
 109     MP_CMD_GET_META_ALBUM,
 110     MP_CMD_GET_META_YEAR,
 111     MP_CMD_GET_META_COMMENT,
 112     MP_CMD_GET_META_TRACK,
 113     MP_CMD_GET_META_GENRE,
 114     MP_CMD_RADIO_STEP_CHANNEL,
 115     MP_CMD_RADIO_SET_CHANNEL,
 116     MP_CMD_RADIO_SET_FREQ,
 117     MP_CMD_SET_MOUSE_POS,
 118     MP_CMD_STEP_PROPERTY,
 119     MP_CMD_STEP_PROPERTY_OSD,
 120     MP_CMD_RADIO_STEP_FREQ,
 121     MP_CMD_TV_STEP_FREQ,
 122     MP_CMD_LOOP,
 123     MP_CMD_BALANCE,
 124     MP_CMD_SUB_SCALE,
 125     MP_CMD_TV_TELETEXT_ADD_DEC,
 126     MP_CMD_TV_TELETEXT_GO_LINK,
 127     MP_CMD_TV_START_SCAN,
 128     MP_CMD_SUB_SOURCE,
 129     MP_CMD_SUB_FILE,
 130     MP_CMD_SUB_VOB,
 131     MP_CMD_SUB_DEMUX,
 132     MP_CMD_SWITCH_ANGLE,
 133     MP_CMD_ASS_USE_MARGINS,
 134     MP_CMD_SWITCH_TITLE,
 135     MP_CMD_STOP,
 136
 137     /// DVDNAV commands
 138     MP_CMD_DVDNAV_UP = 1000,
 139     MP_CMD_DVDNAV_DOWN,
 140     MP_CMD_DVDNAV_LEFT,
 141     MP_CMD_DVDNAV_RIGHT,
 142     MP_CMD_DVDNAV_MENU,
 143     MP_CMD_DVDNAV_SELECT,
 144     MP_CMD_DVDNAV_PREVMENU,
 145     MP_CMD_DVDNAV_MOUSECLICK,
 146
 147     /// DVB commands
 148     MP_CMD_DVB_SET_CHANNEL = 5101,
 149
 150     /// Console commands
 151     MP_CMD_CHELP = 7000,
 152     MP_CMD_CEXIT,
 153     MP_CMD_CHIDE,
 154
 155     /// Audio Filter commands
 156     MP_CMD_AF_SWITCH,
 157     MP_CMD_AF_ADD,
 158     MP_CMD_AF_DEL,
 159     MP_CMD_AF_CLR,
 160     MP_CMD_AF_CMDLINE,
 161 };
 162
 163 // The arg types
 164 #define MP_CMD_ARG_INT 0
 165 #define MP_CMD_ARG_FLOAT 1
 166 #define MP_CMD_ARG_STRING 2
 167 #define MP_CMD_ARG_VOID 3
 168
 169 #ifndef MP_CMD_MAX_ARGS
 170 #define MP_CMD_MAX_ARGS 10
 171 #endif
 172
 173 // Error codes for the drivers
 174
 175 // An error occurred but we can continue
 176 #define MP_INPUT_ERROR -1
 177 // A fatal error occurred, this driver should be removed
 178 #define MP_INPUT_DEAD -2
 179 // No input was available
 180 #define MP_INPUT_NOTHING -3
 181 //! Input will be available if you try again
 182 #define MP_INPUT_RETRY -4
 183 // Key FIFO was full - release events may be lost, zero button-down status
 184 #define MP_INPUT_RELEASE_ALL -5
 185
 186
 187 struct input_ctx;
 188
 189 struct mp_cmd_arg {
 190     int type;
 191     union {
 192         int i;
 193         float f;
 194         char *s;
 195         void *v;
 196     } v;
 197 };
 198
 199 typedef struct mp_cmd {
 200     int id;
 201     char *name;
 202     int nargs;
 203     struct mp_cmd_arg args[MP_CMD_MAX_ARGS];
 204     int pausing;
 205     struct mp_cmd *queue_prev;
 206     struct mp_cmd *queue_next;
 207 } mp_cmd_t;
 208
 209
 210 // Set this to grab all incoming key codes
 211 extern int (*mp_input_key_cb)(int code);
 212 // Should return 1 if the command was processed
 213 typedef int (*mp_input_cmd_filter)(struct mp_cmd *cmd, void *ctx);
 214
 215 /* Add a new command input source.
 216  * "fd" is a file descriptor (use a negative value if you don't use any fd)
 217  * "select" tells whether to use select() on the fd to determine when to
 218  * try reading.
 219  * "read_func" is optional. If NULL a default function which reads data
 220  * directly from the fd will be used. It must return either text data
 221  * or one of the MP_INPUT error codes above.
 222  * "close_func" will be called when closing. Can be NULL. Its return value
 223  * is ignored (it's only there to allow using standard close() as the func).
 224  */
 225 int mp_input_add_cmd_fd(struct input_ctx *ictx, int fd, int select,
 226                         int read_func(int fd, char *dest, int size),
 227                         int close_func(int fd));
 228
 229 // This removes a cmd driver, you usually don't need to use it.
 230 void mp_input_rm_cmd_fd(struct input_ctx *ictx, int fd);
 231
 232 /* The args are similar to the cmd version above, except you must give
 233  * a read_func, and it should return key codes (ASCII plus keycodes.h).
 234  */
 235 int mp_input_add_key_fd(struct input_ctx *ictx, int fd, int select,
 236                         int read_func(void *ctx, int fd),
 237                         int close_func(int fd), void *ctx);
 238
 239 // Feed a keypress (alternative to being returned from read_func above)
 240 void mp_input_feed_key(struct input_ctx *ictx, int code);
 241
 242 // As for the cmd one you usually don't need this function.
 243 void mp_input_rm_key_fd(struct input_ctx *ictx, int fd);
 244
 245 // Get input key from its name.
 246 int mp_input_get_key_from_name(const char *name);
 247
 248 // Add a command to the command queue.
 249 int mp_input_queue_cmd(struct input_ctx *ictx, struct mp_cmd *cmd);
 250
 251 /* Return next available command, or sleep up to "time" ms if none is
 252  * available. If "peek_only" is true return a reference to the command
 253  * but leave it queued.
 254  */
 255 struct mp_cmd *mp_input_get_cmd(struct input_ctx *ictx, int time,
 256                                 int peek_only);
 257
 258 /* Parse text and return corresponding struct mp_cmd. */
 259 struct mp_cmd *mp_input_parse_cmd(char *str);
 260
 261 /**
 262  * Parse and queue commands separated by '\n'.
 263  * Return number of commands queued.
 264  */
 265 int mp_input_parse_and_queue_cmds(struct input_ctx *ictx, const char *str);
 266
 267 // These filters allow you to process the command before MPlayer.
 268 // If a filter returns a true value mp_input_get_cmd will return NULL.
 269 void 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 mp_cmd_free(struct mp_cmd *cmd);
 274
 275 // This creates a copy of a command (used by the auto repeat stuff).
 276 struct mp_cmd *mp_cmd_clone(struct mp_cmd *cmd);
 277
 278 // Set current input section
 279 void mp_input_set_section(struct input_ctx *ictx, char *name);
 280
 281 // Get current input section
 282 char *mp_input_get_section(struct input_ctx *ictx);
 283
 284 // Initialize the input system
 285 struct input_conf;
 286 struct input_ctx *mp_input_init(struct input_conf *input_conf);
 287
 288 void mp_input_uninit(struct input_ctx *ictx);
 289
 290 struct m_config;
 291 void mp_input_register_options(struct m_config *cfg);
 292
 293 // Interruptible usleep:  (used by libmpdemux)
 294 int mp_input_check_interrupt(struct input_ctx *ictx, int time);
 295
 296 extern int async_quit_request;
 297
 298 #endif /* MPLAYER_INPUT_H */