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_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
 300  * the default value being 1. It represents the ratio of playback speed to
 301  * nominal speed (bigger is faster).
 302  *
 303  * Internally, the rate is stored as a value in the range
 304  * [INPUT_RATE_MIN, INPUT_RATE_MAX].
 305  * internal rate = INPUT_RATE_DEFAULT / rate variable
 306  */
 307
 308 /**
 309  * Default rate value
 310  */
 311 #define INPUT_RATE_DEFAULT  1000
 312 /**
 313  * Minimal rate value
 314  */
 315 #define INPUT_RATE_MIN        32            /* Up to 32/1 */
 316 /**
 317  * Maximal rate value
 318  */
 319 #define INPUT_RATE_MAX     32000            /* Up to 1/32 */
 320
 321 /**
 322  * Input events
 323  *
 324  * You can catch input event by adding a callback on the variable "intf-event".
 325  * This variable is an integer that will hold a input_event_type_e value.
 326  */
 327 typedef enum input_event_type_e
 328 {
 329     /* "state" has changed */
 330     INPUT_EVENT_STATE,
 331     /* b_dead is true */
 332     INPUT_EVENT_DEAD,
 333
 334     /* "rate" has changed */
 335     INPUT_EVENT_RATE,
 336
 337     /* "capabilities" has changed */
 338     INPUT_EVENT_CAPABILITIES,
 339
 340     /* At least one of "position" or "time" */
 341     INPUT_EVENT_POSITION,
 342
 343     /* "length" has changed */
 344     INPUT_EVENT_LENGTH,
 345
 346     /* A title has been added or removed or selected.
 347      * It implies that the chapter has changed (no chapter event is sent) */
 348     INPUT_EVENT_TITLE,
 349     /* A chapter has been added or removed or selected. */
 350     INPUT_EVENT_CHAPTER,
 351
 352     /* A program ("program") has been added or removed or selected,
 353      * or "program-scrambled" has changed.*/
 354     INPUT_EVENT_PROGRAM,
 355     /* A ES has been added or removed or selected */
 356     INPUT_EVENT_ES,
 357
 358     /* "record" has changed */
 359     INPUT_EVENT_RECORD,
 360
 361     /* input_item_t media has changed */
 362     INPUT_EVENT_ITEM_META,
 363     /* input_item_t info has changed */
 364     INPUT_EVENT_ITEM_INFO,
 365     /* input_item_t epg has changed */
 366     INPUT_EVENT_ITEM_EPG,
 367
 368     /* Input statistics have been updated */
 369     INPUT_EVENT_STATISTICS,
 370     /* At least one of "signal-quality" or "signal-strength" has changed */
 371     INPUT_EVENT_SIGNAL,
 372
 373     /* "audio-delay" has changed */
 374     INPUT_EVENT_AUDIO_DELAY,
 375     /* "spu-delay" has changed */
 376     INPUT_EVENT_SUBTITLE_DELAY,
 377
 378     /* "bookmark" has changed */
 379     INPUT_EVENT_BOOKMARK,
 380
 381     /* cache" has changed */
 382     INPUT_EVENT_CACHE,
 383
 384     /* A vout_thread_t object has been created/deleted by *the input* */
 385     INPUT_EVENT_VOUT,
 386
 387     /* (pre-)parsing events */
 388     INPUT_EVENT_SUBITEMS,
 389
 390     /* vbi_page has changed */
 391     INPUT_EVENT_VBI_PAGE,
 392     /* vbi_transparent has changed */
 393     INPUT_EVENT_VBI_TRANSPARENCY,
 394
 395     /* subs_fps has changed */
 396     INPUT_EVENT_SUBS_FPS,
 397
 398     /* Thumbnail generation */
 399     INPUT_EVENT_THUMBNAIL_READY,
 400 } input_event_type_e;
 401
 402 #define VLC_INPUT_CAPABILITIES_SEEKABLE (1<<0)
 403 #define VLC_INPUT_CAPABILITIES_PAUSEABLE (1<<1)
 404 #define VLC_INPUT_CAPABILITIES_CHANGE_RATE (1<<2)
 405 #define VLC_INPUT_CAPABILITIES_REWINDABLE (1<<3)
 406 #define VLC_INPUT_CAPABILITIES_RECORDABLE (1<<4)
 407
 408 struct vlc_input_event_position
 409 {
 410     float percentage;
 411     vlc_tick_t ms;
 412 };
 413
 414 struct vlc_input_event_title
 415 {
 416     enum {
 417         VLC_INPUT_TITLE_NEW_LIST,
 418         VLC_INPUT_TITLE_SELECTED,
 419     } action;
 420     union
 421     {
 422         struct
 423         {
 424             input_title_t *const *array;
 425             size_t count;
 426         } list;
 427         size_t selected_idx;
 428     };
 429 };
 430
 431 struct vlc_input_event_chapter
 432 {
 433     int title;
 434     int seekpoint;
 435 };
 436
 437 struct vlc_input_event_program {
 438     enum {
 439         VLC_INPUT_PROGRAM_ADDED,
 440         VLC_INPUT_PROGRAM_DELETED,
 441         VLC_INPUT_PROGRAM_UPDATED,
 442         VLC_INPUT_PROGRAM_SELECTED,
 443         VLC_INPUT_PROGRAM_SCRAMBLED,
 444     } action;
 445     int id;
 446     union {
 447         const char *title;
 448         bool scrambled;
 449     };
 450 };
 451
 452 struct vlc_input_event_es {
 453     enum {
 454         VLC_INPUT_ES_ADDED,
 455         VLC_INPUT_ES_DELETED,
 456         VLC_INPUT_ES_UPDATED,
 457         VLC_INPUT_ES_SELECTED,
 458         VLC_INPUT_ES_UNSELECTED,
 459     } action;
 460     /**
 461      * ES track id: only valid from the event callback, unless the id is held
 462      * by the user with vlc_es_Hold(). */
 463     vlc_es_id_t *id;
 464     /**
 465      * Title of ES track, can be updated after the VLC_INPUT_ES_UPDATED event.
 466      */
 467     const char *title;
 468     /**
 469      * ES track information, can be updated after the VLC_INPUT_ES_UPDATED event.
 470      */
 471     const es_format_t *fmt;
 472 };
 473
 474 struct vlc_input_event_signal {
 475     float quality;
 476     float strength;
 477 };
 478
 479 struct vlc_input_event_vout
 480 {
 481     enum {
 482         VLC_INPUT_EVENT_VOUT_ADDED,
 483         VLC_INPUT_EVENT_VOUT_DELETED,
 484     } action;
 485     vout_thread_t *vout;
 486 };
 487
 488 struct vlc_input_event
 489 {
 490     input_event_type_e type;
 491
 492     union {
 493         /* INPUT_EVENT_STATE */
 494         input_state_e state;
 495         /* INPUT_EVENT_RATE */
 496         float rate;
 497         /* INPUT_EVENT_CAPABILITIES */
 498         int capabilities; /**< cf. VLC_INPUT_CAPABILITIES_* bitwise flags */
 499         /* INPUT_EVENT_POSITION */
 500         struct vlc_input_event_position position;
 501         /* INPUT_EVENT_LENGTH */
 502         vlc_tick_t length;
 503         /* INPUT_EVENT_TITLE */
 504         struct vlc_input_event_title title;
 505         /* INPUT_EVENT_CHAPTER */
 506         struct vlc_input_event_chapter chapter;
 507         /* INPUT_EVENT_PROGRAM */
 508         struct vlc_input_event_program program;
 509         /* INPUT_EVENT_ES */
 510         struct vlc_input_event_es es;
 511         /* INPUT_EVENT_RECORD */
 512         bool record;
 513         /* INPUT_EVENT_STATISTICS */
 514         const struct input_stats_t *stats;
 515         /* INPUT_EVENT_SIGNAL */
 516         struct vlc_input_event_signal signal;
 517         /* INPUT_EVENT_AUDIO_DELAY */
 518         vlc_tick_t audio_delay;
 519         /* INPUT_EVENT_SUBTITLE_DELAY */
 520         vlc_tick_t subtitle_delay;
 521         /* INPUT_EVENT_CACHE */
 522         float cache;
 523         /* INPUT_EVENT_VOUT */
 524         struct vlc_input_event_vout vout;
 525         /* INPUT_EVENT_SUBITEMS */
 526         input_item_node_t *subitems;
 527         /* INPUT_EVENT_VBI_PAGE */
 528         unsigned vbi_page;
 529         /* INPUT_EVENT_VBI_TRANSPARENCY */
 530         bool vbi_transparent;
 531         /* INPUT_EVENT_SUBS_FPS */
 532         float subs_fps;
 533         /* INPUT_EVENT_THUMBNAIL_READY */
 534         picture_t *thumbnail;
 535     };
 536 };
 537
 538 typedef void (*input_thread_events_cb)( input_thread_t *input,
 539                                         const struct vlc_input_event *event,
 540                                         void *userdata);
 541
 542 /**
 543  * Input queries
 544  */
 545 enum input_query_e
 546 {
 547     /* Menu (VCD/DVD/BD) Navigation */
 548     /** Activate the navigation item selected. res=can fail */
 549     INPUT_NAV_ACTIVATE,
 550     /** Use the up arrow to select a navigation item above. res=can fail */
 551     INPUT_NAV_UP,
 552     /** Use the down arrow to select a navigation item under. res=can fail */
 553     INPUT_NAV_DOWN,
 554     /** Use the left arrow to select a navigation item on the left. res=can fail */
 555     INPUT_NAV_LEFT,
 556     /** Use the right arrow to select a navigation item on the right. res=can fail */
 557     INPUT_NAV_RIGHT,
 558     /** Activate the popup Menu (for BD). res=can fail */
 559     INPUT_NAV_POPUP,
 560     /** Activate disc Root Menu. res=can fail */
 561     INPUT_NAV_MENU,
 562
 563     /* bookmarks */
 564     INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
 565     INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
 566     INPUT_CLEAR_BOOKMARKS, /* res=can fail */
 567     INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 568     INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
 569     INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
 570     INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
 571
 572     /* titles */
 573     INPUT_GET_FULL_TITLE_INFO,     /* arg1=input_title_t*** arg2= int * res=can fail */
 574
 575     /* On the fly input slave */
 576     INPUT_ADD_SLAVE,       /* arg1= enum slave_type, arg2= const char *,
 577                             * arg3= bool forced, arg4= bool notify,
 578                             * arg5= bool check_extension */
 579
 580     /* ES */
 581     INPUT_RESTART_ES_BY_ID,/* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
 582
 583     /* Viewpoint */
 584     INPUT_UPDATE_VIEWPOINT, /* arg1=(const vlc_viewpoint_t*), arg2=bool b_absolute */
 585     INPUT_SET_INITIAL_VIEWPOINT, /* arg1=(const vlc_viewpoint_t*) */
 586
 587     /* Input ressources
 588      * XXX You must call vlc_object_release as soon as possible */
 589     INPUT_GET_AOUT,         /* arg1=audio_output_t **              res=can fail */
 590     INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
 591     INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
 592
 593     /* Renderers */
 594     INPUT_SET_RENDERER,     /* arg1=vlc_renderer_item_t* */
 595
 596     /* External clock managments */
 597     INPUT_GET_PCR_SYSTEM,   /* arg1=vlc_tick_t *, arg2=vlc_tick_t *       res=can fail */
 598     INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=vlc_tick_t   res=can fail */
 599 };
 600
 601 /** @}*/
 602
 603 /*****************************************************************************
 604  * Prototypes
 605  *****************************************************************************/
 606 VLC_API input_thread_t * input_Create( vlc_object_t *p_parent,
 607                                        input_thread_events_cb event_cb, void *events_data,
 608                                        input_item_t *, const char *psz_log, input_resource_t *,
 609                                        vlc_renderer_item_t* p_renderer ) VLC_USED;
 610 #define input_Create(a,b,c,d,e,f,g) input_Create(VLC_OBJECT(a),b,c,d,e,f,g)
 611
 612
 613 /**
 614  * Creates an item preparser.
 615  *
 616  * Creates an input thread to preparse an item. The input needs to be started
 617  * with input_Start() afterwards.
 618  *
 619  * @param obj parent object
 620  * @param item input item to preparse
 621  * @return an input thread or NULL on error
 622  */
 623 VLC_API input_thread_t *input_CreatePreparser(vlc_object_t *obj,
 624                                               input_thread_events_cb events_cb,
 625                                               void *events_data, input_item_t *item)
 626 VLC_USED;
 627
 628 VLC_API
 629 input_thread_t *input_CreateThumbnailer(vlc_object_t *obj,
 630                                         input_thread_events_cb events_cb,
 631                                         void *events_data, input_item_t *item)
 632 VLC_USED;
 633
 634 VLC_API int input_Start( input_thread_t * );
 635
 636 VLC_API void input_Stop( input_thread_t * );
 637
 638 VLC_API int input_Read( vlc_object_t *, input_item_t *,
 639                         input_thread_events_cb, void * );
 640 #define input_Read(a,b,c,d) input_Read(VLC_OBJECT(a),b,c,d)
 641
 642 VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
 643
 644 VLC_API int input_Control( input_thread_t *, int i_query, ...  );
 645
 646 VLC_API void input_Close( input_thread_t * );
 647
 648 VLC_API void input_SetTime( input_thread_t *, vlc_tick_t i_time, bool b_fast );
 649
 650 VLC_API void input_SetPosition( input_thread_t *, float f_position, bool b_fast );
 651
 652 VLC_API void input_LegacyEvents(input_thread_t *, const struct vlc_input_event *, void * );
 653 VLC_API void input_LegacyVarInit ( input_thread_t * );
 654
 655 /**
 656  * Get the input item for an input thread
 657  *
 658  * You have to keep a reference to the input or to the input_item_t until
 659  * you do not need it anymore.
 660  */
 661 VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
 662
 663 /**
 664  * Return one of the video output (if any). If possible, you should use
 665  * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
 666  * @param p_input an input thread from which to get a video output
 667  * @return NULL on error, or a video output thread pointer (which needs to be
 668  * released with vlc_object_release()).
 669  */
 670 static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
 671 {
 672      vout_thread_t **pp_vout, *p_vout;
 673      size_t i_vout;
 674
 675      if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
 676          return NULL;
 677
 678      for( size_t i = 1; i < i_vout; i++ )
 679          vlc_object_release( (vlc_object_t *)(pp_vout[i]) );
 680
 681      p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
 682      free( pp_vout );
 683      return p_vout;
 684 }
 685
 686 static inline int input_AddSlave( input_thread_t *p_input, enum slave_type type,
 687                                   const char *psz_uri, bool b_forced,
 688                                   bool b_notify, bool b_check_ext )
 689 {
 690     return input_Control( p_input, INPUT_ADD_SLAVE, type, psz_uri, b_forced,
 691                           b_notify, b_check_ext );
 692 }
 693
 694 /**
 695  * Update the viewpoint of the input thread. The viewpoint will be applied to
 696  * all vouts and aouts.
 697  *
 698  * @param p_input an input thread
 699  * @param p_viewpoint the viewpoint value
 700  * @param b_absolute if true replace the old viewpoint with the new one. If
 701  * false, increase/decrease it.
 702  * @return VLC_SUCCESS or a VLC error code
 703  */
 704 static inline int input_UpdateViewpoint( input_thread_t *p_input,
 705                                          const vlc_viewpoint_t *p_viewpoint,
 706                                          bool b_absolute )
 707 {
 708     return input_Control( p_input, INPUT_UPDATE_VIEWPOINT, p_viewpoint,
 709                           b_absolute );
 710 }
 711
 712 /**
 713  * Return the audio output (if any) associated with an input.
 714  * @param p_input an input thread
 715  * @return NULL on error, or the audio output (which needs to be
 716  * released with vlc_object_release()).
 717  */
 718 static inline audio_output_t *input_GetAout( input_thread_t *p_input )
 719 {
 720      audio_output_t *p_aout;
 721      return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
 722 }
 723
 724 /**
 725  * Returns the objects associated to an ES.
 726  *
 727  * You must release all non NULL object using vlc_object_release.
 728  * You may set pointer of pointer to NULL to avoid retreiving it.
 729  */
 730 static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
 731                                       vlc_object_t **pp_decoder,
 732                                       vout_thread_t **pp_vout, audio_output_t **pp_aout )
 733 {
 734     return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
 735                           pp_decoder, pp_vout, pp_aout );
 736 }
 737
 738 /**
 739  * \see input_clock_GetSystemOrigin
 740  */
 741 static inline int input_GetPcrSystem( input_thread_t *p_input, vlc_tick_t *pi_system, vlc_tick_t *pi_delay )
 742 {
 743     return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
 744 }
 745 /**
 746  * \see input_clock_ChangeSystemOrigin
 747  */
 748 static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, vlc_tick_t i_system )
 749 {
 750     return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
 751 }
 752
 753 /* */
 754 VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, const es_format_t *, input_resource_t * ) VLC_USED;
 755 VLC_API void input_DecoderDelete( decoder_t * );
 756 VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
 757 VLC_API void input_DecoderDrain( decoder_t * );
 758 VLC_API void input_DecoderFlush( decoder_t * );
 759 VLC_API int  input_DecoderSetSpuHighlight( decoder_t *, const vlc_spu_highlight_t * );
 760
 761 /**
 762  * This function creates a sane filename path.
 763  */
 764 VLC_API char * input_CreateFilename( input_thread_t *, input_item_t *,
 765                                      const char *psz_path, const char *psz_prefix,
 766                                      const char *psz_extension ) VLC_USED;
 767
 768 /**
 769  * It creates an empty input resource handler.
 770  *
 771  * The given object MUST stay alive as long as the input_resource_t is
 772  * not deleted.
 773  */
 774 VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
 775
 776 /**
 777  * It releases an input resource.
 778  */
 779 VLC_API void input_resource_Release( input_resource_t * );
 780
 781 /**
 782  * Forcefully destroys the video output (e.g. when the playlist is stopped).
 783  */
 784 VLC_API void input_resource_TerminateVout( input_resource_t * );
 785
 786 /**
 787  * This function releases all resources (object).
 788  */
 789 VLC_API void input_resource_Terminate( input_resource_t * );
 790
 791 /**
 792  * \return the current audio output if any.
 793  * Use vlc_object_release() to drop the reference.
 794  */
 795 VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * );
 796
 797 /**
 798  * This function creates or recycles an audio output.
 799  */
 800 VLC_API audio_output_t *input_resource_GetAout( input_resource_t * );
 801
 802 /**
 803  * This function retains or destroys an audio output.
 804  */
 805 VLC_API void input_resource_PutAout( input_resource_t *, audio_output_t * );
 806
 807 /**
 808  * Prevents the existing audio output (if any) from being recycled.
 809  */
 810 VLC_API void input_resource_ResetAout( input_resource_t * );
 811
 812 /** @} */
 813 #endif