vlc_input.h 22.3 KB
Newer Older
1
/*****************************************************************************
2
 * vlc_input.h: Core input structures
3
 *****************************************************************************
4
 * Copyright (C) 1999-2015 VLC authors and VideoLAN
5
 * $Id$
6 7 8 9
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
 *          Laurent Aimar <fenrir@via.ecp.fr>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13 14 15 16
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 24
 *****************************************************************************/

25 26
#ifndef VLC_INPUT_H
#define VLC_INPUT_H 1
27

28
/**
29 30 31
 * \defgroup input Input
 * Input thread
 * @{
32
 * \file
33
 * Input thread interface
34 35
 */

36
#include <vlc_es.h>
37
#include <vlc_meta.h>
Laurent Aimar's avatar
Laurent Aimar committed
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 48 49 50 51 52 53 54 55 56 57
/*****************************************************************************
 * Seek point: (generalisation of chapters)
 *****************************************************************************/
struct seekpoint_t
{
    int64_t i_time_offset;
    char    *psz_name;
};

static inline seekpoint_t *vlc_seekpoint_New( void )
{
    seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
58 59
    if( !point )
        return NULL;
60
    point->i_time_offset = -1;
61 62 63 64 65 66 67
    point->psz_name = NULL;
    return point;
}

static inline void vlc_seekpoint_Delete( seekpoint_t *point )
{
    if( !point ) return;
68
    free( point->psz_name );
69 70 71
    free( point );
}

72
static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
73 74
{
    seekpoint_t *point = vlc_seekpoint_New();
75 76 77 78 79
    if( likely(point) )
    {
        if( src->psz_name ) point->psz_name = strdup( src->psz_name );
        point->i_time_offset = src->i_time_offset;
    }
80 81 82 83 84 85
    return point;
}

/*****************************************************************************
 * Title:
 *****************************************************************************/
86 87

/* input_title_t.i_flags field */
88 89
#define INPUT_TITLE_MENU         0x01   /* Menu title */
#define INPUT_TITLE_INTERACTIVE  0x02   /* Interactive title. Playback position has no meaning. */
90

91
typedef struct input_title_t
92 93 94 95 96
{
    char        *psz_name;

    int64_t     i_length;   /* Length(microsecond) if known, else 0 */

97
    unsigned    i_flags;    /* Is it a menu or a normal entry */
98

99 100 101 102 103
    /* Title seekpoint */
    int         i_seekpoint;
    seekpoint_t **seekpoint;
} input_title_t;

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 108
    if( !t )
        return NULL;
109 110

    t->psz_name = NULL;
111
    t->i_flags = 0;
112 113 114 115 116 117
    t->i_length = 0;
    t->i_seekpoint = 0;
    t->seekpoint = NULL;

    return t;
}
118

119 120 121 122 123 124
static inline void vlc_input_title_Delete( input_title_t *t )
{
    int i;
    if( t == NULL )
        return;

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 130 131
    free( t );
}

Rémi Duraffort's avatar
Rémi Duraffort committed
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 136
    if( dup == NULL) return NULL;

137
    if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
138
    dup->i_flags     = t->i_flags;
139 140 141
    dup->i_length    = t->i_length;
    if( t->i_seekpoint > 0 )
    {
142 143
        dup->seekpoint = (seekpoint_t**)malloc( t->i_seekpoint * sizeof(seekpoint_t*) );
        if( likely(dup->seekpoint) )
144
        {
145
            for( int i = 0; i < t->i_seekpoint; i++ )
146 147
                dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
            dup->i_seekpoint = t->i_seekpoint;
148 149 150 151 152
        }
    }

    return dup;
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
153

154 155 156 157 158 159 160 161
/*****************************************************************************
 * Attachments
 *****************************************************************************/
struct input_attachment_t
{
    char *psz_name;
    char *psz_mime;
    char *psz_description;
162

163
    size_t i_data;
164 165
    void *p_data;
};
Jean-Paul Saman's avatar
Jean-Paul Saman committed
166

167 168 169 170 171 172 173 174 175 176 177 178
static inline void vlc_input_attachment_Delete( input_attachment_t *a )
{
    if( !a )
        return;

    free( a->p_data );
    free( a->psz_description );
    free( a->psz_mime );
    free( a->psz_name );
    free( a );
}

