]> git.sesse.net Git - vlc/blob - include/vlc_input.h
GC: thread-safety, and offset independence
[vlc] / include / vlc_input.h
1 /*****************************************************************************
2  * vlc_input.h: Core input structures
3  *****************************************************************************
4  * Copyright (C) 1999-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Christophe Massiot <massiot@via.ecp.fr>
8  *          Laurent Aimar <fenrir@via.ecp.fr>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 /* __ is need because conflict with <vlc/input.h> */
26 #ifndef VLC__INPUT_H
27 #define VLC__INPUT_H 1
28
29 /**
30  * \file
31  * This file defines functions, structures and enums for input objects in vlc
32  */
33
34 #include <vlc_es.h>
35 #include <vlc_meta.h>
36 #include <vlc_epg.h>
37 #include <vlc_events.h>
38
39 #include <string.h>                                     /* strcasestr() */
40
41 struct vlc_meta_t;
42
43 /*****************************************************************************
44  * input_item_t: Describes an input and is used to spawn input_thread_t objects
45  *****************************************************************************/
46 struct info_t
47 {
48     char *psz_name;            /**< Name of this info */
49     char *psz_value;           /**< Value of the info */
50 };
51
52 struct info_category_t
53 {
54     char   *psz_name;      /**< Name of this category */
55     int    i_infos;        /**< Number of infos in the category */
56     struct info_t **pp_infos;     /**< Pointer to an array of infos */
57 };
58
59 struct input_item_t
60 {
61     VLC_GC_MEMBERS
62     int        i_id;                 /**< Identifier of the item */
63     libvlc_int_t *p_libvlc;
64
65     char       *psz_name;            /**< text describing this item */
66     char       *psz_uri;             /**< mrl of this item */
67     bool       b_fixed_name;        /**< Can the interface change the name ?*/
68
69     int        i_options;            /**< Number of input options */
70     char       **ppsz_options;       /**< Array of input options */
71     uint8_t    *optflagv;            /**< Some flags of input options */
72     unsigned   optflagc;
73
74     mtime_t    i_duration;           /**< Duration in milliseconds*/
75
76     uint8_t    i_type;               /**< Type (file, disc, ...) */
77     bool b_prefers_tree;             /**< Do we prefer being displayed as tree*/
78
79     int        i_categories;         /**< Number of info categories */
80     info_category_t **pp_categories; /**< Pointer to the first info category */
81
82     int         i_es;                /**< Number of es format descriptions */
83     es_format_t **es;                /**< Es formats */
84
85     input_stats_t *p_stats;          /**< Statistics */
86     int           i_nb_played;       /**< Number of times played */
87
88     bool          b_error_when_reading;       /**< Error When Reading */
89
90     vlc_meta_t *p_meta;
91
92     vlc_event_manager_t event_manager;
93
94     vlc_mutex_t lock;                 /**< Lock for the item */
95 };
96
97 #define ITEM_TYPE_UNKNOWN       0
98 #define ITEM_TYPE_FILE          1
99 #define ITEM_TYPE_DIRECTORY     2
100 #define ITEM_TYPE_DISC          3
101 #define ITEM_TYPE_CDDA          4
102 #define ITEM_TYPE_CARD          5
103 #define ITEM_TYPE_NET           6
104 #define ITEM_TYPE_PLAYLIST      7
105 #define ITEM_TYPE_NODE          8
106 #define ITEM_TYPE_NUMBER        9
107
108 VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
109 VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );
110
111 /* This won't hold the item, but can tell to interested third parties
112  * Like the playlist, that there is a new sub item. With this design
113  * It is not the input item's responsability to keep all the ref of
114  * the input item children. */
115 VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
116
117
118 /* Flags handled past input_item_AddOpt() */
119 #define VLC_INPUT_OPTION_TRUSTED 0x2
120
121 /* Flags handled within input_item_AddOpt() */
122 #define VLC_INPUT_OPTION_UNIQUE  0x100
123
124 VLC_EXPORT( int, input_item_AddOpt, ( input_item_t *, const char *str, unsigned flags ) );
125 VLC_EXPORT( int, input_item_AddOption, (input_item_t *item, const char *str) );
126 VLC_EXPORT( int ,input_item_AddOption, (input_item_t *item, const char *str) );
127 VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) );
128 VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
129
130 VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) );
131
132 VLC_EXPORT( bool,input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) );
133 VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) );
134 VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) );
135 VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) );
136 VLC_EXPORT( void,   input_item_SetURI, ( input_item_t * p_i, char * psz_uri ));
137 VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) );
138 VLC_EXPORT( void,   input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration ));
139 VLC_EXPORT( bool,   input_item_IsPreparsed, ( input_item_t *p_i ));
140 VLC_EXPORT( bool,   input_item_IsArtFetched, ( input_item_t *p_i ));
141 VLC_EXPORT( const vlc_meta_t *, input_item_GetMetaObject, ( input_item_t *p_i ));
142 VLC_EXPORT( void,   input_item_MetaMerge, ( input_item_t *p_i, const vlc_meta_t * p_new_meta ));
143
144
145 #define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
146 #define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
147 #define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
148 #define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
149 #define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
150 #define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
151 #define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
152 #define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
153 #define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
154 #define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
155 #define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
156 #define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
157 #define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
158 #define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
159 #define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
160 #define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
161 #define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )
162
163 #define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
164 #define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
165 #define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
166 #define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
167 #define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
168 #define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
169 #define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
170 #define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
171 #define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
172 #define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
173 #define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
174 #define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
175 #define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
176 #define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
177 #define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
178 #define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
179 #define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
180 #define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
181
182 VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
183 VLC_EXPORT(int, input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
184
185 #define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, -1 )
186 #define input_item_NewExt(a,b,c,d,e,f) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f)
187 VLC_EXPORT( input_item_t *, __input_item_NewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
188 VLC_EXPORT( input_item_t *, input_item_NewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
189
190 #define input_item_GetById(a,b) __input_item_GetById( VLC_OBJECT(a),b )
191 VLC_EXPORT( input_item_t *, __input_item_GetById, (vlc_object_t *, int ) );
192
193 /*****************************************************************************
194  * Meta data helpers
195  *****************************************************************************/
196 static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
197                                                         const vlc_meta_t *p_meta )
198 {
199     char * psz_value;
200
201     if( !p_meta )
202         return;
203
204     if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
205         (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
206     {
207         p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
208         p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
209     }
210     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
211              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
212     {
213         p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
214         p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
215     }
216     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
217              (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
218     {
219         p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
220         p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
221     }
222     else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
223     {
224         p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
225         p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
226     }
227 }
228
229 /*****************************************************************************
230  * Seek point: (generalisation of chapters)
231  *****************************************************************************/
232 struct seekpoint_t
233 {
234     int64_t i_byte_offset;
235     int64_t i_time_offset;
236     char    *psz_name;
237     int     i_level;
238 };
239
240 static inline seekpoint_t *vlc_seekpoint_New( void )
241 {
242     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
243     point->i_byte_offset =
244     point->i_time_offset = -1;
245     point->i_level = 0;
246     point->psz_name = NULL;
247     return point;
248 }
249
250 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
251 {
252     if( !point ) return;
253     free( point->psz_name );
254     free( point );
255 }
256
257 static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
258 {
259     seekpoint_t *point = vlc_seekpoint_New();
260     if( src->psz_name ) point->psz_name = strdup( src->psz_name );
261     point->i_time_offset = src->i_time_offset;
262     point->i_byte_offset = src->i_byte_offset;
263     return point;
264 }
265
266 /*****************************************************************************
267  * Title:
268  *****************************************************************************/
269 typedef struct
270 {
271     char        *psz_name;
272
273     bool        b_menu;      /* Is it a menu or a normal entry */
274
275     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
276     int64_t     i_size;     /* Size (bytes) if known, else 0 */
277
278     /* Title seekpoint */
279     int         i_seekpoint;
280     seekpoint_t **seekpoint;
281
282 } input_title_t;
283
284 static inline input_title_t *vlc_input_title_New(void)
285 {
286     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
287
288     t->psz_name = NULL;
289     t->b_menu = false;
290     t->i_length = 0;
291     t->i_size   = 0;
292     t->i_seekpoint = 0;
293     t->seekpoint = NULL;
294
295     return t;
296 }
297
298 static inline void vlc_input_title_Delete( input_title_t *t )
299 {
300     int i;
301     if( t == NULL )
302         return;
303
304     free( t->psz_name );
305     for( i = 0; i < t->i_seekpoint; i++ )
306     {
307         free( t->seekpoint[i]->psz_name );
308         free( t->seekpoint[i] );
309     }
310     free( t->seekpoint );
311     free( t );
312 }
313
314 static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
315 {
316     input_title_t *dup = vlc_input_title_New( );
317     int i;
318
319     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
320     dup->b_menu      = t->b_menu;
321     dup->i_length    = t->i_length;
322     dup->i_size      = t->i_size;
323     dup->i_seekpoint = t->i_seekpoint;
324     if( t->i_seekpoint > 0 )
325     {
326         dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
327                                                 sizeof(seekpoint_t*) );
328
329         for( i = 0; i < t->i_seekpoint; i++ )
330         {
331             dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
332         }
333     }
334
335     return dup;
336 }
337
338 /*****************************************************************************
339  * Attachments
340  *****************************************************************************/
341 struct input_attachment_t
342 {
343     char *psz_name;
344     char *psz_mime;
345     char *psz_description;
346
347     int  i_data;
348     void *p_data;
349 };
350
351 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
352                                                             const char *psz_mime,
353                                                             const char *psz_description,
354                                                             const void *p_data,
355                                                             int i_data )
356 {
357     input_attachment_t *a =
358         (input_attachment_t*)malloc( sizeof(input_attachment_t) );
359     if( !a )
360         return NULL;
361     a->psz_name = strdup( psz_name ? psz_name : "" );
362     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
363     a->psz_description = strdup( psz_description ? psz_description : "" );
364     a->i_data = i_data;
365     a->p_data = NULL;
366     if( i_data > 0 )
367     {
368         a->p_data = malloc( i_data );
369         if( a->p_data && p_data )
370             memcpy( a->p_data, p_data, i_data );
371     }
372     return a;
373 }
374 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
375 {
376     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
377                                      a->p_data, a->i_data );
378 }
379 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
380 {
381     if( !a )
382         return;
383     free( a->psz_name );
384     free( a->psz_mime );
385     free( a->psz_description );
386     free( a->p_data );
387     free( a );
388 }
389
390 /*****************************************************************************
391  * input defines/constants.
392  *****************************************************************************/
393
394 /* "state" value */
395 /* NOTE: you need to update ppsz_input_state in the RC interface
396  * if you modify this list. */
397 typedef enum input_state_e
398 {
399     INIT_S = 0,
400     OPENING_S,
401     BUFFERING_S,
402     PLAYING_S,
403     PAUSE_S,
404     STOP_S,
405     FORWARD_S,
406     BACKWARD_S,
407     END_S,
408     ERROR_S,
409 } input_state_e;
410
411 /* "rate" default, min/max
412  * A rate below 1000 plays the movie faster,
413  * A rate above 1000 plays the movie slower.
414  */
415 #define INPUT_RATE_DEFAULT  1000
416 #define INPUT_RATE_MIN       125            /* Up to 8/1 */
417 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
418
419 /* i_update field of access_t/demux_t */
420 #define INPUT_UPDATE_NONE       0x0000
421 #define INPUT_UPDATE_SIZE       0x0001
422 #define INPUT_UPDATE_TITLE      0x0010
423 #define INPUT_UPDATE_SEEKPOINT  0x0020
424 #define INPUT_UPDATE_META       0x0040
425
426 /* Input control XXX: internal */
427 #define INPUT_CONTROL_FIFO_SIZE    100
428
429 /** Get the input item for an input thread */
430 VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));
431
432 typedef struct input_thread_private_t input_thread_private_t;
433
434 /**
435  * Main structure representing an input thread. This structure is mostly
436  * private. The only public fields are READ-ONLY. You must use the helpers
437  * to modify them
438  */
439 struct input_thread_t
440 {
441     VLC_COMMON_MEMBERS;
442
443     bool b_eof;
444     bool b_preparsing;
445     bool b_dead;
446
447     int i_state;
448     bool b_can_pace_control;
449     int64_t     i_time;     /* Current time */
450
451     /* Internal caching common to all inputs */
452     mtime_t i_pts_delay;
453
454     /* All other data is input_thread is PRIVATE. You can't access it
455      * outside of src/input */
456     input_thread_private_t *p;
457 };
458
459 /*****************************************************************************
460  * Prototypes
461  *****************************************************************************/
462
463 /* input_CreateThread
464  * Release the returned input_thread_t using vlc_object_release() */
465 #define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
466 VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
467
468 #define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
469 VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
470
471 #define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
472 VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
473 VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
474
475 enum input_query_e
476 {
477     /* input variable "position" */
478     INPUT_GET_POSITION,         /* arg1= double *       res=    */
479     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
480
481     /* input variable "length" */
482     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
483
484     /* input variable "time" */
485     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
486     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
487
488     /* input variable "rate" (1 is DEFAULT_RATE) */
489     INPUT_GET_RATE,             /* arg1= int *          res=    */
490     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
491
492     /* input variable "state" */
493     INPUT_GET_STATE,            /* arg1= int *          res=    */
494     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
495
496     /* input variable "audio-delay" and "sub-delay" */
497     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
498     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
499     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
500     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
501
502     /* Meta datas */
503     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
504     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
505     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
506     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
507
508     /* Input config options */
509     INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/
510
511     /* Input properties */
512     INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
513     INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */
514     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
515
516     /* bookmarks */
517     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
518     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
519     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
520     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
521     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
522     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
523
524     /* Attachments */
525     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
526     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
527
528     /* On the fly input slave */
529     INPUT_ADD_SLAVE,       /* arg1= char * */
530
531     /* On the fly record while playing */
532     INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
533     INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
534
535     /* ES */
536     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
537 };
538
539 VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
540 VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );
541
542 static inline input_state_e input_GetState( input_thread_t * p_input )
543 {
544     input_state_e state = INIT_S;
545     input_Control( p_input, INPUT_GET_STATE, &state );
546     return state;
547 }
548 VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, sout_instance_t * ) );
549 VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
550 VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );
551
552 VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) );
553
554 VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) );
555
556 /**
557  * This function allows to split a MRL into access, demux and path part.
558  *
559  *  You should not write into access and demux string as they may not point into
560  * the provided buffer.
561  *  The buffer provided by psz_dup will be modified.
562  */
563 VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );
564
565 #endif