git.sesse.net Git - vlc/blob - include/vlc_input.h

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