vlc_input.h 20 KB
Newer Older
Laurent Aimar's avatar
Laurent Aimar committed
1
/*****************************************************************************
2
 * vlc_input.h: Core input structures
Laurent Aimar's avatar
Laurent Aimar committed
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2006 VLC authors and VideoLAN
5
 * $Id$
Laurent Aimar's avatar
Laurent Aimar committed
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
Laurent Aimar's avatar
Laurent Aimar committed
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.
Laurent Aimar's avatar
Laurent Aimar committed
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.
Laurent Aimar's avatar
Laurent Aimar committed
23 24 25
 *****************************************************************************/

/* __ is need because conflict with <vlc/input.h> */
26 27
#ifndef VLC_INPUT_H
#define VLC_INPUT_H 1
Laurent Aimar's avatar
Laurent Aimar committed
28

29 30 31 32 33
/**
 * \file
 * This file defines functions, structures and enums for input objects in vlc
 */

34
#include <vlc_es.h>
35
#include <vlc_meta.h>
Laurent Aimar's avatar
Laurent Aimar committed
36
#include <vlc_epg.h>
37
#include <vlc_events.h>
38
#include <vlc_input_item.h>
39

40
#include <string.h>
41

Laurent Aimar's avatar
Laurent Aimar committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55
/*****************************************************************************
 * Seek point: (generalisation of chapters)
 *****************************************************************************/
struct seekpoint_t
{
    int64_t i_byte_offset;
    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 ) );
    point->i_byte_offset =
56
    point->i_time_offset = -1;
Laurent Aimar's avatar
Laurent Aimar committed
57 58 59 60 61 62 63
    point->psz_name = NULL;
    return point;
}