179 180 181 182
static inline input_attachment_t *vlc_input_attachment_New( const char *psz_name,
                                                            const char *psz_mime,
                                                            const char *psz_description,
                                                            const void *p_data,
183
                                                            size_t i_data )
184
{
185 186
    input_attachment_t *a = (input_attachment_t *)malloc( sizeof (*a) );
    if( unlikely(a == NULL) )
187
        return NULL;
188

189 190 191 192
    a->psz_name = strdup( psz_name ? psz_name : "" );
    a->psz_mime = strdup( psz_mime ? psz_mime : "" );
    a->psz_description = strdup( psz_description ? psz_description : "" );
    a->i_data = i_data;
193
    a->p_data = malloc( i_data );
Zhao Zhili's avatar
Zhao Zhili committed
194
    if( i_data > 0 && likely(a->p_data != NULL) )
195 196 197
        memcpy( a->p_data, p_data, i_data );

    if( unlikely(a->psz_name == NULL || a->psz_mime == NULL
198
              || a->psz_description == NULL || (i_data > 0 && a->p_data == NULL)) )
199
    {
200 201
        vlc_input_attachment_Delete( a );
        a = NULL;
202 203 204
    }
    return a;
}
205

206 207 208 209 210
static inline input_attachment_t *vlc_input_attachment_Duplicate( const input_attachment_t *a )
{
    return vlc_input_attachment_New( a->psz_name, a->psz_mime, a->psz_description,
                                     a->p_data, a->i_data );
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
211

212 213 214 215
/*****************************************************************************
 * input defines/constants.
 *****************************************************************************/

216 217 218 219 220
/**
 * This defines an opaque input resource handler.
 */
typedef struct input_resource_t input_resource_t;

Clément Stenac's avatar
Clément Stenac committed
221 222
/**
 * Main structure representing an input thread. This structure is mostly
223
 * private. The only public fields are read-only and constant.
Clément Stenac's avatar
Clément Stenac committed
224
 */
225 226
struct input_thread_t
{
227
    VLC_COMMON_MEMBERS
228 229
};

230 231 232 233
/**
 * Record prefix string.
 * TODO make it configurable.
 */
234
#define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
235

Laurent Aimar's avatar
Laurent Aimar committed
236 237 238 239 240 241 242 243 244 245 246 247
/*****************************************************************************
 * Input events and variables
 *****************************************************************************/

/**
 * \defgroup inputvariable Input variables
 *
 * The input provides multiples variable you can write to and/or read from.
 *
 * TODO complete the documentation.
 * The read only variables are:
 *  - "length"
248
 *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
Laurent Aimar's avatar
Laurent Aimar committed
249 250
 *    or not, for that check position != 0.0)
 *  - "can-pause"
251
 *  - "can-rate"
Laurent Aimar's avatar
Laurent Aimar committed
252 253
 *  - "can-rewind"
 *  - "can-record" (if a stream can be recorded while playing)
254 255
 *  - "teletext-es" (list of id from the spu tracks (spu-es) that are teletext, the
 *                   variable value being the one currently selected, -1 if no teletext)
256 257
 *  - "signal-quality"
 *  - "signal-strength"
258
 *  - "program-scrambled" (if the current program is scrambled)
259
 *  - "cache" (level of data cached [0 .. 1])
Laurent Aimar's avatar
Laurent Aimar committed
260 261 262
 *
 * The read-write variables are:
 *  - state (\see input_state_e)
263
 *  - rate
264
 *  - position
Laurent Aimar's avatar
Laurent Aimar committed
265
 *  - time, time-offset
266 267
 *  - title, next-title, prev-title
 *  - chapter, next-chapter, next-chapter-prev
Laurent Aimar's avatar
Laurent Aimar committed
268 269
 *  - program, audio-es, video-es, spu-es
 *  - audio-delay, spu-delay
270
 *  - bookmark (bookmark list)
271 272 273 274
 *  - record
 *  - frame-next
 *  - navigation (list of "title %2i")
 *  - "title %2i"
Laurent Aimar's avatar
Laurent Aimar committed
275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
 *
 * The variable used for event is
 *  - intf-event (\see input_event_type_e)
 */

/**
 * Input state
 *
 * This enum is used by the variable "state"
 */
typedef enum input_state_e
{
    INIT_S = 0,
    OPENING_S,
    PLAYING_S,
    PAUSE_S,
    END_S,
    ERROR_S,
} input_state_e;

/**
 * Input rate.
 *
298
 * It is an float used by the variable "rate" in the
Frédéric Yhuel's avatar
Frédéric Yhuel committed
299
 * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
300 301
 * the default value being 1. It represents the ratio of playback speed to
 * nominal speed (bigger is faster).
Laurent Aimar's avatar
Laurent Aimar committed
302
 *
303 304 305
 * Internally, the rate is stored as a value in the range
 * [INPUT_RATE_MIN, INPUT_RATE_MAX].
 * internal rate = INPUT_RATE_DEFAULT / rate variable
Laurent Aimar's avatar
Laurent Aimar committed
306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330
 */

/**
 * Default rate value
 */
#define INPUT_RATE_DEFAULT  1000
/**
 * Minimal rate value
 */
#define INPUT_RATE_MIN        32            /* Up to 32/1 */
/**
 * Maximal rate value
 */
#define INPUT_RATE_MAX     32000            /* Up to 1/32 */

/**
 * Input events
 *
 * You can catch input event by adding a callback on the variable "intf-event".
 * This variable is an integer that will hold a input_event_type_e value.
 */
typedef enum input_event_type_e
{
    /* "state" has changed */
    INPUT_EVENT_STATE,
331 332 333
    /* b_dead is true */
    INPUT_EVENT_DEAD,

Laurent Aimar's avatar
Laurent Aimar committed
334 335
    /* "rate" has changed */
    INPUT_EVENT_RATE,
336

337 338 339 340 341
    /* At least one of "position" or "time" */
    INPUT_EVENT_POSITION,

    /* "length" has changed */
    INPUT_EVENT_LENGTH,
Laurent Aimar's avatar
Laurent Aimar committed
342 343

    /* A title has been added or removed or selected.
Felix Paul Kühne's avatar
Felix Paul Kühne committed
344
     * It implies that the chapter has changed (no chapter event is sent) */
Laurent Aimar's avatar
Laurent Aimar committed
345 346 347 348
    INPUT_EVENT_TITLE,
    /* A chapter has been added or removed or selected. */
    INPUT_EVENT_CHAPTER,

349 350
    /* A program ("program") has been added or removed or selected,
     * or "program-scrambled" has changed.*/
Laurent Aimar's avatar
Laurent Aimar committed
351 352 353
    INPUT_EVENT_PROGRAM,
    /* A ES has been added or removed or selected */
    INPUT_EVENT_ES,
Laurent Aimar's avatar
Laurent Aimar committed
354 355
    /* "teletext-es" has changed */
    INPUT_EVENT_TELETEXT,
Laurent Aimar's avatar
Laurent Aimar committed
356 357 358 359 360 361 362 363

    /* "record" has changed */
    INPUT_EVENT_RECORD,

    /* input_item_t media has changed */
    INPUT_EVENT_ITEM_META,
    /* input_item_t info has changed */
    INPUT_EVENT_ITEM_INFO,
364 365
    /* input_item_t epg has changed */
    INPUT_EVENT_ITEM_EPG,
Laurent Aimar's avatar
Laurent Aimar committed
366 367 368 369 370 371 372 373 374 375 376

    /* Input statistics have been updated */
    INPUT_EVENT_STATISTICS,
    /* At least one of "signal-quality" or "signal-strength" has changed */
    INPUT_EVENT_SIGNAL,

    /* "audio-delay" has changed */
    INPUT_EVENT_AUDIO_DELAY,
    /* "spu-delay" has changed */
    INPUT_EVENT_SUBTITLE_DELAY,

377 378 379
    /* "bookmark" has changed */
    INPUT_EVENT_BOOKMARK,

380 381 382
    /* cache" has changed */
    INPUT_EVENT_CACHE,

383
    /* A audio_output_t object has been created/deleted by *the input* */
384 385 386 387
    INPUT_EVENT_AOUT,
    /* A vout_thread_t object has been created/deleted by *the input* */
    INPUT_EVENT_VOUT,

Laurent Aimar's avatar
Laurent Aimar committed
388 389
} input_event_type_e;

390
/**
391
 * Input queries
392
 */
393 394 395 396 397 398 399 400 401 402 403 404 405
enum input_query_e
{
    /* input variable "position" */
    INPUT_GET_POSITION,         /* arg1= double *       res=    */
    INPUT_SET_POSITION,         /* arg1= double         res=can fail    */

    /* input variable "length" */
    INPUT_GET_LENGTH,           /* arg1= int64_t *      res=can fail    */

    /* input variable "time" */
    INPUT_GET_TIME,             /* arg1= int64_t *      res=    */
    INPUT_SET_TIME,             /* arg1= int64_t        res=can fail    */

406
    /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
407 408 409 410 411 412 413
    INPUT_GET_RATE,             /* arg1= int *          res=    */
    INPUT_SET_RATE,             /* arg1= int            res=can fail    */

    /* input variable "state" */
    INPUT_GET_STATE,            /* arg1= int *          res=    */
    INPUT_SET_STATE,            /* arg1= int            res=can fail    */

414
    /* input variable "audio-delay" and "sub-delay" */
415 416 417 418 419
    INPUT_GET_AUDIO_DELAY,      /* arg1 = int* res=can fail */
    INPUT_SET_AUDIO_DELAY,      /* arg1 = int  res=can fail */
    INPUT_GET_SPU_DELAY,        /* arg1 = int* res=can fail */
    INPUT_SET_SPU_DELAY,        /* arg1 = int  res=can fail */

420 421
    /* Menu (VCD/DVD/BD) Navigation */
    /** Activate the navigation item selected. res=can fail */
422
    INPUT_NAV_ACTIVATE,
423
    /** Use the up arrow to select a navigation item above. res=can fail */
424
    INPUT_NAV_UP,
425
    /** Use the down arrow to select a navigation item under. res=can fail */
426
    INPUT_NAV_DOWN,
427
    /** Use the left arrow to select a navigation item on the left. res=can fail */
428
    INPUT_NAV_LEFT,
429
    /** Use the right arrow to select a navigation item on the right. res=can fail */
430
    INPUT_NAV_RIGHT,
431
    /** Activate the popup Menu (for BD). res=can fail */
432
    INPUT_NAV_POPUP,
433 434
    /** Activate disc Root Menu. res=can fail */
    INPUT_NAV_MENU,
435

436
    /* Meta datas */
437
    INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
438 439
    INPUT_REPLACE_INFOS,/* arg1= info_category_t *            res=cannot fail */
    INPUT_MERGE_INFOS,/* arg1= info_category_t *              res=cannot fail */
440
    INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
441

442
    /* bookmarks */
443
    INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
444 445 446 447 448 449
    INPUT_GET_BOOKMARKS,   /* arg1= seekpoint_t *** arg2= int * res=can fail */
    INPUT_CLEAR_BOOKMARKS, /* res=can fail */
    INPUT_ADD_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
    INPUT_CHANGE_BOOKMARK, /* arg1= seekpoint_t * arg2= int * res=can fail   */
    INPUT_DEL_BOOKMARK,    /* arg1= seekpoint_t *  res=can fail   */
    INPUT_SET_BOOKMARK,    /* arg1= int  res=can fail    */
450

451 452
    /* titles */
    INPUT_GET_TITLE_INFO,     /* arg1=input_title_t** arg2= int * res=can fail */
453
    INPUT_GET_FULL_TITLE_INFO,     /* arg1=input_title_t*** arg2= int * res=can fail */
454

455 456 457
    /* seekpoints */
    INPUT_GET_SEEKPOINTS,  /* arg1=seekpoint_t*** arg2= int * res=can fail */

458 459 460 461
    /* Attachments */
    INPUT_GET_ATTACHMENTS, /* arg1=input_attachment_t***, arg2=int*  res=can fail */
    INPUT_GET_ATTACHMENT,  /* arg1=input_attachment_t**, arg2=char*  res=can fail */

462
    /* On the fly input slave */
463
    INPUT_ADD_SLAVE,       /* arg1= enum slave_type, arg2= const char *, arg3= bool */
464
    INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
465 466 467 468

    /* On the fly record while playing */
    INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
    INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
469 470 471

    /* ES */
    INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
472

473 474
    /* Viewpoint */
    INPUT_UPDATE_VIEWPOINT, /* arg1=(const vlc_viewpoint_t*), arg2=bool b_absolute */
475
    INPUT_SET_INITIAL_VIEWPOINT, /* arg1=(const vlc_viewpoint_t*) */
476

477 478
    /* Input ressources
     * XXX You must call vlc_object_release as soon as possible */
479
    INPUT_GET_AOUT,         /* arg1=audio_output_t **              res=can fail */
480
    INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
481
    INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
482 483

    /* External clock managments */
484
    INPUT_GET_PCR_SYSTEM,   /* arg1=mtime_t *, arg2=mtime_t *       res=can fail */
485
    INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t      res=can fail */
486 487
};

488 489 490 491 492 493
/** @}*/

/*****************************************************************************
 * Prototypes
 *****************************************************************************/

494
VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED;
495
#define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
496

497
VLC_API int input_Start( input_thread_t * );
498

499
VLC_API void input_Stop( input_thread_t * );
500

501
VLC_API int input_Read( vlc_object_t *, input_item_t * );
502
#define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
503

504
VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
505

506
VLC_API int input_Control( input_thread_t *, int i_query, ...  );
507

508
VLC_API void input_Close( input_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
509

510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530
/**
 * Create a new input_thread_t and start it.
 *
 * Provided for convenience.
 *
 * \see input_Create
 */
static inline
input_thread_t *input_CreateAndStart( vlc_object_t *parent,
                                      input_item_t *item, const char *log )
{
    input_thread_t *input = input_Create( parent, item, log, NULL );
    if( input != NULL && input_Start( input ) )
    {
        vlc_object_release( input );
        input = NULL;
    }
    return input;
}
#define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)

531 532 533 534 535 536
/**
 * Get the input item for an input thread
 *
 * You have to keep a reference to the input or to the input_item_t until
 * you do not need it anymore.
 */
537
VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
538

539 540 541 542
/**
 * It will return the current state of the input.
 * Provided for convenience.
 */
543 544 545 546 547 548
static inline input_state_e input_GetState( input_thread_t * p_input )
{
    input_state_e state = INIT_S;
    input_Control( p_input, INPUT_GET_STATE, &state );
    return state;
}
549

550 551 552 553 554 555 556 557 558 559
/**
 * Return one of the video output (if any). If possible, you should use
 * INPUT_GET_VOUTS directly and process _all_ video outputs instead.
 * @param p_input an input thread from which to get a video output
 * @return NULL on error, or a video output thread pointer (which needs to be
 * released with vlc_object_release()).
 */
static inline vout_thread_t *input_GetVout( input_thread_t *p_input )
{
     vout_thread_t **pp_vout, *p_vout;
560
     size_t i_vout;
561 562 563 564

     if( input_Control( p_input, INPUT_GET_VOUTS, &pp_vout, &i_vout ) )
         return NULL;

565
     for( size_t i = 1; i < i_vout; i++ )
566 567 568
         vlc_object_release( (vlc_object_t *)(pp_vout[i]) );

     p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
569
     free( pp_vout );
570 571 572
     return p_vout;
}

573 574 575 576
/**
 * It will add a new subtitle source to the input.
 * Provided for convenience.
 */
577
static inline int input_AddSubtitleOSD( input_thread_t *p_input, const char *psz_path,
578 579
        bool b_check_extension, bool b_osd )
{
580
    int i_result = input_Control( p_input, INPUT_ADD_SUBTITLE, psz_path, b_check_extension );
581 582 583 584 585 586
    if( i_result != VLC_SUCCESS || !b_osd )
        return i_result;

    vout_thread_t *p_vout = input_GetVout( p_input );
    if( p_vout )
    {
587
        vout_OSDMessage(p_vout, VOUT_SPU_CHANNEL_OSD, "%s",
588
                        vlc_gettext("Subtitle track added") );
589 590 591 592 593 594
        vlc_object_release( (vlc_object_t *)p_vout );
    }
    return i_result;
}
#define input_AddSubtitle(a, b, c) input_AddSubtitleOSD(a, b, c, false)

Thomas Guillem's avatar
Thomas Guillem committed
595
static inline int input_AddSlave( input_thread_t *p_input, enum slave_type type,
596
                                  const char *psz_uri, bool b_forced )
Thomas Guillem's avatar
Thomas Guillem committed
597
{
598
    return input_Control( p_input, INPUT_ADD_SLAVE, type, psz_uri, b_forced );
Thomas Guillem's avatar
Thomas Guillem committed
599 600
}

601 602 603 604
/**
 * Update the viewpoint of the input thread. The viewpoint will be applied to
 * all vouts and aouts.
 *
605
 * @param p_input an input thread
606 607 608 609 610 611 612 613 614 615 616 617
 * @param p_viewpoint the viewpoint value
 * @param b_absolute if true replace the old viewpoint with the new one. If
 * false, increase/decrease it.
 * @return VLC_SUCCESS or a VLC error code
 */
static inline int input_UpdateViewpoint( input_thread_t *p_input,
                                         const vlc_viewpoint_t *p_viewpoint,
                                         bool b_absolute )
{
    return input_Control( p_input, INPUT_UPDATE_VIEWPOINT, p_viewpoint,
                          b_absolute );
}
618

619 620 621 622 623 624
/**
 * Return the audio output (if any) associated with an input.
 * @param p_input an input thread
 * @return NULL on error, or the audio output (which needs to be
 * released with vlc_object_release()).
 */
625
static inline audio_output_t *input_GetAout( input_thread_t *p_input )
626
{
627
     audio_output_t *p_aout;
628
     return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
629 630
}

631 632 633 634 635 636 637 638
/**
 * Returns the objects associated to an ES.
 *
 * You must release all non NULL object using vlc_object_release.
 * You may set pointer of pointer to NULL to avoid retreiving it.
 */
static inline int input_GetEsObjects( input_thread_t *p_input, int i_id,
                                      vlc_object_t **pp_decoder,
639
                                      vout_thread_t **pp_vout, audio_output_t **pp_aout )
640 641 642 643 644
{
    return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
                          pp_decoder, pp_vout, pp_aout );
}

645 646 647
/**
 * \see input_clock_GetSystemOrigin
 */
648
static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
649
{
650
    return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
651 652 653 654 655 656 657 658 659
}
/**
 * \see input_clock_ChangeSystemOrigin
 */
static inline int input_ModifyPcrSystem( input_thread_t *p_input, bool b_absolute, mtime_t i_system )
{
    return input_Control( p_input, INPUT_MODIFY_PCR_SYSTEM, b_absolute, i_system );
}

660
/* */
661
VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, const es_format_t *, input_resource_t * ) VLC_USED;
662 663
VLC_API void input_DecoderDelete( decoder_t * );
VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
664
VLC_API void input_DecoderDrain( decoder_t * );
665
VLC_API void input_DecoderFlush( decoder_t * );
666

