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

39
#include <string.h>                                     /* strcasestr() */
40

41 42
struct vlc_meta_t;

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

Laurent Aimar's avatar
Laurent Aimar committed
64 65
    char       *psz_name;            /**< text describing this item */
    char       *psz_uri;             /**< mrl of this item */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
66
    bool       b_fixed_name;        /**< Can the interface change the name ?*/
Laurent Aimar's avatar
Laurent Aimar committed
67 68 69

    int        i_options;            /**< Number of input options */
    char       **ppsz_options;       /**< Array of input options */
70 71
    uint8_t    *optflagv;            /**< Some flags of input options */
    unsigned   optflagc;
Laurent Aimar's avatar
Laurent Aimar committed
72

73
    mtime_t    i_duration;           /**< Duration in milliseconds*/
Laurent Aimar's avatar
Laurent Aimar committed
74

75
    uint8_t    i_type;               /**< Type (file, disc, ...) */
Geoffroy Couprie's avatar
Geoffroy Couprie committed
76
    bool b_prefers_tree;             /**< Do we prefer being displayed as tree*/
77

Laurent Aimar's avatar
Laurent Aimar committed
78 79 80
    int        i_categories;         /**< Number of info categories */
    info_category_t **pp_categories; /**< Pointer to the first info category */

81
    int         i_es;                /**< Number of es format descriptions */
82
    es_format_t **es;                /**< Es formats */
Clément Stenac's avatar
Clément Stenac committed
83

Clément Stenac's avatar
Clément Stenac committed
84
    input_stats_t *p_stats;          /**< Statistics */
85 86
    int           i_nb_played;       /**< Number of times played */

87 88
    bool          b_error_when_reading;       /**< Error When Reading */

89
    vlc_meta_t *p_meta;
90 91 92

    vlc_event_manager_t event_manager;

93
    vlc_mutex_t lock;                 /**< Lock for the item */
Laurent Aimar's avatar
Laurent Aimar committed
94 95
};

96
#define ITEM_TYPE_UNKNOWN       0
97 98 99 100 101 102 103 104 105
#define ITEM_TYPE_FILE          1
#define ITEM_TYPE_DIRECTORY     2
#define ITEM_TYPE_DISC          3
#define ITEM_TYPE_CDDA          4
#define ITEM_TYPE_CARD          5
#define ITEM_TYPE_NET           6
#define ITEM_TYPE_PLAYLIST      7
#define ITEM_TYPE_NODE          8
#define ITEM_TYPE_NUMBER        9
106

107 108
VLC_EXPORT( void, input_item_CopyOptions, ( input_item_t *p_parent, input_item_t *p_child ) );
VLC_EXPORT( void, input_item_SetName, ( input_item_t *p_item, const char *psz_name ) );
109 110 111 112 113

/* This won't hold the item, but can tell to interested third parties
 * Like the playlist, that there is a new sub item. With this design
 * It is not the input item's responsability to keep all the ref of
 * the input item children. */
114
VLC_EXPORT( void, input_item_AddSubItem, ( input_item_t *p_parent, input_item_t *p_child ) );
115 116


117
/* Flags handled past input_item_AddOpt() */
118 119
#define VLC_INPUT_OPTION_TRUSTED 0x2

120
/* Flags handled within input_item_AddOpt() */
121 122
#define VLC_INPUT_OPTION_UNIQUE  0x100

123
VLC_EXPORT( int, input_item_AddOpt, ( input_item_t *, const char *str, unsigned flags ) );
124 125 126
VLC_EXPORT( int, input_item_AddOption, (input_item_t *item, const char *str) );
VLC_EXPORT( int ,input_item_AddOption, (input_item_t *item, const char *str) );
VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) );
127
VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
128

129
VLC_EXPORT( bool,input_item_HasErrorWhenReading, (input_item_t *item) );
130