static inline void vlc_seekpoint_Delete( seekpoint_t *point )
{
    if( !point ) return;
64
    free( point->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
65 66 67
    free( point );
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
68
static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
Laurent Aimar's avatar
Laurent Aimar committed
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83
{
    seekpoint_t *point = vlc_seekpoint_New();
    if( src->psz_name ) point->psz_name = strdup( src->psz_name );
    point->i_time_offset = src->i_time_offset;
    point->i_byte_offset = src->i_byte_offset;
    return point;
}

/*****************************************************************************
 * Title:
 *****************************************************************************/
typedef struct
{
    char        *psz_name;

Jean-Paul Saman's avatar
Jean-Paul Saman committed
84
    bool        b_menu;      /* Is it a menu or a normal entry */
Laurent Aimar's avatar
Laurent Aimar committed
85 86 87 88 89 90 91 92 93 94

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

    /* Title seekpoint */
    int         i_seekpoint;
    seekpoint_t **seekpoint;

} input_title_t;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
95
static inline input_title_t *vlc_input_title_New(void)
Laurent Aimar's avatar
Laurent Aimar committed
96 97 98 99
{
    input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );

    t->psz_name = NULL;
100
    t->b_menu = false;
Laurent Aimar's avatar
Laurent Aimar committed
101 102 103 104 105 106 107
    t->i_length = 0;
    t->i_size   = 0;
    t->i_seekpoint = 0;
    t->seekpoint = NULL;

    return t;
}
108

Laurent Aimar's avatar
Laurent Aimar committed
109 110 111 112 113 114
static inline void vlc_input_title_Delete( input_title_t *t )
{
    int i;
    if( t == NULL )
        return;

115
    free( t->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
116 117
    for( i = 0; i < t->i_seekpoint; i++ )
    {
118
        free( t->seekpoint[i]->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
119 120
        free( t->seekpoint[i] );
    }
121
    free( t->seekpoint );
Laurent Aimar's avatar
Laurent Aimar committed
122 123 124
    free( t );
}

Rémi Duraffort's avatar
Rémi Duraffort committed
125
static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t )
Laurent Aimar's avatar
Laurent Aimar committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
{
    input_title_t *dup = vlc_input_title_New( );
    int i;

    if( t->psz_name ) dup->psz_name = strdup( t->psz_name );
    dup->b_menu      = t->b_menu;
    dup->i_length    = t->i_length;
    dup->i_size      = t->i_size;
    dup->i_seekpoint = t->i_seekpoint;
    if( t->i_seekpoint > 0 )
    {
        dup->seekpoint = (seekpoint_t**)calloc( t->i_seekpoint,
                                                sizeof(seekpoint_t*) );

        for( i = 0; i < t->i_seekpoint; i++ )
        {
            dup->seekpoint[i] = vlc_seekpoint_Duplicate( t->seekpoint[i] );
        }
    }

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

149 150 151 152 153 154 155 156
/*****************************************************************************
 * Attachments
 *****************************************************************************/
struct input_attachment_t
{
    char *psz_name;
    char *psz_mime;
    char *psz_description;
Laurent Aimar's avatar
Laurent Aimar committed
157

158 159 160
    int  i_data;
    void *p_data;
};
Jean-Paul Saman's avatar
Jean-Paul Saman committed
161

162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
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,
                                                            int i_data )
{
    input_attachment_t *a =
        (input_attachment_t*)malloc( sizeof(input_attachment_t) );
    if( !a )
        return NULL;
    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;
    a->p_data = NULL;
    if( i_data > 0 )
    {
        a->p_data = malloc( i_data );
        if( a->p_data && p_data )
            memcpy( a->p_data, p_data, i_data );
    }
    return a;
}
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 );
}
static inline void vlc_input_attachment_Delete( input_attachment_t *a )
{
    if( !a )
        return;
    free( a->psz_name );
    free( a->psz_mime );
    free( a->psz_description );
197
    free( a->p_data );
198 199
    free( a );
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
200

Laurent Aimar's avatar
Laurent Aimar committed
201 202 203 204 205 206 207
/*****************************************************************************
 * input defines/constants.
 *****************************************************************************/

/* i_update field of access_t/demux_t */
#define INPUT_UPDATE_TITLE      0x0010
#define INPUT_UPDATE_SEEKPOINT  0x0020
208
#define INPUT_UPDATE_META       0x0040
209
#define INPUT_UPDATE_TITLE_LIST 0x0100
Laurent Aimar's avatar
Laurent Aimar committed
210

211 212
/**
 * This defines private core storage for an input.
213
 */
Clément Stenac's avatar
Clément Stenac committed
214 215
typedef struct input_thread_private_t input_thread_private_t;

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 223 224 225
/**
 * Main structure representing an input thread. This structure is mostly
 * private. The only public fields are READ-ONLY. You must use the helpers
 * to modify them
 */
Laurent Aimar's avatar
Laurent Aimar committed
226 227
struct input_thread_t
{
228
    VLC_COMMON_MEMBERS
Laurent Aimar's avatar
Laurent Aimar committed
229

230
    bool b_error;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
231
    bool b_eof;
232
    bool b_preparsing;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
233
    bool b_dead;
234

Clément Stenac's avatar
Clément Stenac committed
235 236 237
    /* All other data is input_thread is PRIVATE. You can't access it
     * outside of src/input */
    input_thread_private_t *p;
Laurent Aimar's avatar
Laurent Aimar committed
238 239
};

240 241 242 243
/**
 * Record prefix string.
 * TODO make it configurable.
 */
244
#define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
245

Laurent Aimar's avatar
Laurent Aimar committed
246 247 248 249 250 251 252 253 254 255 256 257
/*****************************************************************************
 * 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"
258
 *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
Laurent Aimar's avatar
Laurent Aimar committed
259 260
 *    or not, for that check position != 0.0)
 *  - "can-pause"
261
 *  - "can-rate"
Laurent Aimar's avatar
Laurent Aimar committed
262 263
 *  - "can-rewind"
 *  - "can-record" (if a stream can be recorded while playing)
264 265
 *  - "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)
266 267
 *  - "signal-quality"
 *  - "signal-strength"
268
 *  - "program-scrambled" (if the current program is scrambled)
269
 *  - "cache" (level of data cached [0 .. 1])
Laurent Aimar's avatar
Laurent Aimar committed
270 271 272
 *
 * The read-write variables are:
 *  - state (\see input_state_e)
273
 *  - rate
Laurent Aimar's avatar
Laurent Aimar committed
274 275
 *  - position, position-offset
 *  - time, time-offset
276 277
 *  - title, next-title, prev-title
 *  - chapter, next-chapter, next-chapter-prev
Laurent Aimar's avatar
Laurent Aimar committed
278 279
 *  - program, audio-es, video-es, spu-es
 *  - audio-delay, spu-delay
280
 *  - bookmark (bookmark list)
281 282 283 284
 *  - record
 *  - frame-next
 *  - navigation (list of "title %2i")
 *  - "title %2i"
Laurent Aimar's avatar
Laurent Aimar committed
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
 *
 * 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.
 *
308
 * It is an float used by the variable "rate" in the
Frédéric Yhuel's avatar
Frédéric Yhuel committed
309
 * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
310 311
 * 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
312
 *
313 314 315
 * 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
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340
 */

/**
 * 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,
Laurent Aimar's avatar
Laurent Aimar committed
341 342
    /* b_dead is true */
    INPUT_EVENT_DEAD,
343 344
    /* a *user* abort has been requested */
    INPUT_EVENT_ABORT,
Laurent Aimar's avatar
Laurent Aimar committed
345

Laurent Aimar's avatar
Laurent Aimar committed
346 347
    /* "rate" has changed */
    INPUT_EVENT_RATE,
Laurent Aimar's avatar
Laurent Aimar committed
348

349 350 351 352 353
    /* At least one of "position" or "time" */
    INPUT_EVENT_POSITION,

    /* "length" has changed */
    INPUT_EVENT_LENGTH,
Laurent Aimar's avatar
Laurent Aimar committed
354 355 356 357 358 359 360

    /* A title has been added or removed or selected.
     * It imply that chapter has changed (not chapter event is sent) */
    INPUT_EVENT_TITLE,
    /* A chapter has been added or removed or selected. */
    INPUT_EVENT_CHAPTER,

361 362
    /* A program ("program") has been added or removed or selected,
     * or "program-scrambled" has changed.*/
Laurent Aimar's avatar
Laurent Aimar committed
363 364 365
    INPUT_EVENT_PROGRAM,
    /* A ES has been added or removed or selected */
    INPUT_EVENT_ES,
Laurent Aimar's avatar
Laurent Aimar committed
366 367
    /* "teletext-es" has changed */
    INPUT_EVENT_TELETEXT,
Laurent Aimar's avatar
Laurent Aimar committed
368 369 370 371 372 373 374 375 376 377

    /* "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,
    /* input_item_t name has changed */
    INPUT_EVENT_ITEM_NAME,
378 379
    /* input_item_t epg has changed */
    INPUT_EVENT_ITEM_EPG,
Laurent Aimar's avatar
Laurent Aimar committed
380 381 382 383 384 385 386 387 388 389 390

    /* 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,

391 392 393
    /* "bookmark" has changed */
    INPUT_EVENT_BOOKMARK,

394 395 396
    /* cache" has changed */
    INPUT_EVENT_CACHE,

397
    /* A audio_output_t object has been created/deleted by *the input* */
398 399 400 401
    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
402 403
} input_event_type_e;

