mirror of https://code.videolan.org/videolan/vlc
128 lines
5.9 KiB
C
128 lines
5.9 KiB
C
/*****************************************************************************
|
|
* vlc_media_library.h: SQL-based media library
|
|
*****************************************************************************
|
|
* Copyright (C) 2008-2010 the VideoLAN Team and AUTHORS
|
|
* $Id$
|
|
*
|
|
* Authors: Antoine Lejeune <phytos@videolan.org>
|
|
* Jean-Philippe André <jpeg@videolan.org>
|
|
* Rémi Duraffort <ivoire@videolan.org>
|
|
* Adrien Maglo <magsoft@videolan.org>
|
|
* Srikanth Raju <srikiraju at gmail dot com>
|
|
*
|
|
* 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
|
|
* (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 Lesser General Public License for more details.
|
|
*
|
|
* 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.
|
|
*****************************************************************************/
|
|
|
|
#ifndef VLC_MEDIA_LIBRARY_H
|
|
# define VLC_MEDIA_LIBRARY_H
|
|
|
|
# ifdef __cplusplus
|
|
extern "C" {
|
|
# endif
|
|
|
|
/*****************************************************************************
|
|
* ML Enums
|
|
*****************************************************************************/
|
|
|
|
#define ML_PERSON_ARTIST "Artist"
|
|
#define ML_PERSON_ALBUM_ARTIST "Album Artist"
|
|
#define ML_PERSON_ENCODER "Encoder"
|
|
#define ML_PERSON_PUBLISHER "Publisher"
|
|
|
|
|
|
/** List of Query select types.
|
|
* In a query array or variable argument list, each select type is followed
|
|
* by an argument (X) of variable type (char* or int, @see ml_element_t).
|
|
* These types can be used either in the query list or in the result array.
|
|
* Some types are reserved for the result array:
|
|
*/
|
|
typedef enum
|
|
{
|
|
ML_ALBUM = 1, /**< Album Title */
|
|
ML_ALBUM_ID, /**< Album ID */
|
|
ML_ALBUM_COVER, /**< Album Cover art url */
|
|
/* FIXME: Remove ML_ARTIST */
|
|
ML_ARTIST, /**< Artist, interpreted as ML_PEOPLE
|
|
&& ML_PEOPLE_ROLE = ML_PERSON_ARTIST */
|
|
ML_ARTIST_ID, /**< Artist ID, interpreted as ML_PEOPLE_ID
|
|
&& ML_PEOPLE_ROLE = ML_PERSON_ARTIST */
|
|
ML_COMMENT, /**< Comment about media */
|
|
ML_COUNT_MEDIA, /**< Number of medias */
|
|
ML_COUNT_ALBUM, /**< Number of albums */
|
|
ML_COUNT_PEOPLE, /**< Number of people */
|
|
ML_COVER, /**< Cover art url */
|
|
ML_DURATION, /**< Duration in ms */
|
|
ML_DISC_NUMBER, /**< Disc number of the track */
|
|
ML_EXTRA, /**< Extra/comment (string) on the media */
|
|
ML_FIRST_PLAYED, /**< First time media was played */
|
|
ML_FILESIZE, /**< Size of the media file */
|
|
ML_GENRE, /**< Genre of the media (if any) */
|
|
ML_ID, /**< Media ID */
|
|
ML_IMPORT_TIME, /**< Date when media was imported */
|
|
ML_LANGUAGE, /**< Language */
|
|
ML_LAST_PLAYED, /**< Last play UNIX timestamp */
|
|
ML_LAST_SKIPPED, /**< Time when media was last skipped */
|
|
ML_ORIGINAL_TITLE, /**< Media original title (if any) */
|
|
ML_PEOPLE, /**< Any People associated with this media */
|
|
ML_PEOPLE_ID, /**< Id of a person */
|
|
ML_PEOPLE_ROLE, /**< Person role */
|
|
ML_PLAYED_COUNT, /**< Media play count */
|
|
ML_PREVIEW, /**< Url of the video preview */
|
|
ML_SKIPPED_COUNT, /**< Number of times skipped */
|
|
ML_SCORE, /**< Computed media score */
|
|
ML_TITLE, /**< Media title */
|
|
ML_TRACK_NUMBER, /**< Media track number (if any) */
|
|
ML_TYPE, /**< Media type. @see ml_type_e */
|
|
ML_URI, /**< Media full URI. */
|
|
ML_VOTE, /**< Media user vote value */
|
|
ML_YEAR, /**< Media publishing year */
|
|
ML_DIRECTORY, /**< Monitored directory */
|
|
ML_MEDIA, /**< Full media descriptor. @see ml_media_t */
|
|
ML_MEDIA_SPARSE, /**< Sparse media. @see ml_media_t */
|
|
ML_MEDIA_EXTRA, /**< Sparse + Extra = Full media */
|
|
|
|
/* Some special elements */
|
|
ML_LIMIT = -1, /**< Limit a query to X results */
|
|
ML_SORT_DESC = -2, /**< Sort a query descending on argument X */
|
|
ML_SORT_ASC = -3, /**< Sort a query ascending on argument X */
|
|
ML_DISTINCT = -4, /**< Add DISTINCT to SELECT statements. */
|
|
ML_END = -42 /**< End of argument list */
|
|
} ml_select_e;
|
|
|
|
/** Media types (audio, video, etc...) */
|
|
typedef enum
|
|
{
|
|
ML_UNKNOWN = 0, /**< Unknown media type */
|
|
ML_AUDIO = 1 << 0, /**< Audio only media */
|
|
ML_VIDEO = 1 << 1, /**< Video media. May contain audio channels */
|
|
ML_STREAM = 1 << 2, /**< Streamed media = not a local file */
|
|
ML_NODE = 1 << 3, /**< Nodes like simple nodes, directories, playlists, etc */
|
|
ML_REMOVABLE = 1 << 4, /**< Removable media: CD/DVD/Card/... */
|
|
} ml_type_e;
|
|
|
|
/** Query result item/list type: integers, strings, medias, timestamps */
|
|
typedef enum {
|
|
ML_TYPE_INT, /**< Object is an int */
|
|
ML_TYPE_PSZ, /**< A string char* */
|
|
ML_TYPE_TIME, /**< A timestamp mtime_t */
|
|
ML_TYPE_MEDIA, /**< A pointer to a media ml_media_t* */
|
|
} ml_result_type_e;
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif /* C++ */
|
|
|
|
#endif /* VLC_MEDIA_LIBRARY_H */
|