vlc_input.h 21.6 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

42 43 44 45 46 47
/*****************************************************************************
 * Meta data helpers
 *****************************************************************************/
static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
                                                        const vlc_meta_t *p_meta )
{
48
    const char * psz_value;
49

50 51 52
    if( !p_meta )
        return;

53 54
    if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_GAIN")) ||
        (psz_value = vlc_meta_GetExtra(p_meta, "RG_RADIO")) )
55
    {
56
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
57 58
        p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
    }
59 60
    else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_TRACK_PEAK" )) ||
             (psz_value = vlc_meta_GetExtra(p_meta, "RG_PEAK" )) )
61
    {
62
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
63 64
        p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
    }
65 66
    else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_GAIN" )) ||
             (psz_value = vlc_meta_GetExtra(p_meta, "RG_AUDIOPHILE" )) )
67
    {
68
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
69 70
        p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
    }
71
    else if( (psz_value = vlc_meta_GetExtra(p_meta, "REPLAYGAIN_ALBUM_PEAK" )) )
72
    {
73
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
74
        p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
75 76 77
    }
}

Laurent Aimar's avatar
Laurent Aimar committed
78 79 80 81 82 83 84 85 86 87 88 89 90 91
/*****************************************************************************
 * 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 =
92
    point->i_time_offset = -1;
Laurent Aimar's avatar
Laurent Aimar committed
93 94 95 96 97 98 99
    point->psz_name = NULL;
    return point;
}

static inline void vlc_seekpoint_Delete( seekpoint_t *point )
{
    if( !point ) return;
100
    free( point->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
101 102 103
    free( point );
}

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
104
static inline seekpoint_t *vlc_seekpoint_Duplicate( const seekpoint_t *src )
Laurent Aimar's avatar
Laurent Aimar committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
{
    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
120
    bool        b_menu;      /* Is it a menu or a normal entry */
Laurent Aimar's avatar
Laurent Aimar committed
121 122 123 124 125 126 127 128 129 130

    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
131
static inline input_title_t *vlc_input_title_New(void)
Laurent Aimar's avatar
Laurent Aimar committed
132 133 134 135
{
    input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );

    t->psz_name = NULL;
136
    t->b_menu = false;
Laurent Aimar's avatar
Laurent Aimar committed
137 138 139 140 141 142 143
    t->i_length = 0;
    t->i_size   = 0;
    t->i_seekpoint = 0;
    t->seekpoint = NULL;

    return t;
}
144

