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 "id3v2frame.h"
#include "taglib_export.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
      {
        PeakVolume() : bitsRepresentingPeak(0) {}
        unsigned char bitsRepresentingPeak;
        ByteVector peakVolume;
      };
 
      RelativeVolumeFrame();
 
      RelativeVolumeFrame(const ByteVector &data);
 
      virtual ~RelativeVolumeFrame();
 
      virtual String toString() const;
 
      List<ChannelType> channels() const;
 
      ChannelType channelType() const;
 
      void setChannelType(ChannelType t);
 
      /*
       * There was a terrible API goof here, and while this can't be changed to
       * the way it appears below for binary compatibility reasons, let's at
       * least pretend that it looks clean.
       */
 
#ifdef DOXYGEN
 
      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);
 
#else
 
      // BIC: Combine each of the following pairs of functions (or maybe just
      // rework this junk altogether).
 
      short volumeAdjustmentIndex(ChannelType type) const;
      short volumeAdjustmentIndex() const;
 
      void setVolumeAdjustmentIndex(short index, ChannelType type);
      void setVolumeAdjustmentIndex(short index);
 
      float volumeAdjustment(ChannelType type) const;
      float volumeAdjustment() const;
 
      void setVolumeAdjustment(float adjustment, ChannelType type);
      void setVolumeAdjustment(float adjustment);
 
      PeakVolume peakVolume(ChannelType type) const;
      PeakVolume peakVolume() const;
 
      void setPeakVolume(const PeakVolume &peak, ChannelType type);
      void setPeakVolume(const PeakVolume &peak);
 
#endif
 
      String identification() const;
 
      void setIdentification(const String &s);
 
    protected:
      virtual void parseFields(const ByteVector &data);
      virtual ByteVector renderFields() const;
 
    private:
      RelativeVolumeFrame(const ByteVector &data, Header *h);
      RelativeVolumeFrame(const RelativeVolumeFrame &);
      RelativeVolumeFrame &operator=(const RelativeVolumeFrame &);
 
      class RelativeVolumeFramePrivate;
      RelativeVolumeFramePrivate *d;
    };
 
  }
}
#endif