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