8911370e2bb433d47fe334ffff47eae8df4d5040
[vlc.git] / include / vlc_input.h
1 /*****************************************************************************
2  * vlc_input.h: Core input structures
3  *****************************************************************************
4  * Copyright (C) 1999-2015 VLC authors and VideoLAN
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 it
11  * under the terms of the GNU Lesser General Public License as published by
12  * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public License
21  * along with this program; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #ifndef VLC_INPUT_H
26 #define VLC_INPUT_H 1
27
28 /**
29  * \defgroup input Input
30  * \ingroup vlc
31  * Input thread
32  * @{
33  * \file
34  * Input thread interface
35  */
36
37 #include <vlc_es.h>
38 #include <vlc_meta.h>
39 #include <vlc_epg.h>
40 #include <vlc_events.h>
41 #include <vlc_input_item.h>
42 #include <vlc_vout.h>
43 #include <vlc_vout_osd.h>
44
45 #include <string.h>
46
47 /*****************************************************************************
48  * Seek point: (generalisation of chapters)
49  *****************************************************************************/
50 struct seekpoint_t
51 {
52     int64_t i_time_offset;
53     char    *psz_name;
54 };
55
56 static inline seekpoint_t *vlc_seekpoint_New( void )
57 {
58     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
59     if( !point )
60         return NULL;
61     point->i_time_offset = -1;
62     point->psz_name = NULL;
63     return point;
64 }
65
66 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
67 {
68     if( !point ) return;
69     free( point->psz_name );
70     free( point );
71 }
72
73 static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
74 {
75     seekpoint_t *point = vlc_seekpoint_New();
76     if( likely(point) )
77     {
78         if( src->psz_name ) point->psz_name = strdup( src->psz_name );
79         point->i_time_offset = src->i_time_offset;
80     }
81     return point;
82 }
83
84 /*****************************************************************************
85  * Title:
86  *****************************************************************************/
87
88 /* input_title_t.i_flags field */
89 #define INPUT_TITLE_MENU         0x01   /* Menu title */
90 #define INPUT_TITLE_INTERACTIVE  0x02   /* Interactive title. Playback position has no meaning. */
91
92 typedef struct input_title_t
93 {
94     char        *psz_name;
95
96     vlc_tick_t  i_length;   /* Length(microsecond) if known, else 0 */
97
98     unsigned    i_flags;    /* Is it a menu or a normal entry */
99
100     /* Title seekpoint */
101     int         i_seekpoint;
102     seekpoint_t **seekpoint;
103 } input_title_t;
104
105 static inline input_title_t *vlc_input_title_New(void)
106 {
107     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
108     if( !t )
109         return NULL;
110
111     t->psz_name = NULL;
112     t->i_flags = 0;
113     t->i_length = 0;
114     t->i_seekpoint = 0;
115     t->seekpoint = NULL;
116
117     return t;
118 }
119
120 static inline void vlc_input_title_Delete( input_title_t *t )
121 {
122     int i;
123     if( t == NULL )
124         return;
125
126     free( t->psz_name );
127     for( i = 0; i < t->i_seekpoint; i++ )
128         vlc_seekpoint_Delete( t->seekpoint[i] );
129     free( t->seekpoint );
130     free( t );
131 }
132
133 static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t )
134 {
135     input_title_t *dup = vlc_input_title_New( );
136     if( dup == NULL) return NULL;
137
138     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
139     dup->i_flags     = t->i_flags;
140     dup->i_length    = t->i_length;
141     if( t->i_seekpoint > 0 )
142     {
143         dup->seekpoint = (seekpoint_t**)vlc_alloc( t->i_seekpoint, sizeof(seekpoint_t*) );
144         if( likely(dup->seekpoint) )
145         {
146             for( int i = 0; i < t->i_seekpoint; i++ )
147                 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
148             dup->i_seekpoint = t->i_seekpoint;
149         }
150     }
151
152     return dup;
153 }
154
155 /*****************************************************************************
156  * Attachments
157  *****************************************************************************/
158 struct input_attachment_t
159 {
160     char *psz_name;
161     char *psz_mime;
162     char *psz_description;
163
164     size_t i_data;
165     void *p_data;
166 };
167
168 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
169 {
170     if( !a )
171         return;
172
173     free( a->p_data );
174     free( a->psz_description );
175     free( a->psz_mime );
176     free( a->psz_name );
177     free( a );
178 }
179
180 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
181                                                             const char *psz_mime,
182                                                             const char *psz_description,
183                                                             const void *p_data,
184                                                             size_t i_data )
185 {
186     input_attachment_t *a = (input_attachment_t *)malloc( sizeof (*a) );
187     if( unlikely(a == NULL) )
188         return NULL;
189
190     a->psz_name = strdup( psz_name ? psz_name : "" );
191     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
192     a->psz_description = strdup( psz_description ? psz_description : "" );
193     a->i_data = i_data;
194     a->p_data = malloc( i_data );
195     if( i_data > 0 && likely(a->p_data != NULL) )
196         memcpy( a->p_data, p_data, i_data );
197
198     if( unlikely(a->psz_name == NULL || a->psz_mime == NULL
199               || a->psz_description == NULL || (i_data > 0 && a->p_data == NULL)) )
200     {
201         vlc_input_attachment_Delete( a );
202         a = NULL;
203     }
204     return a;
205 }
206
207 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
208 {
209     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
210                                      a->p_data, a->i_data );
211 }
212
213 /*****************************************************************************
214  * input defines/constants.
215  *****************************************************************************/
216
217 /**
218  * This defines an opaque input resource handler.
219  */
220 typedef struct input_resource_t input_resource_t;
221
222 /**
223  * Main structure representing an input thread. This structure is mostly
224  * private. The only public fields are read-only and constant.
225  */
226 struct input_thread_t
227 {
228     struct vlc_common_members obj;
229 };
230
231 /**
232  * Record prefix string.
233  * TODO make it configurable.
234  */
235 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
236
237 /*****************************************************************************
238  * Input events and variables
239  *****************************************************************************/
240
241 /**
242  * \defgroup inputvariable Input variables
243  *
244  * The input provides multiples variable you can write to and/or read from.
245  *
246  * TODO complete the documentation.
247  * The read only variables are:
248  *  - "length"
249  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
250  *    or not, for that check position != 0.0)
251  *  - "can-pause"
252  *  - "can-rate"
253  *  - "can-rewind"
254  *  - "can-record" (if a stream can be recorded while playing)
255  *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
256  *                   variable value being the one currently selected, -1 if no teletext)
257  *  - "signal-quality"
258  *  - "signal-strength"
259  *  - "program-scrambled" (if the current program is scrambled)
260  *  - "cache" (level of data cached [0 .. 1])
261  *
262  * The read-write variables are:
263  *  - state (\see input_state_e)
264  *  - rate
265  *  - position
266  *  - time, time-offset
267  *  - title, next-title, prev-title
268  *  - chapter, next-chapter, next-chapter-prev
269  *  - program, audio-es, video-es, spu-es
270  *  - audio-delay, spu-delay
271  *  - bookmark (bookmark list)
272  *  - record
273  *  - frame-next
274  *  - navigation (list of "title %2i")
275  *  - "title %2i"
276  *
277  * The variable used for event is
278  *  - intf-event (\see input_event_type_e)
279  */
280
281 /**
282  * Input state
283  *
284  * This enum is used by the variable "state"
285  */
286 typedef enum input_state_e
287 {
288     INIT_S = 0,
289     OPENING_S,
290     PLAYING_S,
291     PAUSE_S,
292     END_S,
293     ERROR_S,
294 } input_state_e;
295
296 /**
297  * Input rate.
298  *
299  * It is an float used by the variable "rate" in the
300  * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
301  * the default value being 1. It represents the ratio of playback speed to
302  * nominal speed (bigger is faster).
303  *
304  * Internally, the rate is stored as a value in the range
305  * [INPUT_RATE_MIN, INPUT_RATE_MAX].
306  * internal rate = INPUT_RATE_DEFAULT / rate variable
307  */
308
309 /**
310  * Default rate value
311  */
312 #define INPUT_RATE_DEFAULT  1000
313 /**
314  * Minimal rate value
315  */
316 #define INPUT_RATE_MIN        32            /* Up to 32/1 */
317 /**
318  * Maximal rate value
319  */
320 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
321
322 /**
323  * Input events
324  *
325  * You can catch input event by adding a callback on the variable "intf-event".
326  * This variable is an integer that will hold a input_event_type_e value.
327  */
328 typedef enum input_event_type_e
329 {
330     /* "state" has changed */
331     INPUT_EVENT_STATE,
332     /* b_dead is true */
333     INPUT_EVENT_DEAD,
334
335     /* "rate" has changed */
336     INPUT_EVENT_RATE,
337
338     /* "capabilities" has changed */
339     INPUT_EVENT_CAPABILITIES,
340
341     /* At least one of "position" or "time" */
342     INPUT_EVENT_POSITION,
343
344     /* "length" has changed */
345     INPUT_EVENT_LENGTH,
346
347     /* A title has been added or removed or selected.
348      * It implies that the chapter has changed (no chapter event is sent) */
349     INPUT_EVENT_TITLE,
350     /* A chapter has been added or removed or selected. */
351     INPUT_EVENT_CHAPTER,
352
353     /* A program ("program") has been added or removed or selected,
354      * or "program-scrambled" has changed.*/
355     INPUT_EVENT_PROGRAM,
356     /* A ES has been added or removed or selected */
357     INPUT_EVENT_ES,
358
359     /* "record" has changed */
360     INPUT_EVENT_RECORD,
361
362     /* input_item_t media has changed */
363     INPUT_EVENT_ITEM_META,
364     /* input_item_t info has changed */
365     INPUT_EVENT_ITEM_INFO,
366     /* input_item_t epg has changed */
367     INPUT_EVENT_ITEM_EPG,
368
369     /* Input statistics have been updated */
370     INPUT_EVENT_STATISTICS,
371     /* At least one of "signal-quality" or "signal-strength" has changed */
372     INPUT_EVENT_SIGNAL,
373
374     /* "audio-delay" has changed */
375     INPUT_EVENT_AUDIO_DELAY,
376     /* "spu-delay" has changed */
377     INPUT_EVENT_SUBTITLE_DELAY,
378
379     /* "bookmark" has changed */
380     INPUT_EVENT_BOOKMARK,
381
382     /* cache" has changed */
383     INPUT_EVENT_CACHE,
384
385     /* A audio_output_t object has been created/deleted by *the input* */
386     INPUT_EVENT_AOUT,
387     /* A vout_thread_t object has been created/deleted by *the input* */
388     INPUT_EVENT_VOUT,
389
390 } input_event_type_e;
391
392 #define VLC_INPUT_CAPABILITIES_SEEKABLE (1<<0)
393 #define VLC_INPUT_CAPABILITIES_PAUSEABLE (1<<1)
394 #define VLC_INPUT_CAPABILITIES_CHANGE_RATE (1<<2)
395 #define VLC_INPUT_CAPABILITIES_REWINDABLE (1<<3)
396 #define VLC_INPUT_CAPABILITIES_RECORDABLE (1<<4)
397
398 struct vlc_input_event
399 {
400     input_event_type_e type;
401
402     union {
403         /* INPUT_EVENT_STATE */
404         input_state_e state;
405         /* INPUT_EVENT_RATE */
406         float rate;
407         /* INPUT_EVENT_CAPABILITIES */
408         int capabilities; /**< cf. VLC_INPUT_CAPABILITIES_* bitwise flags */
409         /* INPUT_EVENT_POSITION */
410         struct {
411             float     percentage;
412             vlc_tick_t ms;
413         } position;
414         /* INPUT_EVENT_LENGTH */
415         vlc_tick_t length;
416         /* INPUT_EVENT_TITLE */
417         int title;
418         /* INPUT_EVENT_CHAPTER */
419         struct {
420             int title;
421             int seekpoint;
422         } chapter;
423         /* INPUT_EVENT_PROGRAM */
424         struct {
425             enum {
426                 VLC_INPUT_PROGRAM_ADDED,
427                 VLC_INPUT_PROGRAM_DELETED,
428                 VLC_INPUT_PROGRAM_SELECTED,
429                 VLC_INPUT_PROGRAM_SCRAMBLED,
430             } action;
431             int id;
432             union {
433                 const char *title;
434                 bool scrambled;
435             };
436         } program;
437         /* INPUT_EVENT_ES */
438         struct {
439             enum {
440                 VLC_INPUT_ES_ADDED,
441                 VLC_INPUT_ES_DELETED,
442                 VLC_INPUT_ES_SELECTED,
443                 VLC_INPUT_ES_UNSELECTED,
444             } action;
445             const char *title;
446             const es_format_t *fmt;
447         } es;
448         /* INPUT_EVENT_RECORD */
449         bool record;
450         /* INPUT_EVENT_SIGNAL */
451         struct {
452             float quality;
453             float strength;
454         } signal;
455         /* INPUT_EVENT_AUDIO_DELAY */
456         vlc_tick_t audio_delay;
457         /* INPUT_EVENT_SUBTITLE_DELAY */
458         vlc_tick_t subtitle_delay;
459         /* INPUT_EVENT_CACHE */
460         float cache;
461     };
462 };
463
464 typedef void (*input_thread_events_cb)( input_thread_t *input, void *user_data,
465                                         const struct vlc_input_event *event );
466
467 /**
468  * Input queries
469  */
470 enum input_query_e
471 {
472     /* Menu (VCD/DVD/BD) Navigation */
473     /** Activate the navigation item selected. res=can fail */
474     INPUT_NAV_ACTIVATE,
475     /** Use the up arrow to select a navigation item above. res=can fail */
476     INPUT_NAV_UP,
477     /** Use the down arrow to select a navigation item under. res=can fail */
478     INPUT_NAV_DOWN,
479     /** Use the left arrow to select a navigation item on the left. res=can fail */
480     INPUT_NAV_LEFT,
481     /** Use the right arrow to select a navigation item on the right. res=can fail */
482     INPUT_NAV_RIGHT,
483     /** Activate the popup Menu (for BD). res=can fail */
484     INPUT_NAV_POPUP,
485     /** Activate disc Root Menu. res=can fail */
486     INPUT_NAV_MENU,
487
488     /* Meta datas */
489     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
490     INPUT_REPLACE_INFOS,/* arg1= info_category_t *            res=cannot fail */
491     INPUT_MERGE_INFOS,/* arg1= info_category_t *              res=cannot fail */
492     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
493
494     /* bookmarks */
495     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
496     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
497     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
498     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
499     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
500     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
501     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
502
503     /* titles */
504     INPUT_GET_FULL_TITLE_INFO,     /* arg1=input_title_t*** arg2= int * res=can fail */
505
506     /* Attachments */
507     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
508     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
509
510     /* On the fly input slave */
511     INPUT_ADD_SLAVE,       /* arg1= enum slave_type, arg2= const char *,
512                             * arg3= bool forced, arg4= bool notify,
513                             * arg5= bool check_extension */
514
515     /* ES */
516     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
517
518     /* Viewpoint */
519     INPUT_UPDATE_VIEWPOINT, /* arg1=(const vlc_viewpoint_t*), arg2=bool b_absolute */
520     INPUT_SET_INITIAL_VIEWPOINT, /* arg1=(const vlc_viewpoint_t*) */
521
522     /* Input ressources
523      * XXX You must call vlc_object_release as soon as possible */
524     INPUT_GET_AOUT,         /* arg1=audio_output_t **              res=can fail */
525     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
526     INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
527
528     /* Renderers */
529     INPUT_SET_RENDERER,     /* arg1=vlc_renderer_item_t* */
530
531     /* External clock managments */
532     INPUT_GET_PCR_SYSTEM,   /* arg1=vlc_tick_t *, arg2=vlc_tick_t *       res=can fail */
533     INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=vlc_tick_t   res=can fail */
534 };
535
536 /** @}*/
537
538 /*****************************************************************************
539  * Prototypes
540  *****************************************************************************/
541 VLC_API input_thread_t * input_Create( vlc_object_t *p_parent,
542                                        input_thread_events_cb event_cb, void *events_data,
543                                        input_item_t *, const char *psz_log, input_resource_t *,
544                                        vlc_renderer_item_t* p_renderer ) VLC_USED;
545 #define input_Create(a,b,c,d,e,f,g) input_Create(VLC_OBJECT(a),b,c,d,e,f,g)
546
547
548 /**
549  * Creates an item preparser.
550  *
551  * Creates an input thread to preparse an item. The input needs to be started
552  * with input_Start() afterwards.
553  *
554  * @param obj parent object
555  * @param item input item to preparse
556  * @return an input thread or NULL on error
557  */
558 VLC_API input_thread_t *input_CreatePreparser(vlc_object_t *obj,
559                                               input_thread_events_cb events_cb,
560                                               void *events_data, input_item_t *item)
561 VLC_USED;
562
563 VLC_API int input_Start( input_thread_t * );
564
565 VLC_API void input_Stop( input_thread_t * );
566
567 VLC_API int input_Read( vlc_object_t *, input_item_t * );
568 #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
569
570 VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
571
572 VLC_API int input_Control( input_thread_t *, int i_query, ...  );
573
574 VLC_API void input_Close( input_thread_t * );
575
576 VLC_API void input_SetTime( input_thread_t *, vlc_tick_t i_time, bool b_fast );
577
578 VLC_API void input_SetPosition( input_thread_t *, float f_position, bool b_fast );
579
580 VLC_API void input_LegacyEvents(input_thread_t *, void *, const struct vlc_input_event * );
581 VLC_API void input_LegacyVarInit ( input_thread_t * );
582
583 /**
584  * Get the input item for an input thread
585  *
586  * You have to keep a reference to the input or to the input_item_t until
587  * you do not need it anymore.
588  */
589 VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
590
591 /**
592  * Return one of the video output (if any). If possible, you should use
593  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
594  * @param p_input an input thread from which to get a video output
595  * @return NULL on error, or a video output thread pointer (which needs to be
596  * released with vlc_object_release()).
597  */
598 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
599 {
600      vout_thread_t **pp_vout, *p_vout;
601      size_t i_vout;
602
603      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
604          return NULL;
605
606      for( size_t i = 1; i < i_vout; i++ )
607          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
608
609      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
610      free( pp_vout );
611      return p_vout;
612 }
613
614 static inline int input_AddSlave( input_thread_t *p_input, enum slave_type type,
615                                   const char *psz_uri, bool b_forced,
616                                   bool b_notify, bool b_check_ext )
617 {
618     return input_Control( p_input, INPUT_ADD_SLAVE, type, psz_uri, b_forced,
619                           b_notify, b_check_ext );
620 }
621
622 /**
623  * Update the viewpoint of the input thread. The viewpoint will be applied to
624  * all vouts and aouts.
625  *
626  * @param p_input an input thread
627  * @param p_viewpoint the viewpoint value
628  * @param b_absolute if true replace the old viewpoint with the new one. If
629  * false, increase/decrease it.
630  * @return VLC_SUCCESS or a VLC error code
631  */
632 static inline int input_UpdateViewpoint( input_thread_t *p_input,
633                                          const vlc_viewpoint_t *p_viewpoint,
634                                          bool b_absolute )
635 {
636     return input_Control( p_input, INPUT_UPDATE_VIEWPOINT, p_viewpoint,
637                           b_absolute );
638 }
639
640 /**
641  * Return the audio output (if any) associated with an input.
642  * @param p_input an input thread
643  * @return NULL on error, or the audio output (which needs to be
644  * released with vlc_object_release()).
645  */
646 static inline audio_output_t *input_GetAout( input_thread_t *p_input )
647 {
648      audio_output_t *p_aout;
649      return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
650 }
651
652 /**
653  * Returns the objects associated to an ES.
654  *
655  * You must release all non NULL object using vlc_object_release.
656  * You may set pointer of pointer to NULL to avoid retreiving it.
657  */
658 static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
659                                       vlc_object_t **pp_decoder,
660                                       vout_thread_t **pp_vout, audio_output_t **pp_aout )
661 {
662     return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
663                           pp_decoder, pp_vout, pp_aout );
664 }
665
666 /**
667  * \see input_clock_GetSystemOrigin
668  */
669 static inline int input_GetPcrSystem( input_thread_t *p_input, vlc_tick_t *pi_system, vlc_tick_t *pi_delay )
670 {
671     return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
672 }
673 /**
674  * \see input_clock_ChangeSystemOrigin
675  */
676 static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, vlc_tick_t i_system )
677 {
678     return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
679 }
680
681 /* */
682 VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, const es_format_t *, input_resource_t * ) VLC_USED;
683 VLC_API void input_DecoderDelete( decoder_t * );
684 VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
685 VLC_API void input_DecoderDrain( decoder_t * );
686 VLC_API void input_DecoderFlush( decoder_t * );
687
688 /**
689  * This function creates a sane filename path.
690  */
691 VLC_API char * input_CreateFilename( input_thread_t *, input_item_t *,
692                                      const char *psz_path, const char *psz_prefix,
693                                      const char *psz_extension ) VLC_USED;
694
695 /**
696  * It creates an empty input resource handler.
697  *
698  * The given object MUST stay alive as long as the input_resource_t is
699  * not deleted.
700  */
701 VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
702
703 /**
704  * It releases an input resource.
705  */
706 VLC_API void input_resource_Release( input_resource_t * );
707
708 /**
709  * Forcefully destroys the video output (e.g. when the playlist is stopped).
710  */
711 VLC_API void input_resource_TerminateVout( input_resource_t * );
712
713 /**
714  * This function releases all resources (object).
715  */
716 VLC_API void input_resource_Terminate( input_resource_t * );
717
718 /**
719  * \return the current audio output if any.
720  * Use vlc_object_release() to drop the reference.
721  */
722 VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * );
723
724 /**
725  * This function creates or recycles an audio output.
726  */
727 VLC_API audio_output_t *input_resource_GetAout( input_resource_t * );
728
729 /**
730  * This function retains or destroys an audio output.
731  */
732 VLC_API void input_resource_PutAout( input_resource_t *, audio_output_t * );
733
734 /**
735  * Prevents the existing audio output (if any) from being recycled.
736  */
737 VLC_API void input_resource_ResetAout( input_resource_t * );
738
739 /** @} */
740 #endif