git.maemo.org Git - someplayer/blob - src/taglib/mpeg/mpegproperties.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_MPEGPROPERTIES_H
  27 #define TAGLIB_MPEGPROPERTIES_H
  28
  29 #include "taglib_export.h"
  30 #include "audioproperties.h"
  31
  32 #include "mpegheader.h"
  33
  34 namespace TagLib {
  35
  36   namespace MPEG {
  37
  38     class File;
  39     class XingHeader;
  40
  41     //! An implementation of audio property reading for MP3
  42
  43     /*!
  44      * This reads the data from an MPEG Layer III stream found in the
  45      * AudioProperties API.
  46      */
  47
  48     class TAGLIB_EXPORT Properties : public AudioProperties
  49     {
  50     public:
  51       /*!
  52        * Create an instance of MPEG::Properties with the data read from the
  53        * MPEG::File \a file.
  54        */
  55       Properties(File *file, ReadStyle style = Average);
  56
  57       /*!
  58        * Destroys this MPEG Properties instance.
  59        */
  60       virtual ~Properties();
  61
  62       // Reimplementations.
  63
  64       virtual int length() const;
  65       virtual int bitrate() const;
  66       virtual int sampleRate() const;
  67       virtual int channels() const;
  68
  69       /*!
  70        * Returns a pointer to the XingHeader if one exists or null if no
  71        * XingHeader was found.
  72        */
  73
  74       const XingHeader *xingHeader() const;
  75
  76       /*!
  77        * Returns the MPEG Version of the file.
  78        */
  79       Header::Version version() const;
  80
  81       /*!
  82        * Returns the layer version.  This will be between the values 1-3.
  83        */
  84       int layer() const;
  85
  86       /*!
  87        * Returns true if the MPEG protection bit is enabled.
  88        */
  89       bool protectionEnabled() const;
  90
  91       /*!
  92        * Returns the channel mode for this frame.
  93        */
  94       Header::ChannelMode channelMode() const;
  95
  96       /*!
  97        * Returns true if the copyrighted bit is set.
  98        */
  99       bool isCopyrighted() const;
 100
 101       /*!
 102        * Returns true if the "original" bit is set.
 103        */
 104       bool isOriginal() const;
 105
 106     private:
 107       Properties(const Properties &);
 108       Properties &operator=(const Properties &);
 109
 110       void read();
 111
 112       class PropertiesPrivate;
 113       PropertiesPrivate *d;
 114     };
 115   }
 116 }
 117
 118 #endif