relativevolumeframe.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_RELATIVEVOLUMEFRAME_H
#define TAGLIB_RELATIVEVOLUMEFRAME_H

#include "tlist.h"
#include "taglib_export.h"
#include "id3v2frame.h"

namespace TagLib {

  namespace ID3v2 {


    class TAGLIB_EXPORT RelativeVolumeFrame : public Frame
    {
      friend class FrameFactory;

    public:

      enum ChannelType {
        Other        = 0x00,
        MasterVolume = 0x01,
        FrontRight   = 0x02,
        FrontLeft    = 0x03,
        BackRight    = 0x04,
        BackLeft     = 0x05,
        FrontCentre  = 0x06,
        BackCentre   = 0x07,
        Subwoofer    = 0x08
      };


      struct PeakVolume {
        unsigned char bitsRepresentingPeak { 0 };
        ByteVector peakVolume;
      };

      RelativeVolumeFrame();

      RelativeVolumeFrame(const ByteVector &data);

      ~RelativeVolumeFrame() override;

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

      String toString() const override;

      List<ChannelType> channels() const;

      short volumeAdjustmentIndex(ChannelType type = MasterVolume) const;

      void setVolumeAdjustmentIndex(short index, ChannelType type = MasterVolume);

      float volumeAdjustment(ChannelType type = MasterVolume) const;

      void setVolumeAdjustment(float adjustment, ChannelType type = MasterVolume);

      PeakVolume peakVolume(ChannelType type = MasterVolume) const;

      void setPeakVolume(const PeakVolume &peak, ChannelType type = MasterVolume);

      String identification() const;

      void setIdentification(const String &s);

    protected:
      void parseFields(const ByteVector &data) override;
      ByteVector renderFields() const override;

    private:
      RelativeVolumeFrame(const ByteVector &data, Header *h);

      class RelativeVolumeFramePrivate;
      TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
      std::unique_ptr<RelativeVolumeFramePrivate> d;
    };

  }  // namespace ID3v2
}  // namespace TagLib
#endif