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
,
53 MP_CMD_VF_CHANGE_RECTANGLE
,
55 MP_CMD_SUB_VISIBILITY
,
56 MP_CMD_VOBSUB_LANG
, // deprecated: combined with SUB_SELECT
59 MP_CMD_GET_TIME_LENGTH
,
60 MP_CMD_GET_PERCENT_POS
,
62 MP_CMD_TV_SET_CHANNEL
,
65 MP_CMD_TV_LAST_CHANNEL
,
69 MP_CMD_TV_SET_BRIGHTNESS
,
70 MP_CMD_TV_SET_CONTRAST
,
72 MP_CMD_TV_SET_SATURATION
,
73 MP_CMD_GET_VO_FULLSCREEN
,
74 MP_CMD_GET_SUB_VISIBILITY
,
75 MP_CMD_SUB_FORCED_ONLY
,
91 MP_CMD_KEYDOWN_EVENTS
,
94 MP_CMD_SET_PROPERTY_OSD
,
96 MP_CMD_OSD_SHOW_PROPERTY_TEXT
,
97 MP_CMD_OSD_SHOW_PROGRESSION
,
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
,
125 MP_CMD_TV_TELETEXT_ADD_DEC
,
126 MP_CMD_TV_TELETEXT_GO_LINK
,
127 MP_CMD_TV_START_SCAN
,
133 MP_CMD_ASS_USE_MARGINS
,
138 MP_CMD_DVDNAV_UP
= 1000,
143 MP_CMD_DVDNAV_SELECT
,
144 MP_CMD_DVDNAV_PREVMENU
,
145 MP_CMD_DVDNAV_MOUSECLICK
,
148 MP_CMD_DVB_SET_CHANNEL
= 5101,
155 /// Audio Filter commands
165 #define MP_CMD_ARG_INT 0
166 #define MP_CMD_ARG_FLOAT 1
167 #define MP_CMD_ARG_STRING 2
168 #define MP_CMD_ARG_VOID 3
170 #ifndef MP_CMD_MAX_ARGS
171 #define MP_CMD_MAX_ARGS 10
174 // Error codes for the drivers
176 // An error occurred but we can continue
177 #define MP_INPUT_ERROR -1
178 // A fatal error occurred, this driver should be removed
179 #define MP_INPUT_DEAD -2
180 // No input was available
181 #define MP_INPUT_NOTHING -3
182 //! Input will be available if you try again
183 #define MP_INPUT_RETRY -4
185 #ifndef MP_MAX_KEY_DOWN
186 #define MP_MAX_KEY_DOWN 32
191 typedef union mp_cmd_arg_value
{
196 } mp_cmd_arg_value_t
;
198 typedef struct mp_cmd_arg
{
200 mp_cmd_arg_value_t v
;
203 typedef struct mp_cmd
{
207 mp_cmd_arg_t args
[MP_CMD_MAX_ARGS
];
212 // These typedefs are for the drivers. They are the functions used to retrieve
213 // the next key code or command.
215 // These functions should return the key code or one of the error codes
216 typedef int (*mp_key_func_t
)(void *ctx
, int fd
);
217 // These functions should act like read but they must use our error code (if needed ;-)
218 typedef int (*mp_cmd_func_t
)(int fd
,char* dest
,int size
);
219 // These are used to close the driver
220 typedef void (*mp_close_func_t
)(int fd
);
222 // Set this to grab all incoming key codes
223 extern int (*mp_input_key_cb
)(int code
);
224 // Should return 1 if the command was processed
225 typedef int (*mp_input_cmd_filter
)(mp_cmd_t
*cmd
, void *ctx
);
227 // This function adds a new key driver.
228 // The first arg is a file descriptor (use a negative value if you don't use any fd)
229 // The second arg tells if we use select on the fd to know if something is available.
230 // The third arg is optional. If null a default function wich reads an int from the
232 // The last arg can be NULL if nothing is needed to close the driver. The close
233 // function can be used
234 int mp_input_add_cmd_fd(struct input_ctx
*ictx
, int fd
, int select
,
235 mp_cmd_func_t read_func
, mp_close_func_t close_func
);
237 // This removes a cmd driver, you usually don't need to use it.
238 void mp_input_rm_cmd_fd(struct input_ctx
*ictx
, int fd
);
240 // The args are the same as for the key's drivers. If you don't use any valid fd you MUST
242 int mp_input_add_key_fd(struct input_ctx
*ictx
, int fd
, int select
,
243 mp_key_func_t read_func
, mp_close_func_t close_func
,
246 // As for the cmd one you usually don't need this function.
247 void mp_input_rm_key_fd(struct input_ctx
*ictx
, int fd
);
249 /// Get input key from its name.
250 int mp_input_get_key_from_name(const char *name
);
252 // This function can be used to put a command in the system again. It's used by libmpdemux
253 // when it performs a blocking operation to resend the command it received to the main
255 int mp_input_queue_cmd(struct input_ctx
*ictx
, mp_cmd_t
* cmd
);
257 // This function retrieves the next available command waiting no more than time msec.
258 // If pause is true, the next input will always return a pause command.
260 mp_input_get_cmd(struct input_ctx
*ictx
, int time
, int peek_only
);
263 mp_input_parse_cmd(char* str
);
266 * Parse and queue commands separated by '\n'.
267 * @return count of commands new queued.
269 int mp_input_parse_and_queue_cmds(struct input_ctx
*ictx
, const char *str
);
271 /// These filters allow you to process the command before MPlayer.
272 /// If a filter returns a true value mp_input_get_cmd will return NULL.
274 mp_input_add_cmd_filter(mp_input_cmd_filter
, void* ctx
);
276 // After getting a command from mp_input_get_cmd you need to free it using this
279 mp_cmd_free(mp_cmd_t
* cmd
);
281 // This creates a copy of a command (used by the auto repeat stuff).
283 mp_cmd_clone(mp_cmd_t
* cmd
);
285 // Set current input section
286 void mp_input_set_section(struct input_ctx
*ictx
, char *name
);
288 // Get current input section
289 char *mp_input_get_section(struct input_ctx
*ictx
);
291 // When you create a new driver you should add it in these 2 functions.
293 struct input_ctx
*mp_input_init(struct input_conf
*input_conf
);
295 void mp_input_uninit(struct input_ctx
*ictx
);
298 void mp_input_register_options(struct m_config
*cfg
);
300 // Interruptible usleep: (used by libmpdemux)
302 mp_input_check_interrupt(struct input_ctx
*ictx
, int time
);
304 extern int async_quit_request
;
306 #endif /* MPLAYER_INPUT_H */