|
|
/*------------------------------------------------------------------------------ Copyright (c) 2000 Tyrell Corporation. All rights reserved. Tyrell DarkIce File : IceCast2.h Version : $Revision: 1.3 $ Author : $Author: darkeye $ Location : $Source: /cvsroot/darkice/darkice/src/IceCast2.h,v $ Copyright notice: This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. ------------------------------------------------------------------------------*/ #ifndef ICE_CAST2_H #define ICE_CAST2_H #ifndef __cplusplus #error This is a C++ include file #endif /* ============================================================ include files */ #include "Sink.h" #include "TcpSocket.h" #include "CastSink.h" /* ================================================================ constants */ /* =================================================================== macros */ /* =============================================================== data types */ /** * Class representing output to an IceCast2 server with * ice login * * @author $Author: darkeye $ * @version $Revision: 1.3 $ */ class IceCast2 : public CastSink { public: /** * Type for specifying the format of the stream. */ enum StreamFormat { mp3, oggVorbis }; private: /** * The format of the stream. */ StreamFormat format; /** * Mount point of the stream on the server. */ char * mountPoint; /** * Description of the stream. */ char * description; /** * Initalize the object. * * @param mountPoint mount point of the stream on the server. * @param remoteDumpFile remote dump file (may be NULL). * @param description description of the stream. * @exception Exception */ void init ( StreamFormat format, const char * mountPoint, const char * description ) throw ( Exception ); /** * De-initalize the object. * * @exception Exception */ void strip ( void ) throw ( Exception ); protected: /** * Default constructor. Always throws an Exception. * * @exception Exception */ inline IceCast2 ( void ) throw ( Exception ) { throw Exception( __FILE__, __LINE__); } /** * Log in to the server using the socket avialable. * * @return true if login was successful, false otherwise. * @exception Exception */ virtual bool sendLogin ( void ) throw ( Exception ); public: /** * Constructor. * * @param socket socket connection to the server. * @param password password to the server. * @param mountPoint mount point of the stream on the server. * @param name name of the stream. * @param description description of the stream. * @param url URL associated with the stream. * @param genre genre of the stream. * @param bitRate bitrate of the stream (e.g. mp3 bitrate). * @param isPublic is the stream public? * @param bufferDuration duration of the BufferedSink buffer * in seconds. * @exception Exception */ inline IceCast2 ( TcpSocket * socket, const char * password, const char * mountPoint, StreamFormat format, unsigned int bitRate, const char * name = 0, const char * description = 0, const char * url = 0, const char * genre = 0, bool isPublic = false, Sink * streamDump = 0, unsigned int bufferDuration = 10 ) throw ( Exception ) : CastSink( socket, password, bitRate, name, url, genre, isPublic, streamDump, bufferDuration ) { init( format, mountPoint, description); } /** * Copy constructor. * * @param cs the IceCast2 to copy. */ inline IceCast2( const IceCast2 & cs ) throw ( Exception ) : CastSink( cs ) { init( cs.getFormat(), cs.getMountPoint(), cs.getDescription() ); } /** * Destructor. * * @exception Exception */ inline virtual ~IceCast2( void ) throw ( Exception ) { strip(); } /** * Assignment operator. * * @param cs the IceCast2 to assign this to. * @return a reference to this IceCast2. * @exception Exception */ inline virtual IceCast2 & operator= ( const IceCast2 & cs ) throw ( Exception ) { if ( this != &cs ) { strip(); CastSink::operator=( cs ); init( cs.getFormat(), cs.getMountPoint(), cs.getDescription() ); } return *this; } /** * Get the format of the stream. * * @return the format of the stream. */ inline StreamFormat getFormat ( void ) const throw () { return format; } /** * Get the mount point of the stream on the server. * * @return the mount point of the stream on the server. */ inline const char * getMountPoint ( void ) const throw () { return mountPoint; } /** * Get the description of the stream. * * @return the description of the stream. */ inline const char * getDescription ( void ) const throw () { return description; } }; /* ================================================= external data structures */ /* ====================================================== function prototypes */ #endif /* ICE_CAST2_H */ /*------------------------------------------------------------------------------ $Source: /cvsroot/darkice/darkice/src/IceCast2.h,v $ $Log: IceCast2.h,v $ Revision 1.3 2002/02/20 11:54:11 darkeye added local dump file possibility Revision 1.2 2002/02/20 10:35:35 darkeye updated to work with Ogg Vorbis libs rc3 and current IceCast2 cvs Revision 1.1 2001/09/14 19:31:06 darkeye added IceCast2 / vorbis support ------------------------------------------------------------------------------*/
Generated by: darkeye on destroy on Sun Feb 15 23:41:12 2004, using kdoc 2.0a54. |