home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2010 November / maximum-cd-2010-11.iso / DiscContents / vlc-1.1.2-win32.exe / sdk / include / vlc / plugins / vlc_playlist.h < prev    next >
Encoding:
C/C++ Source or Header  |  2010-07-30  |  15.2 KB  |  391 lines
  1. /*****************************************************************************
  2.  * vlc_playlist.h : Playlist functions
  3.  *****************************************************************************
  4.  * Copyright (C) 1999-2004 the VideoLAN team
  5.  * $Id: 86c424acb55a77459c93bf905b7136bb991a2932 $
  6.  *
  7.  * Authors: Samuel Hocevar <sam@zoy.org>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify
  10.  * it under the terms of the GNU General Public License as published by
  11.  * the Free Software Foundation; either version 2 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.  * GNU General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU General Public License along
  20.  * with this program; if not, write to the Free Software Foundation, Inc.,
  21.  * 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. #ifndef VLC_PLAYLIST_H_
  25. #define VLC_PLAYLIST_H_
  26.  
  27. # ifdef __cplusplus
  28. extern "C" {
  29. # endif
  30.  
  31. #include <vlc_input.h>
  32. #include <vlc_events.h>
  33.  
  34. TYPEDEF_ARRAY(playlist_item_t*, playlist_item_array_t)
  35.  
  36. /**
  37.  * \file
  38.  * This file contain structures and function prototypes related
  39.  * to the playlist in vlc
  40.  *
  41.  * \defgroup vlc_playlist Playlist
  42.  *
  43.  * The VLC playlist system has a tree structure. This allows advanced
  44.  * categorization, like for SAP streams (which are grouped by "sap groups").
  45.  *
  46.  * The base structure for all playlist operations is the input_item_t. This
  47.  * contains all information needed to play a stream and get info, ie, mostly,
  48.  * mrl and metadata. This structure contains a unique i_id field. ids are
  49.  * not recycled when an item is destroyed.
  50.  *
  51.  * Input items are not used directly, but through playlist items.
  52.  * The playlist items are themselves in a tree structure. They only contain
  53.  * a link to the input item, a unique id and a few flags. the playlist
  54.  * item id is NOT the same as the input item id.
  55.  * Several playlist items can be attached to a single input item. The input
  56.  * item is refcounted and is automatically destroyed when it is not used
  57.  * anymore.
  58.  *
  59.  * The top-level items are the main media sources and include:
  60.  * playlist, media library, SAP, Shoutcast, devices, ...
  61.  *
  62.  * It is envisioned that a third tree will appear: VLM, but it's not done yet
  63.  *
  64.  * The playlist also stores, for utility purposes, an array of all input
  65.  * items, an array of all playlist items and an array of all playlist items
  66.  * and nodes (both are represented by the same structure).
  67.  *
  68.  * So, here is an example:
  69.  * \verbatim
  70.  * Inputs array
  71.  *  - input 1 -> name = foo 1 uri = ...
  72.  *  - input 2 -> name = foo 2 uri = ...
  73.  *
  74.  * Playlist items tree
  75.  * - playlist (id 1)
  76.  *    - category 1 (id 2)
  77.  *      - foo 2 (id 6 - input 2)
  78.  * - media library (id 2)
  79.  *    - foo 1 (id 5 - input 1)
  80.  * \endverbatim
  81.  *
  82.  * Sometimes, an item creates subitems. This happens for the directory access
  83.  * for example. In that case, if the item is under the "playlist" top-level item
  84.  * and playlist is configured to be flat then the item will be deleted and
  85.  * replaced with new subitems. If the item is under another top-level item, it
  86.  * will be transformed to a node and removed from the list of all items without
  87.  * nodes.
  88.  *
  89.  * For "standard" item addition, you can use playlist_Add, playlist_AddExt
  90.  * (more options) or playlist_AddInput if you already created your input
  91.  * item. This will add the item at the root of "Playlist" or of "Media library"
  92.  * in each of the two trees.
  93.  *
  94.  * You can create nodes with playlist_NodeCreate and can create items from
  95.  * existing input items to be placed under any node with playlist_NodeAddInput.
  96.  *
  97.  * To delete an item, use playlist_DeleteFromInput( p_item ) which will
  98.  * remove all occurrences of the input.
  99.  *
  100.  *
  101.  * The playlist defines the following event variables:
  102.  *
  103.  * - "item-change": It will contain the input_item_t->i_id of a changed input
  104.  * item monitored by the playlist.
  105.  * - "item-current": It will contain a input_item_t->i_id of the current
  106.  * item being played.
  107.  *
  108.  * - "playlist-item-append": It will contain a pointer to a playlist_add_t.
  109.  * - "playlist-item-deleted": It will contain the playlist_item_t->i_id of a
  110.  * deleted playlist_item_t.
  111.  *
  112.  * - "leaf-to-parent": Set when an item gets subitems and is transformed to a
  113.  * node. It will contain a pointer to the input_item_t bound to the transformed
  114.  * playlist item.
  115.  *
  116.  *
  117.  * XXX Be really carefull, playlist_item_t->i_id and input_item_t->i_id are not
  118.  * the same. Yes, the situation is pretty bad.
  119.  *
  120.  * @{
  121.  */
  122.  
  123. /** Helper structure to export to file part of the playlist */
  124. typedef struct playlist_export_t
  125. {
  126.     VLC_COMMON_MEMBERS
  127.     const char *psz_filename;
  128.     FILE *p_file;
  129.     playlist_item_t *p_root;
  130. } playlist_export_t;
  131.  
  132. /** playlist item / node */
  133. struct playlist_item_t
  134. {
  135.     input_item_t           *p_input;    /**< Linked input item */
  136.     /** Number of children, -1 if not a node */
  137.     int                    i_children;
  138.     playlist_item_t      **pp_children; /**< Children nodes/items */
  139.     playlist_item_t       *p_parent;    /**< Item parent */
  140.  
  141.     int                    i_id;        /**< Playlist item specific id */
  142.     uint8_t                i_flags;     /**< Flags */
  143.     playlist_t            *p_playlist;  /**< Parent playlist */
  144. };
  145.  
  146. #define PLAYLIST_SAVE_FLAG      0x0001    /**< Must it be saved */
  147. #define PLAYLIST_SKIP_FLAG      0x0002    /**< Must playlist skip after it ? */
  148. #define PLAYLIST_DBL_FLAG       0x0004    /**< Is it disabled ? */
  149. #define PLAYLIST_RO_FLAG        0x0008    /**< Write-enabled ? */
  150. #define PLAYLIST_REMOVE_FLAG    0x0010    /**< Remove this item at the end */
  151. #define PLAYLIST_EXPANDED_FLAG  0x0020    /**< Expanded node */
  152. #define PLAYLIST_SUBITEM_STOP_FLAG 0x0040 /**< Must playlist stop if the item gets subitems ?*/
  153.  
  154. /** Playlist status */
  155. typedef enum
  156. { PLAYLIST_STOPPED,PLAYLIST_RUNNING,PLAYLIST_PAUSED } playlist_status_t;
  157.  
  158. /** Structure containing information about the playlist */
  159. struct playlist_t
  160. {
  161.     VLC_COMMON_MEMBERS
  162.  
  163.     playlist_item_array_t items; /**< Arrays of items */
  164.     playlist_item_array_t all_items; /**< Array of items and nodes */
  165.  
  166.     playlist_item_array_t current; /**< Items currently being played */
  167.     int                   i_current_index; /**< Index in current array */
  168.  
  169.     /* Predefined items */
  170.     playlist_item_t *     p_root;
  171.     playlist_item_t *     p_playing;
  172.     playlist_item_t *     p_media_library;
  173.  
  174.     //Phony ones, point to those above;
  175.     playlist_item_t *     p_root_category; /**< Root of category tree */
  176.     playlist_item_t *     p_root_onelevel; /**< Root of onelevel tree */
  177.     playlist_item_t *     p_local_category; /** < "Playlist" in CATEGORY view */
  178.     playlist_item_t *     p_ml_category; /** < "Library" in CATEGORY view */
  179.     playlist_item_t *     p_local_onelevel; /** < "Playlist" in ONELEVEL view */
  180.     playlist_item_t *     p_ml_onelevel; /** < "Library" in ONELEVEL view */
  181. };
  182.  
  183. /** Helper to add an item */
  184. struct playlist_add_t
  185. {
  186.     int i_node; /**< Playist id of the parent node */
  187.     int i_item; /**< Playist id of the playlist_item_t */
  188. };
  189.  
  190. /* A bit of macro magic to generate an enum out of the following list,
  191.  * and later, to generate a list of static functions out of the same list.
  192.  * There is also SORT_RANDOM, which is always last and handled specially.
  193.  */
  194. #define VLC_DEFINE_SORT_FUNCTIONS \
  195.     DEF( SORT_ID )\
  196.     DEF( SORT_TITLE )\
  197.     DEF( SORT_TITLE_NODES_FIRST )\
  198.     DEF( SORT_ARTIST )\
  199.     DEF( SORT_GENRE )\
  200.     DEF( SORT_DURATION )\
  201.     DEF( SORT_TITLE_NUMERIC )\
  202.     DEF( SORT_ALBUM )\
  203.     DEF( SORT_TRACK_NUMBER )\
  204.     DEF( SORT_DESCRIPTION )\
  205.     DEF( SORT_RATING )\
  206.     DEF( SORT_URI )
  207.  
  208. #define DEF( s ) s,
  209. enum
  210. {
  211.     VLC_DEFINE_SORT_FUNCTIONS
  212.     SORT_RANDOM,
  213.     NUM_SORT_FNS=SORT_RANDOM
  214. };
  215. #undef  DEF
  216. #ifndef VLC_INTERNAL_PLAYLIST_SORT_FUNCTIONS
  217. #undef  VLC_DEFINE_SORT_FUNCTIONS
  218. #endif
  219.  
  220. enum
  221. {
  222.     ORDER_NORMAL = 0,
  223.     ORDER_REVERSE = 1,
  224. };
  225.  
  226. /* Used by playlist_Import */
  227. #define PLAYLIST_INSERT          0x0001
  228. #define PLAYLIST_APPEND          0x0002
  229. #define PLAYLIST_GO              0x0004
  230. #define PLAYLIST_PREPARSE        0x0008
  231. #define PLAYLIST_SPREPARSE       0x0010
  232. #define PLAYLIST_NO_REBUILD      0x0020
  233.  
  234. #define PLAYLIST_END           -666
  235.  
  236. enum pl_locked_state
  237. {
  238.     pl_Locked = true,
  239.     pl_Unlocked = false
  240. };
  241.  
  242. /*****************************************************************************
  243.  * Prototypes
  244.  *****************************************************************************/
  245.  
  246. /* Helpers */
  247. #define PL_LOCK playlist_Lock( p_playlist )
  248. #define PL_UNLOCK playlist_Unlock( p_playlist )
  249. #define PL_ASSERT_LOCKED playlist_AssertLocked( p_playlist )
  250.  
  251. VLC_EXPORT( playlist_t *, pl_Get, ( vlc_object_t * ) );
  252. #define pl_Get( a ) pl_Get( VLC_OBJECT(a) )
  253.  
  254. /* Playlist control */
  255. #define playlist_Play(p) playlist_Control(p,PLAYLIST_PLAY, pl_Unlocked )
  256. #define playlist_Pause(p) playlist_Control(p,PLAYLIST_PAUSE, pl_Unlocked )
  257. #define playlist_Stop(p) playlist_Control(p,PLAYLIST_STOP, pl_Unlocked )
  258. #define playlist_Next(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, 1)
  259. #define playlist_Prev(p) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked, -1)
  260. #define playlist_Skip(p,i) playlist_Control(p,PLAYLIST_SKIP, pl_Unlocked,  (i) )
  261.  
  262. VLC_EXPORT( void, playlist_Lock, ( playlist_t * ) );
  263. VLC_EXPORT( void, playlist_Unlock, ( playlist_t * ) );
  264. VLC_EXPORT( void, playlist_AssertLocked, ( playlist_t * ) );
  265.  
  266. /**
  267.  * Do a playlist action.
  268.  * If there is something in the playlist then you can do playlist actions.
  269.  * Possible queries are listed in vlc_common.h
  270.  * \param p_playlist the playlist to do the command on
  271.  * \param i_query the command to do
  272.  * \param b_locked TRUE if playlist is locked when entering this function
  273.  * \param variable number of arguments
  274.  * \return VLC_SUCCESS or an error
  275.  */
  276. VLC_EXPORT( int, playlist_Control, ( playlist_t *p_playlist, int i_query, bool b_locked, ...  ) );
  277.  
  278. /** Get current playing input. The object is retained.
  279.  */
  280. VLC_EXPORT( input_thread_t *, playlist_CurrentInput, ( playlist_t *p_playlist ) );
  281.  
  282. /** Clear the playlist
  283.  * \param b_locked TRUE if playlist is locked when entering this function
  284.  */
  285. VLC_EXPORT( void,  playlist_Clear, ( playlist_t *, bool ) );
  286.  
  287. /** Enqueue an input item for preparsing */
  288. VLC_EXPORT( int, playlist_PreparseEnqueue, (playlist_t *, input_item_t * ) );
  289.  
  290. /** Request the art for an input item to be fetched */
  291. VLC_EXPORT( int, playlist_AskForArtEnqueue, (playlist_t *, input_item_t * ) );
  292.  
  293. /* Playlist sorting */
  294. VLC_EXPORT( int,  playlist_TreeMove, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
  295. VLC_EXPORT( int,  playlist_TreeMoveMany, ( playlist_t *, int, playlist_item_t **, playlist_item_t *, int ) );
  296. VLC_EXPORT( int,  playlist_RecursiveNodeSort, ( playlist_t *, playlist_item_t *,int, int ) );
  297.  
  298. VLC_EXPORT( playlist_item_t *,  playlist_CurrentPlayingItem, ( playlist_t * ) );
  299. VLC_EXPORT( int,   playlist_Status, ( playlist_t * ) );
  300.  
  301. /**
  302.  * Export a node of the playlist to a certain type of playlistfile
  303.  * \param p_playlist the playlist to export
  304.  * \param psz_filename the location where the exported file will be saved
  305.  * \param p_export_root the root node to export
  306.  * \param psz_type the type of playlist file to create (m3u, pls, ..)
  307.  * \return VLC_SUCCESS on success
  308.  */
  309. VLC_EXPORT( int,  playlist_Export, ( playlist_t *p_playlist, const char *psz_name, playlist_item_t *p_export_root, const char *psz_type ) );
  310.  
  311. /**
  312.  * Open a playlist file, add its content to the current playlist
  313.  */
  314. VLC_EXPORT( int, playlist_Import, ( playlist_t *p_playlist, const char *psz_file ) );
  315.  
  316. /********************** Services discovery ***********************/
  317.  
  318. /** Add a list of comma-separated service discovery modules */
  319. VLC_EXPORT( int, playlist_ServicesDiscoveryAdd, (playlist_t *, const char *));
  320. /** Remove a services discovery module by name */
  321. VLC_EXPORT( int, playlist_ServicesDiscoveryRemove, (playlist_t *, const char *));
  322. /** Check whether a given SD is loaded */
  323. VLC_EXPORT( bool, playlist_IsServicesDiscoveryLoaded, ( playlist_t *,const char *));
  324.  
  325.  
  326.  
  327. /********************************************************
  328.  * Item management
  329.  ********************************************************/
  330.  
  331. /*************************** Item deletion **************************/
  332. VLC_EXPORT( int,  playlist_DeleteFromInput, ( playlist_t *, input_item_t *, bool ) );
  333.  
  334. /******************** Item addition ********************/
  335. VLC_EXPORT( int,  playlist_Add,    ( playlist_t *, const char *, const char *, int, int, bool, bool ) );
  336. VLC_EXPORT( int,  playlist_AddExt, ( playlist_t *, const char *, const char *, int, int, mtime_t, int, const char *const *, unsigned, bool, bool ) );
  337. VLC_EXPORT( int, playlist_AddInput, ( playlist_t *, input_item_t *, int, int, bool, bool ) );
  338. VLC_EXPORT( playlist_item_t *, playlist_NodeAddInput, ( playlist_t *, input_item_t *, playlist_item_t *, int, int, bool ) );
  339. VLC_EXPORT( int, playlist_NodeAddCopy, ( playlist_t *, playlist_item_t *, playlist_item_t *, int ) );
  340.  
  341. /********************************** Item search *************************/
  342. VLC_EXPORT( playlist_item_t *, playlist_ItemGetById, (playlist_t *, int ) );
  343. VLC_EXPORT( playlist_item_t *, playlist_ItemGetByInput, (playlist_t *,input_item_t * ) );
  344.  
  345. VLC_EXPORT( int, playlist_LiveSearchUpdate, (playlist_t *, playlist_item_t *, const char *, bool ) );
  346.  
  347. /********************************************************
  348.  * Tree management
  349.  ********************************************************/
  350. /* Node management */
  351. 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 * ) );
  352. VLC_EXPORT( int, playlist_NodeAppend, (playlist_t *,playlist_item_t*,playlist_item_t *) );
  353. VLC_EXPORT( int, playlist_NodeInsert, (playlist_t *,playlist_item_t*,playlist_item_t *, int) );
  354. VLC_EXPORT( int, playlist_NodeRemoveItem, (playlist_t *,playlist_item_t*,playlist_item_t *) );
  355. VLC_EXPORT( playlist_item_t *, playlist_ChildSearchName, (playlist_item_t*, const char* ) );
  356. VLC_EXPORT( int, playlist_NodeDelete, ( playlist_t *, playlist_item_t *, bool , bool ) );
  357.  
  358. 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 ) );
  359. 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 ) );
  360.  
  361. /***********************************************************************
  362.  * Inline functions
  363.  ***********************************************************************/
  364. /** Small helper tp get current playing input or NULL. Release the input after use. */
  365. #define pl_CurrentInput(a) __pl_CurrentInput( VLC_OBJECT(a) )
  366. static  inline input_thread_t * __pl_CurrentInput( vlc_object_t * p_this )
  367. {
  368.     return playlist_CurrentInput( pl_Get( p_this ) );
  369. }
  370.  
  371. /** Tell if the playlist is empty */
  372. static inline bool playlist_IsEmpty( playlist_t *p_playlist )
  373. {
  374.     PL_ASSERT_LOCKED;
  375.     return p_playlist->items.i_size == 0;
  376. }
  377.  
  378. /** Tell the number of items in the current playing context */
  379. static inline int playlist_CurrentSize( playlist_t *p_playlist )
  380. {
  381.     PL_ASSERT_LOCKED;
  382.     return p_playlist->current.i_size;
  383. }
  384.  
  385. /** @} */
  386. # ifdef __cplusplus
  387. }
  388. # endif
  389.  
  390. #endif
  391.