667 668 669
/**
 * This function creates a sane filename path.
 */
670
VLC_API char * input_CreateFilename( input_thread_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED;
671

672
/**
673
 * It creates an empty input resource handler.
674
 *
675 676
 * The given object MUST stay alive as long as the input_resource_t is
 * not deleted.
677
 */
678
VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
679 680

/**
681
 * It releases an input resource.
682
 */
683
VLC_API void input_resource_Release( input_resource_t * );
684

685 686 687
/**
 * Forcefully destroys the video output (e.g. when the playlist is stopped).
 */
688
VLC_API void input_resource_TerminateVout( input_resource_t * );
689

690 691 692
/**
 * This function releases all resources (object).
 */
693
VLC_API void input_resource_Terminate( input_resource_t * );
694

695 696 697 698 699 700
/**
 * \return the current audio output if any.
 * Use vlc_object_release() to drop the reference.
 */
VLC_API audio_output_t *input_resource_HoldAout( input_resource_t * );

701 702 703 704 705 706 707 708 709 710
/**
 * This function creates or recycles an audio output.
 */
VLC_API audio_output_t *input_resource_GetAout( input_resource_t * );

/**
 * This function retains or destroys an audio output.
 */
VLC_API void input_resource_PutAout( input_resource_t *, audio_output_t * );

711 712 713 714 715
/**
 * Prevents the existing audio output (if any) from being recycled.
 */
VLC_API void input_resource_ResetAout( input_resource_t * );

716
/** @} */
717
#endif