vlc_input.h 14.7 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
 *****************************************************************************/

Clément Stenac's avatar
Clément Stenac committed
25 26 27 28
#if !defined( __LIBVLC__ )
  #error You are not libvlc or one of its plugins. You cannot include this file
#endif

Laurent Aimar's avatar
Laurent Aimar committed
29 30 31 32
/* __ is need because conflict with <vlc/input.h> */
#ifndef _VLC__INPUT_H
#define _VLC__INPUT_H 1

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

struct vlc_meta_t;

Laurent Aimar's avatar
Laurent Aimar committed
39
/*****************************************************************************
40
 * input_item_t: Describes an input and is used to spawn input_thread_t objects
Laurent Aimar's avatar
Laurent Aimar committed
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
 *****************************************************************************/
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
{
57 58 59
    VLC_GC_MEMBERS
    int        i_id;                 /**< Identifier of the item */

Laurent Aimar's avatar
Laurent Aimar committed
60 61
    char       *psz_name;            /**< text describing this item */
    char       *psz_uri;             /**< mrl of this item */
62
    vlc_bool_t  b_fixed_name;        /**< Can the interface change the name ?*/
Laurent Aimar's avatar
Laurent Aimar committed
63 64 65 66

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

67
    mtime_t    i_duration;           /**< Duration in milliseconds*/
Laurent Aimar's avatar
Laurent Aimar committed
68

69
    uint8_t    i_type;               /**< Type (file, disc, ...) */
70
    vlc_bool_t b_prefers_tree;      /**< Do we prefer being displayed as tree*/
71

Laurent Aimar's avatar
Laurent Aimar committed
72 73 74
    int        i_categories;         /**< Number of info categories */
    info_category_t **pp_categories; /**< Pointer to the first info category */

75
    int         i_es;                /**< Number of es format descriptions */
76
    es_format_t **es;                /**< Es formats */
Clément Stenac's avatar
Clément Stenac committed
77

Clément Stenac's avatar
Clément Stenac committed
78
    input_stats_t *p_stats;          /**< Statistics */
79 80 81
    int           i_nb_played;       /**< Number of times played */

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

83
    vlc_mutex_t lock;                /**< Lock for the item */
Laurent Aimar's avatar
Laurent Aimar committed
84 85
};

86
#define ITEM_TYPE_UNKNOWN       0
Clément Stenac's avatar
Clément Stenac committed
87 88 89 90 91 92 93 94 95
#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
96
#define ITEM_TYPE_NUMBER        10
97

98
static inline void input_ItemInit( vlc_object_t *p_o, input_item_t *p_i )
99 100
{
    memset( p_i, 0, sizeof(input_item_t) );
101 102 103 104 105 106
    p_i->psz_name = NULL;
    p_i->psz_uri = NULL;
    TAB_INIT( p_i->i_es, p_i->es );
    TAB_INIT( p_i->i_options, p_i->ppsz_options );
    TAB_INIT( p_i->i_categories, p_i->pp_categories );

107
    p_i->i_type = ITEM_TYPE_UNKNOWN;
Clément Stenac's avatar
Clément Stenac committed
108
    p_i->b_fixed_name = VLC_TRUE;
Clément Stenac's avatar
Clément Stenac committed
109

110
    p_i->p_stats = NULL;
111
    p_i->p_meta = NULL;
Clément Stenac's avatar
Clément Stenac committed
112

113 114 115
    vlc_mutex_init( p_o, &p_i->lock );
}

116 117
static inline void input_ItemCopyOptions( input_item_t *p_parent,
                                          input_item_t *p_child )
118 119 120 121 122
{
    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
123 124 125 126 127
        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;
128 129 130
    }
}

131 132
VLC_EXPORT( void, input_ItemAddOption,( input_item_t *, const char * ) );
VLC_EXPORT( void, input_ItemAddOptionNoDup,( input_item_t *, const char * ) );
133