131 132 133 134 135 136 137 138 139 140 141
VLC_EXPORT( bool,input_item_MetaMatch, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz ) );
VLC_EXPORT( char *, input_item_GetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type ) );
VLC_EXPORT( char *, input_item_GetName, ( input_item_t * p_i ) );
VLC_EXPORT( char *, input_item_GetURI, ( input_item_t * p_i ) );
VLC_EXPORT( void,   input_item_SetURI, ( input_item_t * p_i, char * psz_uri ));
VLC_EXPORT(mtime_t, input_item_GetDuration, ( input_item_t * p_i ) );
VLC_EXPORT( void,   input_item_SetDuration, ( input_item_t * p_i, mtime_t i_duration ));
VLC_EXPORT( bool,   input_item_IsPreparsed, ( input_item_t *p_i ));
VLC_EXPORT( bool,   input_item_IsArtFetched, ( input_item_t *p_i ));
VLC_EXPORT( const vlc_meta_t *, input_item_GetMetaObject, ( input_item_t *p_i ));
VLC_EXPORT( void,   input_item_MetaMerge, ( input_item_t *p_i, const vlc_meta_t * p_new_meta ));
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


#define input_item_SetTitle( item, b )       input_item_SetMeta( item, vlc_meta_Title, b )
#define input_item_SetArtist( item, b )      input_item_SetMeta( item, vlc_meta_Artist, b )
#define input_item_SetGenre( item, b )       input_item_SetMeta( item, vlc_meta_Genre, b )
#define input_item_SetCopyright( item, b )   input_item_SetMeta( item, vlc_meta_Copyright, b )
#define input_item_SetAlbum( item, b )       input_item_SetMeta( item, vlc_meta_Album, b )
#define input_item_SetTrackNum( item, b )    input_item_SetMeta( item, vlc_meta_TrackNumber, b )
#define input_item_SetDescription( item, b ) input_item_SetMeta( item, vlc_meta_Description, b )
#define input_item_SetRating( item, b )      input_item_SetMeta( item, vlc_meta_Rating, b )
#define input_item_SetDate( item, b )        input_item_SetMeta( item, vlc_meta_Date, b )
#define input_item_SetSetting( item, b )     input_item_SetMeta( item, vlc_meta_Setting, b )
#define input_item_SetURL( item, b )         input_item_SetMeta( item, vlc_meta_URL, b )
#define input_item_SetLanguage( item, b )    input_item_SetMeta( item, vlc_meta_Language, b )
#define input_item_SetNowPlaying( item, b )  input_item_SetMeta( item, vlc_meta_NowPlaying, b )
#define input_item_SetPublisher( item, b )   input_item_SetMeta( item, vlc_meta_Publisher, b )
#define input_item_SetEncodedBy( item, b )   input_item_SetMeta( item, vlc_meta_EncodedBy, b )
#define input_item_SetArtURL( item, b )      input_item_SetMeta( item, vlc_meta_ArtworkURL, b )
#define input_item_SetTrackID( item, b )     input_item_SetMeta( item, vlc_meta_TrackID, b )

#define input_item_GetTitle( item )          input_item_GetMeta( item, vlc_meta_Title )
#define input_item_GetArtist( item )         input_item_GetMeta( item, vlc_meta_Artist )
#define input_item_GetGenre( item )          input_item_GetMeta( item, vlc_meta_Genre )
#define input_item_GetCopyright( item )      input_item_GetMeta( item, vlc_meta_Copyright )
#define input_item_GetAlbum( item )          input_item_GetMeta( item, vlc_meta_Album )
#define input_item_GetTrackNum( item )       input_item_GetMeta( item, vlc_meta_TrackNumber )
#define input_item_GetDescription( item )    input_item_GetMeta( item, vlc_meta_Description )
#define input_item_GetRating( item )         input_item_GetMeta( item, vlc_meta_Rating )
#define input_item_GetDate( item )           input_item_GetMeta( item, vlc_meta_Date )
#define input_item_GetGetting( item )        input_item_GetMeta( item, vlc_meta_Getting )
#define input_item_GetURL( item )            input_item_GetMeta( item, vlc_meta_URL )
#define input_item_GetLanguage( item )       input_item_GetMeta( item, vlc_meta_Language )
#define input_item_GetNowPlaying( item )     input_item_GetMeta( item, vlc_meta_NowPlaying )
#define input_item_GetPublisher( item )      input_item_GetMeta( item, vlc_meta_Publisher )
#define input_item_GetEncodedBy( item )      input_item_GetMeta( item, vlc_meta_EncodedBy )
#define input_item_GetArtURL( item )         input_item_GetMeta( item, vlc_meta_ArtworkURL )
#define input_item_GetTrackID( item )        input_item_GetMeta( item, vlc_meta_TrackID )
179
#define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
180

