vlc_input.h 17.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-2004 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 26 27 28
 *****************************************************************************/

/* __ is need because conflict with <vlc/input.h> */
#ifndef _VLC__INPUT_H
#define _VLC__INPUT_H 1

29 30 31 32 33
#include <vlc_playlist.h>
#include <vlc_meta.h>

struct vlc_meta_t;

Laurent Aimar's avatar
Laurent Aimar committed
34
/*****************************************************************************
35
 * input_item_t: Describes an input and is used to spawn input_thread_t objects
Laurent Aimar's avatar
Laurent Aimar committed
36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51
 *****************************************************************************/
struct info_t
{
    char *psz_name;            /**< Name of this info */
    char *psz_value;           /**< Value of the info */
};

struct info_category_t
{
    char   *psz_name;      /**< Name of this category */
    int    i_infos;        /**< Number of infos in the category */
    struct info_t **pp_infos;     /**< Pointer to an array of infos */
};

struct input_item_t
{
52 53 54
    VLC_GC_MEMBERS
    int        i_id;                 /**< Identifier of the item */

Laurent Aimar's avatar
Laurent Aimar committed
55 56
    char       *psz_name;            /**< text describing this item */
    char       *psz_uri;             /**< mrl of this item */
57
    vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
Laurent Aimar's avatar
Laurent Aimar committed
58 59 60 61

    int        i_options;            /**< Number of input options */
    char       **ppsz_options;       /**< Array of input options */

62
    mtime_t    i_duration;           /**< Duration in milliseconds*/
Laurent Aimar's avatar
Laurent Aimar committed
63

64
    uint8_t    i_type;               /**< Type (file, disc, ...) */
65
    vlc_bool_t b_prefers_tree;      /**< Do we prefer being displayed as tree*/
66

Laurent Aimar's avatar
Laurent Aimar committed
67 68 69
    int        i_categories;         /**< Number of info categories */
    info_category_t **pp_categories; /**< Pointer to the first info category */

70
    int         i_es;                /**< Number of es format descriptions */
71
    es_format_t **es;                /**< Es formats */
Clément Stenac's avatar
Clément Stenac committed
72

Clément Stenac's avatar
Clément Stenac committed
73
    input_stats_t *p_stats;          /**< Statistics */
74 75 76
    int           i_nb_played;       /**< Number of times played */

    vlc_meta_t *p_meta;
Clément Stenac's avatar
Clément Stenac committed
77

78
    vlc_mutex_t lock;                /**< Lock for the item */
Laurent Aimar's avatar
Laurent Aimar committed
79 80
};

81
#define ITEM_TYPE_UNKNOWN       0
Clément Stenac's avatar
Clément Stenac committed
82 83 84 85 86 87 88 89 90
#define ITEM_TYPE_AFILE         1
#define ITEM_TYPE_VFILE         2
#define ITEM_TYPE_DIRECTORY     3
#define ITEM_TYPE_DISC          4
#define ITEM_TYPE_CDDA          5
#define ITEM_TYPE_CARD          6
#define ITEM_TYPE_NET           7
#define ITEM_TYPE_PLAYLIST      8
#define ITEM_TYPE_NODE          9
Clément Stenac's avatar
Clément Stenac committed
91
#define ITEM_TYPE_NUMBER        10
92

93 94 95 96 97
static inline void vlc_input_item_Init( vlc_object_t *p_o, input_item_t *p_i )
{
    memset( p_i, 0, sizeof(input_item_t) );
    p_i->psz_name = 0;
    p_i->psz_uri = 0;
98 99 100
    p_i->i_es = 0;
    p_i->es = 0;
    p_i->i_options  = 0;
101
    p_i->ppsz_options = 0;
102
    p_i->i_categories = 0 ;
103
    p_i->pp_categories = 0;
104
    p_i->i_type = ITEM_TYPE_UNKNOWN;
Clément Stenac's avatar
Clément Stenac committed
105
    p_i->b_fixed_name = VLC_TRUE;
Clément Stenac's avatar
Clément Stenac committed
106 107

    p_i->p_stats = (input_stats_t*) malloc( sizeof( input_stats_t ) );
108
    p_i->p_meta = NULL;
Clément Stenac's avatar
Clément Stenac committed
109 110
    vlc_mutex_init( p_o, &p_i->p_stats->lock );

111 112 113
    vlc_mutex_init( p_o, &p_i->lock );
}

114 115 116 117 118 119 120
static inline void vlc_input_item_CopyOptions( input_item_t *p_parent,
                                               input_item_t *p_child )
{
    int i;
    for( i = 0 ; i< p_parent->i_options; i++ )
    {
        char *psz_option= strdup( p_parent->ppsz_options[i] );
Clément Stenac's avatar
Clément Stenac committed
121 122 123 124 125
        p_child->i_options++;
        p_child->ppsz_options = (char **)realloc( p_child->ppsz_options,
                                                  p_child->i_options *
                                                  sizeof( char * ) );
        p_child->ppsz_options[p_child->i_options-1] = psz_option;
126 127 128
    }
}

129 130
VLC_EXPORT( void, vlc_input_item_AddOption, ( input_item_t *p_input, const char *psz_option ) );

131 132 133 134
static inline void vlc_input_item_Clean( input_item_t *p_i )
{
    if( p_i->psz_name ) free( p_i->psz_name );
    if( p_i->psz_uri ) free( p_i->psz_uri );
135
    if( p_i->p_stats ) free( p_i->p_stats );
136 137 138
    p_i->psz_name = 0;
    p_i->psz_uri = 0;

139 140
    if( p_i->p_meta ) vlc_meta_Delete( p_i->p_meta );

141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
    while( p_i->i_options )
    {
        p_i->i_options--;
        if( p_i->ppsz_options[p_i->i_options] )
            free( p_i->ppsz_options[p_i->i_options] );
        if( !p_i->i_options ) free( p_i->ppsz_options );
    }

    while( p_i->i_es )
    {
        p_i->i_es--;
        es_format_Clean( p_i->es[p_i->i_es] );
        if( !p_i->i_es ) free( p_i->es );
    }

    while( p_i->i_categories )
    {
        info_category_t *p_category =
            p_i->pp_categories[--(p_i->i_categories)];

        while( p_category->i_infos )
        {
            p_category->i_infos--;

            if( p_category->pp_infos[p_category->i_infos]->psz_name )
                free( p_category->pp_infos[p_category->i_infos]->psz_name);
            if( p_category->pp_infos[p_category->i_infos]->psz_value )
                free( p_category->pp_infos[p_category->i_infos]->psz_value );
            free( p_category->pp_infos[p_category->i_infos] );

            if( !p_category->i_infos ) free( p_category->pp_infos );
        }

        if( p_category->psz_name ) free( p_category->psz_name );
        free( p_category );

        if( !p_i->i_categories ) free( p_i->pp_categories );
    }

    vlc_mutex_destroy( &p_i->lock );
}
Laurent Aimar's avatar
Laurent Aimar committed
182

183 184 185
VLC_EXPORT( char *, vlc_input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
VLC_EXPORT(int, vlc_input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );

186 187 188 189 190 191 192 193
#define input_ItemNew( a,b,c ) input_ItemNewExt( a, b, c, 0, NULL, -1 )
#define input_ItemNewExt(a,b,c,d,e,f) __input_ItemNewExt( VLC_OBJECT(a),b,c,d,e,f)
VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char **, int)  );
VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char **, int, int ) );

VLC_EXPORT( input_item_t *, input_ItemGetById, (playlist_t *, int ) );


Laurent Aimar's avatar
Laurent Aimar committed
194 195 196 197 198 199 200 201
/*****************************************************************************
 * Seek point: (generalisation of chapters)
 *****************************************************************************/
struct seekpoint_t
{
    int64_t i_byte_offset;
    int64_t i_time_offset;
    char    *psz_name;
202
    int     i_level;
Laurent Aimar's avatar
Laurent Aimar committed
203 204 205 206 207 208
};

static inline seekpoint_t *vlc_seekpoint_New( void )
{
    seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
    point->i_byte_offset =
209
    point->i_time_offset = -1;
210
    point->i_level = 0;
Laurent Aimar's avatar
Laurent Aimar committed
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
    point->psz_name = NULL;
    return point;
}

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

