X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=include%2Fvlc_playlist.h;h=f6cb8a94bf14ea2661d858f302ce26371befe71f;hb=a5c73d38fa4744962e5fee55abcd56b8237e6c08;hp=ac477ac6a614e4cae2c040194829a71ce35d943c;hpb=15abf70b6e6074748a52e6c56986a9fde0aeed0f;p=vlc diff --git a/include/vlc_playlist.h b/include/vlc_playlist.h index ac477ac6a6..f6cb8a94bf 100644 --- a/include/vlc_playlist.h +++ b/include/vlc_playlist.h @@ -16,9 +16,9 @@ * 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. + * 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. *****************************************************************************/ #ifndef VLC_PLAYLIST_H_ @@ -31,7 +31,7 @@ extern "C" { #include #include -TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t); +TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t) /** * \file @@ -111,19 +111,35 @@ TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t); * Generally speaking, playlist_NodeAddInput should not be used in newer code, it * will maybe become useful again when we merge VLM; * - * To delete an item, use playlist_DeleteFromInput( input_id ) which will + * To delete an item, use playlist_DeleteFromInput( p_item ) which will * remove all occurrences of the input in both trees * + * + * The playlist defines the following event variables: + * + * - "item-change": It will contains the input_item_t->i_id of a changed input + * item monitored by the playlist. + * * - "item-current": It will contains a input_item_t->i_id of the current + * item being played. + * + * - "playlist-item-append": It will contains a pointer to a playlist_add_t. + * - "playlist-item-deleted": It will contains the playlist_item_t->i_id of a deleted + * playlist_item_t. + * + * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not + * the same. Yes, the situation is pretty bad. + * * @{ */ /** Helper structure to export to file part of the playlist */ -struct playlist_export_t +typedef struct playlist_export_t { - char *psz_filename; + VLC_COMMON_MEMBERS + const char *psz_filename; FILE *p_file; playlist_item_t *p_root; -}; +} playlist_export_t; /** playlist item / node */ struct playlist_item_t @@ -145,6 +161,7 @@ struct playlist_item_t #define PLAYLIST_RO_FLAG 0x0008 /**< Write-enabled ? */ #define PLAYLIST_REMOVE_FLAG 0x0010 /**< Remove this item at the end */ #define PLAYLIST_EXPANDED_FLAG 0x0020 /**< Expanded node */ +#define PLAYLIST_SUBITEM_STOP_FLAG 0x0040 /**< Must playlist stop if the item gets subitems ?*/ /** Playlist status */ typedef enum @@ -162,6 +179,11 @@ struct playlist_t int i_current_index; /**< Index in current array */ /* Predefined items */ + playlist_item_t * p_root; + playlist_item_t * p_playing; + playlist_item_t * p_media_library; + + //Phony ones, point to those above; playlist_item_t * p_root_category; /**< Root of category tree */ playlist_item_t * p_root_onelevel; /**< Root of onelevel tree */ playlist_item_t * p_local_category; /** < "Playlist" in CATEGORY view */ @@ -173,27 +195,40 @@ struct playlist_t /** Helper to add an item */ struct playlist_add_t { - int i_node; - int i_item; - int i_position; + int i_node; /**< Playist id of the parent node */ + int i_item; /**< Playist id of the playlist_item_t */ }; +/* A bit of macro magic to generate an enum out of the following list, + * and later, to generate a list of static functions out of the same list. + * There is also SORT_RANDOM, which is always last and handled specially. + */ +#define VLC_DEFINE_SORT_FUNCTIONS \ + DEF( SORT_ID )\ + DEF( SORT_TITLE )\ + DEF( SORT_TITLE_NODES_FIRST )\ + DEF( SORT_ARTIST )\ + DEF( SORT_GENRE )\ + DEF( SORT_DURATION )\ + DEF( SORT_TITLE_NUMERIC )\ + DEF( SORT_ALBUM )\ + DEF( SORT_TRACK_NUMBER )\ + DEF( SORT_DESCRIPTION )\ + DEF( SORT_RATING )\ + DEF( SORT_URI ) + +#define DEF( s ) s, enum { - SORT_ID = 0, - SORT_TITLE = 1, - SORT_TITLE_NODES_FIRST = 2, - SORT_ARTIST = 3, - SORT_GENRE = 4, - SORT_RANDOM = 5, - SORT_DURATION = 6, - SORT_TITLE_NUMERIC = 7, - SORT_ALBUM = 8, - SORT_TRACK_NUMBER = 9, - SORT_DESCRIPTION = 10, - SORT_RATING = 11, - SORT_URI = 12, + VLC_DEFINE_SORT_FUNCTIONS + SORT_RANDOM, + NUM_SORT_FNS=SORT_RANDOM }; +#undef DEF +#ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS +#undef VLC_DEFINE_SORT_FUNCTIONS +#endif + enum { ORDER_NORMAL = 0, @@ -225,11 +260,8 @@ enum pl_locked_state #define PL_UNLOCK playlist_Unlock( p_playlist ) #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist ) -VLC_EXPORT( playlist_t *, __pl_Hold, ( vlc_object_t * ) ); -#define pl_Hold( a ) __pl_Hold( VLC_OBJECT(a) ) - -VLC_EXPORT( void, __pl_Release, ( vlc_object_t * ) ); -#define pl_Release(a) __pl_Release( VLC_OBJECT(a) ) +VLC_EXPORT( playlist_t *, pl_Get, ( vlc_object_t * ) ); +#define pl_Get( a ) pl_Get( VLC_OBJECT(a) ) /* Playlist control */ #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked ) @@ -265,18 +297,17 @@ VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) VLC_EXPORT( void, playlist_Clear, ( playlist_t *, bool ) ); /** Enqueue an input item for preparsing */ -VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t *, bool b_locked ) ); +VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t * ) ); /** Request the art for an input item to be fetched */ -VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t *, bool b_locked ) ); +VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t * ) ); /* Playlist sorting */ VLC_EXPORT( int, playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) ); +VLC_EXPORT( int, playlist_TreeMoveMany, ( playlist_t *, int, playlist_item_t **, playlist_item_t *, int ) ); VLC_EXPORT( int, playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) ); -VLC_EXPORT( int, playlist_CurrentId, ( playlist_t * ) ); VLC_EXPORT( playlist_item_t *, playlist_CurrentPlayingItem, ( playlist_t * ) ); -VLC_EXPORT( bool, playlist_IsPlaying, ( playlist_t * ) ); VLC_EXPORT( int, playlist_Status, ( playlist_t * ) ); /** @@ -310,42 +341,34 @@ VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char ********************************************************/ /*************************** Item deletion **************************/ -VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, int, bool ) ); +VLC_EXPORT( int, playlist_DeleteFromInput, ( playlist_t *, input_item_t *, bool ) ); /******************** Item addition ********************/ VLC_EXPORT( int, playlist_Add, ( playlist_t *, const char *, const char *, int, int, bool, bool ) ); VLC_EXPORT( int, playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool ) ); VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) ); -VLC_EXPORT( int, playlist_BothAddInput, ( playlist_t *, input_item_t *,playlist_item_t *,int , int, int*, int*, bool ) ); - -/********************** Misc item operations **********************/ -VLC_EXPORT( playlist_item_t*, playlist_ItemToNode, (playlist_t *,playlist_item_t *, bool) ); +VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool ) ); +VLC_EXPORT( int, playlist_NodeAddCopy, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) ); /********************************** Item search *************************/ -VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int, bool ) ); -VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t *, bool ) ); -VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInputId, (playlist_t *, int, playlist_item_t *) ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) ); +VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) ); -VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *) ); +VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *, bool ) ); /******************************************************** * Tree management ********************************************************/ -VLC_EXPORT( int, playlist_NodeChildrenCount, (playlist_t *,playlist_item_t* ) ); - /* Node management */ -VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_flags, input_item_t * ) ); +VLC_EXPORT( playlist_item_t *, playlist_NodeCreate, ( playlist_t *, const char *, playlist_item_t * p_parent, int i_pos, int i_flags, input_item_t * ) ); VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) ); VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) ); VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) ); VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) ); VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) ); -VLC_EXPORT( int, playlist_NodeEmpty, ( playlist_t *, playlist_item_t *, bool ) ); -VLC_EXPORT( void, playlist_NodesPairCreate, (playlist_t *, const char *, playlist_item_t **, playlist_item_t **, bool ) ); -VLC_EXPORT( playlist_item_t *, playlist_GetPreferredNode, ( playlist_t *p_playlist, playlist_item_t *p_node ) ); + VLC_EXPORT( playlist_item_t *, playlist_GetNextLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) ); VLC_EXPORT( playlist_item_t *, playlist_GetPrevLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root, playlist_item_t *p_item, bool b_ena, bool b_unplayed ) ); -VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, playlist_item_t *p_root ) ); /*********************************************************************** * Inline functions @@ -354,11 +377,7 @@ VLC_EXPORT( playlist_item_t *, playlist_GetLastLeaf, ( playlist_t *p_playlist, p #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) ) static inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this ) { - playlist_t * p_playlist = pl_Hold( p_this ); - if( !p_playlist ) return NULL; - input_thread_t * p_input = playlist_CurrentInput( p_playlist ); - pl_Release( p_this ); - return p_input; + return playlist_CurrentInput( pl_Get( p_this ) ); } /** Tell if the playlist is empty */