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( src->psz_name ) point->psz_name = strdup( src->psz_name );
  75     point->i_time_offset = src->i_time_offset;
  76     return point;
  77 }
  78
  79 /*****************************************************************************
  80  * Title:
  81  *****************************************************************************/
  82 typedef struct input_title_t
  83 {
  84     char        *psz_name;
  85
  86     bool        b_menu;      /* Is it a menu or a normal entry */
  87
  88     int64_t     i_length;   /* Length(microsecond) if known, else 0 */
  89
  90     /* Title seekpoint */
  91     int         i_seekpoint;
  92     seekpoint_t **seekpoint;
  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     if( !t )
  99         return NULL;
 100
 101     t->psz_name = NULL;
 102     t->b_menu = false;
 103     t->i_length = 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_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     size_t i_data;
 159     void *p_data;
 160 };
 161
 162 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 163 {
 164     if( !a )
 165         return;
 166
 167     free( a->p_data );
 168     free( a->psz_description );
 169     free( a->psz_mime );
 170     free( a->psz_name );
 171     free( a );
 172 }
 173
 174 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 175                                                             const char *psz_mime,
 176                                                             const char *psz_description,
 177                                                             const void *p_data,
 178                                                             size_t i_data )
 179 {
 180     input_attachment_t *a = (input_attachment_t *)malloc( sizeof (*a) );
 181     if( unlikely(a == NULL) )
 182         return NULL;
 183
 184     a->psz_name = strdup( psz_name ? psz_name : "" );
 185     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 186     a->psz_description = strdup( psz_description ? psz_description : "" );
 187     a->i_data = i_data;
 188     a->p_data = malloc( i_data );
 189     if( i_data > 0 && likely(p_data != NULL) )
 190         memcpy( a->p_data, p_data, i_data );
 191
 192     if( unlikely(a->psz_name == NULL || a->psz_mime == NULL
 193               || a->psz_description == NULL || (i_data > 0 && a->p_data == NULL)) )
 194     {
 195         vlc_input_attachment_Delete( a );
 196         a = NULL;
 197     }
 198     return a;
 199 }
 200
 201 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 202 {
 203     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 204                                      a->p_data, a->i_data );
 205 }
 206
 207 /*****************************************************************************
 208  * input defines/constants.
 209  *****************************************************************************/
 210
 211 /**
 212  * This defines private core storage for an input.
 213  */
 214 typedef struct input_thread_private_t input_thread_private_t;
 215
 216 /**
 217  * This defines an opaque input resource handler.
 218  */
 219 typedef struct input_resource_t input_resource_t;
 220
 221 /**
 222  * Main structure representing an input thread. This structure is mostly
 223  * private. The only public fields are read-only and constant.
 224  */
 225 struct input_thread_t
 226 {
 227     VLC_COMMON_MEMBERS
 228
 229     bool b_preparsing;
 230     bool b_dead VLC_DEPRECATED;
 231
 232     /* All other data is input_thread is PRIVATE. You can't access it
 233      * outside of src/input */
 234     input_thread_private_t *p;
 235 };
 236
 237 /**
 238  * Record prefix string.
 239  * TODO make it configurable.
 240  */
 241 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
 242
 243 /*****************************************************************************
 244  * Input events and variables
 245  *****************************************************************************/
 246
 247 /**
 248  * \defgroup inputvariable Input variables
 249  *
 250  * The input provides multiples variable you can write to and/or read from.
 251  *
 252  * TODO complete the documentation.
 253  * The read only variables are:
 254  *  - "length"
 255  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
 256  *    or not, for that check position != 0.0)
 257  *  - "can-pause"
 258  *  - "can-rate"
 259  *  - "can-rewind"
 260  *  - "can-record" (if a stream can be recorded while playing)
 261  *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
 262  *                   variable value being the one currently selected, -1 if no teletext)
 263  *  - "signal-quality"
 264  *  - "signal-strength"
 265  *  - "program-scrambled" (if the current program is scrambled)
 266  *  - "cache" (level of data cached [0 .. 1])
 267  *
 268  * The read-write variables are:
 269  *  - state (\see input_state_e)
 270  *  - rate
 271  *  - position, position-offset
 272  *  - time, time-offset
 273  *  - title, next-title, prev-title
 274  *  - chapter, next-chapter, next-chapter-prev
 275  *  - program, audio-es, video-es, spu-es
 276  *  - audio-delay, spu-delay
 277  *  - bookmark (bookmark list)
 278  *  - record
 279  *  - frame-next
 280  *  - navigation (list of "title %2i")
 281  *  - "title %2i"
 282  *
 283  * The variable used for event is
 284  *  - intf-event (\see input_event_type_e)
 285  */
 286
 287 /**
 288  * Input state
 289  *
 290  * This enum is used by the variable "state"
 291  */
 292 typedef enum input_state_e
 293 {
 294     INIT_S = 0,
 295     OPENING_S,
 296     PLAYING_S,
 297     PAUSE_S,
 298     END_S,
 299     ERROR_S,
 300 } input_state_e;
 301
 302 /**
 303  * Input rate.
 304  *
 305  * It is an float used by the variable "rate" in the
 306  * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
 307  * the default value being 1. It represents the ratio of playback speed to
 308  * nominal speed (bigger is faster).
 309  *
 310  * Internally, the rate is stored as a value in the range
 311  * [INPUT_RATE_MIN, INPUT_RATE_MAX].
 312  * internal rate = INPUT_RATE_DEFAULT / rate variable
 313  */
 314
 315 /**
 316  * Default rate value
 317  */
 318 #define INPUT_RATE_DEFAULT  1000
 319 /**
 320  * Minimal rate value
 321  */
 322 #define INPUT_RATE_MIN        32            /* Up to 32/1 */
 323 /**
 324  * Maximal rate value
 325  */
 326 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 327
 328 /**
 329  * Input events
 330  *
 331  * You can catch input event by adding a callback on the variable "intf-event".
 332  * This variable is an integer that will hold a input_event_type_e value.
 333  */
 334 typedef enum input_event_type_e
 335 {
 336     /* "state" has changed */
 337     INPUT_EVENT_STATE,
 338     /* b_dead is true */
 339     INPUT_EVENT_DEAD,
 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     /* bookmarks */
 445     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
 446     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 447     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 448     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 449     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 450     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 451     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 452
 453     /* titles */
 454     INPUT_GET_TITLE_INFO,     /* arg1=input_title_t** arg2= int * res=can fail */
 455     INPUT_GET_FULL_TITLE_INFO,     /* arg1=input_title_t*** arg2= int * res=can fail */
 456
 457     /* seekpoints */
 458     INPUT_GET_SEEKPOINTS,  /* arg1=seekpoint_t*** arg2= int * res=can fail */
 459
 460     /* Attachments */
 461     INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
 462     INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */
 463
 464     /* On the fly input slave */
 465     INPUT_ADD_SLAVE,       /* arg1= const char * */
 466     INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
 467
 468     /* On the fly record while playing */
 469     INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
 470     INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
 471
 472     /* ES */
 473     INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
 474
 475     /* Input ressources
 476      * XXX You must call vlc_object_release as soon as possible */
 477     INPUT_GET_AOUT,         /* arg1=audio_output_t **              res=can fail */
 478     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
 479     INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
 480
 481     /* External clock managments */
 482     INPUT_GET_PCR_SYSTEM,   /* arg1=mtime_t *, arg2=mtime_t *       res=can fail */
 483     INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t      res=can fail */
 484 };
 485
 486 /** @}*/
 487
 488 /*****************************************************************************
 489  * Prototypes
 490  *****************************************************************************/
 491
 492 VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED;
 493 #define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
 494
 495 VLC_API int input_Start( input_thread_t * );
 496
 497 VLC_API void input_Stop( input_thread_t * );
 498
 499 VLC_API int input_Read( vlc_object_t *, input_item_t * );
 500 #define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
 501
 502 VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
 503
 504 VLC_API int input_Control( input_thread_t *, int i_query, ...  );
 505
 506 VLC_API void input_Close( input_thread_t * );
 507
 508 /**
 509  * Create a new input_thread_t and start it.
 510  *
 511  * Provided for convenience.
 512  *
 513  * \see input_Create
 514  */
 515 static inline
 516 input_thread_t *input_CreateAndStart( vlc_object_t *parent,
 517                                       input_item_t *item, const char *log )
 518 {
 519     input_thread_t *input = input_Create( parent, item, log, NULL );
 520     if( input != NULL && input_Start( input ) )
 521     {
 522         vlc_object_release( input );
 523         input = NULL;
 524     }
 525     return input;
 526 }
 527 #define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
 528
 529 /**
 530  * Get the input item for an input thread
 531  *
 532  * You have to keep a reference to the input or to the input_item_t until
 533  * you do not need it anymore.
 534  */
 535 VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
 536
 537 /**
 538  * It will return the current state of the input.
 539  * Provided for convenience.
 540  */
 541 static inline input_state_e input_GetState( input_thread_t * p_input )
 542 {
 543     input_state_e state = INIT_S;
 544     input_Control( p_input, INPUT_GET_STATE, &state );
 545     return state;
 546 }
 547
 548 /**
 549  * Return one of the video output (if any). If possible, you should use
 550  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
 551  * @param p_input an input thread from which to get a video output
 552  * @return NULL on error, or a video output thread pointer (which needs to be
 553  * released with vlc_object_release()).
 554  */
 555 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
 556 {
 557      vout_thread_t **pp_vout, *p_vout;
 558      size_t i_vout;
 559
 560      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
 561          return NULL;
 562
 563      for( size_t i = 1; i < i_vout; i++ )
 564          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
 565
 566      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
 567      free( pp_vout );
 568      return p_vout;
 569 }
 570
 571 /**
 572  * It will add a new subtitle source to the input.
 573  * Provided for convenience.
 574  */
 575 static inline int input_AddSubtitleOSD( input_thread_t *p_input, const char *psz_url,
 576         bool b_check_extension, bool b_osd )
 577 {
 578     int i_result = input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
 579     if( i_result != VLC_SUCCESS || !b_osd )
 580         return i_result;
 581
 582     vout_thread_t *p_vout = input_GetVout( p_input );
 583     if( p_vout )
 584     {
 585         vout_OSDMessage(p_vout, SPU_DEFAULT_CHANNEL, "%s",
 586                         vlc_gettext("Subtitle track added") );
 587         vlc_object_release( (vlc_object_t *)p_vout );
 588     }
 589     return i_result;
 590 }
 591 #define input_AddSubtitle(a, b, c) input_AddSubtitleOSD(a, b, c, false)
 592
 593
 594 /**
 595  * Return the audio output (if any) associated with an input.
 596  * @param p_input an input thread
 597  * @return NULL on error, or the audio output (which needs to be
 598  * released with vlc_object_release()).
 599  */
 600 static inline audio_output_t *input_GetAout( input_thread_t *p_input )
 601 {
 602      audio_output_t *p_aout;
 603      return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
 604 }
 605
 606 /**
 607  * Returns the objects associated to an ES.
 608  *
 609  * You must release all non NULL object using vlc_object_release.
 610  * You may set pointer of pointer to NULL to avoid retreiving it.
 611  */
 612 static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
 613                                       vlc_object_t **pp_decoder,
 614                                       vout_thread_t **pp_vout, audio_output_t **pp_aout )
 615 {
 616     return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
 617                           pp_decoder, pp_vout, pp_aout );
 618 }
 619
 620 /**
 621  * \see input_clock_GetSystemOrigin
 622  */
 623 static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
 624 {
 625     return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
 626 }
 627 /**
 628  * \see input_clock_ChangeSystemOrigin
 629  */
 630 static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system )
 631 {
 632     return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
 633 }
 634
 635 /* */
 636 VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, const es_format_t *, input_resource_t * ) VLC_USED;
 637 VLC_API void input_DecoderDelete( decoder_t * );
 638 VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
 639 VLC_API void input_DecoderDrain( decoder_t * );
 640 VLC_API void input_DecoderFlush( decoder_t * );
 641
 642 /**
 643  * This function creates a sane filename path.
 644  */
 645 VLC_API char * input_CreateFilename( input_thread_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED;
 646
 647 /**
 648  * It creates an empty input resource handler.
 649  *
 650  * The given object MUST stay alive as long as the input_resource_t is
 651  * not deleted.
 652  */
 653 VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
 654
 655 /**
 656  * It releases an input resource.
 657  */
 658 VLC_API void input_resource_Release( input_resource_t * );
 659
 660 /**
 661  * Forcefully destroys the video output (e.g. when the playlist is stopped).
 662  */
 663 VLC_API void input_resource_TerminateVout( input_resource_t * );
 664
 665 /**
 666  * This function releases all resources (object).
 667  */
 668 VLC_API void input_resource_Terminate( input_resource_t * );
 669
 670 /**
 671  * \return the current audio output if any.
 672  * Use vlc_object_release() to drop the reference.
 673  */
 674 VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * );
 675
 676 /**
 677  * This function creates or recycles an audio output.
 678  */
 679 VLC_API audio_output_t *input_resource_GetAout( input_resource_t * );
 680
 681 /**
 682  * This function retains or destroys an audio output.
 683  */
 684 VLC_API void input_resource_PutAout( input_resource_t *, audio_output_t * );
 685
 686 /**
 687  * Prevents the existing audio output (if any) from being recycled.
 688  */
 689 VLC_API void input_resource_ResetAout( input_resource_t * );
 690
 691 /** @} */
 692 #endif