OggPage.h

Go to the documentation of this file.
00001 //===========================================================================
00002 //Copyright (C) 2003, 2004 Zentaro Kavanagh
00003 //
00004 //Redistribution and use in source and binary forms, with or without
00005 //modification, are permitted provided that the following conditions
00006 //are met:
00007 //
00008 //- Redistributions of source code must retain the above copyright
00009 //  notice, this list of conditions and the following disclaimer.
00010 //
00011 //- Redistributions in binary form must reproduce the above copyright
00012 //  notice, this list of conditions and the following disclaimer in the
00013 //  documentation and/or other materials provided with the distribution.
00014 //
00015 //- Neither the name of Zentaro Kavanagh nor the names of contributors 
00016 //  may be used to endorse or promote products derived from this software 
00017 //  without specific prior written permission.
00018 //
00019 //THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00020 //``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00021 //LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00022 //PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE ORGANISATION OR
00023 //CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00024 //EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00025 //PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00026 //PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00027 //LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00028 //NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00029 //SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00030 //===========================================================================
00031 
00032 #pragma once
00033 
00034 //STL Includes
00035 #include <vector>
00036 using namespace std;
00037 
00038 //Class Includes
00039 #include <libOOOgg/StampedOggPacket.h>
00040 #include <libOOOgg/OggPageHeader.h>
00041 #include <libOOOgg/IOggPackSource.h>
00042 
00043 //OggPage represents an Ogg Encapsulation Format page
00044 class LIBOOOGG_API OggPage
00045         : public IOggPackSource
00046 {
00047 public:
00048         //Constants
00049         static const unsigned long HEX_DUMP_LINE_LENGTH = 16;
00050         
00051         //Constructors
00052         OggPage(void);
00053         virtual ~OggPage(void);
00054 
00056         OggPage* clone();
00057         
00059         unsigned long pageSize();
00060 
00062         unsigned long headerSize();
00063 
00065         unsigned long dataSize();
00066 
00067         //IOggPackSource Implementation
00068         virtual OggPacket* getPacket(unsigned long inPacketNo);
00069         virtual unsigned long numPackets();
00070 
00072         StampedOggPacket* getStampedPacket(unsigned long inPacketNo);
00073 
00074         //TODO::: This really shouldn't be ehere.
00075         bool addPacket(StampedOggPacket* inPacket);
00076         
00078         OggPageHeader* header();
00079         
00081         unsigned char* createRawPageData();
00082 
00084         void computeAndSetCRCChecksum();
00085 
00086 protected:
00087         //Member data of packets and header.
00088         vector<StampedOggPacket*> mPacketList;
00089         OggPageHeader* mHeader;
00090 
00091 private:
00092         OggPage& operator=(const OggPage& other);  /* Don't assign me */
00093         OggPage(const OggPage& other); /* Don't copy me */
00094 };

Generated on Tue Feb 15 14:54:21 2005 for oggdsf by  doxygen 1.3.9