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