oggpageheader.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_OGGPAGEHEADER_H
#define TAGLIB_OGGPAGEHEADER_H

#include "tlist.h"
#include "tbytevector.h"
#include "taglib.h"
#include "taglib_export.h"

namespace TagLib {

  namespace Ogg {

    class File;


    class TAGLIB_EXPORT PageHeader
    {
    public:
      PageHeader(File *file = nullptr, offset_t pageOffset = -1);

      ~PageHeader();

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

      bool isValid() const;

      List<int> packetSizes() const;

      void setPacketSizes(const List<int> &sizes);

      bool firstPacketContinued() const;

      void setFirstPacketContinued(bool continued);

      bool lastPacketCompleted() const;

      void setLastPacketCompleted(bool completed);

      bool firstPageOfStream() const;

      void setFirstPageOfStream(bool first);

      bool lastPageOfStream() const;

      void setLastPageOfStream(bool last);

      long long absoluteGranularPosition() const;

      void setAbsoluteGranularPosition(long long agp);

      unsigned int streamSerialNumber() const;

      void setStreamSerialNumber(unsigned int n);

      int pageSequenceNumber() const;

      void setPageSequenceNumber(int sequenceNumber);

      int size() const;

      int dataSize() const;

      ByteVector render() const;

    private:
      void read(Ogg::File *file, offset_t pageOffset);
      ByteVector lacingValues() const;

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

  }  // namespace Ogg
}  // namespace TagLib

#endif