include/vlc_input.h

   1 /*****************************************************************************
   2  * vlc_input.h: Core input structures
   3  *****************************************************************************
   4  * Copyright (C) 1999-2015 VLC authors and VideoLAN
   5  *
   6  * Authors: Christophe Massiot <massiot@via.ecp.fr>
   7  *          Laurent Aimar <fenrir@via.ecp.fr>
   8  *
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU Lesser General Public License as published by
  11  * the Free Software Foundation; either version 2.1 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef VLC_INPUT_H
  25 #define VLC_INPUT_H 1
  26
  27 /**
  28  * \defgroup input Input
  29  * \ingroup vlc
  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.h>
  42 #include <vlc_vout_osd.h>
  43
  44 #include <string.h>
  45
  46 /*****************************************************************************
  47  * Seek point: (generalisation of chapters)
  48  *****************************************************************************/
  49 struct seekpoint_t
  50 {
  51     vlc_tick_t i_time_offset;
  52     char    *psz_name;
  53 };
  54
  55 static inline seekpoint_t *vlc_seekpoint_New( void )
  56 {
  57     seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
  58     if( !point )
  59         return NULL;
  60     point->i_time_offset = -1;
  61     point->psz_name = NULL;
  62     return point;
  63 }
  64
  65 static inline void vlc_seekpoint_Delete( seekpoint_t *point )
  66 {
  67     if( !point ) return;
  68     free( point->psz_name );
  69     free( point );
  70 }
  71
  72 static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
  73 {
  74     seekpoint_t *point = vlc_seekpoint_New();
  75     if( likely(point) )
  76     {
  77         if( src->psz_name ) point->psz_name = strdup( src->psz_name );
  78         point->i_time_offset = src->i_time_offset;
  79     }
  80     return point;
  81 }
  82
  83 /*****************************************************************************
  84  * Title:
  85  *****************************************************************************/
  86
  87 /* input_title_t.i_flags field */
  88 #define INPUT_TITLE_MENU         0x01   /* Menu title */
  89 #define INPUT_TITLE_INTERACTIVE  0x02   /* Interactive title. Playback position has no meaning. */
  90
  91 typedef struct input_title_t
  92 {
  93     char        *psz_name;
  94
  95     vlc_tick_t  i_length;   /* Length(microsecond) if known, else 0 */
  96
  97     unsigned    i_flags;    /* Is it a menu or a normal entry */
  98
  99     /* Title seekpoint */
 100     int         i_seekpoint;
 101     seekpoint_t **seekpoint;
 102 } input_title_t;
 103
 104 static inline input_title_t *vlc_input_title_New(void)
 105 {
 106     input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );
 107     if( !t )
 108         return NULL;
 109
 110     t->psz_name = NULL;
 111     t->i_flags = 0;
 112     t->i_length = 0;
 113     t->i_seekpoint = 0;
 114     t->seekpoint = NULL;
 115
 116     return t;
 117 }
 118
 119 static inline void vlc_input_title_Delete( input_title_t *t )
 120 {
 121     int i;
 122     if( t == NULL )
 123         return;
 124
 125     free( t->psz_name );
 126     for( i = 0; i < t->i_seekpoint; i++ )
 127         vlc_seekpoint_Delete( t->seekpoint[i] );
 128     free( t->seekpoint );
 129     free( t );
 130 }
 131
 132 static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t )
 133 {
 134     input_title_t *dup = vlc_input_title_New( );
 135     if( dup == NULL) return NULL;
 136
 137     if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
 138     dup->i_flags     = t->i_flags;
 139     dup->i_length    = t->i_length;
 140     if( t->i_seekpoint > 0 )
 141     {
 142         dup->seekpoint = (seekpoint_t**)vlc_alloc( t->i_seekpoint, sizeof(seekpoint_t*) );
 143         if( likely(dup->seekpoint) )
 144         {
 145             for( int i = 0; i < t->i_seekpoint; i++ )
 146                 dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
 147             dup->i_seekpoint = t->i_seekpoint;
 148         }
 149     }
 150
 151     return dup;
 152 }
 153
 154 /*****************************************************************************
 155  * Attachments
 156  *****************************************************************************/
 157 struct input_attachment_t
 158 {
 159     char *psz_name;
 160     char *psz_mime;
 161     char *psz_description;
 162
 163     size_t i_data;
 164     void *p_data;
 165 };
 166
 167 static inline void vlc_input_attachment_Delete( input_attachment_t *a )
 168 {
 169     if( !a )
 170         return;
 171
 172     free( a->p_data );
 173     free( a->psz_description );
 174     free( a->psz_mime );
 175     free( a->psz_name );
 176     free( a );
 177 }
 178
 179 static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
 180                                                             const char *psz_mime,
 181                                                             const char *psz_description,
 182                                                             const void *p_data,
 183                                                             size_t i_data )
 184 {
 185     input_attachment_t *a = (input_attachment_t *)malloc( sizeof (*a) );
 186     if( unlikely(a == NULL) )
 187         return NULL;
 188
 189     a->psz_name = strdup( psz_name ? psz_name : "" );
 190     a->psz_mime = strdup( psz_mime ? psz_mime : "" );
 191     a->psz_description = strdup( psz_description ? psz_description : "" );
 192     a->i_data = i_data;
 193     a->p_data = malloc( i_data );
 194     if( i_data > 0 && likely(a->p_data != NULL) )
 195         memcpy( a->p_data, p_data, i_data );
 196
 197     if( unlikely(a->psz_name == NULL || a->psz_mime == NULL
 198               || a->psz_description == NULL || (i_data > 0 && a->p_data == NULL)) )
 199     {
 200         vlc_input_attachment_Delete( a );
 201         a = NULL;
 202     }
 203     return a;
 204 }
 205
 206 static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
 207 {
 208     return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
 209                                      a->p_data, a->i_data );
 210 }
 211
 212 /*****************************************************************************
 213  * input defines/constants.
 214  *****************************************************************************/
 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     struct vlc_common_members obj;
 228 };
 229
 230 /**
 231  * Record prefix string.
 232  * TODO make it configurable.
 233  */
 234 #define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
 235
 236 /*****************************************************************************
 237  * Input events and variables
 238  *****************************************************************************/
 239
 240 /**
 241  * \defgroup inputvariable Input variables
 242  *
 243  * The input provides multiples variable you can write to and/or read from.
 244  *
 245  * TODO complete the documentation.
 246  * The read only variables are:
 247  *  - "length"
 248  *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
 249  *    or not, for that check position != 0.0)
 250  *  - "can-pause"
 251  *  - "can-rate"
 252  *  - "can-rewind"
 253  *  - "can-record" (if a stream can be recorded while playing)
 254  *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
 255  *                   variable value being the one currently selected, -1 if no teletext)
 256  *  - "signal-quality"
 257  *  - "signal-strength"
 258  *  - "program-scrambled" (if the current program is scrambled)
 259  *  - "cache" (level of data cached [0 .. 1])
 260  *
 261  * The read-write variables are:
 262  *  - state (\see input_state_e)
 263  *  - rate
 264  *  - position
 265  *  - time, time-offset
 266  *  - title, next-title, prev-title
 267  *  - chapter, next-chapter, next-chapter-prev
 268  *  - program, audio-es, video-es, spu-es
 269  *  - audio-delay, spu-delay
 270  *  - bookmark (bookmark list)
 271  *  - record
 272  *  - frame-next
 273  *  - navigation (list of "title %2i")
 274  *  - "title %2i"
 275  *
 276  * The variable used for event is
 277  *  - intf-event (\see input_event_type_e)
 278  */
 279
 280 /**
 281  * Input state
 282  *
 283  * This enum is used by the variable "state"
 284  */
 285 typedef enum input_state_e
 286 {
 287     INIT_S = 0,
 288     OPENING_S,
 289     PLAYING_S,
 290     PAUSE_S,
 291     END_S,
 292     ERROR_S,
 293 } input_state_e;
 294
 295 /**
 296  * Input rate.
 297  *
 298  * It is an float used by the variable "rate" in the
 299  * range [INPUT_RATE_MIN, INPUT_RATE_MAX]
 300  * the default value being 1.f. It represents the ratio of playback speed to
 301  * nominal speed (bigger is faster).
 302  */
 303
 304 /**
 305  * Minimal rate value
 306  */
 307 #define INPUT_RATE_MIN 0.03125f
 308 /**
 309  * Maximal rate value
 310  */
 311 #define INPUT_RATE_MAX 31.25f
 312
 313 /**
 314  * Input events
 315  *
 316  * You can catch input event by adding a callback on the variable "intf-event".
 317  * This variable is an integer that will hold a input_event_type_e value.
 318  */
 319 typedef enum input_event_type_e
 320 {
 321     /* "state" has changed */
 322     INPUT_EVENT_STATE,
 323     /* b_dead is true */
 324     INPUT_EVENT_DEAD,
 325
 326     /* "rate" has changed */
 327     INPUT_EVENT_RATE,
 328
 329     /* "capabilities" has changed */
 330     INPUT_EVENT_CAPABILITIES,
 331
 332     /* At least one of "position" or "time" */
 333     INPUT_EVENT_POSITION,
 334
 335     /* "length" has changed */
 336     INPUT_EVENT_LENGTH,
 337
 338     /* A title has been added or removed or selected.
 339      * It implies that the chapter has changed (no chapter event is sent) */
 340     INPUT_EVENT_TITLE,
 341     /* A chapter has been added or removed or selected. */
 342     INPUT_EVENT_CHAPTER,
 343
 344     /* A program ("program") has been added or removed or selected,
 345      * or "program-scrambled" has changed.*/
 346     INPUT_EVENT_PROGRAM,
 347     /* A ES has been added or removed or selected */
 348     INPUT_EVENT_ES,
 349
 350     /* "record" has changed */
 351     INPUT_EVENT_RECORD,
 352
 353     /* input_item_t media has changed */
 354     INPUT_EVENT_ITEM_META,
 355     /* input_item_t info has changed */
 356     INPUT_EVENT_ITEM_INFO,
 357     /* input_item_t epg has changed */
 358     INPUT_EVENT_ITEM_EPG,
 359
 360     /* Input statistics have been updated */
 361     INPUT_EVENT_STATISTICS,
 362     /* At least one of "signal-quality" or "signal-strength" has changed */
 363     INPUT_EVENT_SIGNAL,
 364
 365     /* "audio-delay" has changed */
 366     INPUT_EVENT_AUDIO_DELAY,
 367     /* "spu-delay" has changed */
 368     INPUT_EVENT_SUBTITLE_DELAY,
 369
 370     /* "bookmark" has changed */
 371     INPUT_EVENT_BOOKMARK,
 372
 373     /* cache" has changed */
 374     INPUT_EVENT_CACHE,
 375
 376     /* A vout_thread_t object has been created/deleted by *the input* */
 377     INPUT_EVENT_VOUT,
 378
 379     /* (pre-)parsing events */
 380     INPUT_EVENT_SUBITEMS,
 381
 382     /* vbi_page has changed */
 383     INPUT_EVENT_VBI_PAGE,
 384     /* vbi_transparent has changed */
 385     INPUT_EVENT_VBI_TRANSPARENCY,
 386
 387     /* subs_fps has changed */
 388     INPUT_EVENT_SUBS_FPS,
 389
 390     /* Thumbnail generation */
 391     INPUT_EVENT_THUMBNAIL_READY,
 392 } input_event_type_e;
 393
 394 #define VLC_INPUT_CAPABILITIES_SEEKABLE (1<<0)
 395 #define VLC_INPUT_CAPABILITIES_PAUSEABLE (1<<1)
 396 #define VLC_INPUT_CAPABILITIES_CHANGE_RATE (1<<2)
 397 #define VLC_INPUT_CAPABILITIES_REWINDABLE (1<<3)
 398 #define VLC_INPUT_CAPABILITIES_RECORDABLE (1<<4)
 399
 400 struct vlc_input_event_position
 401 {
 402     float percentage;
 403     vlc_tick_t ms;
 404 };
 405
 406 struct vlc_input_event_title
 407 {
 408     enum {
 409         VLC_INPUT_TITLE_NEW_LIST,
 410         VLC_INPUT_TITLE_SELECTED,
 411     } action;
 412     union
 413     {
 414         struct
 415         {
 416             input_title_t *const *array;
 417             size_t count;
 418         } list;
 419         size_t selected_idx;
 420     };
 421 };
 422
 423 struct vlc_input_event_chapter
 424 {
 425     int title;
 426     int seekpoint;
 427 };
 428
 429 struct vlc_input_event_program {
 430     enum {
 431         VLC_INPUT_PROGRAM_ADDED,
 432         VLC_INPUT_PROGRAM_DELETED,
 433         VLC_INPUT_PROGRAM_UPDATED,
 434         VLC_INPUT_PROGRAM_SELECTED,
 435         VLC_INPUT_PROGRAM_SCRAMBLED,
 436     } action;
 437     int id;
 438     union {
 439         const char *title;
 440         bool scrambled;
 441     };
 442 };
 443
 444 struct vlc_input_event_es {
 445     enum {
 446         VLC_INPUT_ES_ADDED,
 447         VLC_INPUT_ES_DELETED,
 448         VLC_INPUT_ES_UPDATED,
 449         VLC_INPUT_ES_SELECTED,
 450         VLC_INPUT_ES_UNSELECTED,
 451     } action;
 452     /**
 453      * ES track id: only valid from the event callback, unless the id is held
 454      * by the user with vlc_es_Hold(). */
 455     vlc_es_id_t *id;
 456     /**
 457      * Title of ES track, can be updated after the VLC_INPUT_ES_UPDATED event.
 458      */
 459     const char *title;
 460     /**
 461      * ES track information, can be updated after the VLC_INPUT_ES_UPDATED event.
 462      */
 463     const es_format_t *fmt;
 464 };
 465
 466 struct vlc_input_event_signal {
 467     float quality;
 468     float strength;
 469 };
 470
 471 struct vlc_input_event_vout
 472 {
 473     enum {
 474         VLC_INPUT_EVENT_VOUT_ADDED,
 475         VLC_INPUT_EVENT_VOUT_DELETED,
 476     } action;
 477     vout_thread_t *vout;
 478 };
 479
 480 struct vlc_input_event
 481 {
 482     input_event_type_e type;
 483
 484     union {
 485         /* INPUT_EVENT_STATE */
 486         input_state_e state;
 487         /* INPUT_EVENT_RATE */
 488         float rate;
 489         /* INPUT_EVENT_CAPABILITIES */
 490         int capabilities; /**< cf. VLC_INPUT_CAPABILITIES_* bitwise flags */
 491         /* INPUT_EVENT_POSITION */
 492         struct vlc_input_event_position position;
 493         /* INPUT_EVENT_LENGTH */
 494         vlc_tick_t length;
 495         /* INPUT_EVENT_TITLE */
 496         struct vlc_input_event_title title;
 497         /* INPUT_EVENT_CHAPTER */
 498         struct vlc_input_event_chapter chapter;
 499         /* INPUT_EVENT_PROGRAM */
 500         struct vlc_input_event_program program;
 501         /* INPUT_EVENT_ES */
 502         struct vlc_input_event_es es;
 503         /* INPUT_EVENT_RECORD */
 504         bool record;
 505         /* INPUT_EVENT_STATISTICS */
 506         const struct input_stats_t *stats;
 507         /* INPUT_EVENT_SIGNAL */
 508         struct vlc_input_event_signal signal;
 509         /* INPUT_EVENT_AUDIO_DELAY */
 510         vlc_tick_t audio_delay;
 511         /* INPUT_EVENT_SUBTITLE_DELAY */
 512         vlc_tick_t subtitle_delay;
 513         /* INPUT_EVENT_CACHE */
 514         float cache;
 515         /* INPUT_EVENT_VOUT */
 516         struct vlc_input_event_vout vout;
 517         /* INPUT_EVENT_SUBITEMS */
 518         input_item_node_t *subitems;
 519         /* INPUT_EVENT_VBI_PAGE */
 520         unsigned vbi_page;
 521         /* INPUT_EVENT_VBI_TRANSPARENCY */
 522         bool vbi_transparent;
 523         /* INPUT_EVENT_SUBS_FPS */
 524         float subs_fps;
 525         /* INPUT_EVENT_THUMBNAIL_READY */
 526         picture_t *thumbnail;
 527     };
 528 };
 529
 530 typedef void (*input_thread_events_cb)( input_thread_t *input,
 531                                         const struct vlc_input_event *event,
 532                                         void *userdata);
 533
 534 /**
 535  * Input queries
 536  */
 537 enum input_query_e
 538 {
 539     /* Menu (VCD/DVD/BD) Navigation */
 540     /** Activate the navigation item selected. res=can fail */
 541     INPUT_NAV_ACTIVATE,
 542     /** Use the up arrow to select a navigation item above. res=can fail */
 543     INPUT_NAV_UP,
 544     /** Use the down arrow to select a navigation item under. res=can fail */
 545     INPUT_NAV_DOWN,
 546     /** Use the left arrow to select a navigation item on the left. res=can fail */
 547     INPUT_NAV_LEFT,
 548     /** Use the right arrow to select a navigation item on the right. res=can fail */
 549     INPUT_NAV_RIGHT,
 550     /** Activate the popup Menu (for BD). res=can fail */
 551     INPUT_NAV_POPUP,
 552     /** Activate disc Root Menu. res=can fail */
 553     INPUT_NAV_MENU,
 554
 555     /* bookmarks */
 556     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
 557     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 558     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 559     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 560     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 561     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 562     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 563
 564     /* titles */
 565     INPUT_GET_FULL_TITLE_INFO,     /* arg1=input_title_t*** arg2= int * res=can fail */
 566
 567     /* On the fly input slave */
 568     INPUT_ADD_SLAVE,       /* arg1= enum slave_type, arg2= const char *,
 569                             * arg3= bool forced, arg4= bool notify,
 570                             * arg5= bool check_extension */
 571
 572     /* ES */
 573     INPUT_RESTART_ES_BY_ID,/* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
 574
 575     /* Viewpoint */
 576     INPUT_UPDATE_VIEWPOINT, /* arg1=(const vlc_viewpoint_t*), arg2=bool b_absolute */
 577     INPUT_SET_INITIAL_VIEWPOINT, /* arg1=(const vlc_viewpoint_t*) */
 578
 579     /* Input ressources
 580      * XXX You must call vlc_object_release as soon as possible */
 581     INPUT_GET_AOUT,         /* arg1=audio_output_t **              res=can fail */
 582     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
 583     INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
 584
 585     /* Renderers */
 586     INPUT_SET_RENDERER,     /* arg1=vlc_renderer_item_t* */
 587
 588     /* External clock managments */
 589     INPUT_GET_PCR_SYSTEM,   /* arg1=vlc_tick_t *, arg2=vlc_tick_t *       res=can fail */
 590     INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=vlc_tick_t   res=can fail */
 591 };
 592
 593 /** @}*/
 594
 595 /*****************************************************************************
 596  * Prototypes
 597  *****************************************************************************/
 598 VLC_API input_thread_t * input_Create( vlc_object_t *p_parent,
 599                                        input_thread_events_cb event_cb, void *events_data,
 600                                        input_item_t *, input_resource_t *,
 601                                        vlc_renderer_item_t* p_renderer ) VLC_USED;
 602 #define input_Create(a,b,c,d,e,f) input_Create(VLC_OBJECT(a),b,c,d,e,f)
 603
 604
 605 /**
 606  * Creates an item preparser.
 607  *
 608  * Creates an input thread to preparse an item. The input needs to be started
 609  * with input_Start() afterwards.
 610  *
 611  * @param obj parent object
 612  * @param item input item to preparse
 613  * @return an input thread or NULL on error
 614  */
 615 VLC_API input_thread_t *input_CreatePreparser(vlc_object_t *obj,
 616                                               input_thread_events_cb events_cb,
 617                                               void *events_data, input_item_t *item)
 618 VLC_USED;
 619
 620 VLC_API
 621 input_thread_t *input_CreateThumbnailer(vlc_object_t *obj,
 622                                         input_thread_events_cb events_cb,
 623                                         void *events_data, input_item_t *item)
 624 VLC_USED;
 625
 626 VLC_API int input_Start( input_thread_t * );
 627
 628 VLC_API void input_Stop( input_thread_t * );
 629
 630 VLC_API int input_Read( vlc_object_t *, input_item_t *,
 631                         input_thread_events_cb, void * );
 632 #define input_Read(a,b,c,d) input_Read(VLC_OBJECT(a),b,c,d)
 633
 634 VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
 635
 636 VLC_API int input_Control( input_thread_t *, int i_query, ...  );
 637
 638 VLC_API void input_Close( input_thread_t * );
 639
 640 VLC_API void input_SetTime( input_thread_t *, vlc_tick_t i_time, bool b_fast );
 641
 642 VLC_API void input_SetPosition( input_thread_t *, float f_position, bool b_fast );
 643
 644 VLC_API void input_LegacyEvents(input_thread_t *, const struct vlc_input_event *, void * );
 645 VLC_API void input_LegacyVarInit ( input_thread_t * );
 646
 647 /**
 648  * Get the input item for an input thread
 649  *
 650  * You have to keep a reference to the input or to the input_item_t until
 651  * you do not need it anymore.
 652  */
 653 VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
 654
 655 /**
 656  * Return one of the video output (if any). If possible, you should use
 657  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
 658  * @param p_input an input thread from which to get a video output
 659  * @return NULL on error, or a video output thread pointer (which needs to be
 660  * released with vlc_object_release()).
 661  */
 662 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
 663 {
 664      vout_thread_t **pp_vout, *p_vout;
 665      size_t i_vout;
 666
 667      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
 668          return NULL;
 669
 670      for( size_t i = 1; i < i_vout; i++ )
 671          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
 672
 673      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
 674      free( pp_vout );
 675      return p_vout;
 676 }
 677
 678 static inline int input_AddSlave( input_thread_t *p_input, enum slave_type type,
 679                                   const char *psz_uri, bool b_forced,
 680                                   bool b_notify, bool b_check_ext )
 681 {
 682     return input_Control( p_input, INPUT_ADD_SLAVE, type, psz_uri, b_forced,
 683                           b_notify, b_check_ext );
 684 }
 685
 686 /**
 687  * Update the viewpoint of the input thread. The viewpoint will be applied to
 688  * all vouts and aouts.
 689  *
 690  * @param p_input an input thread
 691  * @param p_viewpoint the viewpoint value
 692  * @param b_absolute if true replace the old viewpoint with the new one. If
 693  * false, increase/decrease it.
 694  * @return VLC_SUCCESS or a VLC error code
 695  */
 696 static inline int input_UpdateViewpoint( input_thread_t *p_input,
 697                                          const vlc_viewpoint_t *p_viewpoint,
 698                                          bool b_absolute )
 699 {
 700     return input_Control( p_input, INPUT_UPDATE_VIEWPOINT, p_viewpoint,
 701                           b_absolute );
 702 }
 703
 704 /**
 705  * Return the audio output (if any) associated with an input.
 706  * @param p_input an input thread
 707  * @return NULL on error, or the audio output (which needs to be
 708  * released with vlc_object_release()).
 709  */
 710 static inline audio_output_t *input_GetAout( input_thread_t *p_input )
 711 {
 712      audio_output_t *p_aout;
 713      return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
 714 }
 715
 716 /**
 717  * Returns the objects associated to an ES.
 718  *
 719  * You must release all non NULL object using vlc_object_release.
 720  * You may set pointer of pointer to NULL to avoid retreiving it.
 721  */
 722 static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
 723                                       vlc_object_t **pp_decoder,
 724                                       vout_thread_t **pp_vout, audio_output_t **pp_aout )
 725 {
 726     return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
 727                           pp_decoder, pp_vout, pp_aout );
 728 }
 729
 730 /**
 731  * \see input_clock_GetSystemOrigin
 732  */
 733 static inline int input_GetPcrSystem( input_thread_t *p_input, vlc_tick_t *pi_system, vlc_tick_t *pi_delay )
 734 {
 735     return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
 736 }
 737 /**
 738  * \see input_clock_ChangeSystemOrigin
 739  */
 740 static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, vlc_tick_t i_system )
 741 {
 742     return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
 743 }
 744
 745 /* */
 746 VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, const es_format_t *, input_resource_t * ) VLC_USED;
 747 VLC_API void input_DecoderDelete( decoder_t * );
 748 VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
 749 VLC_API void input_DecoderDrain( decoder_t * );
 750 VLC_API void input_DecoderFlush( decoder_t * );
 751 VLC_API int  input_DecoderSetSpuHighlight( decoder_t *, const vlc_spu_highlight_t * );
 752
 753 /**
 754  * This function creates a sane filename path.
 755  */
 756 VLC_API char * input_CreateFilename( input_thread_t *, input_item_t *,
 757                                      const char *psz_path, const char *psz_prefix,
 758                                      const char *psz_extension ) VLC_USED;
 759
 760 /**
 761  * It creates an empty input resource handler.
 762  *
 763  * The given object MUST stay alive as long as the input_resource_t is
 764  * not deleted.
 765  */
 766 VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
 767
 768 /**
 769  * It releases an input resource.
 770  */
 771 VLC_API void input_resource_Release( input_resource_t * );
 772
 773 /**
 774  * Forcefully destroys the video output (e.g. when the playlist is stopped).
 775  */
 776 VLC_API void input_resource_TerminateVout( input_resource_t * );
 777
 778 /**
 779  * This function releases all resources (object).
 780  */
 781 VLC_API void input_resource_Terminate( input_resource_t * );
 782
 783 /**
 784  * \return the current audio output if any.
 785  * Use vlc_object_release() to drop the reference.
 786  */
 787 VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * );
 788
 789 /**
 790  * This function creates or recycles an audio output.
 791  */
 792 VLC_API audio_output_t *input_resource_GetAout( input_resource_t * );
 793
 794 /**
 795  * This function retains or destroys an audio output.
 796  */
 797 VLC_API void input_resource_PutAout( input_resource_t *, audio_output_t * );
 798
 799 /**
 800  * Prevents the existing audio output (if any) from being recycled.
 801  */
 802 VLC_API void input_resource_ResetAout( input_resource_t * );
 803
 804 /** @} */
 805 #endif