2 * This file is part of MPlayer.
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.
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.
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.
19 #ifndef MPLAYER_INPUT_H
20 #define MPLAYER_INPUT_H
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
,
35 MP_CMD_MIXER_USEMASTER
,
41 MP_CMD_TV_STEP_CHANNEL
,
43 MP_CMD_TV_STEP_CHANNEL_LIST
,
52 MP_CMD_VF_CHANGE_RECTANGLE
,
54 MP_CMD_SUB_VISIBILITY
,
55 MP_CMD_VOBSUB_LANG
, // deprecated: combined with SUB_SELECT
58 MP_CMD_GET_TIME_LENGTH
,
59 MP_CMD_GET_PERCENT_POS
,
61 MP_CMD_TV_SET_CHANNEL
,
64 MP_CMD_TV_LAST_CHANNEL
,
68 MP_CMD_TV_SET_BRIGHTNESS
,
69 MP_CMD_TV_SET_CONTRAST
,
71 MP_CMD_TV_SET_SATURATION
,
72 MP_CMD_GET_VO_FULLSCREEN
,
73 MP_CMD_GET_SUB_VISIBILITY
,
74 MP_CMD_SUB_FORCED_ONLY
,
90 MP_CMD_KEYDOWN_EVENTS
,
94 MP_CMD_OSD_SHOW_PROPERTY_TEXT
,
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
,
121 MP_CMD_TV_TELETEXT_ADD_DEC
,
122 MP_CMD_TV_TELETEXT_GO_LINK
,
123 MP_CMD_TV_START_SCAN
,
129 MP_CMD_ASS_USE_MARGINS
,
135 MP_CMD_DVDNAV_UP
= 1000,
140 MP_CMD_DVDNAV_SELECT
,
141 MP_CMD_DVDNAV_PREVMENU
,
142 MP_CMD_DVDNAV_MOUSECLICK
,
145 MP_CMD_DVB_SET_CHANNEL
= 5101,
154 #define MP_CMD_ARG_INT 0
155 #define MP_CMD_ARG_FLOAT 1
156 #define MP_CMD_ARG_STRING 2
157 #define MP_CMD_ARG_VOID 3
159 #ifndef MP_CMD_MAX_ARGS
160 #define MP_CMD_MAX_ARGS 10
163 // Error codes for the drivers
165 // An error occurred but we can continue
166 #define MP_INPUT_ERROR -1
167 // A fatal error occurred, this driver should be removed
168 #define MP_INPUT_DEAD -2
169 // No input was available
170 #define MP_INPUT_NOTHING -3
171 //! Input will be available if you try again
172 #define MP_INPUT_RETRY -4
174 // For the key's drivers, if possible you can send key up and key down
175 // events. Key up is the default, to send a key down you must use the
176 // OR operator between the key code and MP_KEY_DOWN.
177 #define MP_KEY_DOWN (1<<29)
178 // Use this when the key shouldn't be auto-repeated (like mouse buttons)
179 #define MP_NO_REPEAT_KEY (1<<28)
181 #ifndef MP_MAX_KEY_DOWN
182 #define MP_MAX_KEY_DOWN 32
187 typedef union mp_cmd_arg_value
{
192 } mp_cmd_arg_value_t
;
194 typedef struct mp_cmd_arg
{
196 mp_cmd_arg_value_t v
;
199 typedef struct mp_cmd
{
203 mp_cmd_arg_t args
[MP_CMD_MAX_ARGS
];
208 // These typedefs are for the drivers. They are the functions used to retrieve
209 // the next key code or command.
211 // These functions should return the key code or one of the error codes
212 typedef int (*mp_key_func_t
)(void *ctx
, int fd
);
213 // These functions should act like read but they must use our error code (if needed ;-)
214 typedef int (*mp_cmd_func_t
)(int fd
,char* dest
,int size
);
215 // These are used to close the driver
216 typedef void (*mp_close_func_t
)(int fd
);
218 // Set this to grab all incoming key codes
219 extern int (*mp_input_key_cb
)(int code
);
220 // Should return 1 if the command was processed
221 typedef int (*mp_input_cmd_filter
)(mp_cmd_t
* cmd
, int paused
, void* ctx
);
223 // This function adds a new key driver.
224 // The first arg is a file descriptor (use a negative value if you don't use any fd)
225 // The second arg tells if we use select on the fd to know if something is available.
226 // The third arg is optional. If null a default function wich reads an int from the
228 // The last arg can be NULL if nothing is needed to close the driver. The close
229 // function can be used
230 int mp_input_add_cmd_fd(struct input_ctx
*ictx
, int fd
, int select
,
231 mp_cmd_func_t read_func
, mp_close_func_t close_func
);
233 // This removes a cmd driver, you usually don't need to use it.
234 void mp_input_rm_cmd_fd(struct input_ctx
*ictx
, int fd
);
236 // The args are the same as for the key's drivers. If you don't use any valid fd you MUST
238 int mp_input_add_key_fd(struct input_ctx
*ictx
, int fd
, int select
,
239 mp_key_func_t read_func
, mp_close_func_t close_func
,
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
);
245 /// Get input key from its name.
246 int mp_input_get_key_from_name(const char *name
);
248 // This function can be used to put a command in the system again. It's used by libmpdemux
249 // when it performs a blocking operation to resend the command it received to the main
251 int mp_input_queue_cmd(struct input_ctx
*ictx
, mp_cmd_t
* cmd
);
253 // This function retrieves the next available command waiting no more than time msec.
254 // If pause is true, the next input will always return a pause command.
256 mp_input_get_cmd(struct input_ctx
*ictx
, int time
, int paused
, int peek_only
);
259 mp_input_parse_cmd(char* str
);
262 * Parse and queue commands separated by '\n'.
263 * @return count of commands new queued.
265 int mp_input_parse_and_queue_cmds(struct input_ctx
*ictx
, const char *str
);
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.
270 mp_input_add_cmd_filter(mp_input_cmd_filter
, void* ctx
);
272 // After getting a command from mp_input_get_cmd you need to free it using this
275 mp_cmd_free(mp_cmd_t
* cmd
);
277 // This creates a copy of a command (used by the auto repeat stuff).
279 mp_cmd_clone(mp_cmd_t
* cmd
);
281 // Set current input section
282 void mp_input_set_section(struct input_ctx
*ictx
, char *name
);
284 // Get current input section
285 char *mp_input_get_section(struct input_ctx
*ictx
);
287 // When you create a new driver you should add it in these 2 functions.
289 struct input_ctx
*mp_input_init(struct input_conf
*input_conf
);
291 void mp_input_uninit(struct input_ctx
*ictx
);
294 void mp_input_register_options(struct m_config
*cfg
);
296 // Interruptible usleep: (used by libmpdemux)
298 mp_input_check_interrupt(struct input_ctx
*ictx
, int time
);
300 extern int async_quit_request
;
302 #endif /* MPLAYER_INPUT_H */