oggpage.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_OGGPAGE_H
#define TAGLIB_OGGPAGE_H
 
#include "taglib_export.h"
#include "tbytevectorlist.h"
 
namespace TagLib {
 
  namespace Ogg {
 
    class File;
    class PageHeader;
 
 
    class TAGLIB_EXPORT Page
    {
    public:
      Page(File *file, long pageOffset);
 
      virtual ~Page();
 
      long fileOffset() const;
 
      const PageHeader *header() const;
 
      int pageSequenceNumber() const;
 
      void setPageSequenceNumber(int sequenceNumber);
 
      Page* getCopyWithNewPageSequenceNumber(int sequenceNumber);
 
      int firstPacketIndex() const;
 
      void setFirstPacketIndex(int index);
 
      enum ContainsPacketFlags {
        DoesNotContainPacket = 0x0000,
        CompletePacket       = 0x0001,
        BeginsWithPacket     = 0x0002,
        EndsWithPacket       = 0x0004
      };
 
      ContainsPacketFlags containsPacket(int index) const;
 
      unsigned int packetCount() const;
 
      ByteVectorList packets() const;
 
      int size() const;
 
      ByteVector render() const;
 
      enum PaginationStrategy {
        SinglePagePerGroup,
        Repaginate
      };
 
      static List<Page *> paginate(const ByteVectorList &packets,
                                   PaginationStrategy strategy,
                                   unsigned int streamSerialNumber,
                                   int firstPage,
                                   bool firstPacketContinued = false,
                                   bool lastPacketCompleted = true,
                                   bool containsLastPacket = false);
 
    protected:
      Page(const ByteVectorList &packets,
           unsigned int streamSerialNumber,
           int pageNumber,
           bool firstPacketContinued = false,
           bool lastPacketCompleted = true,
           bool containsLastPacket = false);
 
    private:
      Page(const Page &);
      Page &operator=(const Page &);
 
      class PagePrivate;
      PagePrivate *d;
    };
  }
}
#endif