Laurent Aimar's avatar
Laurent Aimar committed
145 146 147 148 149 150
static inline void vlc_input_title_Delete( input_title_t *t )
{
    int i;
    if( t == NULL )
        return;

151
    free( t->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
152 153
    for( i = 0; i < t->i_seekpoint; i++ )
    {
154
        free( t->seekpoint[i]->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
155 156
        free( t->seekpoint[i] );
    }
157
    free( t->seekpoint );
Laurent Aimar's avatar
Laurent Aimar committed
158 159 160
    free( t );
}

Rémi Duraffort's avatar
Rémi Duraffort committed
161
static inline input_title_t *vlc_input_title_Duplicate( const input_title_t *t )
Laurent Aimar's avatar
Laurent Aimar committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183
{
    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
184

185 186 187 188 189 190 191 192
/*****************************************************************************
 * Attachments
 *****************************************************************************/
struct input_attachment_t
{
    char *psz_name;
    char *psz_mime;
    char *psz_description;
Laurent Aimar's avatar
Laurent Aimar committed
193

194 195 196
    int  i_data;
    void *p_data;
};
Jean-Paul Saman's avatar
Jean-Paul Saman committed
197

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232
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 );
233
    free( a->p_data );
234 235
    free( a );
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
236

Laurent Aimar's avatar
Laurent Aimar committed
237 238 239 240 241 242 243 244 245
/*****************************************************************************
 * input defines/constants.
 *****************************************************************************/

/* i_update field of access_t/demux_t */
#define INPUT_UPDATE_NONE       0x0000
#define INPUT_UPDATE_SIZE       0x0001
#define INPUT_UPDATE_TITLE      0x0010
#define INPUT_UPDATE_SEEKPOINT  0x0020
246
#define INPUT_UPDATE_META       0x0040
247
#define INPUT_UPDATE_SIGNAL     0x0080
248
#define INPUT_UPDATE_TITLE_LIST 0x0100
Laurent Aimar's avatar
Laurent Aimar committed
249

250 251
/**
 * This defines private core storage for an input.
252
 */
Clément Stenac's avatar
Clément Stenac committed
253 254
typedef struct input_thread_private_t input_thread_private_t;

255 256 257 258 259
/**
 * This defines an opaque input resource handler.
 */
typedef struct input_resource_t input_resource_t;

Clément Stenac's avatar
Clément Stenac committed
260 261 262 263 264
/**
 * 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
265 266
struct input_thread_t
{
267
    VLC_COMMON_MEMBERS
Laurent Aimar's avatar
Laurent Aimar committed
268

269
    bool b_error;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
270
    bool b_eof;
271
    bool b_preparsing;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
272
    bool b_dead;
273

Clément Stenac's avatar
Clément Stenac committed
274 275 276
    /* 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
277 278
};

279 280 281 282
/**
 * Record prefix string.
 * TODO make it configurable.
 */
283
#define INPUT_RECORD_PREFIX "vlc-record-%Y-%m-%d-%Hh%Mm%Ss-$ N-$ p"
284

Laurent Aimar's avatar
Laurent Aimar committed
285 286 287 288 289 290 291 292 293 294 295 296
/*****************************************************************************
 * 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"
297
 *  - "can-seek" (if you can seek, it doesn't say if 'bar display' has be shown
Laurent Aimar's avatar
Laurent Aimar committed
298 299
 *    or not, for that check position != 0.0)
 *  - "can-pause"
300
 *  - "can-rate"
Laurent Aimar's avatar
Laurent Aimar committed
301 302
 *  - "can-rewind"
 *  - "can-record" (if a stream can be recorded while playing)
303 304
 *  - "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)
305 306
 *  - "signal-quality"
 *  - "signal-strength"
307
 *  - "program-scrambled" (if the current program is scrambled)
308
 *  - "cache" (level of data cached [0 .. 1])
Laurent Aimar's avatar
Laurent Aimar committed
309 310 311
 *
 * The read-write variables are:
 *  - state (\see input_state_e)
312
 *  - rate
Laurent Aimar's avatar
Laurent Aimar committed
313 314
 *  - position, position-offset
 *  - time, time-offset
315 316
 *  - title, next-title, prev-title
 *  - chapter, next-chapter, next-chapter-prev
Laurent Aimar's avatar
Laurent Aimar committed
317 318
 *  - program, audio-es, video-es, spu-es
 *  - audio-delay, spu-delay
319
 *  - bookmark (bookmark list)
320 321 322 323
 *  - record
 *  - frame-next
 *  - navigation (list of "title %2i")
 *  - "title %2i"
Laurent Aimar's avatar
Laurent Aimar committed
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
 *
 * 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.
 *
347
 * It is an float used by the variable "rate" in the
Frédéric Yhuel's avatar
Frédéric Yhuel committed
348
 * range [INPUT_RATE_DEFAULT/INPUT_RATE_MAX, INPUT_RATE_DEFAULT/INPUT_RATE_MIN]
349 350
 * 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
351
 *
352 353 354
 * 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
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
 */

/**
 * 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
380 381
    /* b_dead is true */
    INPUT_EVENT_DEAD,
382 383
    /* a *user* abort has been requested */
    INPUT_EVENT_ABORT,
Laurent Aimar's avatar
Laurent Aimar committed
384

Laurent Aimar's avatar
Laurent Aimar committed
385 386
    /* "rate" has changed */
    INPUT_EVENT_RATE,
Laurent Aimar's avatar
Laurent Aimar committed
387

388 389 390 391 392
    /* At least one of "position" or "time" */
    INPUT_EVENT_POSITION,

    /* "length" has changed */
    INPUT_EVENT_LENGTH,
Laurent Aimar's avatar
Laurent Aimar committed
393 394 395 396 397 398 399

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

400 401
    /* A program ("program") has been added or removed or selected,
     * or "program-scrambled" has changed.*/
Laurent Aimar's avatar
Laurent Aimar committed
402 403 404
    INPUT_EVENT_PROGRAM,
    /* A ES has been added or removed or selected */
    INPUT_EVENT_ES,
Laurent Aimar's avatar
Laurent Aimar committed
405 406
    /* "teletext-es" has changed */
    INPUT_EVENT_TELETEXT,
Laurent Aimar's avatar
Laurent Aimar committed
407 408 409 410 411 412 413 414 415 416

    /* "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,
417 418
    /* input_item_t epg has changed */
    INPUT_EVENT_ITEM_EPG,
Laurent Aimar's avatar
Laurent Aimar committed
419 420 421 422 423 424 425 426 427 428 429

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

430 431 432
    /* "bookmark" has changed */
    INPUT_EVENT_BOOKMARK,

433 434 435
    /* cache" has changed */
    INPUT_EVENT_CACHE,

436
    /* A audio_output_t object has been created/deleted by *the input* */
437 438 439 440
    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
441 442
} input_event_type_e;

443
/**
444
 * Input queries
445
 */
Laurent Aimar's avatar
Laurent Aimar committed
446 447 448 449 450 451 452 453 454 455 456 457 458
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    */

459
    /* input variable "rate" (nominal is INPUT_RATE_DEFAULT) */
Laurent Aimar's avatar
Laurent Aimar committed
460 461 462 463 464 465 466
    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    */

467
    /* input variable "audio-delay" and "sub-delay" */
468 469 470 471 472
    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 */

473 474 475 476 477 478 479
    /* Menu navigation */
    INPUT_NAV_ACTIVATE,
    INPUT_NAV_UP,
    INPUT_NAV_DOWN,
    INPUT_NAV_LEFT,
    INPUT_NAV_RIGHT,

480
    /* Meta datas */
481
    INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
482 483
    INPUT_REPLACE_INFOS,/* arg1= info_category_t *            res=cannot fail */
    INPUT_MERGE_INFOS,/* arg1= info_category_t *              res=cannot fail */
484 485 486
    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    */
487

488
    /* Input properties */
489
    INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
490

Laurent Aimar's avatar
Laurent Aimar committed
491
    /* bookmarks */
492
    INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
Laurent Aimar's avatar
Laurent Aimar committed
493 494 495 496 497 498
    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    */
499

500 501 502
    /* titles */
    INPUT_GET_TITLE_INFO,     /* arg1=input_title_t** arg2= int * res=can fail */

503 504 505 506
    /* 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 */

507
    /* On the fly input slave */
508 509
    INPUT_ADD_SLAVE,       /* arg1= const char * */
    INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
510 511 512 513

    /* On the fly record while playing */
    INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
    INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
514 515 516

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

    /* Input ressources
     * XXX You must call vlc_object_release as soon as possible */
520
    INPUT_GET_AOUT,         /* arg1=audio_output_t **              res=can fail */
521
    INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
522
    INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, audio_output_t ** */
523 524

    /* External clock managments */
525
    INPUT_GET_PCR_SYSTEM,   /* arg1=mtime_t *, arg2=mtime_t *       res=can fail */
526
    INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t      res=can fail */
Laurent Aimar's avatar
Laurent Aimar committed
527 528
};

529 530 531 532 533 534
/** @}*/

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

535
VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED;
536
#define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
537

538
VLC_API input_thread_t * input_CreateAndStart( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) VLC_USED;
539
#define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
540

541
VLC_API int input_Start( input_thread_t * );
542

543
VLC_API void input_Stop( input_thread_t *, bool b_abort );
544

545
VLC_API int input_Read( vlc_object_t *, input_item_t * );
546
#define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
547

548
VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
549

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

552
VLC_API void input_Close( input_thread_t * );
553 554
void input_Join( input_thread_t * );
void input_Release( input_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
555

556 557 558 559 560 561
/**
 * 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.
 */
562
VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
563

564 565 566 567
/**
 * It will return the current state of the input.
 * Provided for convenience.
 */
568 569 570 571 572 573
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;
}
574 575 576 577 578 579 580 581
/**
 * 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 );
}
582

583 584 585 586 587 588 589 590 591 592
/**
 * 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;
593
     size_t i_vout;
594 595 596 597

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

598
     for( size_t i = 1; i < i_vout; i++ )
599 600 601
         vlc_object_release( (vlc_object_t *)(pp_vout[i]) );

     p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
602
     free( pp_vout );
603 604 605 606 607 608 609 610 611
     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()).
 */
612
static inline audio_output_t *input_GetAout( input_thread_t *p_input )
613
{
614
     audio_output_t *p_aout;
615
     return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
616 617
}

618 619 620 621 622 623 624 625
/**
 * 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,
626
                                      vout_thread_t **pp_vout, audio_output_t **pp_aout )
627 628 629 630 631
{
    return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
                          pp_decoder, pp_vout, pp_aout );
}

632 633 634
/**
 * \see input_clock_GetSystemOrigin
 */
635
static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
636
{
637
    return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
638 639 640 641 642 643 644 645 646
}
/**
 * \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 );
}

647
/* */
648
VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, es_format_t *, input_resource_t * ) VLC_USED;
649 650
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
651

652 653 654
/**
 * This function creates a sane filename path.
 */
655
VLC_API char * input_CreateFilename( vlc_object_t *, const char *psz_path, const char *psz_prefix, const char *psz_extension ) VLC_USED;
656

657
/**
658
 * It creates an empty input resource handler.
659
 *
660 661
 * The given object MUST stay alive as long as the input_resource_t is
 * not deleted.
662
 */
663
VLC_API input_resource_t * input_resource_New( vlc_object_t * ) VLC_USED;
664 665

/**
666
 * It releases an input resource.
667
 */
668
VLC_API void input_resource_Release( input_resource_t * );
669

670 671 672
/**
 * Forcefully destroys the video output (e.g. when the playlist is stopped).
 */
673
VLC_API void input_resource_TerminateVout( input_resource_t * );
674

675 676 677
/**
 * This function releases all resources (object).
 */
678
VLC_API void input_resource_Terminate( input_resource_t * );
679

680 681 682 683 684 685
/**
 * \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
686
#endif