libs/taglib/taglib/fileref.h

   1 /***************************************************************************
   2     copyright            : (C) 2002 - 2008 by Scott Wheeler
   3     email                : wheeler@kde.org
   4  ***************************************************************************/
   5
   6 /***************************************************************************
   7  *   This library is free software; you can redistribute it and/or modify  *
   8  *   it under the terms of the GNU Lesser General Public License version   *
   9  *   2.1 as published by the Free Software Foundation.                     *
  10  *                                                                         *
  11  *   This library is distributed in the hope that it will be useful, but   *
  12  *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
  14  *   Lesser General Public License for more details.                       *
  15  *                                                                         *
  16  *   You should have received a copy of the GNU Lesser General Public      *
  17  *   License along with this library; if not, write to the Free Software   *
  18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
  19  *   USA                                                                   *
  20  *                                                                         *
  21  *   Alternatively, this file is available under the Mozilla Public        *
  22  *   License Version 1.1.  You may obtain a copy of the License at         *
  23  *   http://www.mozilla.org/MPL/                                           *
  24  ***************************************************************************/
  25
  26 #ifndef TAGLIB_FILEREF_H
  27 #define TAGLIB_FILEREF_H
  28
  29 #include <tfile.h>
  30 #include <tstringlist.h>
  31
  32 #include "taglib_export.h"
  33 #include "audioproperties.h"
  34
  35 namespace TagLib {
  36
  37   class Tag;
  38
  39   //! This class provides a simple abstraction for creating and handling files
  40
  41   /*!
  42    * FileRef exists to provide a minimal, generic and value-based wrapper around
  43    * a File.  It is lightweight and implicitly shared, and as such suitable for
  44    * pass-by-value use.  This hides some of the uglier details of TagLib::File
  45    * and the non-generic portions of the concrete file implementations.
  46    *
  47    * This class is useful in a "simple usage" situation where it is desirable
  48    * to be able to get and set some of the tag information that is similar
  49    * across file types.
  50    *
  51    * Also note that it is probably a good idea to plug this into your mime
  52    * type system rather than using the constructor that accepts a file name using
  53    * the FileTypeResolver.
  54    *
  55    * \see FileTypeResolver
  56    * \see addFileTypeResolver()
  57    */
  58
  59   class TAGLIB_EXPORT FileRef
  60   {
  61   public:
  62
  63   //! A class for pluggable file type resolution.
  64
  65   /*!
  66    * This class is used to add extend TagLib's very basic file name based file
  67    * type resolution.
  68    *
  69    * This can be accomplished with:
  70    *
  71    * \code
  72    *
  73    * class MyFileTypeResolver : FileTypeResolver
  74    * {
  75    *   TagLib::File *createFile(TagLib::FileName *fileName, bool, AudioProperties::ReadStyle)
  76    *   {
  77    *     if(someCheckForAnMP3File(fileName))
  78    *       return new TagLib::MPEG::File(fileName);
  79    *     return 0;
  80    *   }
  81    * }
  82    *
  83    * FileRef::addFileTypeResolver(new MyFileTypeResolver);
  84    *
  85    * \endcode
  86    *
  87    * Naturally a less contrived example would be slightly more complex.  This
  88    * can be used to plug in mime-type detection systems or to add new file types
  89    * to TagLib.
  90    */
  91
  92     class TAGLIB_EXPORT FileTypeResolver
  93     {
  94     public:
  95       // do not fix compiler warning about missing virtual destructor
  96       // since this would not be binary compatible
  97       // let Scott fix it whenever he thinks BIC changes can next be applied
  98       /*!
  99        * This method must be overridden to provide an additional file type
 100        * resolver.  If the resolver is able to determine the file type it should
 101        * return a valid File object; if not it should return 0.
 102        *
 103        * \note The created file is then owned by the FileRef and should not be
 104        * deleted.  Deletion will happen automatically when the FileRef passes
 105        * out of scope.
 106        */
 107       virtual File *createFile(FileName fileName,
 108                                bool readAudioProperties = true,
 109                                AudioProperties::ReadStyle
 110                                audioPropertiesStyle = AudioProperties::Average) const = 0;
 111     };
 112
 113     /*!
 114      * Creates a null FileRef.
 115      */
 116     FileRef();
 117
 118     /*!
 119      * Create a FileRef from \a fileName.  If \a readAudioProperties is true then
 120      * the audio properties will be read using \a audioPropertiesStyle.  If
 121      * \a readAudioProperties is false then \a audioPropertiesStyle will be
 122      * ignored.
 123      *
 124      * Also see the note in the class documentation about why you may not want to
 125      * use this method in your application.
 126      */
 127     explicit FileRef(FileName fileName,
 128                      bool readAudioProperties = true,
 129                      AudioProperties::ReadStyle
 130                      audioPropertiesStyle = AudioProperties::Average);
 131
 132     /*!
 133      * Contruct a FileRef using \a file.  The FileRef now takes ownership of the
 134      * pointer and will delete the File when it passes out of scope.
 135      */
 136     explicit FileRef(File *file);
 137
 138     /*!
 139      * Make a copy of \a ref.
 140      */
 141     FileRef(const FileRef &ref);
 142
 143     /*!
 144      * Destroys this FileRef instance.
 145      */
 146     virtual ~FileRef();
 147
 148     /*!
 149      * Returns a pointer to represented file's tag.
 150      *
 151      * \warning This pointer will become invalid when this FileRef and all
 152      * copies pass out of scope.
 153      *
 154      * \see File::tag()
 155      */
 156     Tag *tag() const;
 157
 158     /*!
 159      * Returns the audio properties for this FileRef.  If no audio properties
 160      * were read then this will returns a null pointer.
 161      */
 162     AudioProperties *audioProperties() const;
 163
 164     /*!
 165      * Returns a pointer to the file represented by this handler class.
 166      *
 167      * As a general rule this call should be avoided since if you need to work
 168      * with file objects directly, you are probably better served instantiating
 169      * the File subclasses (i.e. MPEG::File) manually and working with their APIs.
 170      *
 171      * This <i>handle</i> exists to provide a minimal, generic and value-based
 172      * wrapper around a File.  Accessing the file directly generally indicates
 173      * a moving away from this simplicity (and into things beyond the scope of
 174      * FileRef).
 175      *
 176      * \warning This pointer will become invalid when this FileRef and all
 177      * copies pass out of scope.
 178      */
 179     File *file() const;
 180
 181     /*!
 182      * Saves the file.  Returns true on success.
 183      */
 184     bool save();
 185
 186     /*!
 187      * Adds a FileTypeResolver to the list of those used by TagLib.  Each
 188      * additional FileTypeResolver is added to the front of a list of resolvers
 189      * that are tried.  If the FileTypeResolver returns zero the next resolver
 190      * is tried.
 191      *
 192      * Returns a pointer to the added resolver (the same one that's passed in --
 193      * this is mostly so that static inialializers have something to use for
 194      * assignment).
 195      *
 196      * \see FileTypeResolver
 197      */
 198     static const FileTypeResolver *addFileTypeResolver(const FileTypeResolver *resolver);
 199
 200     /*!
 201      * As is mentioned elsewhere in this class's documentation, the default file
 202      * type resolution code provided by TagLib only works by comparing file
 203      * extensions.
 204      *
 205      * This method returns the list of file extensions that are used by default.
 206      *
 207      * The extensions are all returned in lowercase, though the comparison used
 208      * by TagLib for resolution is case-insensitive.
 209      *
 210      * \note This does not account for any additional file type resolvers that
 211      * are plugged in.  Also note that this is not intended to replace a propper
 212      * mime-type resolution system, but is just here for reference.
 213      *
 214      * \see FileTypeResolver
 215      */
 216     static StringList defaultFileExtensions();
 217
 218     /*!
 219      * Returns true if the file (and as such other pointers) are null.
 220      */
 221     bool isNull() const;
 222
 223     /*!
 224      * Assign the file pointed to by \a ref to this FileRef.
 225      */
 226     FileRef &operator=(const FileRef &ref);
 227
 228     /*!
 229      * Returns true if this FileRef and \a ref point to the same File object.
 230      */
 231     bool operator==(const FileRef &ref) const;
 232
 233     /*!
 234      * Returns true if this FileRef and \a ref do not point to the same File
 235      * object.
 236      */
 237     bool operator!=(const FileRef &ref) const;
 238
 239     /*!
 240      * A simple implementation of file type guessing.  If \a readAudioProperties
 241      * is true then the audio properties will be read using
 242      * \a audioPropertiesStyle.  If \a readAudioProperties is false then
 243      * \a audioPropertiesStyle will be ignored.
 244      *
 245      * \note You generally shouldn't use this method, but instead the constructor
 246      * directly.
 247      *
 248      * \deprecated
 249      */
 250     static File *create(FileName fileName,
 251                         bool readAudioProperties = true,
 252                         AudioProperties::ReadStyle audioPropertiesStyle = AudioProperties::Average);
 253
 254
 255   private:
 256     class FileRefPrivate;
 257     FileRefPrivate *d;
 258   };
 259
 260 } // namespace TagLib
 261
 262 #endif