playlist_internal.h 6.84 KB
Newer Older
1
/*****************************************************************************
2
 * playlist_internal.h : Playlist internals
3
 *****************************************************************************
4
 * Copyright (C) 1999-2008 the VideoLAN team
Jean-Paul Saman's avatar
Jean-Paul Saman committed
5
 * $Id$
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *          Clément Stenac <zorglub@videolan.org>
 *
 * 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
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
 *****************************************************************************/

25 26 27
#ifndef __LIBVLC_PLAYLIST_INTERNAL_H
# define __LIBVLC_PLAYLIST_INTERNAL_H 1

28 29 30 31 32 33 34 35 36
/**
 *  \file
 *  This file contain internal structures and function prototypes related
 *  to the playlist in vlc
 *
 * \defgroup vlc_playlist Playlist
 * @{
 */

37
#include "input/input_interface.h"
38
#include <assert.h>
Clément Stenac's avatar
Clément Stenac committed
39

40 41 42
#include "art.h"
#include "fetcher.h"
#include "preparser.h"
43

44
typedef struct playlist_private_t
45
{
46
    playlist_t           public_data;
47 48 49
    playlist_preparser_t *p_preparser;  /**< Preparser data */
    playlist_fetcher_t   *p_fetcher;    /**< Meta and art fetcher data */
    sout_instance_t      *p_sout;       /**< Kept sout instance */
50

51 52 53
    playlist_item_array_t items_to_delete; /**< Array of items and nodes to
            delete... At the very end. This sucks. */

54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
    struct playlist_services_discovery_support_t {
        /* the playlist items for category and onelevel */
        playlist_item_t*    p_cat;
        playlist_item_t*    p_one;
        services_discovery_t * p_sd; /**< Loaded service discovery modules */
    } ** pp_sds;
    int                   i_sds;   /**< Number of service discovery modules */
    input_thread_t *      p_input;  /**< the input thread associated
                                     * with the current item */
    struct {
        /* Current status. These fields are readonly, only the playlist
         * main loop can touch it*/
        playlist_status_t   i_status;  /**< Current status of playlist */
        playlist_item_t *   p_item; /**< Currently playing/active item */
        playlist_item_t *   p_node; /**< Current node to play from */
    } status;

    struct {
        /* Request. Use this to give orders to the playlist main loop  */
        playlist_status_t   i_status; /**< requested playlist status */
        playlist_item_t *   p_node;   /**< requested node to play from */
        playlist_item_t *   p_item;   /**< requested item to play in the node */

        int                 i_skip;   /**< Number of items to skip */

        bool          b_request;/**< Set to true by the requester
                                           The playlist sets it back to false
                                           when processing the request */
        vlc_mutex_t         lock;     /**< Lock to protect request */
    } request;

85 86
    bool     b_tree; /**< Display as a tree */
    bool     b_doing_ml; /**< Doing media library stuff  get quicker */
87
    bool     b_auto_preparse;
88
    bool     b_cant_sleep;
89
    mtime_t  gc_date;
90
    mtime_t  last_rebuild_date;
91
    bool     b_reset_currently_playing; /** Reset current item array */
92
    int      i_last_playlist_id; /**< Last id to an item */
93

94 95 96
} playlist_private_t;

#define pl_priv( pl ) ((playlist_private_t *)(pl))
97 98 99 100 101

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

102 103 104 105
/* Global thread */
#define playlist_ThreadCreate(a) __playlist_ThreadCreate(VLC_OBJECT(a))
void        __playlist_ThreadCreate   ( vlc_object_t * );

106 107 108
playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
                                              input_item_t *p_input );

109 110 111 112 113 114
/* Creation/Deletion */
playlist_t *playlist_Create   ( vlc_object_t * );

/* Engine */
void playlist_MainLoop( playlist_t * );
void playlist_LastLoop( playlist_t * );
115
void *playlist_PreparseLoop( void * );
116
void *playlist_FetcherLoop( void * );
117

118
void ResetCurrentlyPlaying( playlist_t *, bool, playlist_item_t * );
119

120 121 122 123 124
playlist_item_t * get_current_status_item( playlist_t * p_playlist);
playlist_item_t * get_current_status_node( playlist_t * p_playlist );
void set_current_status_item( playlist_t *, playlist_item_t * );
void set_current_status_node( playlist_t *, playlist_item_t * );

125 126 127 128 129 130 131 132 133 134 135 136
/* Control */
playlist_item_t * playlist_NextItem  ( playlist_t * );
int playlist_PlayItem  ( playlist_t *, playlist_item_t * );

/* Load/Save */
int playlist_MLLoad( playlist_t *p_playlist );
int playlist_MLDump( playlist_t *p_playlist );

/**********************************************************************
 * Item management
 **********************************************************************/

137
void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
138
                             int i_node_id, bool b_signal );
139

140 141 142
playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
        playlist_item_t *,int , int, bool );

143
/* Tree walking */
144 145 146 147
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
                                   int i_input_id, playlist_item_t *p_root,
                                   bool );

148
int playlist_DeleteFromInputInParent( playlist_t *, int, playlist_item_t *, bool );
149
int playlist_DeleteFromItemId( playlist_t*, int );
150
int playlist_ItemRelease( playlist_item_t * );
151

152 153 154
void playlist_release_current_input( playlist_t * p_playlist );
void playlist_set_current_input(
    playlist_t * p_playlist, input_thread_t * p_input );
155

156

157 158 159 160
/**
 * @}
 */

161
#define PLAYLIST_DEBUG 1
162
//#undef PLAYLIST_DEBUG2
163 164

#ifdef PLAYLIST_DEBUG
165 166 167 168 169 170
 #define PL_DEBUG( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 #ifdef PLAYLIST_DEBUG2
  #define PL_DEBUG2( msg, args... ) msg_Dbg( p_playlist, msg, ## args )
 #else
  #define PL_DEBUG2( msg, args... ) {}
 #endif
171
#else
172 173
 #define PL_DEBUG( msg, args ... ) {}
 #define PL_DEBUG2( msg, args... ) {}
174 175
#endif

176
#define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
177

178 179 180 181 182 183 184 185 186 187 188
#define PL_LOCK_IF( cond ) pl_lock_if( p_playlist, cond )
static inline void pl_lock_if( playlist_t * p_playlist, bool cond )
{
    if( cond ) PL_LOCK; else PL_ASSERT_LOCKED;
}

#define PL_UNLOCK_IF( cond ) pl_unlock_if( p_playlist, cond )
static inline void pl_unlock_if( playlist_t * p_playlist, bool cond )
{
    if( cond ) PL_UNLOCK;
}
189

190
#endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */