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_NONE       0x0000
 207 #define INPUT_UPDATE_SIZE       0x0001
 208 #define INPUT_UPDATE_TITLE      0x0010
 209 #define INPUT_UPDATE_SEEKPOINT  0x0020
 210 #define INPUT_UPDATE_META       0x0040
 211 #define INPUT_UPDATE_SIGNAL     0x0080
 212 #define INPUT_UPDATE_TITLE_LIST 0x0100
 213
 214 /**
 215  * This defines private core storage for an input.
 216  */
 217 typedef struct input_thread_private_t input_thread_private_t;
 218
 219 /**
 220  * This defines an opaque input resource handler.
 221  */
 222 typedef struct input_resource_t input_resource_t;
 223
 224 /**
 225  * Main structure representing an input thread. This structure is mostly
 226  * private. The only public fields are READ-ONLY. You must use the helpers
 227  * to modify them
 228  */
 229 struct input_thread_t
 230 {
 231     VLC_COMMON_MEMBERS
 232
 233     bool b_error;
 234     bool b_eof;
 235     bool b_preparsing;
 236     bool b_dead;
 237
 238     /* All other data is input_thread is PRIVATE. You can't access it
 239      * outside of src/input */
 240     input_thread_private_t *p;
 241 };
 242
 243 /**
 244  * Record prefix string.
 245  * TODO make it configurable.
 246  */
 247 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
 248
 249 /*****************************************************************************
 250  * Input events and variables
 251  *****************************************************************************/
 252
 253 /**
 254  * \defgroup inputvariable Input variables
 255  *
 256  * The input provides multiples variable you can write to and/or read from.
 257  *
 258  * TODO complete the documentation.
 259  * The read only variables are:
 260  *  - "length"
 261  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
 262  *    or not, for that check position != 0.0)
 263  *  - "can-pause"
 264  *  - "can-rate"
 265  *  - "can-rewind"
 266  *  - "can-record" (if a stream can be recorded while playing)
 267  *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
 268  *                   variable value being the one currently selected, -1 if no teletext)
 269  *  - "signal-quality"
 270  *  - "signal-strength"
 271  *  - "program-scrambled" (if the current program is scrambled)
 272  *  - "cache" (level of data cached [0 .. 1])
 273  *
 274  * The read-write variables are:
 275  *  - state (\see input_state_e)
 276  *  - rate
 277  *  - position, position-offset
 278  *  - time, time-offset
 279  *  - title, next-title, prev-title
 280  *  - chapter, next-chapter, next-chapter-prev
 281  *  - program, audio-es, video-es, spu-es
 282  *  - audio-delay, spu-delay
 283  *  - bookmark (bookmark list)
 284  *  - record
 285  *  - frame-next
 286  *  - navigation (list of "title %2i")
 287  *  - "title %2i"
 288  *
 289  * The variable used for event is
 290  *  - intf-event (\see input_event_type_e)
 291  */
 292
 293 /**
 294  * Input state
 295  *
 296  * This enum is used by the variable "state"
 297  */
 298 typedef enum input_state_e
 299 {
 300     INIT_S = 0,
 301     OPENING_S,
 302     PLAYING_S,
 303     PAUSE_S,
 304     END_S,
 305     ERROR_S,
 306 } input_state_e;
 307
 308 /**
 309  * Input rate.
 310  *
 311  * It is an float used by the variable "rate" in the
 312  * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
 313  * the default value being 1. It represents the ratio of playback speed to
 314  * nominal speed (bigger is faster).
 315  *
 316  * Internally, the rate is stored as a value in the range
 317  * [INPUT_RATE_MIN, INPUT_RATE_MAX].
 318  * internal rate = INPUT_RATE_DEFAULT / rate variable
 319  */
 320
 321 /**
 322  * Default rate value
 323  */
 324 #define INPUT_RATE_DEFAULT  1000
 325 /**
 326  * Minimal rate value
 327  */
 328 #define INPUT_RATE_MIN        32            /* Up to 32/1 */
 329 /**
 330  * Maximal rate value
 331  */
 332 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 333
 334 /**
 335  * Input events
 336  *
 337  * You can catch input event by adding a callback on the variable "intf-event".
 338  * This variable is an integer that will hold a input_event_type_e value.
 339  */
 340 typedef enum input_event_type_e
 341 {
 342     /* "state" has changed */
 343     INPUT_EVENT_STATE,
 344     /* b_dead is true */
 345     INPUT_EVENT_DEAD,
 346     /* a *user* abort has been requested */
 347     INPUT_EVENT_ABORT,
 348
 349     /* "rate" has changed */
 350     INPUT_EVENT_RATE,
 351
 352     /* At least one of "position" or "time" */
 353     INPUT_EVENT_POSITION,
 354
 355     /* "length" has changed */
 356     INPUT_EVENT_LENGTH,
 357
 358     /* A title has been added or removed or selected.
 359      * It imply that chapter has changed (not chapter event is sent) */
 360     INPUT_EVENT_TITLE,
 361     /* A chapter has been added or removed or selected. */
 362     INPUT_EVENT_CHAPTER,
 363
 364     /* A program ("program") has been added or removed or selected,
 365      * or "program-scrambled" has changed.*/
 366     INPUT_EVENT_PROGRAM,
 367     /* A ES has been added or removed or selected */
 368     INPUT_EVENT_ES,
 369     /* "teletext-es" has changed */
 370     INPUT_EVENT_TELETEXT,
 371
 372     /* "record" has changed */
 373     INPUT_EVENT_RECORD,
 374
 375     /* input_item_t media has changed */
 376     INPUT_EVENT_ITEM_META,
 377     /* input_item_t info has changed */
 378     INPUT_EVENT_ITEM_INFO,
 379     /* input_item_t name has changed */
 380     INPUT_EVENT_ITEM_NAME,
 381     /* input_item_t epg has changed */
 382     INPUT_EVENT_ITEM_EPG,
 383
 384     /* Input statistics have been updated */
 385     INPUT_EVENT_STATISTICS,
 386     /* At least one of "signal-quality" or "signal-strength" has changed */
 387     INPUT_EVENT_SIGNAL,
 388
 389     /* "audio-delay" has changed */
 390     INPUT_EVENT_AUDIO_DELAY,
 391     /* "spu-delay" has changed */
 392     INPUT_EVENT_SUBTITLE_DELAY,
 393
 394     /* "bookmark" has changed */
 395     INPUT_EVENT_BOOKMARK,
 396
 397     /* cache" has changed */
 398     INPUT_EVENT_CACHE,
 399
 400     /* A audio_output_t object has been created/deleted by *the input* */
 401     INPUT_EVENT_AOUT,
 402     /* A vout_thread_t object has been created/deleted by *the input* */
 403     INPUT_EVENT_VOUT,
 404
 405 } input_event_type_e;
 406
 407 /**
 408  * Input queries
 409  */
 410 enum input_query_e
 411 {
 412     /* input variable "position" */
 413     INPUT_GET_POSITION,         /* arg1= double *       res=    */
 414     INPUT_SET_POSITION,         /* arg1= double         res=can fail    */
 415
 416     /* input variable "length" */
 417     INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */
 418
 419     /* input variable "time" */
 420     INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
 421     INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */
 422
 423     /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
 424     INPUT_GET_RATE,             /* arg1= int *          res=    */
 425     INPUT_SET_RATE,             /* arg1= int            res=can fail    */
 426
 427     /* input variable "state" */
 428     INPUT_GET_STATE,            /* arg1= int *          res=    */
 429     INPUT_SET_STATE,            /* arg1= int            res=can fail    */
 430
 431     /* input variable "audio-delay" and "sub-delay" */
 432     INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
 433     INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
 434     INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
 435     INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */
 436
 437     /* Menu navigation */
 438     INPUT_NAV_ACTIVATE,
 439     INPUT_NAV_UP,
 440     INPUT_NAV_DOWN,
 441     INPUT_NAV_LEFT,
 442     INPUT_NAV_RIGHT,
 443
 444     /* Meta datas */
 445     INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
 446     INPUT_REPLACE_INFOS,/* arg1= info_category_t *            res=cannot fail */
 447     INPUT_MERGE_INFOS,/* arg1= info_category_t *              res=cannot fail */
 448     INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
 449     INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
 450     INPUT_SET_NAME,   /* arg1= char* res=can fail    */
 451
 452     /* Input properties */
 453     INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
 454
 455     /* bookmarks */
 456     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
 457     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 458     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 459     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 460     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 461     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 462     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 463
 464     /* titles */
 465     INPUT_GET_TITLE_INFO,     /* arg1=input_title_t** arg2= int * res=can fail */
 466
 467     /* Attachments */
 468     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 469     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 470
 471     /* On the fly input slave */
 472     INPUT_ADD_SLAVE,       /* arg1= const char * */
 473     INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
 474
 475     /* On the fly record while playing */
 476     INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
 477     INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
 478
 479     /* ES */
 480     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
 481
 482     /* Input ressources
 483      * XXX You must call vlc_object_release as soon as possible */
 484     INPUT_GET_AOUT,         /* arg1=audio_output_t **              res=can fail */
 485     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
 486     INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
 487
 488     /* External clock managments */
 489     INPUT_GET_PCR_SYSTEM,   /* arg1=mtime_t *, arg2=mtime_t *       res=can fail */
 490     INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t      res=can fail */
 491 };
 492
 493 /** @}*/
 494
 495 /*****************************************************************************
 496  * Prototypes
 497  *****************************************************************************/
 498
 499 VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED;
 500 #define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
 501
 502 VLC_API input_thread_t * input_CreateAndStart( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) VLC_USED;
 503 #define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
 504
 505 VLC_API int input_Start( input_thread_t * );
 506
 507 VLC_API void input_Stop( input_thread_t *, bool b_abort );
 508
 509 VLC_API int input_Read( vlc_object_t *, input_item_t * );
 510 #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
 511
 512 VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
 513
 514 VLC_API int input_Control( input_thread_t *, int i_query, ...  );
 515
 516 VLC_API void input_Close( input_thread_t * );
 517 void input_Join( input_thread_t * );
 518 void input_Release( input_thread_t * );
 519
 520 /**
 521  * Get the input item for an input thread
 522  *
 523  * You have to keep a reference to the input or to the input_item_t until
 524  * you do not need it anymore.
 525  */
 526 VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
 527
 528 /**
 529  * It will return the current state of the input.
 530  * Provided for convenience.
 531  */
 532 static inline input_state_e input_GetState( input_thread_t * p_input )
 533 {
 534     input_state_e state = INIT_S;
 535     input_Control( p_input, INPUT_GET_STATE, &state );
 536     return state;
 537 }
 538 /**
 539  * It will add a new subtitle source to the input.
 540  * Provided for convenience.
 541  */
 542 static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
 543 {
 544     return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
 545 }
 546
 547 /**
 548  * Return one of the video output (if any). If possible, you should use
 549  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
 550  * @param p_input an input thread from which to get a video output
 551  * @return NULL on error, or a video output thread pointer (which needs to be
 552  * released with vlc_object_release()).
 553  */
 554 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
 555 {
 556      vout_thread_t **pp_vout, *p_vout;
 557      size_t i_vout;
 558
 559      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
 560          return NULL;
 561
 562      for( size_t i = 1; i < i_vout; i++ )
 563          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
 564
 565      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
 566      free( pp_vout );
 567      return p_vout;
 568 }
 569
 570 /**
 571  * Return the audio output (if any) associated with an input.
 572  * @param p_input an input thread
 573  * @return NULL on error, or the audio output (which needs to be
 574  * released with vlc_object_release()).
 575  */
 576 static inline audio_output_t *input_GetAout( input_thread_t *p_input )
 577 {
 578      audio_output_t *p_aout;
 579      return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
 580 }
 581
 582 /**
 583  * Returns the objects associated to an ES.
 584  *
 585  * You must release all non NULL object using vlc_object_release.
 586  * You may set pointer of pointer to NULL to avoid retreiving it.
 587  */
 588 static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
 589                                       vlc_object_t **pp_decoder,
 590                                       vout_thread_t **pp_vout, audio_output_t **pp_aout )
 591 {
 592     return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
 593                           pp_decoder, pp_vout, pp_aout );
 594 }
 595
 596 /**
 597  * \see input_clock_GetSystemOrigin
 598  */
 599 static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
 600 {
 601     return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
 602 }
 603 /**
 604  * \see input_clock_ChangeSystemOrigin
 605  */
 606 static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system )
 607 {
 608     return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
 609 }
 610
 611 /* */
 612 VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, es_format_t *, input_resource_t * ) VLC_USED;
 613 VLC_API void input_DecoderDelete( decoder_t * );
 614 VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
 615
 616 /**
 617  * This function creates a sane filename path.
 618  */
 619 VLC_API char * input_CreateFilename( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED;
 620
 621 /**
 622  * It creates an empty input resource handler.
 623  *
 624  * The given object MUST stay alive as long as the input_resource_t is
 625  * not deleted.
 626  */
 627 VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
 628
 629 /**
 630  * It releases an input resource.
 631  */
 632 VLC_API void input_resource_Release( input_resource_t * );
 633
 634 /**
 635  * Forcefully destroys the video output (e.g. when the playlist is stopped).
 636  */
 637 VLC_API void input_resource_TerminateVout( input_resource_t * );
 638
 639 /**
 640  * This function releases all resources (object).
 641  */
 642 VLC_API void input_resource_Terminate( input_resource_t * );
 643
 644 /**
 645  * \return the current audio output if any.
 646  * Use vlc_object_release() to drop the reference.
 647  */
 648 VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * );
 649
 650 #endif