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

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

29
#include <vlc_es.h>
30
#include <vlc_meta.h>
Laurent Aimar's avatar
Laurent Aimar committed
31
#include <vlc_epg.h>
32
#include <vlc_events.h>
33

34
#include <string.h>                                     /* strcasestr() */
35

36 37
struct vlc_meta_t;

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

Laurent Aimar's avatar
Laurent Aimar committed
59 60
    char       *psz_name;            /**< text describing this item */
    char       *psz_uri;             /**< mrl of this item */
Jean-Paul Saman's avatar
Jean-Paul Saman committed
61
    bool       b_fixed_name;        /**< Can the interface change the name ?*/
Laurent Aimar's avatar
Laurent Aimar committed
62 63 64

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

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

70 71
    uint8_t    i_type;               /**< Type (file, disc, ...) */

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;
82 83 84

    vlc_event_manager_t event_manager;

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

88
#define ITEM_TYPE_UNKNOWN       0
89 90 91 92 93 94 95 96 97
#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
98

99 100
static inline void input_ItemCopyOptions( input_item_t *p_parent,
                                          input_item_t *p_child )
101 102 103 104 105
{
    int i;
    for( i = 0 ; i< p_parent->i_options; i++ )
    {
        char *psz_option= strdup( p_parent->ppsz_options[i] );
106 107 108 109 110
        if( !strcmp( psz_option, "meta-file" ) )
        {
            free( psz_option );
            continue;
        }
Clément Stenac's avatar
Clément Stenac committed
111 112 113 114 115
        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;
116 117 118 119
        p_child->optflagc++;
        p_child->optflagv = (uint8_t *)realloc( p_child->optflagv,
                                                p_child->optflagc );
        p_child->optflagv[p_child->optflagc - 1] = p_parent->optflagv[i];
120 121 122
    }
}

123
static inline void input_item_SetName( input_item_t *p_item, const char *psz_name )
124
{
125
    free( p_item->psz_name );
126 127 128 129 130 131 132 133
    p_item->psz_name = strdup( psz_name );
}

/* 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. */
static inline void input_ItemAddSubItem( input_item_t *p_parent,
Pierre d'Herbemont's avatar
Pierre d'Herbemont committed
134
                                         input_item_t *p_child )
135 136 137 138 139 140 141 142 143 144 145
{
    vlc_event_t event;

    p_parent->i_type = ITEM_TYPE_PLAYLIST;

    /* Notify interested third parties */
    event.type = vlc_InputItemSubItemAdded;
    event.u.input_item_subitem_added.p_new_child = p_child;
    vlc_event_send( &p_parent->event_manager, &event );
}

146
/* Flags handled past input_ItemAddOpt() */
147 148
#define VLC_INPUT_OPTION_TRUSTED 0x2

149 150 151 152
/* Flags handled within input_ItemAddOpt() */
#define VLC_INPUT_OPTION_UNIQUE  0x100

VLC_EXPORT( int, input_ItemAddOpt, ( input_item_t *, const char *str, unsigned flags ) );
153 154

static inline
155
int input_ItemAddOption (input_item_t *item, const char *str)
156
{
157
    return input_ItemAddOpt (item, str, VLC_INPUT_OPTION_TRUSTED);
158
}
159

Laurent Aimar's avatar
Laurent Aimar committed
160

161
VLC_EXPORT( void, input_item_SetMeta, ( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz_val ));
162

163
static inline bool input_item_MetaMatch( input_item_t *p_i, vlc_meta_type_t meta_type, const char *psz )
164
{
Rafaël Carré's avatar
Rafaël Carré committed
165
    vlc_mutex_lock( &p_i->lock );
166 167 168
    if( !p_i->p_meta )
    {
        vlc_mutex_unlock( &p_i->lock );
169
        return false;
170
    }
171
    const char * meta = vlc_meta_Get( p_i->p_meta, meta_type );
172
    bool ret = meta && strcasestr( meta, psz );
Rafaël Carré's avatar
Rafaël Carré committed
173
    vlc_mutex_unlock( &p_i->lock );
174 175 176 177

    return ret;
}