181 182
VLC_EXPORT( char *, input_item_GetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
VLC_EXPORT(int, input_item_AddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
183

184 185 186 187
#define input_item_New( a,b,c ) input_item_NewExt( a, b, c, 0, NULL, -1 )
#define input_item_NewExt(a,b,c,d,e,f) __input_item_NewExt( VLC_OBJECT(a),b,c,d,e,f)
VLC_EXPORT( input_item_t *, __input_item_NewExt, (vlc_object_t *, const char *, const char*, int, const char *const *, mtime_t i_duration )  );
VLC_EXPORT( input_item_t *, input_item_NewWithType, ( vlc_object_t *, const char *, const char *e, int, const char *const *, mtime_t i_duration, int ) );
188

189 190 191 192 193 194
/*****************************************************************************
 * Meta data helpers
 *****************************************************************************/
static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
                                                        const vlc_meta_t *p_meta )
{
195 196
    char * psz_value;

197 198 199
    if( !p_meta )
        return;

200 201
    if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_GAIN" )) ||
        (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_RADIO" )) )
202
    {
203
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
204 205 206 207 208
        p_dst->pf_gain[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_TRACK_PEAK" )) ||
             (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_PEAK" )) )
    {
209
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
210 211 212 213 214
        p_dst->pf_peak[AUDIO_REPLAY_GAIN_TRACK] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_GAIN" )) ||
             (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "RG_AUDIOPHILE" )) )
    {
215
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
216 217 218 219
        p_dst->pf_gain[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
    }
    else if( (psz_value = (char *)vlc_dictionary_value_for_key( &p_meta->extra_tags, "REPLAYGAIN_ALBUM_PEAK" )) )
    {
220
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
221
        p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
222 223 224
    }
}

Laurent Aimar's avatar
Laurent Aimar committed
225 226 227 228 229 230 231 232
/*****************************************************************************
 * Seek point: (generalisation of chapters)
 *****************************************************************************/
struct seekpoint_t
{
    int64_t i_byte_offset;
    int64_t i_time_offset;
    char    *psz_name;
233
    int     i_level;
Laurent Aimar's avatar
Laurent Aimar committed
234 235 236 237 238 239
};

static inline seekpoint_t *vlc_seekpoint_New( void )
{
    seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
    point->i_byte_offset =
240
    point->i_time_offset = -1;
241
    point->i_level = 0;
Laurent Aimar's avatar
Laurent Aimar committed
242 243 244 245 246 247 248
    point->psz_name = NULL;
    return point;
}

static inline void vlc_seekpoint_Delete( seekpoint_t *point )
{
    if( !point ) return;
249
    free( point->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268
    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;

Jean-Paul Saman's avatar
Jean-Paul Saman committed
269
    bool        b_menu;      /* Is it a menu or a normal entry */
Laurent Aimar's avatar
Laurent Aimar committed
270 271 272 273 274 275 276 277 278 279

    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
280
static inline input_title_t *vlc_input_title_New(void)
Laurent Aimar's avatar
Laurent Aimar committed
281 282 283 284
{
    input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );

    t->psz_name = NULL;
285
    t->b_menu = false;
Laurent Aimar's avatar
Laurent Aimar committed
286 287 288 289 290 291 292
    t->i_length = 0;
    t->i_size   = 0;
    t->i_seekpoint = 0;
    t->seekpoint = NULL;

    return t;
}
293

Laurent Aimar's avatar
Laurent Aimar committed
294 295 296 297 298 299
static inline void vlc_input_title_Delete( input_title_t *t )
{
    int i;
    if( t == NULL )
        return;

300
    free( t->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
301 302
    for( i = 0; i < t->i_seekpoint; i++ )
    {
303
        free( t->seekpoint[i]->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
304 305
        free( t->seekpoint[i] );
    }
306
    free( t->seekpoint );
Laurent Aimar's avatar
Laurent Aimar committed
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
    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;
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
333

334 335 336 337 338 339 340 341
/*****************************************************************************
 * Attachments
 *****************************************************************************/
struct input_attachment_t
{
    char *psz_name;
    char *psz_mime;
    char *psz_description;
Laurent Aimar's avatar
Laurent Aimar committed
342

343 344 345
    int  i_data;
    void *p_data;
};
Jean-Paul Saman's avatar
Jean-Paul Saman committed
346

347 348 349 350 351 352 353 354 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 380 381
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 );
382
    free( a->p_data );
383 384
    free( a );
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
385

Laurent Aimar's avatar
Laurent Aimar committed
386 387 388 389 390
/*****************************************************************************
 * input defines/constants.
 *****************************************************************************/

/* "state" value */
391 392
/* NOTE: you need to update ppsz_input_state in the RC interface
 * if you modify this list. */
393
typedef enum input_state_e
Laurent Aimar's avatar
Laurent Aimar committed
394
{
395
    INIT_S = 0,
396 397
    OPENING_S,
    BUFFERING_S,
Laurent Aimar's avatar
Laurent Aimar committed
398 399
    PLAYING_S,
    PAUSE_S,
400
    STOP_S,
401 402
    FORWARD_S,
    BACKWARD_S,
403
    END_S,
404
    ERROR_S,
405
} input_state_e;
Laurent Aimar's avatar
Laurent Aimar committed
406

Jean-Paul Saman's avatar
Jean-Paul Saman committed
407 408 409 410
/* "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
411 412
#define INPUT_RATE_DEFAULT  1000
#define INPUT_RATE_MIN       125            /* Up to 8/1 */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
413
#define INPUT_RATE_MAX     32000            /* Up to 1/32 */
Laurent Aimar's avatar
Laurent Aimar committed
414 415 416 417 418 419

/* 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
420
#define INPUT_UPDATE_META       0x0040
421
#define INPUT_UPDATE_SIGNAL     0x0080
Laurent Aimar's avatar
Laurent Aimar committed
422 423 424 425

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

Clément Stenac's avatar
Clément Stenac committed
426 427 428 429 430 431 432 433 434 435
/** 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
436 437
struct input_thread_t
{
Clément Stenac's avatar
Clément Stenac committed
438
    VLC_COMMON_MEMBERS;
Laurent Aimar's avatar
Laurent Aimar committed
439

Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
440
    bool b_eof;
441
    bool b_preparsing;
Rémi Denis-Courmont's avatar
Rémi Denis-Courmont committed
442
    bool b_dead;
443

Clément Stenac's avatar
Clément Stenac committed
444
    int i_state;
445
    bool b_can_pace_control;
Laurent Aimar's avatar
Laurent Aimar committed
446
    int64_t     i_time;     /* Current time */
447

Clément Stenac's avatar
Clément Stenac committed
448
    /* Internal caching common to all inputs */
449
    mtime_t i_pts_delay;
Clément Stenac's avatar
Clément Stenac committed
450 451 452 453

    /* 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
454 455 456 457 458
};

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
459 460 461

/* input_CreateThread
 * Release the returned input_thread_t using vlc_object_release() */
Laurent Aimar's avatar
Laurent Aimar committed
462 463
#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 466
#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
467 468

#define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
469
VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
Laurent Aimar's avatar
Laurent Aimar committed
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
VLC_EXPORT( void,             input_StopThread,     ( 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    */

493
    /* input variable "audio-delay" and "sub-delay" */
494 495 496 497 498 499
    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 */
500 501 502 503
    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    */
504

505 506 507 508 509 510
    /* 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=    */
511
    INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
512

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

521 522 523 524
    /* 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 */

525
    /* On the fly input slave */
526 527 528 529 530
    INPUT_ADD_SLAVE,       /* arg1= char * */

    /* On the fly record while playing */
    INPUT_SET_RECORD_STATE, /* arg1=bool    res=can fail */
    INPUT_GET_RECORD_STATE, /* arg1=bool*   res=can fail */
531 532 533

    /* ES */
    INPUT_RESTART_ES,       /* arg1=int (-AUDIO/VIDEO/SPU_ES for the whole category) */
Laurent Aimar's avatar
Laurent Aimar committed
534 535 536 537 538
};

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

539 540 541 542 543 544
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;
}
545
VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, sout_instance_t * ) );
Laurent Aimar's avatar
Laurent Aimar committed
546 547 548
VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );

549
VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) );
550

551 552
VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) );

Laurent Aimar's avatar
Laurent Aimar committed
553 554 555 556 557 558 559 560 561
/**
 * 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.
 */
VLC_EXPORT( void, input_SplitMRL, ( const char **ppsz_access, const char **ppsz_demux, char **ppsz_path, char *psz_dup ) );

Laurent Aimar's avatar
Laurent Aimar committed
562
#endif