mpegproperties.h

Go to the documentation of this file.

/***************************************************************************
    copyright            : (C) 2002 - 2008 by Scott Wheeler
    email                : wheeler@kde.org
 ***************************************************************************/

/***************************************************************************
 *   This library is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU Lesser General Public License version   *
 *   2.1 as published by the Free Software Foundation.                     *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful, but   *
 *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the Free Software   *
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
 *   02110-1301  USA                                                       *
 *                                                                         *
 *   Alternatively, this file is available under the Mozilla Public        *
 *   License Version 1.1.  You may obtain a copy of the License at         *
 *   http://www.mozilla.org/MPL/                                           *
 ***************************************************************************/

#ifndef TAGLIB_MPEGPROPERTIES_H
#define TAGLIB_MPEGPROPERTIES_H

#include "taglib_export.h"
#include "audioproperties.h"
#include "mpegheader.h"

namespace TagLib {

  namespace MPEG {

    class File;
    class XingHeader;


    class TAGLIB_EXPORT Properties : public AudioProperties
    {
    public:
      Properties(File *file, ReadStyle style = Average);

      ~Properties() override;

      Properties(const Properties &) = delete;
      Properties &operator=(const Properties &) = delete;

      int lengthInMilliseconds() const override;

      int bitrate() const override;

      int sampleRate() const override;

      int channels() const override;

      const XingHeader *xingHeader() const;

      Header::Version version() const;

      int layer() const;

      bool protectionEnabled() const;

      Header::ChannelMode channelMode() const;

      Header::ChannelConfiguration channelConfiguration() const;

      bool isADTS() const;

      bool isCopyrighted() const;

      bool isOriginal() const;

    private:
      void read(File *file, ReadStyle readStyle);

      class PropertiesPrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<PropertiesPrivate> d;
    };
  }  // namespace MPEG
}  // namespace TagLib

#endif