404
/**
405
 * Input queries
406
 */
Laurent Aimar's avatar
Laurent Aimar committed
407 408 409 410 411 412 413 414 415 416 417 418 419
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    */

420
    /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
Laurent Aimar's avatar
Laurent Aimar committed
421 422 423 424 425 426 427
    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    */

428
    /* input variable "audio-delay" and "sub-delay" */
429 430 431 432 433
    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 */

434 435 436 437 438 439 440
    /* Menu navigation */
    INPUT_NAV_ACTIVATE,
    INPUT_NAV_UP,
    INPUT_NAV_DOWN,
    INPUT_NAV_LEFT,
    INPUT_NAV_RIGHT,

441
    /* Meta datas */
442
    INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
443 444
    INPUT_REPLACE_INFOS,/* arg1= info_category_t *            res=cannot fail */
    INPUT_MERGE_INFOS,/* arg1= info_category_t *              res=cannot fail */
445 446 447
    INPUT_GET_INFO,   /* arg1= char* arg2= char* arg3= char** res=can fail */
    INPUT_DEL_INFO,   /* arg1= char* arg2= char*              res=can fail */
    INPUT_SET_NAME,   /* arg1= char* res=can fail    */
448

449
    /* Input properties */
450
    INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
451

Laurent Aimar's avatar
Laurent Aimar committed
452
    /* bookmarks */
453
    INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
