![]() |
|
00001 /*************************************************************************** 00002 copyright : (C) 2002 - 2008 by Scott Wheeler 00003 email : wheeler@kde.org 00004 ***************************************************************************/ 00005 00006 /*************************************************************************** 00007 * This library is free software; you can redistribute it and/or modify * 00008 * it under the terms of the GNU Lesser General Public License version * 00009 * 2.1 as published by the Free Software Foundation. * 00010 * * 00011 * This library is distributed in the hope that it will be useful, but * 00012 * WITHOUT ANY WARRANTY; without even the implied warranty of * 00013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * 00014 * Lesser General Public License for more details. * 00015 * * 00016 * You should have received a copy of the GNU Lesser General Public * 00017 * License along with this library; if not, write to the Free Software * 00018 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA * 00019 * 02110-1301 USA * 00020 * * 00021 * Alternatively, this file is available under the Mozilla Public * 00022 * License Version 1.1. You may obtain a copy of the License at * 00023 * http://www.mozilla.org/MPL/ * 00024 ***************************************************************************/ 00025 00026 #ifndef TAGLIB_VORBISFILE_H 00027 #define TAGLIB_VORBISFILE_H 00028 00029 #include "taglib_export.h" 00030 #include "oggfile.h" 00031 #include "xiphcomment.h" 00032 00033 #include "vorbisproperties.h" 00034 00035 namespace TagLib { 00036 00037 /* 00038 * This is just to make this appear to be in the Ogg namespace in the 00039 * documentation. The typedef below will make this work with the current code. 00040 * In the next BIC version of TagLib this will be really moved into the Ogg 00041 * namespace. 00042 */ 00043 00044 #ifdef DOXYGEN 00045 namespace Ogg { 00046 #endif 00047 00049 00050 namespace Vorbis { 00051 00052 00054 00062 class TAGLIB_EXPORT File : public Ogg::File 00063 { 00064 public: 00070 File(FileName file, bool readProperties = true, 00071 Properties::ReadStyle propertiesStyle = Properties::Average); 00072 00081 File(IOStream *stream, bool readProperties = true, 00082 Properties::ReadStyle propertiesStyle = Properties::Average); 00083 00087 virtual ~File(); 00088 00094 virtual Ogg::XiphComment *tag() const; 00095 00096 00101 PropertyMap properties() const; 00102 00107 PropertyMap setProperties(const PropertyMap &); 00108 00113 virtual Properties *audioProperties() const; 00114 00115 virtual bool save(); 00116 00117 private: 00118 File(const File &); 00119 File &operator=(const File &); 00120 00121 void read(bool readProperties, Properties::ReadStyle propertiesStyle); 00122 00123 class FilePrivate; 00124 FilePrivate *d; 00125 }; 00126 } 00127 00128 /* 00129 * To keep compatibility with the current version put Vorbis in the Ogg namespace 00130 * only in the docs and provide a typedef to make it work. In the next BIC 00131 * version this will be removed and it will only exist in the Ogg namespace. 00132 */ 00133 00134 #ifdef DOXYGEN 00135 } 00136 #else 00137 namespace Ogg { namespace Vorbis { typedef TagLib::Vorbis::File File; } } 00138 #endif 00139 00140 } 00141 00142 #endif