From 94ca87f3e5f9a2de994893f4927bd374f36a8dc7 Mon Sep 17 00:00:00 2001 From: Christophe Fergeau Date: Mon, 10 Apr 2006 18:17:25 +0000 Subject: * docs/Makefile.am: * docs/reference/Makefile.am: * docs/reference/libgpod-docs.xml: * docs/reference/libgpod-sections.txt: * docs/reference/tmpl/Internal.sgml: * docs/reference/tmpl/artwork.sgml: * docs/reference/tmpl/device.sgml: * docs/reference/tmpl/itunesdb-copying.sgml: * docs/reference/tmpl/itunesdb-db.sgml: * docs/reference/tmpl/itunesdb-lowlevel.sgml: * docs/reference/tmpl/itunesdb-time.sgml: * docs/reference/tmpl/libgpod-unused.sgml: * docs/reference/tmpl/playlists.sgml: * docs/reference/tmpl/smart-playlists.sgml: * docs/reference/tmpl/track.sgml: * docs/reference/version.xml.in: all the files below are new files needed for gtk-doc support * Makefile.am: * configure.ac: add gtk-doc support to build system * src/itdb_artwork.c: * src/itdb_device.c: * src/itdb_itunesdb.c: * src/itdb_playlist.c: * src/itdb_track.c: update inline comments in those files so that gtk-doc can pick them up to build documentation git-svn-id: https://gtkpod.svn.sf.net/svnroot/gtkpod/libgpod/trunk@1243 f01d2545-417e-4e96-918e-98f8d0dbbcb6 --- docs/Makefile.am | 1 + docs/reference/Makefile.am | 78 ++++++++ docs/reference/libgpod-docs.xml | 75 ++++++++ docs/reference/libgpod-sections.txt | 266 ++++++++++++++++++++++++++ docs/reference/tmpl/Internal.sgml | 19 ++ docs/reference/tmpl/artwork.sgml | 160 ++++++++++++++++ docs/reference/tmpl/device.sgml | 129 +++++++++++++ docs/reference/tmpl/itunesdb-copying.sgml | 74 ++++++++ docs/reference/tmpl/itunesdb-db.sgml | 133 +++++++++++++ docs/reference/tmpl/itunesdb-lowlevel.sgml | 164 +++++++++++++++++ docs/reference/tmpl/itunesdb-time.sgml | 45 +++++ docs/reference/tmpl/libgpod-unused.sgml | 126 +++++++++++++ docs/reference/tmpl/playlists.sgml | 287 +++++++++++++++++++++++++++++ docs/reference/tmpl/smart-playlists.sgml | 269 +++++++++++++++++++++++++++ docs/reference/tmpl/track.sgml | 232 +++++++++++++++++++++++ docs/reference/version.xml.in | 4 + 16 files changed, 2062 insertions(+) create mode 100644 docs/Makefile.am create mode 100644 docs/reference/Makefile.am create mode 100644 docs/reference/libgpod-docs.xml create mode 100644 docs/reference/libgpod-sections.txt create mode 100644 docs/reference/tmpl/Internal.sgml create mode 100644 docs/reference/tmpl/artwork.sgml create mode 100644 docs/reference/tmpl/device.sgml create mode 100644 docs/reference/tmpl/itunesdb-copying.sgml create mode 100644 docs/reference/tmpl/itunesdb-db.sgml create mode 100644 docs/reference/tmpl/itunesdb-lowlevel.sgml create mode 100644 docs/reference/tmpl/itunesdb-time.sgml create mode 100644 docs/reference/tmpl/libgpod-unused.sgml create mode 100644 docs/reference/tmpl/playlists.sgml create mode 100644 docs/reference/tmpl/smart-playlists.sgml create mode 100644 docs/reference/tmpl/track.sgml create mode 100644 docs/reference/version.xml.in (limited to 'docs') diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..b68c774 --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1 @@ +SUBDIRS=reference diff --git a/docs/reference/Makefile.am b/docs/reference/Makefile.am new file mode 100644 index 0000000..138d70a --- /dev/null +++ b/docs/reference/Makefile.am @@ -0,0 +1,78 @@ +## Process this file with automake to produce Makefile.in + +# We require automake 1.6 at least. +AUTOMAKE_OPTIONS = 1.6 + +# This is a blank Makefile.am for using gtk-doc. +# Copy this to your project's API docs directory and modify the variables to +# suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples +# of using the various options. + +# The name of the module, e.g. 'glib'. +DOC_MODULE=libgpod + +# The top-level SGML file. You can change this if you want to. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml + +# The directory containing the source code. Relative to $(srcdir). +# gtk-doc will search all .c & .h files beneath here for inline comments +# documenting the functions and macros. +# e.g. DOC_SOURCE_DIR=../../../gtk +DOC_SOURCE_DIR=../../src + +# Extra options to pass to gtkdoc-scangobj. Not normally needed. +SCANGOBJ_OPTIONS= + +# Extra options to supply to gtkdoc-scan. +# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb. +# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml +MKDB_OPTIONS=--sgml-mode --output-format=xml + +# Extra options to supply to gtkdoc-mktmpl +# e.g. MKTMPL_OPTIONS=--only-section-tmpl +MKTMPL_OPTIONS= + +# Extra options to supply to gtkdoc-fixref. Not normally needed. +# e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html +FIXXREF_OPTIONS= + +# Used for dependencies. The docs will be rebuilt if any of these change. +# e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h +# e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c +HFILE_GLOB=$(top_srcdir)/src/*.h +CFILE_GLOB=$(top_srcdir)/src/*.c + +# Header files to ignore when scanning. +# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h +IGNORE_HFILES= + +# Images to copy into HTML directory. +# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png +HTML_IMAGES= + +# Extra SGML files that are included by $(DOC_MAIN_SGML_FILE). +# e.g. content_files=running.sgml building.sgml changes-2.0.sgml +content_files= + +# SGML files where gtk-doc abbrevations (#GtkWidget) are expanded +# These files must be listed here *and* in content_files +# e.g. expand_content_files=running.sgml +expand_content_files= + +# CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library. +# Only needed if you are using gtkdoc-scangobj to dynamically query widget +# signals and properties. +# e.g. INCLUDES=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) +# e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) +INCLUDES= +GTKDOC_LIBS= + +# This includes the standard gtk-doc make rules, copied by gtkdocize. +include $(top_srcdir)/gtk-doc.make + +# Other files to distribute +# e.g. EXTRA_DIST += version.xml.in +EXTRA_DIST += diff --git a/docs/reference/libgpod-docs.xml b/docs/reference/libgpod-docs.xml new file mode 100644 index 0000000..facff7b --- /dev/null +++ b/docs/reference/libgpod-docs.xml @@ -0,0 +1,75 @@ + + + + + libgpod Reference Manual + for libgpod + + + Jorg + Schuler + +
+ jorg.schuler@gmx.de +
+ + + + Christophe + Fergeau + +
+ teuf@gnome.org +
+ + + + + 2006 + Christophe Fergeau + + + + Permission is granted to copy, distribute and/or modify + this document under the terms of the GNU Free + Documentation License, Version 1.1 or any later + version published by the Free Software Foundation with no + Invariant Sections, no Front-Cover Texts, and no Back-Cover + Texts. You may obtain a copy of the GNU Free + Documentation License from the Free Software + Foundation by visiting their Web site or by writing + to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, + Boston, MA 02111-1307, USA. + + Many of the names used by companies to distinguish their + products and services are claimed as trademarks. Where those + names appear in any GNOME documentation, and those trademarks + are made aware to the members of the GNOME Documentation + Project, the names have been printed in caps or initial + caps. + + + + This manual documents the interfaces of the libgpod + library and has some short notes to help get you up to speed + with using the library. + + + + + iPod database + + + + + + + iPod database components + + + + + + diff --git a/docs/reference/libgpod-sections.txt b/docs/reference/libgpod-sections.txt new file mode 100644 index 0000000..676f4d6 --- /dev/null +++ b/docs/reference/libgpod-sections.txt @@ -0,0 +1,266 @@ +
+itunesdb-db +The Itdb_iTunesDB structure +Itdb_iTunesDB +ItdbUserDataDestroyFunc +ItdbUserDataDuplicateFunc + +itdb_new +itdb_free +itdb_parse +itdb_write +itdb_set_mountpoint +itdb_get_mountpoint + +itdb_tracks_number +itdb_tracks_number_nontransferred +itdb_playlists_number +
+ +
+itunesdb-copying +File handling functions +itdb_cp_track_to_ipod +itdb_filename_fs2ipod +itdb_filename_ipod2fs +itdb_filename_on_ipod +itdb_musicdirs_number +itdb_rename_files +
+ +
+itunesdb-lowlevel +Low-level functions +itdb_get_control_dir +itdb_get_itunes_dir +itdb_get_music_dir +itdb_get_artwork_dir +itdb_get_device_dir +itdb_get_itunesdb_path +itdb_get_artworkdb_path +itdb_get_path + +itdb_resolve_path +itdb_shuffle_write +itdb_shuffle_write_file +itdb_cp +itdb_parse_file +itdb_write_file +itdb_duplicate +
+ +
+itunesdb-time +Time handling +itdb_time_get_mac_time +itdb_time_mac_to_host +itdb_time_host_to_mac +
+ +
+track +Tracks +Itdb_Track +itdb_track_new +itdb_track_free +itdb_track_add +itdb_track_remove +itdb_track_unlink +itdb_track_duplicate +itdb_track_by_id +itdb_track_id_tree_create +itdb_track_id_tree_destroy +itdb_track_id_tree_by_id +itdb_track_set_thumbnails +itdb_track_remove_thumbnails +ITDB_RATING_STEP +
+ + +
+playlists +Playlists +Itdb_Playlist +ItdbPlaylistSortOrder +itdb_playlist_new +itdb_playlist_free +itdb_playlist_duplicate +itdb_playlist_add +itdb_playlist_move +itdb_playlist_remove +itdb_playlist_unlink + +itdb_playlist_add_track +itdb_playlist_remove_track +itdb_playlist_contains_track +itdb_playlist_contain_track_number +itdb_playlist_tracks_number + +itdb_playlist_mpl +itdb_playlist_is_mpl +itdb_playlist_set_mpl +itdb_playlist_podcasts +itdb_playlist_is_podcasts +itdb_playlist_set_podcasts +itdb_playlist_exists +itdb_playlist_by_id +itdb_playlist_by_nr +itdb_playlist_by_name + +itdb_playlist_randomize +
+ +
+smart-playlists +Smart Playlists +SPLPref +SPLRule +SPLRules +SPLAction +SPLFieldType +SPLActionType +SPLField +SPLDATE_IDENTIFIER +SPL_MAXSTRINGLENGTH +SPL_STRING_MAXLEN +itdb_splr_get_field_type +itdb_splr_get_action_type +itdb_splr_validate +itdb_splr_remove +itdb_splr_new +itdb_splr_add +itdb_splr_add_new +itdb_spl_copy_rules +itdb_splr_eval +itdb_spl_update +itdb_spl_update_all +itdb_spl_update_live +
+ +
+device +Device +Itdb_Device +itdb_device_new +itdb_device_free +itdb_device_set_mountpoint +itdb_device_read_sysinfo +itdb_device_get_sysinfo +Itdb_IpodModel +Itdb_ArtworkFormat +Itdb_Generation +Itdb_ModelType +
+ +
+artwork +Artwork +Itdb_Artwork +Itdb_Thumb +ItdbThumbType +itdb_artwork_new +itdb_artwork_duplicate +itdb_artwork_free +itdb_artwork_add_thumbnail +itdb_artwork_remove_thumbnail +itdb_artwork_remove_thumbnails +itdb_artwork_get_thumb_by_type +itdb_thumb_get_gdk_pixbuf +itdb_thumb_duplicate +itdb_thumb_free +itdb_thumb_new +itdb_thumb_get_filename +
+ + + + +
+Internal + +G_GNUC_INTERNAL +g_stat +g_mkdir +g_rename +g_printf +G_IS_DIR_SEPARATOR +dump_mhif +dump_mhia +dump_mhod_type_1 +dump_mhod_type_3 +dump_mhni +dump_mhod +dump_mhii +dump_mhl +dump_mhsd +dump_mhfd +dump_mhba +ITUNESDB_MAX_SIZE +MHeader +MhlHeader +MhbdHeader +ArtworkDB_MhsdHeader +MhltHeader +MhlpHeader +MhypHeader +MhipHeader +MhitHeader +ArtworkDB_MhodHeader +MhfdHeader +MhliHeader +MhiiHeader +MhniHeader +MhlaHeader +MhbaHeader +MhlfHeader +MhifHeader +MhiaHeader +MhitHeader471 +ArtworkDB_MhodHeaderArtworkType3 +MhodHeaderString +MhodHeaderArtworkType1 +MhodHeaderSmartPlaylistData +MhodHeaderSmartPlaylistRuleString +MhodHeaderSmartPlaylistRuleNonString +MhodHeaderSmartPlaylistRule +iTunesDB_MhsdHeader +MhodHeader +_MhodHeaderArtworkType1 +MhodHeaderArtworkType3 +playcount +NO_PLAYCOUNT +WCONTENTS_STEPSIZE +RED_BITS +RED_SHIFT +RED_MASK +GREEN_BITS +GREEN_SHIFT +GREEN_MASK +BLUE_BITS +BLUE_SHIFT +BLUE_MASK +DBParseContext +db_parse_context_get_m_header +iPodSong +DB_TO_CPU_GET +DB_TO_CPU_GET_DB +ItdbFileError +ITDB_FILE_ERROR +itdb_file_error_quark + +SPLACTION_LAST_HOURS_VALUE +SPLACTION_LAST_MINUTES_VALUE +SPLACTION_LAST_YEARS_VALUE +SPLACTION_LAST_LUNARCYCLE_VALUE +SPLACTION_LAST_SIDEREAL_DAY +SPLACTION_LAST_SWATCH_BEAT +SPLACTION_LAST_MOMENT +SPLACTION_LAST_OSTENT +SPLACTION_LAST_FORTNIGHT +SPLACTION_LAST_VINAL +SPLACTION_LAST_QUARTER +SPLACTION_LAST_SOLAR_YEAR +SPLACTION_LAST_SIDEREAL_YEAR + +
+ diff --git a/docs/reference/tmpl/Internal.sgml b/docs/reference/tmpl/Internal.sgml new file mode 100644 index 0000000..5bae25a --- /dev/null +++ b/docs/reference/tmpl/Internal.sgml @@ -0,0 +1,19 @@ + +Internal + + +Symbols to be hidden ;) + + + + + + + + + + + + + + diff --git a/docs/reference/tmpl/artwork.sgml b/docs/reference/tmpl/artwork.sgml new file mode 100644 index 0000000..a7ce2a5 --- /dev/null +++ b/docs/reference/tmpl/artwork.sgml @@ -0,0 +1,160 @@ + +Artwork + + +Data structure to store iPod artwork (cover and photos) + + + + + + + + + + + + + + + + + + + +@thumbnails: +@artwork_size: +@id: + + + + + + +@type: +@filename: +@offset: +@size: +@width: +@height: + + + + + + +@ITDB_THUMB_COVER_SMALL: +@ITDB_THUMB_COVER_LARGE: +@ITDB_THUMB_PHOTO_SMALL: +@ITDB_THUMB_PHOTO_LARGE: +@ITDB_THUMB_PHOTO_FULL_SCREEN: +@ITDB_THUMB_PHOTO_TV_SCREEN: + + + + + + +@Returns: + + + + + + + +@artwork: +@Returns: + + + + + + + +@artwork: + + + + + + + +@artwork: +@type: +@filename: +@Returns: + + + + + + + +@artwork: +@thumb: + + + + + + + +@artwork: + + + + + + + +@artwork: +@type: +@Returns: + + + + + + + +@device: +@thumb: +@Returns: + + + + + + + +@thumb: +@Returns: + + + + + + + +@thumb: + + + + + + + +@Returns: + + + + + + + +@device: +@thumb: +@Returns: + + diff --git a/docs/reference/tmpl/device.sgml b/docs/reference/tmpl/device.sgml new file mode 100644 index 0000000..07090ed --- /dev/null +++ b/docs/reference/tmpl/device.sgml @@ -0,0 +1,129 @@ + +Device + + +Data structure holding information about the iPod (model, mount point, ...) + + + + + + + + + + + + + + + + + + + +@mountpoint: +@musicdirs: +@byte_order: +@endianess_reversed: + + + + + + +@Returns: + + + + + + + +@device: + + + + + + + +@device: +@mp: + + + + + + + +@device: +@Returns: + + + + + + + +@device: +@field: +@Returns: + + + + + + + +@model_number: +@capacity: +@model_type: +@generation: + + + + + + +@type: +@width: +@height: +@correlation_id: + + + + + + +@UNKNOWN_GENERATION: +@FIRST_GENERATION: +@SECOND_GENERATION: +@THIRD_GENERATION: +@FOURTH_GENERATION: +@FIFTH_GENERATION: +@MOBILE_GENERATION: + + + + + + +@MODEL_TYPE_INVALID: +@MODEL_TYPE_UNKNOWN: +@MODEL_TYPE_COLOR: +@MODEL_TYPE_COLOR_U2: +@MODEL_TYPE_REGULAR: +@MODEL_TYPE_REGULAR_U2: +@MODEL_TYPE_MINI: +@MODEL_TYPE_MINI_BLUE: +@MODEL_TYPE_MINI_PINK: +@MODEL_TYPE_MINI_GREEN: +@MODEL_TYPE_MINI_GOLD: +@MODEL_TYPE_SHUFFLE: +@MODEL_TYPE_NANO_WHITE: +@MODEL_TYPE_NANO_BLACK: +@MODEL_TYPE_VIDEO_WHITE: +@MODEL_TYPE_VIDEO_BLACK: +@MODEL_TYPE_MOBILE_1: + diff --git a/docs/reference/tmpl/itunesdb-copying.sgml b/docs/reference/tmpl/itunesdb-copying.sgml new file mode 100644 index 0000000..82bfe94 --- /dev/null +++ b/docs/reference/tmpl/itunesdb-copying.sgml @@ -0,0 +1,74 @@ + +File handling functions + + +Functions to copy new files to the iPod + + + + + + + + + + + + + + + + + + + +@track: +@filename: +@error: +@Returns: + + + + + + + +@filename: + + + + + + + +@ipod_file: + + + + + + + +@track: +@Returns: + + + + + + + +@itdb: +@Returns: + + + + + + + +@mp: +@error: +@Returns: + + diff --git a/docs/reference/tmpl/itunesdb-db.sgml b/docs/reference/tmpl/itunesdb-db.sgml new file mode 100644 index 0000000..37fc775 --- /dev/null +++ b/docs/reference/tmpl/itunesdb-db.sgml @@ -0,0 +1,133 @@ + +iPod database reading/writing + + +Functions to create, read, write the iPod database + + + + + + + + + + + + + + + + + + + +@tracks: +@playlists: +@filename: +@device: +@version: +@id: +@usertype: +@userdata: +@userdata_duplicate: +@userdata_destroy: + + + + + + +@userdata: + + + + + + + +@userdata: +@Returns: + + + + + + + +@Returns: + + + + + + + +@itdb: + + + + + + + +@mp: +@error: +@Returns: + + + + + + + +@itdb: +@error: +@Returns: + + + + + + + +@itdb: +@mp: + + + + + + + +@itdb: +@Returns: + + + + + + + +@itdb: +@Returns: + + + + + + + +@itdb: +@Returns: + + + + + + + +@itdb: +@Returns: + + diff --git a/docs/reference/tmpl/itunesdb-lowlevel.sgml b/docs/reference/tmpl/itunesdb-lowlevel.sgml new file mode 100644 index 0000000..b91b65c --- /dev/null +++ b/docs/reference/tmpl/itunesdb-lowlevel.sgml @@ -0,0 +1,164 @@ + +Low-level functions + + +Low-level functions which shouldn't be needed in normal situations + + + + + + + + + + + + + + + + + + + +@mountpoint: +@Returns: + + + + + + + +@mountpoint: +@Returns: + + + + + + + +@mountpoint: +@Returns: + + + + + + + +@mountpoint: +@Returns: + + + + + + + +@mountpoint: +@Returns: + + + + + + + +@mountpoint: +@Returns: + + + + + + + +@mountpoint: +@Returns: + + + + + + + +@dir: +@file: +@Returns: + + + + + + + +@root: +@components: +@Returns: + + + + + + + +@itdb: +@error: +@Returns: + + + + + + + +@itdb: +@filename: +@error: +@Returns: + + + + + + + +@from_file: +@to_file: +@error: +@Returns: + + + + + + + +@filename: +@error: +@Returns: + + + + + + + +@itdb: +@filename: +@error: +@Returns: + + + + + + + +@itdb: +@Returns: + + diff --git a/docs/reference/tmpl/itunesdb-time.sgml b/docs/reference/tmpl/itunesdb-time.sgml new file mode 100644 index 0000000..d06849e --- /dev/null +++ b/docs/reference/tmpl/itunesdb-time.sgml @@ -0,0 +1,45 @@ + +Time handling + + +Helper functions to convert between Epoch time and Mac (iPod) time + + + + + + + + + + + + + + + + + + + +@Returns: + + + + + + + +@mactime: +@Returns: + + + + + + + +@time: +@Returns: + + diff --git a/docs/reference/tmpl/libgpod-unused.sgml b/docs/reference/tmpl/libgpod-unused.sgml new file mode 100644 index 0000000..6fd94dc --- /dev/null +++ b/docs/reference/tmpl/libgpod-unused.sgml @@ -0,0 +1,126 @@ + + + + + + + + + + + + + +Main data structure to manipulate an iPod content (songs, playlists, ...) + + + + + + + +iTunesDB + + + + + + + + + + + + + +@ITDB_FILE_ERROR_SEEK: +@ITDB_FILE_ERROR_CORRUPT: +@ITDB_FILE_ERROR_NOTFOUND: +@ITDB_FILE_ERROR_RENAME: +@ITDB_FILE_ERROR_ITDB_CORRUPT: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +@Returns: + diff --git a/docs/reference/tmpl/playlists.sgml b/docs/reference/tmpl/playlists.sgml new file mode 100644 index 0000000..70395be --- /dev/null +++ b/docs/reference/tmpl/playlists.sgml @@ -0,0 +1,287 @@ + +Playlists + + +Data structure to represent an iPod playlist + + + + + + + + + + + + + + + + + + + +@itdb: +@name: +@type: +@flag1: +@flag2: +@flag3: +@num: +@members: +@is_spl: +@timestamp: +@id: +@mhodcount: +@libmhodcount: +@sortorder: +@podcastflag: +@splpref: +@splrules: +@usertype: +@userdata: +@userdata_duplicate: +@userdata_destroy: + + + + + + +@ITDB_PSO_MANUAL: +@ITDB_PSO_TITLE: +@ITDB_PSO_ALBUM: +@ITDB_PSO_ARTIST: +@ITDB_PSO_BIRATE: +@ITDB_PSO_GENRE: +@ITDB_PSO_FILETYPE: +@ITDB_PSO_TIME_MODIFIED: +@ITDB_PSO_TRACK_NR: +@ITDB_PSO_SIZE: +@ITDB_PSO_TIME: +@ITDB_PSO_YEAR: +@ITDB_PSO_SAMPLERATE: +@ITDB_PSO_COMMENT: +@ITDB_PSO_TIME_ADDED: +@ITDB_PSO_EQUALIZER: +@ITDB_PSO_COMPOSER: +@ITDB_PSO_PLAYCOUNT: +@ITDB_PSO_TIME_PLAYED: +@ITDB_PSO_CD_NR: +@ITDB_PSO_RATING: +@ITDB_PSO_RELEASE_DATE: +@ITDB_PSO_BPM: +@ITDB_PSO_GROUPING: +@ITDB_PSO_CATEGORY: +@ITDB_PSO_DESCRIPTION: + + + + + + +@title: +@spl: +@Returns: + + + + + + + +@pl: + + + + + + + +@pl: +@Returns: + + + + + + + +@itdb: +@pl: +@pos: + + + + + + + +@pl: +@pos: + + + + + + + +@pl: + + + + + + + +@pl: + + + + + + + +@pl: +@track: +@pos: + + + + + + + +@pl: +@track: + + + + + + + +@pl: +@track: +@Returns: + + + + + + + +@tr: +@Returns: + + + + + + + +@pl: +@Returns: + + + + + + + +@itdb: +@Returns: + + + + + + + +@pl: +@Returns: + + + + + + + +@pl: + + + + + + + +@itdb: +@Returns: + + + + + + + +@pl: +@Returns: + + + + + + + +@pl: + + + + + + + +@itdb: +@pl: +@Returns: + + + + + + + +@itdb: +@id: +@Returns: + + + + + + + +@itdb: +@num: +@Returns: + + + + + + + +@itdb: +@name: +@Returns: + + + + + + + +@pl: + + diff --git a/docs/reference/tmpl/smart-playlists.sgml b/docs/reference/tmpl/smart-playlists.sgml new file mode 100644 index 0000000..d910ccd --- /dev/null +++ b/docs/reference/tmpl/smart-playlists.sgml @@ -0,0 +1,269 @@ + +Smart Playlists + + +Data structures used to manipulate iPod smart playlists + + + + + + + + + + + + + + + + + + + +@liveupdate: +@checkrules: +@checklimits: +@limittype: +@limitsort: +@limitvalue: +@matchcheckedonly: + + + + + + +@field: +@action: +@string: +@fromvalue: +@fromdate: +@fromunits: +@tovalue: +@todate: +@tounits: +@unk052: +@unk056: +@unk060: +@unk064: +@unk068: + + + + + + +@unk004: +@match_operator: +@rules: + + + + + + +@SPLACTION_IS_INT: +@SPLACTION_IS_GREATER_THAN: +@SPLACTION_IS_LESS_THAN: +@SPLACTION_IS_IN_THE_RANGE: +@SPLACTION_IS_IN_THE_LAST: +@SPLACTION_IS_STRING: +@SPLACTION_CONTAINS: +@SPLACTION_STARTS_WITH: +@SPLACTION_ENDS_WITH: +@SPLACTION_IS_NOT_INT: +@SPLACTION_IS_NOT_GREATER_THAN: +@SPLACTION_IS_NOT_LESS_THAN: +@SPLACTION_IS_NOT_IN_THE_RANGE: +@SPLACTION_IS_NOT_IN_THE_LAST: +@SPLACTION_IS_NOT: +@SPLACTION_DOES_NOT_CONTAIN: +@SPLACTION_DOES_NOT_START_WITH: +@SPLACTION_DOES_NOT_END_WITH: + + + + + + +@splft_string: +@splft_int: +@splft_boolean: +@splft_date: +@splft_playlist: +@splft_unknown: + + + + + + +@splat_string: +@splat_int: +@splat_date: +@splat_range_int: +@splat_range_date: +@splat_inthelast: +@splat_playlist: +@splat_none: +@splat_invalid: +@splat_unknown: + + + + + + +@SPLFIELD_SONG_NAME: +@SPLFIELD_ALBUM: +@SPLFIELD_ARTIST: +@SPLFIELD_BITRATE: +@SPLFIELD_SAMPLE_RATE: +@SPLFIELD_YEAR: +@SPLFIELD_GENRE: +@SPLFIELD_KIND: +@SPLFIELD_DATE_MODIFIED: +@SPLFIELD_TRACKNUMBER: +@SPLFIELD_SIZE: +@SPLFIELD_TIME: +@SPLFIELD_COMMENT: +@SPLFIELD_DATE_ADDED: +@SPLFIELD_COMPOSER: +@SPLFIELD_PLAYCOUNT: +@SPLFIELD_LAST_PLAYED: +@SPLFIELD_DISC_NUMBER: +@SPLFIELD_RATING: +@SPLFIELD_COMPILATION: +@SPLFIELD_BPM: +@SPLFIELD_GROUPING: +@SPLFIELD_PLAYLIST: + + + + + + + + + + + + + + + + + + + + + + + + + + + +@splr: +@Returns: + + + + + + + +@splr: +@Returns: + + + + + + + +@splr: + + + + + + + +@pl: +@splr: + + + + + + + +@Returns: + + + + + + + +@pl: +@splr: +@pos: + + + + + + + +@pl: +@pos: +@Returns: + + + + + + + +@dest: +@src: + + + + + + + +@splr: +@track: +@Returns: + + + + + + + +@spl: + + + + + + + +@itdb: + + + + + + + +@itdb: + + diff --git a/docs/reference/tmpl/track.sgml b/docs/reference/tmpl/track.sgml new file mode 100644 index 0000000..a96c52f --- /dev/null +++ b/docs/reference/tmpl/track.sgml @@ -0,0 +1,232 @@ + +Tracks + + +Data structure to store metadata about an iPod track + + + + + + + + + + + + + + + + + + + +@itdb: +@title: +@ipod_path: +@album: +@artist: +@genre: +@filetype: +@comment: +@category: +@composer: +@grouping: +@description: +@podcasturl: +@podcastrss: +@chapterdata: +@subtitle: +@id: +@size: +@tracklen: +@cd_nr: +@cds: +@track_nr: +@tracks: +@bitrate: +@samplerate: +@samplerate_low: +@year: +@volume: +@soundcheck: +@time_added: +@time_played: +@time_modified: +@bookmark_time: +@rating: +@playcount: +@playcount2: +@recent_playcount: +@transferred: +@BPM: +@app_rating: +@type1: +@type2: +@compilation: +@starttime: +@stoptime: +@checked: +@dbid: +@drm_userid: +@visible: +@filetype_marker: +@artwork_count: +@artwork_size: +@samplerate2: +@unk126: +@unk132: +@time_released: +@unk144: +@unk146: +@unk148: +@unk152: +@unk156: +@unk160: +@has_artwork: +@flag2: +@flag3: +@flag4: +@dbid2: +@lyrics_flag: +@movie_flag: +@mark_unplayed: +@unk179: +@unk180: +@unk184: +@samplecount: +@unk192: +@unk196: +@unk200: +@unk204: +@unk208: +@unk212: +@unk216: +@unk220: +@unk224: +@unk228: +@unk232: +@unk236: +@unk240: +@chapterdata_raw: +@chapterdata_raw_length: +@artwork: +@usertype: +@userdata: +@userdata_duplicate: +@userdata_destroy: + + + + + + +@Returns: + + + + + + + +@track: + + + + + + + +@itdb: +@track: +@pos: + + + + + + + +@track: + + + + + + + +@track: + + + + + + + +@tr: +@Returns: + + + + + + + +@itdb: +@id: +@Returns: + + + + + + + +@itdb: +@Returns: + + + + + + + +@idtree: + + + + + + + +@idtree: +@id: +@Returns: + + + + + + + +@track: +@filename: +@Returns: + + + + + + + +@track: + + + + + + + + + diff --git a/docs/reference/version.xml.in b/docs/reference/version.xml.in new file mode 100644 index 0000000..0426cae --- /dev/null +++ b/docs/reference/version.xml.in @@ -0,0 +1,4 @@ + + +@LIBGPOD_VERSION@ -- cgit