git.maemo.org Git - someplayer/blob - src/taglib/mp4/mp4file.h

   1 /**************************************************************************
   2     copyright            : (C) 2007 by Lukáš Lalinský
   3     email                : lalinsky@gmail.com
   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_MP4FILE_H
  27 #define TAGLIB_MP4FILE_H
  28
  29 #include "tag.h"
  30 #include "tfile.h"
  31 #include "taglib_export.h"
  32 #include "mp4properties.h"
  33 #include "mp4tag.h"
  34
  35 namespace TagLib {
  36
  37   //! An implementation of MP4 (AAC, ALAC, ...) metadata
  38   namespace MP4 {
  39
  40     class Atoms;
  41
  42     /*!
  43      * This implements and provides an interface for MP4 files to the
  44      * TagLib::Tag and TagLib::AudioProperties interfaces by way of implementing
  45      * the abstract TagLib::File API as well as providing some additional
  46      * information specific to MP4 files.
  47      */
  48     class TAGLIB_EXPORT File : public TagLib::File
  49     {
  50     public:
  51       /*!
  52        * Contructs a MP4 file from \a file.  If \a readProperties is true the
  53        * file's audio properties will also be read using \a propertiesStyle.  If
  54        * false, \a propertiesStyle is ignored.
  55        *
  56        * \note In the current implementation, both \a readProperties and
  57        * \a propertiesStyle are ignored.
  58        */
  59       File(FileName file, bool readProperties = true, Properties::ReadStyle audioPropertiesStyle = Properties::Average);
  60
  61       /*!
  62        * Destroys this instance of the File.
  63        */
  64       virtual ~File();
  65
  66       /*!
  67        * Returns a pointer to the MP4 tag of the file.
  68        *
  69        * MP4::Tag implements the tag interface, so this serves as the
  70        * reimplementation of TagLib::File::tag().
  71        *
  72        * \note The Tag <b>is still</b> owned by the MP4::File and should not be
  73        * deleted by the user.  It will be deleted when the file (object) is
  74        * destroyed.
  75        */
  76       Tag *tag() const;
  77
  78       /*!
  79        * Returns the MP4 audio properties for this file.
  80        */
  81       Properties *audioProperties() const;
  82
  83       /*!
  84        * Save the file.
  85        *
  86        * This returns true if the save was successful.
  87        */
  88       bool save();
  89
  90     private:
  91
  92       void read(bool readProperties, Properties::ReadStyle audioPropertiesStyle);
  93       bool checkValid(const MP4::AtomList &list);
  94
  95       class FilePrivate;
  96       FilePrivate *d;
  97     };
  98
  99   }
 100
 101 }
 102
 103 #endif