libxspf  1.2.0
ProjectOpusPlaylistExtension.h
Go to the documentation of this file.
00001 /*
00002  * libxspf - XSPF playlist handling library
00003  *
00004  * Copyright (C) 2006-2008, Sebastian Pipping / Xiph.Org Foundation
00005  * All rights reserved.
00006  *
00007  * Redistribution  and use in source and binary forms, with or without
00008  * modification,  are permitted provided that the following conditions
00009  * are met:
00010  *
00011  *     * Redistributions   of  source  code  must  retain  the   above
00012  *       copyright  notice, this list of conditions and the  following
00013  *       disclaimer.
00014  *
00015  *     * Redistributions  in  binary  form must  reproduce  the  above
00016  *       copyright  notice, this list of conditions and the  following
00017  *       disclaimer   in  the  documentation  and/or  other  materials
00018  *       provided with the distribution.
00019  *
00020  *     * Neither  the name of the Xiph.Org Foundation nor the names of
00021  *       its  contributors may be used to endorse or promote  products
00022  *       derived  from  this software without specific  prior  written
00023  *       permission.
00024  *
00025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
00026  * "AS  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT  NOT
00027  * LIMITED  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS
00028  * FOR  A  PARTICULAR  PURPOSE ARE DISCLAIMED. IN NO EVENT  SHALL  THE
00029  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00030  * INCIDENTAL,    SPECIAL,   EXEMPLARY,   OR   CONSEQUENTIAL   DAMAGES
00031  * (INCLUDING,  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00032  * SERVICES;  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00033  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
00034  * STRICT  LIABILITY,  OR  TORT (INCLUDING  NEGLIGENCE  OR  OTHERWISE)
00035  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
00036  * OF THE POSSIBILITY OF SUCH DAMAGE.
00037  *
00038  * Sebastian Pipping, sping@xiph.org
00039  */
00040 
00046 #ifndef XSPF_PROJECT_OPUS_PLAYLIST_EXTENSION_H
00047 #define XSPF_PROJECT_OPUS_PLAYLIST_EXTENSION_H
00048 
00049 
00050 #include "../XspfExtension.h"
00051 
00052 namespace Xspf {
00053 namespace ProjectOpus {
00054 
00055 
00056 #define PROJECT_OPUS_NS_HOME      _PT("http://www.projectopus.com")  ///< Project Opus namespace URI
00057 #define PROJECT_OPUS_NS_HOME_LEN  26                                 ///< Project Opus namespace URI string length
00058 
00059 
00063 enum ProjectOpusPlaylistType {
00064         TYPE_PLAYLIST, 
00065         TYPE_ALBUM 
00066 };
00067 
00068 
00069 class ProjectOpusPlaylistExtensionPrivate;
00070 
00071 
00075 class ProjectOpusPlaylistExtension : public XspfExtension {
00076 
00077 private:
00079         ProjectOpusPlaylistExtensionPrivate * const d; 
00080 
00081 
00082 public:
00086         ProjectOpusPlaylistExtension();
00087 
00093         ProjectOpusPlaylistExtension(ProjectOpusPlaylistExtension const & source);
00094 
00100         ProjectOpusPlaylistExtension & operator=(ProjectOpusPlaylistExtension const & source);
00101 
00105         ~ProjectOpusPlaylistExtension();
00106 
00112         ProjectOpusPlaylistType getType() const;
00113 
00119         unsigned int getNodeId() const;
00120 
00126         void setType(ProjectOpusPlaylistType type);
00127 
00133         void setNodeId(unsigned int nodeId);
00134 
00135         XspfExtension * clone() const;
00136 
00137 private:
00138         XspfExtensionWriter * newWriter(XspfXmlFormatter * output,
00139                         XML_Char const * baseUri) const;
00140 
00141 public:
00148         static XML_Char const * typeToString(ProjectOpusPlaylistType type);
00149 
00156         static XML_Char * nodeIdToString(unsigned int nodeId);
00157 
00158         static XML_Char const * const namespaceKey; 
00159         static XML_Char const * const applicationURI; 
00160 
00161 };
00162 
00163 
00164 }
00165 }
00166 
00167 #endif // XSPF_PROJECT_OPUS_PLAYLIST_EXTENSION_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines