OggPacket.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 #include <string>
00035 using namespace std;
00036 #include <libilliCore/StringHelper.h>
00037 
00038 class LIBOOOGG_API OggPacket
00039 {
00040 public:
00041         //Constructors
00042         OggPacket(void);
00043         OggPacket(unsigned char* inPackData, unsigned long inPacketSize, bool inIsTruncated, bool inIsContinuation);
00044         virtual ~OggPacket(void);
00045 
00046         static const unsigned long HEX_DUMP_LINE_LENGTH = 16;
00047 
00049         virtual OggPacket* clone();
00050                                         
00052         unsigned long packetSize() const;
00053 
00055         unsigned char* packetData();
00056         
00058         bool isTruncated() const;
00059 
00061         bool isContinuation() const;
00062 
00064         void setIsTruncated(bool inIsTruncated);
00065 
00067         void setIsContinuation(bool inIsContinuation);
00068 
00070         void setPacketSize (unsigned long inPacketSize );
00071 
00073         void setPacketData (unsigned char* inPacketData );
00074 
00076         virtual void merge(const OggPacket* inMorePacket);
00077 
00079         string toPackDumpString();
00080         
00081 protected:
00082         //Packet member data
00083         unsigned long mPacketSize;
00084         unsigned char* mPacketData;
00085 
00086         bool mIsTruncated;
00087         bool mIsContinuation;
00088 
00089         //TODO::Should these be here ?
00090         string OggPacket::dumpNCharsToString(unsigned char* inStartPoint, unsigned long inNumChars) ;
00091         string OggPacket::padField(string inString, unsigned long inPadWidth, unsigned char inPadChar);
00092 
00093 private:
00094         OggPacket& operator=(const OggPacket& other);  /* Don't assign me */
00095         OggPacket(const OggPacket& other); /* Don't copy me */
00096         
00097 };

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