XspfWriter.h

Go to the documentation of this file.

/*
 * libxspf - XSPF playlist handling library
 *
 * Copyright (C) 2006-2008, Sebastian Pipping / Xiph.Org Foundation
 * All rights reserved.
 *
 * Redistribution  and use in source and binary forms, with or without
 * modification,  are permitted provided that the following conditions
 * are met:
 *
 *     * Redistributions   of  source  code  must  retain  the   above
 *       copyright  notice, this list of conditions and the  following
 *       disclaimer.
 *
 *     * Redistributions  in  binary  form must  reproduce  the  above
 *       copyright  notice, this list of conditions and the  following
 *       disclaimer   in  the  documentation  and/or  other  materials
 *       provided with the distribution.
 *
 *     * Neither  the name of the Xiph.Org Foundation nor the names of
 *       its  contributors may be used to endorse or promote  products
 *       derived  from  this software without specific  prior  written
 *       permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT  NOT
 * LIMITED  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND  FITNESS
 * FOR  A  PARTICULAR  PURPOSE ARE DISCLAIMED. IN NO EVENT  SHALL  THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL,    SPECIAL,   EXEMPLARY,   OR   CONSEQUENTIAL   DAMAGES
 * (INCLUDING,  BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES;  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT  LIABILITY,  OR  TORT (INCLUDING  NEGLIGENCE  OR  OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 * OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Sebastian Pipping, sping@xiph.org
 */

#ifndef XSPF_WRITER_H
#define XSPF_WRITER_H

#include "XspfDefines.h"

namespace Xspf {


class XspfXmlFormatter;
class XspfTrack;
class XspfProps;
class XspfWriterPrivate;


enum XspfWriterReturnCode {
        XSPF_WRITER_SUCCESS, 

        XSPF_WRITER_ERROR_OPENING, 
        XSPF_WRITER_ERROR_BASE_URI_USELESS 
};


class XspfWriter {

private:
        XspfWriterPrivate * const d; 


private:
        XspfWriter(XspfXmlFormatter & formatter, XML_Char const * baseUri,
                        bool embedBase);

public:
        static XspfWriter * makeWriter(XspfXmlFormatter & formatter,
                        XML_Char const * baseUri, bool embedBase = false,
                        int * errorCode = NULL);

        XspfWriter(XspfWriter const & source);

        XspfWriter & operator=(XspfWriter const & source);

        ~XspfWriter();

        bool registerNamespace(XML_Char const * uri,
                        XML_Char const * prefixSuggestion);

        bool addTrack(XspfTrack const * track);

        bool addTrack(XspfTrack const & track);

        bool setProps(XspfProps const * props);

        bool setProps(XspfProps const & props);

        int writeFile(XML_Char const * filename);

        int writeMemory(char * & memory, int & numBytes);

        void reset(XspfXmlFormatter & formatter,
                        XML_Char const * baseUri, bool embedBase = false);

private:
        void onBeforeWrite();

public:
        static bool const EMBED_AS_XML_BASE;

        static bool const NO_XML_BASE;
};


}


#endif // XSPF_WRITER_H

---