static inline seekpoint_t *vlc_seekpoint_Duplicate( seekpoint_t *src )
{
    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;

    vlc_bool_t  b_menu;      /* Is it a menu or a normal entry */

    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;

static inline input_title_t *vlc_input_title_New( )
{
    input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );

    t->psz_name = NULL;
    t->b_menu = VLC_FALSE;
    t->i_length = 0;
    t->i_size   = 0;
    t->i_seekpoint = 0;
    t->seekpoint = NULL;

    return t;
}
262

Laurent Aimar's avatar
Laurent Aimar committed
263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
static inline void vlc_input_title_Delete( input_title_t *t )
{
    int i;
    if( t == NULL )
        return;

    if( t->psz_name ) free( t->psz_name );
    for( i = 0; i < t->i_seekpoint; i++ )
    {
        if( t->seekpoint[i]->psz_name ) free( t->seekpoint[i]->psz_name );
        free( t->seekpoint[i] );
    }
    if( t->seekpoint ) free( t->seekpoint );
    free( t );
}

static inline input_title_t *vlc_input_title_Duplicate( input_title_t *t )
{
    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;
}

/*****************************************************************************
 * input defines/constants.
 *****************************************************************************/

/* "state" value */
enum input_state_e
{
310 311 312
    INIT_S,   
    OPENING_S,
    BUFFERING_S,
Laurent Aimar's avatar
Laurent Aimar committed
313 314
    PLAYING_S,
    PAUSE_S,
Clément Stenac's avatar
Clément Stenac committed
315
    END_S
Laurent Aimar's avatar
Laurent Aimar committed
316 317
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
318 319 320 321
/* "rate" default, min/max
 * A rate below 1000 plays the movie faster,
 * A rate above 1000 plays the movie slower.
 */
Laurent Aimar's avatar
Laurent Aimar committed
322 323 324 325
#define INPUT_RATE_DEFAULT  1000
#define INPUT_RATE_MIN       125            /* Up to 8/1 */
#define INPUT_RATE_MAX      8000            /* Up to 1/8 */

326
/* input_source_t: gathers all information per input source */
Laurent Aimar's avatar
Laurent Aimar committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
typedef struct
{
    /* Input item description */
    input_item_t *p_item;

    /* Access/Stream/Demux plugins */
    access_t *p_access;
    stream_t *p_stream;
    demux_t  *p_demux;

    /* Title infos for that input */
    vlc_bool_t   b_title_demux; /* Titles/Seekpoints provided by demux */
    int          i_title;
    input_title_t **title;

342 343 344 345 346 347 348 349
    int i_title_offset;
    int i_seekpoint_offset;

    int i_title_start;
    int i_title_end;
    int i_seekpoint_start;
    int i_seekpoint_end;

Laurent Aimar's avatar
Laurent Aimar committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
    /* Properties */
    vlc_bool_t b_can_pace_control;
    vlc_bool_t b_can_pause;
    vlc_bool_t b_eof;   /* eof of demuxer */

    /* Clock average variation */
    int     i_cr_average;

} input_source_t;

/* 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
365
#define INPUT_UPDATE_META       0x0040
Laurent Aimar's avatar
Laurent Aimar committed
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402

/* Input control XXX: internal */
#define INPUT_CONTROL_FIFO_SIZE    100

/*****************************************************************************
 * input_thread_t
 *****************************************************************************
 * XXX: this strucrures is *PRIVATE* so nobody can touch it out of src/input.
 * I plan to move it to src/input/input_internal.h anyway
 *
 * XXX: look at src/input/input.c:input_CreateThread for accessible variables
 *      YOU CANNOT HAVE ACCESS TO THE CONTENT OF input_thread_t except
 *      p_input->input.p_item (and it's only temporary).
 * XXX: move the docs somewhere (better than src/input )
 *****************************************************************************/
struct input_thread_t
{
    VLC_COMMON_MEMBERS

     /* Global properties */
    vlc_bool_t  b_eof;
    vlc_bool_t  b_can_pace_control;
    vlc_bool_t  b_can_pause;

    /* Global state */
    int         i_state;
    int         i_rate;

    /* */
    int64_t     i_start;    /* :start-time,0 by default */
    int64_t     i_time;     /* Current time */
    int64_t     i_stop;     /* :stop-time, 0 if none */

