playlist_internal.h 6.72 KB
Newer Older
1
/*****************************************************************************
2
 * playlist_internal.h : Playlist internals
3
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 1999-2008 VLC authors and VideoLAN
Jean-Paul Saman's avatar
Jean-Paul Saman committed
5
 * $Id$
6 7 8 9
 *
 * Authors: Samuel Hocevar <sam@zoy.org>
 *          Clément Stenac <zorglub@videolan.org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
10 11 12
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation; either version 2.1 of the License, or
13 14 15 16
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
17 18
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
19
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
20 21 22
 * You should have received a copy of the GNU Lesser 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.
23 24
 *****************************************************************************/

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>
zorglub's avatar
zorglub committed
39

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

44
typedef struct vlc_sd_internal_t vlc_sd_internal_t;
45

46
typedef struct playlist_private_t
47
{
48
    playlist_t           public_data;
49 50
    playlist_preparser_t *p_preparser;  /**< Preparser data */
    playlist_fetcher_t   *p_fetcher;    /**< Meta and art fetcher data */
51

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

55
    vlc_sd_internal_t   **pp_sds;
56 57 58
    int                   i_sds;   /**< Number of service discovery modules */
    input_thread_t *      p_input;  /**< the input thread associated
                                     * with the current item */
59
    input_resource_t *   p_input_resource; /**< input resources */
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81
    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;

82
    vlc_thread_t thread; /**< engine thread */
83
    vlc_mutex_t lock; /**< dah big playlist global lock */
84
    vlc_cond_t signal; /**< wakes up the playlist engine thread */
85
    bool     killed; /**< playlist is shutting down */
86

87 88 89
    int      i_last_playlist_id; /**< Last id to an item */
    bool     b_reset_currently_playing; /** Reset current item array */

90 91
    bool     b_tree; /**< Display as a tree */
    bool     b_doing_ml; /**< Doing media library stuff  get quicker */
92
    bool     b_auto_preparse;
93 94 95
} playlist_private_t;

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

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

101 102
/* Creation/Deletion */
playlist_t *playlist_Create( vlc_object_t * );
103
void playlist_Destroy( playlist_t * );
104 105 106

/* */
void playlist_Activate( playlist_t * );
107
void pl_Deactivate (libvlc_int_t *);
108

109
/* */
110
playlist_item_t *playlist_ItemNewFromInput( playlist_t *p_playlist,
jpd's avatar
jpd committed
111
                                            input_item_t *p_input );
112

113
/* Engine */
114 115 116 117 118
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 * );

119 120 121 122 123 124 125 126
/* Load/Save */
int playlist_MLLoad( playlist_t *p_playlist );
int playlist_MLDump( playlist_t *p_playlist );

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

127
void playlist_SendAddNotify( playlist_t *p_playlist, int i_item_id,
128
                             int i_node_id, bool b_signal );
129

130 131 132
playlist_item_t * playlist_NodeAddInput( playlist_t *, input_item_t *,
        playlist_item_t *,int , int, bool );

133
int playlist_InsertInputItemTree ( playlist_t *,
jpd's avatar
jpd committed
134 135
        playlist_item_t *, input_item_node_t *, int, bool );

136
/* Tree walking */
137
playlist_item_t *playlist_ItemFindFromInputAndRoot( playlist_t *p_playlist,
138 139
                                input_item_t *p_input, playlist_item_t *p_root,
                                bool );
140

141 142
int playlist_DeleteFromInputInParent( playlist_t *, input_item_t *,
                                      playlist_item_t *, bool );
143
int playlist_DeleteFromItemId( playlist_t*, int );
144
int playlist_ItemRelease( playlist_item_t * );
145

146
int playlist_NodeEmpty( playlist_t *, playlist_item_t *, bool );
147
int playlist_DeleteItem( playlist_t * p_playlist, playlist_item_t *, bool);
148

149 150
void ResetCurrentlyPlaying( playlist_t *p_playlist, playlist_item_t *p_cur );
void ResyncCurrentIndex( playlist_t *p_playlist, playlist_item_t *p_cur );
151

152 153 154 155
/**
 * @}
 */

156
#define PLAYLIST_DEBUG 1
157
//#undef PLAYLIST_DEBUG2
158 159

#ifdef PLAYLIST_DEBUG
160
 #define PL_DEBUG( ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
161
 #ifdef PLAYLIST_DEBUG2
162
  #define PL_DEBUG2( msg, ... ) msg_Dbg( p_playlist, __VA_ARGS__ )
163
 #else
164
  #define PL_DEBUG2( msg, ... ) {}
165
 #endif
166
#else
167 168
 #define PL_DEBUG( msg, ... ) {}
 #define PL_DEBUG2( msg, ... ) {}
169 170
#endif

171
#define PLI_NAME( p ) p && p->p_input ? p->p_input->psz_name : "null"
172

173 174 175 176 177 178 179 180 181 182 183
#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;
}
184

185
#endif /* !__LIBVLC_PLAYLIST_INTERNAL_H */