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