134
static inline void input_ItemClean( input_item_t *p_i )
135
{
136 137
    int i;

138 139 140 141 142 143 144
    free( p_i->psz_name );
    free( p_i->psz_uri );
    if( p_i->p_stats )
    {
        vlc_mutex_destroy( &p_i->p_stats->lock );
        free( p_i->p_stats );
    }
145

146 147
    if( p_i->p_meta )
        vlc_meta_Delete( p_i->p_meta );
148

149
    for( i = 0; i < p_i->i_options; i++ )
150
    {
151 152
        if( p_i->ppsz_options[i] )
            free( p_i->ppsz_options[i] );
153
    }
154
    TAB_CLEAN( p_i->i_options, p_i->ppsz_options );
155

156
    for( i = 0; i < p_i->i_es; i++ )
157
    {
158 159
        es_format_Clean( p_i->es[i] );
        free( p_i->es[i] );
160
    }
161
    TAB_CLEAN( p_i->i_es, p_i->es );
162

163
    for( i = 0; i < p_i->i_categories; i++ )
164
    {
165 166
        info_category_t *p_category = p_i->pp_categories[i];
        int j;
167

168
        for( j = 0; j < p_category->i_infos; j++ )
169
        {
170
            struct info_t *p_info = p_category->pp_infos[j];
171

172 173 174 175 176
            if( p_info->psz_name )
                free( p_info->psz_name);
            if( p_info->psz_value )
                free( p_info->psz_value );
            free( p_info );
177
        }
178
        TAB_CLEAN( p_category->i_infos, p_category->pp_infos );
179 180 181 182

        if( p_category->psz_name ) free( p_category->psz_name );
        free( p_category );
    }
183
    TAB_CLEAN( p_i->i_categories, p_i->pp_categories );
184 185 186

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

188 189
VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) );
190

191 192
#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)
193 194
VLC_EXPORT( input_item_t *, __input_ItemNewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
VLC_EXPORT( input_item_t *, input_ItemNewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
195 196 197

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

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

static inline seekpoint_t *vlc_seekpoint_New( void )
{
    seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
    point->i_byte_offset =
213
    point->i_time_offset = -1;
214
    point->i_level = 0;
Laurent Aimar's avatar
Laurent Aimar committed
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
    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;

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
253
static inline input_title_t *vlc_input_title_New(void)
Laurent Aimar's avatar
Laurent Aimar committed
254 255 256 257 258 259 260 261 262 263 264 265
{
    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;
}
266

Laurent Aimar's avatar
Laurent Aimar committed
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 310 311 312 313
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
{
314
    INIT_S,
315 316
    OPENING_S,
    BUFFERING_S,
Laurent Aimar's avatar
Laurent Aimar committed
317 318
    PLAYING_S,
    PAUSE_S,
319 320
    END_S,
    ERROR_S
Laurent Aimar's avatar
Laurent Aimar committed
321 322
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
323 324 325 326
/* "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
327 328
#define INPUT_RATE_DEFAULT  1000
#define INPUT_RATE_MIN       125            /* Up to 8/1 */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
329
#define INPUT_RATE_MAX     32000            /* Up to 1/32 */
Laurent Aimar's avatar
Laurent Aimar committed
330 331 332 333 334 335

/* 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
336
#define INPUT_UPDATE_META       0x0040
Laurent Aimar's avatar
Laurent Aimar committed
337 338 339 340

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

Clément Stenac's avatar
Clément Stenac committed
341 342 343 344 345 346 347 348 349 350
/** Get the input item for an input thread */
VLC_EXPORT(input_item_t*, input_GetItem, (input_thread_t*));

typedef struct input_thread_private_t input_thread_private_t;

/**
 * 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
351 352
struct input_thread_t
{
Clément Stenac's avatar
Clément Stenac committed
353
    VLC_COMMON_MEMBERS;
Laurent Aimar's avatar
Laurent Aimar committed
354 355

    vlc_bool_t  b_eof;
Clément Stenac's avatar
Clément Stenac committed
356
    vlc_bool_t b_preparsing;
357

Clément Stenac's avatar
Clément Stenac committed
358
    int i_state;
359
    vlc_bool_t b_can_pace_control;
Laurent Aimar's avatar
Laurent Aimar committed
360
    int64_t     i_time;     /* Current time */
361

Clément Stenac's avatar
Clément Stenac committed
362 363 364 365 366 367
    /* Internal caching common to all inputs */
    int i_pts_delay;

    /* 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
368 369 370 371 372 373 374
};

/*****************************************************************************
 * 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 * ) );
375 376
#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
377 378

#define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
379
VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, vlc_bool_t ) );
Laurent Aimar's avatar
Laurent Aimar committed
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
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    */

404
    /* input variable "audio-delay" and "sub-delay" */
405 406 407 408 409 410
    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 */
411 412 413 414
    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    */
415

416 417 418 419 420 421 422
    /* 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
423 424 425 426 427 428 429
    /* 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    */
430 431

    /* On the fly input slave */
Clément Stenac's avatar
Clément Stenac committed
432
    INPUT_ADD_SLAVE        /* arg1= char * */
Laurent Aimar's avatar
Laurent Aimar committed
433 434 435 436 437 438 439 440 441
};

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 * ) );

442 443
VLC_EXPORT( vlc_bool_t, input_AddSubtitles, ( input_thread_t *, char *, vlc_bool_t ) );

Laurent Aimar's avatar
Laurent Aimar committed
444
#endif