VorbisComments.h

Go to the documentation of this file.
00001 //===========================================================================
00002 //Copyright (C) 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 #include "libVorbisComment.h"
00034 #include <string>
00035 #include <vector>
00036 
00037 using namespace std;
00038 #include "SingleVorbisComment.h"
00039 #include <libOOOgg/OggPacket.h>
00040 #include <libilliCore/iLE_Math.h>
00041 
00042 class LIBVORBISCOMMENT_API VorbisComments
00043 {
00044 public:
00045         VorbisComments(void);
00046         ~VorbisComments(void);
00047 
00048         string vendorString();
00049         bool setVendorString(string inVendorString);
00050 
00051         unsigned long numUserComments();
00052         SingleVorbisComment* getUserComment(unsigned long inIndex);
00053         
00054         vector<SingleVorbisComment*> getCommentsByKey(string inKey);
00055 
00056         bool addComment(SingleVorbisComment* inComment);
00057         bool addComment(string inKey, string inValue);
00058 
00059         bool parseOggPacket(OggPacket* inPacket, unsigned long inStartOffset);
00060         OggPacket* toOggPacket(unsigned char* inPrefixBuff, unsigned long inPrefixBuffSize);
00061         string toString();
00062 
00063         unsigned long size();
00064 protected:
00065         string mVendorString;
00066         vector<SingleVorbisComment*> mCommentList;
00067 };

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