no message
[xbmc:xbmc-antiquated.git] / xbmc / lib / libID3 / helpers.h
1 // -*- C++ -*-
2 // $Id$
3
4 // id3lib: a C++ library for creating and manipulating id3v1/v2 tags
5 // Copyright 1999, 2000  Scott Thomas Haug
6
7 // This library is free software; you can redistribute it and/or modify it
8 // under the terms of the GNU Library General Public License as published by
9 // the Free Software Foundation; either version 2 of the License, or (at your
10 // option) any later version.
11 //
12 // This library is distributed in the hope that it will be useful, but WITHOUT
13 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 // FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
15 // License for more details.
16 //
17 // You should have received a copy of the GNU Library General Public License
18 // along with this library; if not, write to the Free Software Foundation,
19 // Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20
21 // The id3lib authors encourage improvements and optimisations to be sent to
22 // the id3lib coordinator.  Please see the README file for details on where to
23 // send such submissions.  See the AUTHORS file for a list of people who have
24 // contributed to id3lib.  See the ChangeLog file for a list of changes to
25 // id3lib.  These files are distributed with id3lib at
26 // http://download.sourceforge.net/id3lib/
27
28 #ifndef _ID3LIB_HELPERS_H_
29 #define _ID3LIB_HELPERS_H_
30
31 #include "id3lib_strings.h"
32 #include "globals.h" //has <stdlib.h> "sized_types.h"
33
34 class ID3_TagImpl;
35 class ID3_Frame;
36
37 namespace dami
38 {
39   namespace id3
40   {
41     namespace v2
42     {
43       ID3_C_EXPORT String     getString(const ID3_Frame*, ID3_FieldID);
44       ID3_C_EXPORT String     getStringAtIndex(const ID3_Frame*, ID3_FieldID, size_t);
45       
46       ID3_C_EXPORT String     getFrameText(const ID3_TagImpl&, ID3_FrameID);
47       ID3_C_EXPORT ID3_Frame* setFrameText(ID3_TagImpl&, ID3_FrameID, String);
48       ID3_C_EXPORT size_t     removeFrames(ID3_TagImpl&, ID3_FrameID);
49
50       ID3_C_EXPORT ID3_Frame* hasArtist(const ID3_TagImpl&);
51       ID3_C_EXPORT String     getArtist(const ID3_TagImpl&);
52       ID3_C_EXPORT ID3_Frame* setArtist(ID3_TagImpl&, String);
53       ID3_C_EXPORT size_t     removeArtists(ID3_TagImpl&);
54
55       ID3_C_EXPORT ID3_Frame* hasAlbum(const ID3_TagImpl&);
56       ID3_C_EXPORT String     getAlbum(const ID3_TagImpl&);
57       ID3_C_EXPORT ID3_Frame* setAlbum(ID3_TagImpl&, String);
58       ID3_C_EXPORT size_t     removeAlbums(ID3_TagImpl&);
59       
60       ID3_C_EXPORT ID3_Frame* hasTitle(const ID3_TagImpl&);
61       ID3_C_EXPORT String     getTitle(const ID3_TagImpl&);
62       ID3_C_EXPORT ID3_Frame* setTitle(ID3_TagImpl&, String);
63       ID3_C_EXPORT size_t     removeTitles(ID3_TagImpl&);
64       
65       ID3_C_EXPORT ID3_Frame* hasYear(const ID3_TagImpl&);
66       ID3_C_EXPORT String     getYear(const ID3_TagImpl&);
67       ID3_C_EXPORT ID3_Frame* setYear(ID3_TagImpl&, String);
68       ID3_C_EXPORT size_t     removeYears(ID3_TagImpl&);
69       
70       ID3_C_EXPORT ID3_Frame* hasV1Comment(const ID3_TagImpl&);
71       //      ID3_C_EXPORT ID3_Frame* hasComment(const ID3_TagImpl&, String desc);
72       ID3_C_EXPORT ID3_Frame* hasComment(const ID3_TagImpl&);
73       ID3_C_EXPORT String     getComment(const ID3_TagImpl&, String desc);
74       ID3_C_EXPORT String     getV1Comment(const ID3_TagImpl&);
75       ID3_C_EXPORT ID3_Frame* setComment(ID3_TagImpl&, String, String, String);
76       ID3_C_EXPORT size_t     removeComments(ID3_TagImpl&, String);
77       ID3_C_EXPORT size_t     removeAllComments(ID3_TagImpl&);
78       
79       ID3_C_EXPORT ID3_Frame* hasTrack(const ID3_TagImpl&);
80       ID3_C_EXPORT String     getTrack(const ID3_TagImpl&);
81       ID3_C_EXPORT size_t     getTrackNum(const ID3_TagImpl&);
82       ID3_C_EXPORT ID3_Frame* setTrack(ID3_TagImpl&, uchar ucTrack, uchar ucTotal);
83       ID3_C_EXPORT size_t     removeTracks(ID3_TagImpl&);
84       
85       ID3_C_EXPORT ID3_Frame* hasGenre(const ID3_TagImpl&);
86       ID3_C_EXPORT String     getGenre(const ID3_TagImpl&);
87       ID3_C_EXPORT size_t     getGenreNum(const ID3_TagImpl&);
88       ID3_C_EXPORT ID3_Frame* setGenre(ID3_TagImpl&, size_t ucGenre);
89       ID3_C_EXPORT size_t     removeGenres(ID3_TagImpl&);
90       
91       ID3_C_EXPORT ID3_Frame* hasLyrics(const ID3_TagImpl&);
92       ID3_C_EXPORT String     getLyrics(const ID3_TagImpl&);
93       ID3_C_EXPORT ID3_Frame* setLyrics(ID3_TagImpl&, String, String, String);
94       ID3_C_EXPORT size_t     removeLyrics(ID3_TagImpl&);
95       
96       ID3_C_EXPORT String     getLyricist(const ID3_TagImpl&);
97       ID3_C_EXPORT ID3_Frame* setLyricist(ID3_TagImpl&, String);
98       ID3_C_EXPORT size_t     removeLyricists(ID3_TagImpl&);
99       
100       ID3_C_EXPORT ID3_Frame* hasSyncLyrics(const ID3_TagImpl&, String lang, String desc);
101       ID3_C_EXPORT ID3_Frame* setSyncLyrics(ID3_TagImpl&, BString, ID3_TimeStampFormat, 
102                                String, String, ID3_ContentType);
103       ID3_C_EXPORT BString    getSyncLyrics(const ID3_TagImpl& tag, String lang, String desc);
104     };
105   };
106 };
107       
108 #endif /* _ID3LIB_HELPERS_H_ */
109