TagLib 1.6.1 (TagLib: oggpageheader.h Source File)

oggpageheader.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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  *
00019  *   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_OGGPAGEHEADER_H
00027 #define TAGLIB_OGGPAGEHEADER_H
00028 
00029 #include "tlist.h"
00030 #include "tbytevector.h"
00031 #include "taglib_export.h"
00032 
00033 namespace TagLib {
00034 
00035   namespace Ogg {
00036 
00037     class File;
00038 
00040 
00047     class TAGLIB_EXPORT PageHeader
00048     {
00049     public:
00055       PageHeader(File *file = 0, long pageOffset = -1);
00056 
00060       virtual ~PageHeader();
00061 
00065       bool isValid() const;
00066 
00074       List<int> packetSizes() const;
00075 
00082       void setPacketSizes(const List<int> &sizes);
00083 
00092       bool firstPacketContinued() const;
00093 
00100       void setFirstPacketContinued(bool continued);
00101 
00109       bool lastPacketCompleted() const;
00110 
00117       void setLastPacketCompleted(bool completed);
00118 
00124       bool firstPageOfStream() const;
00125 
00131       void setFirstPageOfStream(bool first);
00132 
00138       bool lastPageOfStream() const;
00139 
00145       void setLastPageOfStream(bool last);
00146 
00154       long long absoluteGranularPosition() const;
00155 
00163       void setAbsoluteGranularPosition(long long agp);
00164 
00172       uint streamSerialNumber() const;
00173 
00182       void setStreamSerialNumber(uint n);
00183 
00190       int pageSequenceNumber() const;
00191 
00197       void setPageSequenceNumber(int sequenceNumber);
00198 
00202       int size() const;
00203 
00208       int dataSize() const;
00209 
00216       ByteVector render() const;
00217 
00218     private:
00219       PageHeader(const PageHeader &);
00220       PageHeader &operator=(const PageHeader &);
00221 
00222       void read();
00223       ByteVector lacingValues() const;
00224 
00225       class PageHeaderPrivate;
00226       PageHeaderPrivate *d;
00227     };
00228 
00229   }
00230 }
00231 
00232 #endif