    /* Title infos FIXME multi-input (not easy) ? */
    int          i_title;
    input_title_t **title;

403 404 405
    int i_title_offset;
    int i_seekpoint_offset;

Laurent Aimar's avatar
Laurent Aimar committed
406 407 408 409
    /* User bookmarks FIXME won't be easy with multiples input */
    int         i_bookmark;
    seekpoint_t **bookmark;

410 411 412
    /* Global meta datas FIXME move to input_item_t ? */
    vlc_meta_t  *p_meta;

Laurent Aimar's avatar
Laurent Aimar committed
413 414 415 416 417 418 419 420
    /* Output */
    es_out_t    *p_es_out;
    sout_instance_t *p_sout;            /* XXX Move it to es_out ? */
    vlc_bool_t      b_out_pace_control; /*     idem ? */

    /* Internal caching common for all inputs */
    int64_t i_pts_delay;

421
    /* Main input properties */
Laurent Aimar's avatar
Laurent Aimar committed
422 423
    input_source_t input;

424 425 426 427
    /* Slave demuxers (subs, and others) */
    int            i_slave;
    input_source_t **slave;

428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
    /* Stats counters */
    struct {
        counter_t *p_read_packets;
        counter_t *p_read_bytes;
        counter_t *p_input_bitrate;
        counter_t *p_demux_read;
        counter_t *p_demux_bitrate;
        counter_t *p_decoded_audio;
        counter_t *p_decoded_video;
        counter_t *p_decoded_sub;
        counter_t *p_sout_sent_packets;
        counter_t *p_sout_sent_bytes;
        counter_t *p_sout_send_bitrate;
        counter_t *p_played_abuffers;
        counter_t *p_lost_abuffers;
        counter_t *p_displayed_pictures;
        counter_t *p_lost_pictures;
        vlc_mutex_t counters_lock;
    } counters;

Laurent Aimar's avatar
Laurent Aimar committed
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463
    /* Buffer of pending actions */
    vlc_mutex_t lock_control;
    int i_control;
    struct
    {
        /* XXX: val isn't duplicated so it won't works with string */
        int         i_type;
        vlc_value_t val;
    } control[INPUT_CONTROL_FIFO_SIZE];
};

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
#define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
464 465
#define input_CreateThread2(a,b,c) __input_CreateThread2(VLC_OBJECT(a),b,c)
VLC_EXPORT( input_thread_t *, __input_CreateThread2, ( vlc_object_t *, input_item_t *, char * ) );
466 467
#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
468 469

#define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
470
VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
Laurent Aimar's avatar
Laurent Aimar committed
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494
VLC_EXPORT( void,             input_StopThread,     ( input_thread_t * ) );
VLC_EXPORT( void,             input_DestroyThread,  ( input_thread_t * ) );

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

    /* input variable "rate" (1 is DEFAULT_RATE) */
    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    */

495
    /* input variable "audio-delay" and "sub-delay" */
496 497 498 499 500 501
    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 */
502 503 504 505
    INPUT_ADD_INFO,   /* arg1= char* arg2= char* arg3=...     res=can fail */
    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    */
506

507 508 509 510 511 512 513
    /* Input config options */
    INPUT_ADD_OPTION,      /* arg1= char * arg2= char *  res=can fail*/

    /* Input properties */
    INPUT_GET_BYTE_POSITION,     /* arg1= int64_t *       res=    */
    INPUT_SET_BYTE_SIZE,         /* arg1= int64_t *       res=    */

Laurent Aimar's avatar
Laurent Aimar committed
514 515 516 517 518 519 520
    /* bookmarks */
    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    */
521 522

    /* On the fly input slave */
Clément Stenac's avatar
Clément Stenac committed
523
    INPUT_ADD_SLAVE        /* arg1= char * */
Laurent Aimar's avatar
Laurent Aimar committed
524 525 526 527 528 529 530 531 532
};

VLC_EXPORT( int, input_vaControl,( input_thread_t *, int i_query, va_list  ) );
VLC_EXPORT( int, input_Control,  ( input_thread_t *, int i_query, ...  ) );

VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, vlc_bool_t b_force_decoder ) );
VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );

533 534
VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );

Laurent Aimar's avatar
Laurent Aimar committed
535
#endif