oggpage.h
Go to the documentation of this file.
00001 /***************************************************************************
00002     copyright            : (C) 2002 - 2008 by Scott Wheeler
00003     email                : wheeler@kde.org
00004  ***************************************************************************/
00005 
00006 /***************************************************************************
00007  *   This library is free software; you can redistribute it and/or modify  *
00008  *   it under the terms of the GNU Lesser General Public License version   *
00009  *   2.1 as published by the Free Software Foundation.                     *
00010  *                                                                         *
00011  *   This library is distributed in the hope that it will be useful, but   *
00012  *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
00013  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
00014  *   Lesser General Public License for more details.                       *
00015  *                                                                         *
00016  *   You should have received a copy of the GNU Lesser General Public      *
00017  *   License along with this library; if not, write to the Free Software   *
00018  *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA         *
00019  *   02110-1301  USA                                                       *
00020  *                                                                         *
00021  *   Alternatively, this file is available under the Mozilla Public        *
00022  *   License Version 1.1.  You may obtain a copy of the License at         *
00023  *   http://www.mozilla.org/MPL/                                           *
00024  ***************************************************************************/
00025 
00026 #ifndef TAGLIB_OGGPAGE_H
00027 #define TAGLIB_OGGPAGE_H
00028 
00029 #include "taglib_export.h"
00030 #include "tbytevectorlist.h"
00031 
00032 namespace TagLib {
00033 
00034   namespace Ogg {
00035 
00036     class File;
00037     class PageHeader;
00038 
00040 
00052     class TAGLIB_EXPORT Page
00053     {
00054     public:
00058       Page(File *file, long pageOffset);
00059 
00060       virtual ~Page();
00061 
00065       long fileOffset() const;
00066 
00071       const PageHeader *header() const;
00072 
00079       int pageSequenceNumber() const;
00080 
00086       void setPageSequenceNumber(int sequenceNumber);
00087 
00096       Page* getCopyWithNewPageSequenceNumber(int sequenceNumber);
00097 
00104       int firstPacketIndex() const;
00105 
00111       void setFirstPacketIndex(int index);
00112 
00119       enum ContainsPacketFlags {
00121         DoesNotContainPacket = 0x0000,
00123         CompletePacket       = 0x0001,
00125         BeginsWithPacket     = 0x0002,
00127         EndsWithPacket       = 0x0004
00128       };
00129 
00136       ContainsPacketFlags containsPacket(int index) const;
00137 
00141       unsigned int packetCount() const;
00142 
00149       ByteVectorList packets() const;
00150 
00154       int size() const;
00155 
00156       ByteVector render() const;
00157 
00165       enum PaginationStrategy {
00172         SinglePagePerGroup,
00177         Repaginate
00178       };
00179 
00199       static List<Page *> paginate(const ByteVectorList &packets,
00200                                    PaginationStrategy strategy,
00201                                    unsigned int streamSerialNumber,
00202                                    int firstPage,
00203                                    bool firstPacketContinued = false,
00204                                    bool lastPacketCompleted = true,
00205                                    bool containsLastPacket = false);
00206 
00207     protected:
00212       Page(const ByteVectorList &packets,
00213            unsigned int streamSerialNumber,
00214            int pageNumber,
00215            bool firstPacketContinued = false,
00216            bool lastPacketCompleted = true,
00217            bool containsLastPacket = false);
00218 
00219     private:
00220       Page(const Page &);
00221       Page &operator=(const Page &);
00222 
00223       class PagePrivate;
00224       PagePrivate *d;
00225     };
00226   }
00227 }
00228 #endif