Laurent Aimar's avatar
Laurent Aimar committed
454 455 456 457 458 459
    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    */
460

461 462 463
    /* titles */
    INPUT_GET_TITLE_INFO,     /* arg1=input_title_t** arg2= int * res=can fail */

464 465 466 467
    /* 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 */

468
    /* On the fly input slave */
469 470
    INPUT_ADD_SLAVE,       /* arg1= const char * */
    INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
471 472 473 474

    /* On the fly record while playing */
    INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
    INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
475 476 477

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

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

    /* External clock managments */
486
    INPUT_GET_PCR_SYSTEM,   /* arg1=mtime_t *, arg2=mtime_t *       res=can fail */
487
    INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t      res=can fail */
Laurent Aimar's avatar
Laurent Aimar committed
488 489
};

490 491 492 493 494 495
/** @}*/

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

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

499
VLC_API input_thread_t * input_CreateAndStart( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) VLC_USED;
500
#define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
501

502
VLC_API int input_Start( input_thread_t * );
503

504
VLC_API void input_Stop( input_thread_t *, bool b_abort );
505

506
VLC_API int input_Read( vlc_object_t *, input_item_t * );
507
#define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
508

509
VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
510

511
VLC_API int input_Control( input_thread_t *, int i_query, ...  );
Laurent Aimar's avatar
Laurent Aimar committed
512

513
VLC_API void input_Close( input_thread_t * );
514 515
void input_Join( input_thread_t * );
void input_Release( input_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
516

517 518 519 520 521 522
/**
 * 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.
 */
523
VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
524

525 526 527 528
/**
 * It will return the current state of the input.
 * Provided for convenience.
 */
529 530 531 532 533 534
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;
}
535 536 537 538 539 540 541 542
/**
 * It will add a new subtitle source to the input.
 * Provided for convenience.
 */
static inline int input_AddSubtitle( input_thread_t *p_input, const char *psz_url, bool b_check_extension )
{
    return input_Control( p_input, INPUT_ADD_SUBTITLE, psz_url, b_check_extension );
}
543

544 545 546 547 548 549 550 551 552 553
/**
 * 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;
554
     size_t i_vout;
555 556 557 558

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

559
     for( size_t i = 1; i < i_vout; i++ )
560 561 562
         vlc_object_release( (vlc_object_t *)(pp_vout[i]) );

     p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
563
     free( pp_vout );
564 565 566 567 568 569 570 571 572
     return p_vout;
}

/**
 * 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()).
 */
573
static inline audio_output_t *input_GetAout( input_thread_t *p_input )
574
{
575
     audio_output_t *p_aout;
576
     return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
577 578
}

579 580 581 582 583 584 585 586
/**
 * 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,
587
                                      vout_thread_t **pp_vout, audio_output_t **pp_aout )
588 589 590 591 592
{
    return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
                          pp_decoder, pp_vout, pp_aout );
}

593 594 595
/**
 * \see input_clock_GetSystemOrigin
 */
596
static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
597
{
598
    return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
599 600 601 602 603 604 605 606 607
}
/**
 * \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 );
}

608
/* */
609
VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, es_format_t *, input_resource_t * ) VLC_USED;
610 611
VLC_API void input_DecoderDelete( decoder_t * );
VLC_API void input_DecoderDecode( decoder_t *, block_t *, bool b_do_pace );
Laurent Aimar's avatar
Laurent Aimar committed
612

613 614 615
/**
 * This function creates a sane filename path.
 */
616
VLC_API char * input_CreateFilename( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED;
617

618
/**
619
 * It creates an empty input resource handler.
620
 *
621 622
 * The given object MUST stay alive as long as the input_resource_t is
 * not deleted.
623
 */
624
VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
625 626

/**
627
 * It releases an input resource.
628
 */
629
VLC_API void input_resource_Release( input_resource_t * );
630

631 632 633
/**
 * Forcefully destroys the video output (e.g. when the playlist is stopped).
 */
634
VLC_API void input_resource_TerminateVout( input_resource_t * );
635

636 637 638
/**
 * This function releases all resources (object).
 */
639
VLC_API void input_resource_Terminate( input_resource_t * );
640

641 642 643 644 645 646
/**
 * \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 * );

Laurent Aimar's avatar
Laurent Aimar committed
647
#endif