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
 *****************************************************************************
4
 * Copyright (C) 1999-2006 the VideoLAN team
5
 * $Id$
Laurent Aimar's avatar
Laurent Aimar committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * Authors: Christophe Massiot <massiot@via.ecp.fr>
 *          Laurent Aimar <fenrir@via.ecp.fr>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (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
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
Antoine Cellerier's avatar
Antoine Cellerier committed
22
 * 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
/*****************************************************************************
 * Seek point: (generalisation of chapters)
 *****************************************************************************/
struct seekpoint_t
{
    int64_t i_byte_offset;
    int64_t i_time_offset;
    char    *psz_name;
86
    int     i_level;
Laurent Aimar's avatar
Laurent Aimar committed
87 88 89 90 91 92
};

static inline seekpoint_t *vlc_seekpoint_New( void )
{
    seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
    point->i_byte_offset =
93
    point->i_time_offset = -1;
94
    point->i_level = 0;
Laurent Aimar's avatar
Laurent Aimar committed
95 96 97 98 99 100 101
    point->psz_name = NULL;
    return point;
}

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

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

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

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

    return t;
}
146

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

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

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

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

196 197 198
    int  i_data;
    void *p_data;
};
Jean-Paul Saman's avatar
Jean-Paul Saman committed
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 233 234
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 );
235
    free( a->p_data );
236 237
    free( a );
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
238

Laurent Aimar's avatar
Laurent Aimar committed
239 240 241 242 243 244 245 246 247
/*****************************************************************************
 * 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
248
#define INPUT_UPDATE_META       0x0040
249
#define INPUT_UPDATE_SIGNAL     0x0080
Laurent Aimar's avatar
Laurent Aimar committed
250

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    /* Meta datas */
475
    INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
476 477
    INPUT_REPLACE_INFOS,/* arg1= info_category_t *            res=cannot fail */
    INPUT_MERGE_INFOS,/* arg1= info_category_t *              res=cannot fail */
478 479 480
    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    */
481

482
    /* Input properties */
483
    INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
484

Laurent Aimar's avatar
Laurent Aimar committed
485
    /* bookmarks */
486
    INPUT_GET_BOOKMARK,    /* arg1= seekpoint_t *               res=can fail */
Laurent Aimar's avatar
Laurent Aimar committed
487 488 489 490 491 492
    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    */
493

494 495 496
    /* titles */
    INPUT_GET_TITLE_INFO,     /* arg1=input_title_t** arg2= int * res=can fail */

497 498 499 500
    /* 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 */

501
    /* On the fly input slave */
502 503
    INPUT_ADD_SLAVE,       /* arg1= const char * */
    INPUT_ADD_SUBTITLE,    /* arg1= const char *, arg2=bool b_check_extension */
504 505 506 507

    /* On the fly record while playing */
    INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
    INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
508 509 510

    /* ES */
    INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
511 512 513 514

    /* Input ressources
     * XXX You must call vlc_object_release as soon as possible */
    INPUT_GET_AOUT,         /* arg1=aout_instance_t **              res=can fail */
515
    INPUT_GET_VOUTS,        /* arg1=vout_thread_t ***, size_t *        res=can fail */
516
    INPUT_GET_ES_OBJECTS,   /* arg1=int id, vlc_object_t **dec, vout_thread_t **, aout_instance_t ** */
517 518

    /* External clock managments */
519
    INPUT_GET_PCR_SYSTEM,   /* arg1=mtime_t *, arg2=mtime_t *       res=can fail */
520
    INPUT_MODIFY_PCR_SYSTEM,/* arg1=int absolute, arg2=mtime_t      res=can fail */
Laurent Aimar's avatar
Laurent Aimar committed
521 522
};

523 524 525 526 527 528
/** @}*/

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