178
static inline char * input_item_GetMeta( input_item_t *p_i, vlc_meta_type_t meta_type )
179
{
180
    char * psz = NULL;
Rafaël Carré's avatar
Rafaël Carré committed
181
    vlc_mutex_lock( &p_i->lock );
182

183
    if( !p_i->p_meta )
184
    {
Rafaël Carré's avatar
Rafaël Carré committed
185
        vlc_mutex_unlock( &p_i->lock );
186
        return NULL;
187
    }
188 189 190 191

    if( vlc_meta_Get( p_i->p_meta, meta_type ) )
        psz = strdup( vlc_meta_Get( p_i->p_meta, meta_type ) );

Rafaël Carré's avatar
Rafaël Carré committed
192
    vlc_mutex_unlock( &p_i->lock );
193
    return psz;
194 195
}

196
static inline char * input_item_GetName( input_item_t * p_i )
197
{
Rafaël Carré's avatar
Rafaël Carré committed
198
    vlc_mutex_lock( &p_i->lock );
199
    char *psz_s = p_i->psz_name ? strdup( p_i->psz_name ) : NULL;
Rafaël Carré's avatar
Rafaël Carré committed
200
    vlc_mutex_unlock( &p_i->lock );
201
    return psz_s;
202 203
}

204 205 206 207 208 209 210 211 212 213 214
static inline char * input_item_GetURI( input_item_t * p_i )
{
    vlc_mutex_lock( &p_i->lock );
    char *psz_s = p_i->psz_uri ? strdup( p_i->psz_uri ) : NULL;
    vlc_mutex_unlock( &p_i->lock );
    return psz_s;
}

static inline void input_item_SetURI( input_item_t * p_i, char * psz_uri )
{
    vlc_mutex_lock( &p_i->lock );
215 216
    free( p_i->psz_uri );
    p_i->psz_uri = strdup( psz_uri );
217 218 219 220 221 222 223 224 225 226 227 228 229
    vlc_mutex_unlock( &p_i->lock );
}

static inline mtime_t input_item_GetDuration( input_item_t * p_i )
{
    vlc_mutex_lock( &p_i->lock );
    mtime_t i_duration = p_i->i_duration;
    vlc_mutex_unlock( &p_i->lock );
    return i_duration;
}

static inline void input_item_SetDuration( input_item_t * p_i, mtime_t i_duration )
{
230
    bool send_event = false;
231

232
    vlc_mutex_lock( &p_i->lock );
233 234 235
    if( p_i->i_duration != i_duration )
    {
        p_i->i_duration = i_duration;
236
        send_event = true;
237
    }
238
    vlc_mutex_unlock( &p_i->lock );
239

240
    if ( send_event == true )
241 242 243 244 245 246
    {
        vlc_event_t event;
        event.type = vlc_InputItemDurationChanged;
        event.u.input_item_duration_changed.new_duration = i_duration;
        vlc_event_send( &p_i->event_manager, &event );
    }
247

248 249 250
    return;
}

251

252
static inline bool input_item_IsPreparsed( input_item_t *p_i )
253
{
254
    return p_i->p_meta ? p_i->p_meta->i_status & ITEM_PREPARSED : false ;
255 256
}

257
static inline bool input_item_IsArtFetched( input_item_t *p_i )
258
{
259
    return p_i->p_meta ? p_i->p_meta->i_status & ITEM_ART_FETCHED : false ;
260 261 262 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 310 311 312
}

static inline const vlc_meta_t * input_item_GetMetaObject( input_item_t *p_i )
{
    if( !p_i->p_meta )
        p_i->p_meta = vlc_meta_New();

    return p_i->p_meta;
}

static inline void input_item_MetaMerge( input_item_t *p_i, const vlc_meta_t * p_new_meta )
{
    if( !p_i->p_meta )
        p_i->p_meta = vlc_meta_New();

    vlc_meta_Merge( p_i->p_meta, p_new_meta );
}

#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 )
313
#define input_item_GetSetting( item )        input_item_GetMeta( item, vlc_meta_Setting )
314

315
VLC_EXPORT( char *, input_ItemGetInfo, ( input_item_t *p_i, const char *psz_cat,const char *psz_name ) );
316
VLC_EXPORT(int, input_ItemAddInfo, ( input_item_t *p_i, const char *psz_cat, const char *psz_name, const char *psz_format, ... ) LIBVLC_FORMAT( 4, 5 ) );
317

318 319
#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)
320 321
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 ) );
322

323 324
#define input_ItemGetById(a,b) __input_ItemGetById( VLC_OBJECT(a),b )
VLC_EXPORT( input_item_t *, __input_ItemGetById, (vlc_object_t *, int ) );
325

