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