529
VLC_API input_thread_t * input_Create( vlc_object_t *p_parent, input_item_t *, const char *psz_log, input_resource_t * ) VLC_USED;
530
#define input_Create(a,b,c,d) input_Create(VLC_OBJECT(a),b,c,d)
531

532
VLC_API input_thread_t * input_CreateAndStart( vlc_object_t *p_parent, input_item_t *, const char *psz_log ) VLC_USED;
533
#define input_CreateAndStart(a,b,c) input_CreateAndStart(VLC_OBJECT(a),b,c)
534

535
VLC_API int input_Start( input_thread_t * );
536

537
VLC_API void input_Stop( input_thread_t *, bool b_abort );
538

539
VLC_API int input_Read( vlc_object_t *, input_item_t * );
540
#define input_Read(a,b) input_Read(VLC_OBJECT(a),b)
541

542
VLC_API int input_vaControl( input_thread_t *, int i_query, va_list  );
543

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

546
VLC_API void input_Close( input_thread_t * );
547 548
void input_Join( input_thread_t * );
void input_Release( input_thread_t * );
Laurent Aimar's avatar
Laurent Aimar committed
549

550 551 552 553 554 555
/**
 * 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.
 */
556
VLC_API input_item_t* input_GetItem( input_thread_t * ) VLC_USED;
557

558 559 560 561
/**
 * It will return the current state of the input.
 * Provided for convenience.
 */
562 563 564 565 566 567
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;
}
568 569 570 571 572 573 574 575
/**
 * 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 );
}
576

577 578 579 580 581 582 583 584 585 586
/**
 * 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;
587
     size_t i_vout;
588 589 590 591

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

592
     for( size_t i = 1; i < i_vout; i++ )
593 594 595
         vlc_object_release( (vlc_object_t *)(pp_vout[i]) );

     p_vout = (i_vout >= 1) ? pp_vout[0] : NULL;
596
     free( pp_vout );
597 598 599 600 601 602 603 604 605 606 607 608
     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()).
 */
static inline aout_instance_t *input_GetAout( input_thread_t *p_input )
{
     aout_instance_t *p_aout;
609
     return input_Control( p_input, INPUT_GET_AOUT, &p_aout ) ? NULL : p_aout;
610 611
}

612 613 614 615 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,
                                      vout_thread_t **pp_vout, aout_instance_t **pp_aout )
{
    return input_Control( p_input, INPUT_GET_ES_OBJECTS, i_id,
                          pp_decoder, pp_vout, pp_aout );
}

626 627 628
/**
 * \see input_clock_GetSystemOrigin
 */
629
static inline int input_GetPcrSystem( input_thread_t *p_input, mtime_t *pi_system, mtime_t *pi_delay )
630
{
631
    return input_Control( p_input, INPUT_GET_PCR_SYSTEM, pi_system, pi_delay );
632 633 634 635 636 637 638 639 640
}
/**
 * \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 );
}

641
/* */
642
VLC_API decoder_t * input_DecoderCreate( vlc_object_t *, es_format_t *, input_resource_t * ) VLC_USED;
643 644
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
645

Laurent Aimar's avatar
Laurent Aimar committed
646 647 648 649 650 651 652
/**
 * This function allows to split a MRL into access, demux and path part.
 *
 *  You should not write into access and demux string as they may not point into
 * the provided buffer.
 *  The buffer provided by psz_dup will be modified.
 */
653
VLC_API void input_SplitMRL( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup );
Laurent Aimar's avatar
Laurent Aimar committed
654

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

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

/**
669
 * It releases an input resource.
670
 */
671
VLC_API void input_resource_Release( input_resource_t * );
672

673 674 675
/**
 * Forcefully destroys the video output (e.g. when the playlist is stopped).
 */
676
VLC_API void input_resource_TerminateVout( input_resource_t * );
677

678 679 680
/**
 * This function releases all resources (object).
 */
681
VLC_API void input_resource_Terminate( input_resource_t * );
682

Laurent Aimar's avatar
Laurent Aimar committed
683
#endif