326 327 328 329 330 331
/*****************************************************************************
 * Meta data helpers
 *****************************************************************************/
static inline void vlc_audio_replay_gain_MergeFromMeta( audio_replay_gain_t *p_dst,
                                                        const vlc_meta_t *p_meta )
{
332 333
    char * psz_value;

334 335 336
    if( !p_meta )
        return;

337 338
    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" )) )
339
    {
340
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_TRACK] = true;
341 342 343 344 345
        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" )) )
    {
346
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_TRACK] = true;
347 348 349 350 351
        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" )) )
    {
352
        p_dst->pb_gain[AUDIO_REPLAY_GAIN_ALBUM] = true;
353 354 355 356
        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" )) )
    {
357
        p_dst->pb_peak[AUDIO_REPLAY_GAIN_ALBUM] = true;
358
        p_dst->pf_peak[AUDIO_REPLAY_GAIN_ALBUM] = atof( psz_value );
359 360 361
    }
}

Laurent Aimar's avatar
Laurent Aimar committed
362 363 364 365 366 367 368 369
/*****************************************************************************
 * Seek point: (generalisation of chapters)
 *****************************************************************************/
struct seekpoint_t
{
    int64_t i_byte_offset;
    int64_t i_time_offset;
    char    *psz_name;
370
    int     i_level;
Laurent Aimar's avatar
Laurent Aimar committed
371 372 373 374 375 376
};

static inline seekpoint_t *vlc_seekpoint_New( void )
{
    seekpoint_t *point = (seekpoint_t*)malloc( sizeof( seekpoint_t ) );
    point->i_byte_offset =
377
    point->i_time_offset = -1;
378
    point->i_level = 0;
Laurent Aimar's avatar
Laurent Aimar committed
379 380 381 382 383 384 385
    point->psz_name = NULL;
    return point;
}

static inline void vlc_seekpoint_Delete( seekpoint_t *point )
{
    if( !point ) return;
386
    free( point->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405
    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
406
    bool        b_menu;      /* Is it a menu or a normal entry */
Laurent Aimar's avatar
Laurent Aimar committed
407 408 409 410 411 412 413 414 415 416

    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
417
static inline input_title_t *vlc_input_title_New(void)
Laurent Aimar's avatar
Laurent Aimar committed
418 419 420 421
{
    input_title_t *t = (input_title_t*)malloc( sizeof( input_title_t ) );

    t->psz_name = NULL;
422
    t->b_menu = false;
Laurent Aimar's avatar
Laurent Aimar committed
423 424 425 426 427 428 429
    t->i_length = 0;
    t->i_size   = 0;
    t->i_seekpoint = 0;
    t->seekpoint = NULL;

    return t;
}
430

Laurent Aimar's avatar
Laurent Aimar committed
431 432 433 434 435 436
static inline void vlc_input_title_Delete( input_title_t *t )
{
    int i;
    if( t == NULL )
        return;

437
    free( t->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
438 439
    for( i = 0; i < t->i_seekpoint; i++ )
    {
440
        free( t->seekpoint[i]->psz_name );
Laurent Aimar's avatar
Laurent Aimar committed
441 442
        free( t->seekpoint[i] );
    }
443
    free( t->seekpoint );
Laurent Aimar's avatar
Laurent Aimar committed
444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
    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
470

471 472 473 474 475 476 477 478
/*****************************************************************************
 * Attachments
 *****************************************************************************/
struct input_attachment_t
{
    char *psz_name;
    char *psz_mime;
    char *psz_description;
Laurent Aimar's avatar
Laurent Aimar committed
479

480 481 482
    int  i_data;
    void *p_data;
};
Jean-Paul Saman's avatar
Jean-Paul Saman committed
483

484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518
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 );
519
    free( a->p_data );
520 521
    free( a );
}
Jean-Paul Saman's avatar
Jean-Paul Saman committed
522

Laurent Aimar's avatar
Laurent Aimar committed
523 524 525 526 527
/*****************************************************************************
 * input defines/constants.
 *****************************************************************************/

/* "state" value */
528 529
/* NOTE: you need to update ppsz_input_state in the RC interface
 * if you modify this list. */
Laurent Aimar's avatar
Laurent Aimar committed
530 531
enum input_state_e
{
532
    INIT_S = 0,
533 534
    OPENING_S,
    BUFFERING_S,
Laurent Aimar's avatar
Laurent Aimar committed
535 536
    PLAYING_S,
    PAUSE_S,
537
    STOP_S,
538 539
    FORWARD_S,
    BACKWARD_S,
540
    END_S,
541
    ERROR_S,
Laurent Aimar's avatar
Laurent Aimar committed
542 543
};

Jean-Paul Saman's avatar
Jean-Paul Saman committed
544 545 546 547
/* "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
548 549
#define INPUT_RATE_DEFAULT  1000
#define INPUT_RATE_MIN       125            /* Up to 8/1 */
Sigmund Augdal Helberg's avatar
Sigmund Augdal Helberg committed
550
#define INPUT_RATE_MAX     32000            /* Up to 1/32 */
Laurent Aimar's avatar
Laurent Aimar committed
551 552 553 554 555 556

/* 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
557
#define INPUT_UPDATE_META       0x0040
Laurent Aimar's avatar
Laurent Aimar committed
558 559 560 561

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

Clément Stenac's avatar
Clément Stenac committed
562 563 564 565 566 567 568 569 570 571
/** 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
572 573
struct input_thread_t
{
Clément Stenac's avatar
Clément Stenac committed
574
    VLC_COMMON_MEMBERS;
Laurent Aimar's avatar
Laurent Aimar committed
575

576 577
    bool  b_eof;
    bool b_preparsing;
578

Clément Stenac's avatar
Clément Stenac committed
579
    int i_state;
580
    bool b_can_pace_control;
Laurent Aimar's avatar
Laurent Aimar committed
581
    int64_t     i_time;     /* Current time */
582

Clément Stenac's avatar
Clément Stenac committed
583
    /* Internal caching common to all inputs */
584
    mtime_t i_pts_delay;
Clément Stenac's avatar
Clément Stenac committed
585 586 587 588

    /* 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
589 590 591 592 593
};

/*****************************************************************************
 * Prototypes
 *****************************************************************************/
594 595 596

/* input_CreateThread
 * Release the returned input_thread_t using vlc_object_release() */
Laurent Aimar's avatar
Laurent Aimar committed
597 598
#define input_CreateThread(a,b) __input_CreateThread(VLC_OBJECT(a),b)
VLC_EXPORT( input_thread_t *, __input_CreateThread, ( vlc_object_t *, input_item_t * ) );
599

600 601
#define input_Preparse(a,b) __input_Preparse(VLC_OBJECT(a),b)
VLC_EXPORT( int, __input_Preparse, ( vlc_object_t *, input_item_t * ) );
602 603

#define input_Read(a,b,c) __input_Read(VLC_OBJECT(a),b, c)
604
VLC_EXPORT( int, __input_Read, ( vlc_object_t *, input_item_t *, bool ) );
Laurent Aimar's avatar
Laurent Aimar committed
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627
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    */

628
    /* input variable "audio-delay" and "sub-delay" */
629 630 631 632 633 634
    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 */
635 636 637 638
    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    */
639

640 641 642 643 644 645
    /* 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=    */
646
    INPUT_GET_VIDEO_FPS,         /* arg1= double *        res=can fail */
647

Laurent Aimar's avatar
Laurent Aimar committed
648 649 650 651 652 653 654
    /* 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    */
655

656 657 658 659
    /* 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 */

660
    /* On the fly input slave */
Clément Stenac's avatar
Clément Stenac committed
661
    INPUT_ADD_SLAVE        /* arg1= char * */
Laurent Aimar's avatar
Laurent Aimar committed
662 663 664 665 666
};

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

667
VLC_EXPORT( decoder_t *, input_DecoderNew, ( input_thread_t *, es_format_t *, bool b_force_decoder ) );
Laurent Aimar's avatar
Laurent Aimar committed
668 669 670
VLC_EXPORT( void, input_DecoderDelete, ( decoder_t * ) );
VLC_EXPORT( void, input_DecoderDecode,( decoder_t *, block_t * ) );

671
VLC_EXPORT( bool, input_AddSubtitles, ( input_thread_t *, char *, bool ) );
672

673 674
VLC_EXPORT( vlc_event_manager_t *, input_get_event_manager, ( input_thread_t * ) );

Laurent Aimar's avatar
Laurent Aimar committed
675
#endif