diff --git a/livesupport/modules/playlistExecutor/bin/autogen.sh b/livesupport/modules/playlistExecutor/bin/autogen.sh new file mode 100755 index 000000000..96776430b --- /dev/null +++ b/livesupport/modules/playlistExecutor/bin/autogen.sh @@ -0,0 +1,87 @@ +#!/bin/sh +#------------------------------------------------------------------------------- +# Copyright (c) 2004 Media Development Loan Fund +# +# This file is part of the LiveSupport project. +# http://livesupport.campware.org/ +# To report bugs, send an e-mail to bugs@campware.org +# +# LiveSupport 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. +# +# LiveSupport 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 LiveSupport; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# +# Author : $Author: maroy $ +# Version : $Revision: 1.1 $ +# Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/bin/autogen.sh,v $ +#------------------------------------------------------------------------------- + +#------------------------------------------------------------------------------- +# Run this to set up the build system: configure, makefiles, etc. +# (based on the version in enlightenment's cvs) +#------------------------------------------------------------------------------- + +package="PlaylistExecutor" + +# assume we're in $basedir/bin +basedir=`dirname $0`/.. +test -z "$basedir" && basedir=. + +tmpdir=$basedir/tmp + +cd "$tmpdir" +DIE=0 + +# look at all other directories as seen from ${basedir}/tmp +tmpdir=. +bindir=../bin +etcdir=../etc + +(autoheader --version) < /dev/null > /dev/null 2>&1 || { + echo + echo "You must have autoconf installed to compile $package." + echo "Download the appropriate package for your distribution," + echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/" + DIE=1 +} + +(autoconf --version) < /dev/null > /dev/null 2>&1 || { + echo + echo "You must have autoconf installed to compile $package." + echo "Download the appropriate package for your distribution," + echo "or get the source tarball at ftp://ftp.gnu.org/pub/gnu/" + DIE=1 +} + +if test "$DIE" -eq 1; then + exit 1 +fi + +if test -z "$*"; then + echo "I am going to run ./configure with no arguments - if you wish " + echo "to pass any to it, please specify them on the $0 command line." +fi + +echo "Generating configuration files for $package, please wait...." + +configure_ac=${etcdir}/configure.ac +configure=${tmpdir}/configure + +#echo " aclocal $ACLOCAL_FLAGS" +#aclocal $ACLOCAL_FLAGS +echo " autoheader ${configure_ac}" +autoheader ${configure_ac} +echo " autoconf -o ${configure} ${configure_ac}" +autoconf -o ${configure} ${configure_ac} + +${configure} "$@" && echo diff --git a/livesupport/modules/playlistExecutor/bin/gen_coverage_data.sh b/livesupport/modules/playlistExecutor/bin/gen_coverage_data.sh new file mode 100755 index 000000000..ad5f77a64 --- /dev/null +++ b/livesupport/modules/playlistExecutor/bin/gen_coverage_data.sh @@ -0,0 +1,80 @@ +#!/bin/sh +#------------------------------------------------------------------------------- +# Copyright (c) 2004 Media Development Loan Fund +# +# This file is part of the LiveSupport project. +# http://livesupport.campware.org/ +# To report bugs, send an e-mail to bugs@campware.org +# +# LiveSupport 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. +# +# LiveSupport 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 LiveSupport; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# +# Author : $Author: maroy $ +# Version : $Revision: 1.1 $ +# Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/bin/gen_coverage_data.sh,v $ +#------------------------------------------------------------------------------- +#------------------------------------------------------------------------------- +# This script generates code coverage data for the module +#------------------------------------------------------------------------------- +module="LiveSupport PlaylistExecutor" + +reldir=`dirname $0`/.. +basedir=`cd $reldir; pwd; cd -` +bindir=$basedir/bin +docdir=$basedir/doc +tmpdir=$basedir/tmp + +usrdir=`cd $basedir/../../usr; pwd; cd -` + +coverage_report_dir=$docdir/coverage + +raw_coverage_file=$tmpdir/raw_coverage.info +coverage_file=$tmpdir/coverage.info + +lcov=$usrdir/bin/lcov +genhtml=$usrdir/bin/genhtml + + +cd $basedir + +#------------------------------------------------------------------------------- +# Re-configure with covarege collection enabled, compile and run the tests +#------------------------------------------------------------------------------- +$bindir/autogen.sh --enable-coverage +make clean +make check + +#------------------------------------------------------------------------------- +# Generate some symlinks so that the sources are visible from tmpdir +#------------------------------------------------------------------------------- +ln -s $basedir/include $tmpdir/include +ln -s $basedir/src $tmpdir/src + + +#------------------------------------------------------------------------------- +# Use lcov to generate an HTML report on the coverage data +#------------------------------------------------------------------------------- +$lcov -d $tmpdir -c > $raw_coverage_file +$lcov -e $raw_coverage_file "$tmpdir/*" > $coverage_file +rm -rf $coverage_report_dir +mkdir -p $coverage_report_dir +$genhtml -t "$module" -o $coverage_report_dir $coverage_file + + +#------------------------------------------------------------------------------- +# Clean up +#------------------------------------------------------------------------------- +rm -f $tmpdir/include +rm -f $tmpdir/src diff --git a/livesupport/modules/playlistExecutor/doc/.keepme b/livesupport/modules/playlistExecutor/doc/.keepme new file mode 100644 index 000000000..e0808fa16 --- /dev/null +++ b/livesupport/modules/playlistExecutor/doc/.keepme @@ -0,0 +1 @@ +keep me diff --git a/livesupport/modules/playlistExecutor/etc/Makefile.in b/livesupport/modules/playlistExecutor/etc/Makefile.in new file mode 100644 index 000000000..5f487ab20 --- /dev/null +++ b/livesupport/modules/playlistExecutor/etc/Makefile.in @@ -0,0 +1,178 @@ +#------------------------------------------------------------------------------- +# Copyright (c) 2004 Media Development Loan Fund +# +# This file is part of the LiveSupport project. +# http://livesupport.campware.org/ +# To report bugs, send an e-mail to bugs@campware.org +# +# LiveSupport 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. +# +# LiveSupport 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 LiveSupport; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# +# Author : $Author: maroy $ +# Version : $Revision: 1.1 $ +# Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/etc/Makefile.in,v $ +# +# @configure_input@ +#------------------------------------------------------------------------------- + +#------------------------------------------------------------------------------- +# General command definitions +#------------------------------------------------------------------------------- +MKDIR = mkdir -p +RM = rm -f +RMDIR = rm -rf +DOXYGEN = doxygen + + +#------------------------------------------------------------------------------- +# Basic directory and file definitions +#------------------------------------------------------------------------------- +BASE_DIR = @builddir@ +DOC_DIR = ${BASE_DIR}/doc +DOXYGEN_DIR = ${DOC_DIR}/doxygen +COVERAGE_DIR = ${DOC_DIR}/coverage +ETC_DIR = ${BASE_DIR}/etc +INCLUDE_DIR = ${BASE_DIR}/include +LIB_DIR = ${BASE_DIR}/lib +SRC_DIR = ${BASE_DIR}/src +TMP_DIR = ${BASE_DIR}/tmp + +USR_DIR = ${BASE_DIR}/../../usr +USR_INCLUDE_DIR = ${USR_DIR}/include +USR_LIB_DIR = ${USR_DIR}/lib +BOOST_INCLUDE_DIR = ${USR_INCLUDE_DIR}/boost-1_31 +LIBXMLPP_INCLUDE_DIR = ${USR_INCLUDE_DIR}/libxml++-1.0 + +HELIX_INCLUDE_DIR = ${USR_INCLUDE_DIR}/helix +HELIX_LIB_DIR = ${USR_LIB_DIR}/helix +HELIX_LIBS = ${HELIX_LIB_DIR}/runtlib.a \ + ${HELIX_LIB_DIR}/syslib.a \ + ${HELIX_LIB_DIR}/contlib.a \ + ${HELIX_LIB_DIR}/debuglib.a \ + ${HELIX_LIB_DIR}/utillib.a +HELIX_CFLAGS = -march=i686 -D_UNIX + + +MODULES_DIR = ${BASE_DIR}/.. + +CORE_DIR = ${MODULES_DIR}/core +CORE_INCLUDE_DIR = ${CORE_DIR}/include +CORE_LIB_DIR = ${CORE_DIR}/lib +CORE_LIB = livesupport_core +CORE_LIB_FILE = ${CORE_LIB_DIR}/lib${CORE_LIB}.a + +VPATH = ${SRC_DIR} + +TEST_RESULTS = ${DOC_DIR}/testResults.xml +# the text result XSLT has to be relative to the test result file, e.g. TMP_DIR +TEST_XSLT = ../etc/testResultToHtml.xsl + +PLAYLIST_EXECUTOR_LIB = livesupport_playlist_executor +PLAYLIST_EXECUTOR_LIB_FILE = ${LIB_DIR}/lib${PLAYLIST_EXECUTOR_LIB}.a +TEST_RUNNER = ${TMP_DIR}/testRunner + +DOXYGEN_CONFIG = ${ETC_DIR}/doxygen.config + + +#------------------------------------------------------------------------------- +# Configuration parameters +#------------------------------------------------------------------------------- +CPPFLAGS = @CPPFLAGS@ +CXXFLAGS = @CXXFLAGS@ @DEFS@ @COVERAGE_CXXFLAGS@ \ + -Wall -Wno-long-long \ + ${HELIX_CFLAGS} \ + -I${USR_INCLUDE_DIR} \ + -I${BOOST_INCLUDE_DIR} \ + -I${LIBXMLPP_INCLUDE_DIR} \ + -I${HELIX_INCLUDE_DIR} \ + -I${CORE_INCLUDE_DIR} \ + -I${INCLUDE_DIR} -I${TMP_DIR} +LDFLAGS = @LDFLAGS@ -L${USR_LIB_DIR} -L${CORE_LIB_DIR} -L${HELIX_LIB_DIR} \ + -L${LIB_DIR} + + +#------------------------------------------------------------------------------- +# Dependencies +#------------------------------------------------------------------------------- +PLAYLIST_EXECUTOR_LIB_OBJS = ${TMP_DIR}/HelixPlayer.o \ + ${TMP_DIR}/AdviseSink.o \ + ${TMP_DIR}/AuthenticationManager.o \ + ${TMP_DIR}/ClientContext.o \ + ${TMP_DIR}/ErrorSink.o \ + ${TMP_DIR}/HelixIIDs.o +TEST_RUNNER_OBJS = ${TMP_DIR}/HelixPlayerTest.o \ + ${TMP_DIR}/TestRunner.o +TEST_RUNNER_LIBS = -l${PLAYLIST_EXECUTOR_LIB} -l${CORE_LIB} \ + ${HELIX_LIBS} \ + -lxml++-1.0 -lcppunit -ldl -lm -lpthread + + +#------------------------------------------------------------------------------- +# Targets +#------------------------------------------------------------------------------- +.PHONY: all dir_setup doc clean docclean depclean distclean + +all: dir_setup ${PLAYLIST_EXECUTOR_LIB_FILE} + +dir_setup: ${TMP_DIR} ${DOXYGEN_DIR} + +doc: + ${DOXYGEN} ${DOXYGEN_CONFIG} + +clean: + ${RM} ${PLAYLIST_EXECUTOR_LIB_OBJS} ${PLAYLIST_EXECUTOR_LIB_FILE} + ${RM} ${TEST_RUNNER_OBJS} ${TEST_RUNNER} + ${RM} ${TMP_DIR}/*.bb ${TMP_DIR}/*.bbg ${TMP_DIR}/*.da ${TMP_DIR}/*.info + +docclean: + ${RMDIR} ${DOXYGEN_DIR}/html + ${RMDIR} ${COVERAGE_DIR}/* + ${RM} ${TEST_RESULTS} + +depclean: clean + +distclean: clean docclean + ${RMDIR} ${TMP_DIR}/config* ${TMP_DIR}/autom4te* + +check: all ${TEST_RUNNER} + LD_LIBRARY_PATH=${USR_LIB_DIR} ${TEST_RUNNER} \ + -o ${TEST_RESULTS} -s ${TEST_XSLT} + + +#------------------------------------------------------------------------------- +# Specific targets +#------------------------------------------------------------------------------- +${PLAYLIST_EXECUTOR_LIB_FILE}: ${PLAYLIST_EXECUTOR_LIB_OBJS} + ${AR} crus $@ $^ + +${TMP_DIR}: + ${MKDIR} ${TMP_DIR} + +${DOXYGEN_DIR}: + ${MKDIR} ${DOXYGEN_DIR} + +${TEST_RUNNER}: ${CORE_LIB_FILE} ${TEST_RUNNER_OBJS} ${PLAYLIST_EXECUTOR_LIB_FILE} + ${CXX} ${LDFLAGS} -o $@ ${TEST_RUNNER_OBJS} ${TEST_RUNNER_LIBS} + +${CORE_LIB_FILE}: + ${MAKE} -C ${CORE_DIR} + + +#------------------------------------------------------------------------------- +# Pattern rules +#------------------------------------------------------------------------------- +${TMP_DIR}/%.o : ${SRC_DIR}/%.cxx + ${CXX} ${CPPFLAGS} ${CXXFLAGS} -c -o $@ $< + diff --git a/livesupport/modules/playlistExecutor/etc/configure.ac b/livesupport/modules/playlistExecutor/etc/configure.ac new file mode 100644 index 000000000..73f43f9bc --- /dev/null +++ b/livesupport/modules/playlistExecutor/etc/configure.ac @@ -0,0 +1,66 @@ +dnl----------------------------------------------------------------------------- +dnl Copyright (c) 2004 Media Development Loan Fund +dnl +dnl This file is part of the LiveSupport project. +dnl http://livesupport.campware.org/ +dnl To report bugs, send an e-mail to bugs@campware.org +dnl +dnl LiveSupport is free software; you can redistribute it and/or modify +dnl it under the terms of the GNU General Public License as published by +dnl the Free Software Foundation; either version 2 of the License, or +dnl (at your option) any later version. +dnl +dnl LiveSupport is distributed in the hope that it will be useful, +dnl but WITHOUT ANY WARRANTY; without even the implied warranty of +dnl MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +dnl GNU General Public License for more details. +dnl +dnl You should have received a copy of the GNU General Public License +dnl along with LiveSupport; if not, write to the Free Software +dnl Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +dnl +dnl +dnl Author : $Author: maroy $ +dnl Version : $Revision: 1.1 $ +dnl Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/etc/configure.ac,v $ +dnl----------------------------------------------------------------------------- + +dnl----------------------------------------------------------------------------- +dnl NOTE: Run all configure related scripts from the tmp directory of the +dnl project. +dnl This is due to the fact that configure spreads a lot of trash around, +dnl like atom4te cache directories, config.* files, etc. into the directory +dnl it is being run from. We clearly don't want these in our base directory. +dnl----------------------------------------------------------------------------- +AC_INIT(PlaylistExecutor, 1.0, bugs@campware.org) +AC_PREREQ(2.59) +AC_COPYRIGHT([Copyright (c) 2004 Media Development Loan Fund under the GNU GPL]) +AC_REVISION($Revision: 1.1 $) + +AC_CONFIG_SRCDIR(../src/HelixPlayer.cxx) + +AC_CONFIG_HEADERS(configure.h) +AC_PROG_CXX() + +AC_CHECK_HEADERS(getopt.h) + +dnl----------------------------------------------------------------------------- +dnl enable compilaton for code coverage data +dnl----------------------------------------------------------------------------- +AC_SUBST(COVERAGE_CXXFLAGS) + +AC_ARG_ENABLE( coverage, +[ --enable-coverage enable code coverage data generaton (no) ], + ENABLE_COVERAGE=${enableval}, ENABLE_COVERAGE="no" ) + +if test "x${ENABLE_COVERAGE}" == "xyes" ; then + COVERAGE_CXXFLAGS="-fprofile-arcs -ftest-coverage" + AC_MSG_RESULT([compiling in code coverage mode]) +else + AC_MSG_RESULT([not compiling in code coverage mode]) +fi + + +AC_CONFIG_FILES(../Makefile:../etc/Makefile.in) + +AC_OUTPUT() diff --git a/livesupport/modules/playlistExecutor/etc/doxygen.config b/livesupport/modules/playlistExecutor/etc/doxygen.config new file mode 100644 index 000000000..d90dbee65 --- /dev/null +++ b/livesupport/modules/playlistExecutor/etc/doxygen.config @@ -0,0 +1,1144 @@ +#------------------------------------------------------------------------------- +# Copyright (c) 2004 Media Development Loan Fund +# +# This file is part of the LiveSupport project. +# http://livesupport.campware.org/ +# To report bugs, send an e-mail to bugs@campware.org +# +# LiveSupport 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. +# +# LiveSupport 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 LiveSupport; if not, write to the Free Software +# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +# +# +# Author : $Author: maroy $ +# Version : $Revision: 1.1 $ +# Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/etc/doxygen.config,v $ +#------------------------------------------------------------------------------- + +# Doxyfile 1.3.6 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = LiveSupport + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = 1.0 + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = doc/doxygen + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, +# Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en +# (Japanese with English messages), Korean, Korean-en, Norwegian, Polish, Portuguese, +# Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. + +OUTPUT_LANGUAGE = English + +# This tag can be used to specify the encoding used in the generated output. +# The encoding is not always determined by the language that is chosen, +# but also whether or not the output is meant for Windows or non-Windows users. +# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES +# forces the Windows encoding (this is the default for the Windows binary), +# whereas setting the tag to NO uses a Unix-style encoding (the default for +# all platforms other than Windows). + +USE_WINDOWS_ENCODING = NO + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is used +# as the annotated text. Otherwise, the brief description is used as-is. If left +# blank, the following values are used ("$name" is automatically replaced with the +# name of the entity): "The $name class" "The $name widget" "The $name file" +# "is" "provides" "specifies" "contains" "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited +# members of a class in the documentation of that class as if those members were +# ordinary class members. Constructors, destructors and assignment operators of +# the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = NO + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. It is allowed to use relative paths in the argument list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like the Qt-style comments (thus requiring an +# explicit @brief command for a brief description. + +JAVADOC_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = YES + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources +# only. Doxygen will then generate output that is more tailored for Java. +# For instance, namespaces will be presented as packages, qualified scopes +# will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = src + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp +# *.h++ *.idl *.odl *.cs *.php *.php3 *.inc + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories +# that are symbolic links (a Unix filesystem feature) are excluded from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. + +EXCLUDE_PATTERNS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. + +INPUT_FILTER = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = NO + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = NO + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = YES + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_PREDEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = include + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse the +# parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base or +# super classes. Setting the tag to NO turns the diagrams off. Note that this +# option is superseded by the HAVE_DOT option below. This is only a fallback. It is +# recommended to install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will +# generate a call dependency graph for every global function or class method. +# Note that enabling this option will significantly increase the time of a run. +# So in most cases it will be better to enable call graphs for selected +# functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found on the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_WIDTH = 1024 + +# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height +# (in pixels) of the graphs generated by dot. If a graph becomes larger than +# this value, doxygen will try to truncate the graph, so that it fits within +# the specified constraint. Beware that most browsers cannot cope with very +# large images. + +MAX_DOT_GRAPH_HEIGHT = 1024 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes that +# lay further from the root node will be omitted. Note that setting this option to +# 1 or 2 may greatly reduce the computation time needed for large code bases. Also +# note that a graph may be further truncated if the graph's image dimensions are +# not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH and MAX_DOT_GRAPH_HEIGHT). +# If 0 is used for the depth value (the default), the graph is not depth-constrained. + +MAX_DOT_GRAPH_DEPTH = 0 + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/livesupport/modules/playlistExecutor/etc/helixPlayer.xml b/livesupport/modules/playlistExecutor/etc/helixPlayer.xml new file mode 100644 index 000000000..ec00150b9 --- /dev/null +++ b/livesupport/modules/playlistExecutor/etc/helixPlayer.xml @@ -0,0 +1,8 @@ + + + +]> + diff --git a/livesupport/modules/playlistExecutor/etc/testResultToHtml.xsl b/livesupport/modules/playlistExecutor/etc/testResultToHtml.xsl new file mode 100644 index 000000000..d2165c2a4 --- /dev/null +++ b/livesupport/modules/playlistExecutor/etc/testResultToHtml.xsl @@ -0,0 +1,63 @@ + + + + + + + LiveSupport unit test results + + +

Preface

+This document is part of the +LiveSupport +project, Copyright © 2004 Media +Development Loan Fund, under the GNU +GPL. +
+This is an automatically generated document. +

Scope

+This document contains the generated unit test results for the +LiveSupport project. +

Summary

+ + + + + + + + + + + + + + + + + + +
Total number of tests:
Tests passed:
Tests failed:
Test errors:
+ +

Tests

+ + + + + + + + + + + + + +
test nametest status
failedpassed
+ + + + + + diff --git a/livesupport/modules/playlistExecutor/lib/.keepme b/livesupport/modules/playlistExecutor/lib/.keepme new file mode 100644 index 000000000..e0808fa16 --- /dev/null +++ b/livesupport/modules/playlistExecutor/lib/.keepme @@ -0,0 +1 @@ +keep me diff --git a/livesupport/modules/playlistExecutor/src/AdviseSink.cxx b/livesupport/modules/playlistExecutor/src/AdviseSink.cxx new file mode 100644 index 000000000..417795faf --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/AdviseSink.cxx @@ -0,0 +1,309 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/AdviseSink.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include "HelixDefs.h" + +#include + +#include "AdviseSink.h" + +using namespace LiveSupport::PlaylistExecutor; + + +/* =================================================== local data structures */ + + +/* ================================================ local constants & macros */ + + +/* =============================================== local function prototypes */ + + +/* ============================================================= module code */ + +/*------------------------------------------------------------------------------ + * Construct the advise sink + *----------------------------------------------------------------------------*/ +AdviseSink::AdviseSink(IUnknown * pUnknown) throw () + : lRefCount(0) + , pUnknown(NULL) + , pRegistry(NULL) + , pScheduler(NULL) +{ + if (pUnknown) { + this->pUnknown = pUnknown; + this->pUnknown->AddRef(); + + if (HXR_OK != this->pUnknown->QueryInterface(IID_IHXRegistry, + (void**)&pRegistry)) { + pRegistry = NULL; + } + + if (HXR_OK != this->pUnknown->QueryInterface(IID_IHXScheduler, + (void**)&pScheduler)) { + pScheduler = NULL; + } + + IHXPlayer* pPlayer; + if (HXR_OK == this->pUnknown->QueryInterface(IID_IHXPlayer, + (void**)&pPlayer)) { + pPlayer->AddAdviseSink(this); + pPlayer->Release(); + } + } +} + + +/*------------------------------------------------------------------------------ + * Destruct the advise sink + *----------------------------------------------------------------------------*/ +AdviseSink::~AdviseSink(void) throw () +{ + if (pScheduler) { + pScheduler->Release(); + pScheduler = NULL; + } + + if (pRegistry) { + pRegistry->Release(); + pRegistry = NULL; + } + + if (pUnknown) { + pUnknown->Release(); + pUnknown = NULL; + } +} + + +// IUnknown methods + +/*------------------------------------------------------------------------------ + * Implement this to export the interfaces supported by your + * object. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::QueryInterface(REFIID riid, + void ** ppvObj) throw () +{ + if (IsEqualIID(riid, IID_IUnknown)) { + AddRef(); + *ppvObj = (IUnknown*)(IHXClientAdviseSink*)this; + return HXR_OK; + } else if (IsEqualIID(riid, IID_IHXClientAdviseSink)) { + AddRef(); + *ppvObj = (IHXClientAdviseSink*)this; + return HXR_OK; + } + + *ppvObj = NULL; + return HXR_NOINTERFACE; +} + + +/*------------------------------------------------------------------------------ + * Increase the refence count. + *----------------------------------------------------------------------------*/ +STDMETHODIMP_(ULONG32) +AdviseSink::AddRef() throw () +{ + return InterlockedIncrement(&lRefCount); +} + + +/*------------------------------------------------------------------------------ + * Decreaese the refence count. + *----------------------------------------------------------------------------*/ +STDMETHODIMP_(ULONG32) +AdviseSink::Release() throw () +{ + if (InterlockedDecrement(&lRefCount) > 0) { + return lRefCount; + } + + delete this; + return 0; +} + + +// IHXClientAdviseSink methods + +/*------------------------------------------------------------------------------ + * Called to advise the client that the position or length of the + * current playback context has changed. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnPosLength(UINT32 ulPosition, + UINT32 ulLength) throw () +{ + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called to advise the client a presentation has been opened. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnPresentationOpened() throw () +{ + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called to advise the client a presentation has been closed. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnPresentationClosed() throw () +{ + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called to advise the client that the presentation statistics + * have changed. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnStatisticsChanged(void) throw () +{ + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called by client engine to inform the client that a seek is + * about to occur. The render is informed the last time for the + * stream's time line before the seek, as well as the first new + * time for the stream's time line after the seek will be completed. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnPreSeek(ULONG32 ulOldTime, + ULONG32 ulNewTime) throw () +{ + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called by client engine to inform the client that a seek has + * just occured. The render is informed the last time for the + * stream's time line before the seek, as well as the first new + * time for the stream's time line after the seek. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnPostSeek(ULONG32 ulOldTime, + ULONG32 ulNewTime) throw () +{ + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called by client engine to inform the client that a stop has + * just occured. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnStop(void) throw () +{ + HXTimeval now; + + // Find out the current time and subtract the beginning time to + // figure out how many seconds we played + now = pScheduler->GetCurrentSchedulerTime(); + ulStopTime = now.tv_sec; + +// TODO: maybe save the number of seconds played? +// GetGlobal()->g_ulNumSecondsPlayed = ulStopTime - ulStartTime; + + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called by client engine to inform the client that a pause has + * just occured. The render is informed the last time for the + * stream's time line before the pause. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnPause(ULONG32 ulTime) throw () +{ + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called by client engine to inform the client that a begin or + * resume has just occured. The render is informed the first time + * for the stream's time line after the resume. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnBegin(ULONG32 ulTime) throw () +{ + HXTimeval now; + + // Record the current time, so we can figure out many seconds we played + now = pScheduler->GetCurrentSchedulerTime(); + ulStartTime = now.tv_sec; + + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called by client engine to inform the client that buffering + * of data is occuring. The render is informed of the reason for + * the buffering (start-up of stream, seek has occured, network + * congestion, etc.), as well as percentage complete of the + * buffering process. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnBuffering(ULONG32 ulFlags, + UINT16 unPercentComplete) throw () +{ + return HXR_OK; +} + + +/*------------------------------------------------------------------------------ + * Called by client engine to inform the client is contacting + * hosts(s). + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AdviseSink::OnContacting(const char* pHostName) throw () +{ + return HXR_OK; +} + diff --git a/livesupport/modules/playlistExecutor/src/AdviseSink.h b/livesupport/modules/playlistExecutor/src/AdviseSink.h new file mode 100644 index 000000000..1ebc3cf1e --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/AdviseSink.h @@ -0,0 +1,273 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/AdviseSink.h,v $ + +------------------------------------------------------------------------------*/ +#ifndef AdviseSink_h +#define AdviseSink_h + +#ifndef __cplusplus +#error This is a C++ include file +#endif + + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include +#include +#include +#include +#include + + +namespace LiveSupport { +namespace PlaylistExecutor { + +using namespace LiveSupport; + + +/* ================================================================ constants */ + + +/* =================================================================== macros */ + + +/* =============================================================== data types */ + +/** + * A Helix client advise sink, receiving notifications on the status + * of the client playing. + * + * @author $Author: maroy $ + * @version $Revision: 1.1 $ + */ +class AdviseSink : public IHXClientAdviseSink +{ + private: + /** + * The reference count for this object. + */ + LONG32 lRefCount; + + /** + * The pointer to the object this is an advise sink for. + */ + IUnknown * pUnknown; + + /** + * Pointer to the registry of pUnkown. + */ + IHXRegistry * pRegistry; + + /** + * Pointer to the scheduler of pUnkown. + */ + IHXScheduler * pScheduler; + + /** + * The time playing is started. + */ + UINT32 ulStartTime; + + /** + * The time playing os stopped. + */ + UINT32 ulStopTime; + + + public: + + /** + * Constructor + */ + AdviseSink(IUnknown * pUnknown) throw (); + + + /** + * Destructor. + */ + virtual + ~AdviseSink(void) throw (); + + // IUnknown methods + + /** + * Query the object to determine if it supports a specific interface. + * + * @param riid the reference identifier for the interface queried. + * @param ppvObj points to an interface pointer, that is filled + * if the requested interface is implemented. + */ + STDMETHOD(QueryInterface) (THIS_ + REFIID riid, + void** ppvObj) throw (); + + /** + * Increase the objects reference count by one. + * + * @return the new reference count. + */ + STDMETHOD_(ULONG32,AddRef) (THIS) throw (); + + /** + * Decreases the objects reference count by one. If the count + * reaches 0, the object is destroyed. + * + * @return the new value of the reference count. + */ + STDMETHOD_(ULONG32,Release) (THIS) throw (); + + // IHXClientAdviseSink methods + + /** + * Called to advise the client that the position or length of the + * current playback context has changed. + * + * @param ulPosition the new position of the playback. + * @param ulLength the new length of the playback. + */ + STDMETHOD(OnPosLength) (THIS_ + UINT32 ulPosition, + UINT32 ulLength) throw (); + + /** + * Called to advise the client a presentation has been opened. + */ + STDMETHOD(OnPresentationOpened) (THIS) throw (); + + /** + * Called to advise the client a presentation has been closed. + */ + STDMETHOD(OnPresentationClosed) (THIS) throw (); + + /** + * Called to advise the client that the presentation statistics + * have changed. + */ + STDMETHOD(OnStatisticsChanged) (THIS) throw (); + + /** + * Called by client engine to inform the client that a seek is + * about to occur. The render is informed the last time for the + * stream's time line before the seek, as well as the first new + * time for the stream's time line after the seek will be completed. + * + * @param ulOldTime the end of the stream's time line before the + * current seek. + * @param ulNewTime the beginning of the stream's time line after the + * current seek. + */ + STDMETHOD (OnPreSeek) (THIS_ + ULONG32 ulOldTime, + ULONG32 ulNewTime) throw (); + + /** + * Called by client engine to inform the client that a seek has + * just occured. The render is informed the last time for the + * stream's time line before the seek, as well as the first new + * time for the stream's time line after the seek. + * + * @param ulOldTime the end of the stream's time line before the + * current seek. + * @param ulNewTime the beginning of the stream's time line after the + * current seek. + */ + STDMETHOD (OnPostSeek) (THIS_ + ULONG32 ulOldTime, + ULONG32 ulNewTime) throw (); + + /** + * Called by client engine to inform the client that a stop has + * just occured. + */ + STDMETHOD (OnStop) (THIS) throw (); + + /** + * Called by client engine to inform the client that a pause has + * just occured. The render is informed the last time for the + * stream's time line before the pause. + * + * @param ulTime the time in the streams time line before being + * paused. + */ + STDMETHOD (OnPause) (THIS_ + ULONG32 ulTime) throw (); + + /** + * Called by client engine to inform the client that a begin or + * resume has just occured. The render is informed the first time + * for the stream's time line after the resume. + * + * The time in the streams time line from which to begin or resume. + */ + STDMETHOD (OnBegin) (THIS_ + ULONG32 ulTime) throw (); + + /** + * Called by client engine to inform the client that buffering + * of data is occuring. The render is informed of the reason for + * the buffering (start-up of stream, seek has occured, network + * congestion, etc.), as well as percentage complete of the + * buffering process. + * + * @param ulFlags the reason for the buffering, one of: + * BUFFERING_START_UP, BUFFERING_SEEK, BUFFERING_CONGESTION + * or BUFFERING_LIVE_PAUSE + * @param unPercentComplete the percentage of the buffering that has + * completed. + */ + STDMETHOD (OnBuffering) (THIS_ + ULONG32 ulFlags, + UINT16 unPercentComplete) throw (); + + + /** + * Called by client engine to inform the client is contacting + * hosts(s). + * + * @param pHostName the name of the host being contacted. + */ + STDMETHOD (OnContacting) (THIS_ + const char* pHostName) throw (); + +}; + + +/* ================================================= external data structures */ + + +/* ====================================================== function prototypes */ + + +} // namespace PlaylistExecutor +} // namespace LiveSupport + +#endif // AdviseSink_h + diff --git a/livesupport/modules/playlistExecutor/src/AuthenticationManager.cxx b/livesupport/modules/playlistExecutor/src/AuthenticationManager.cxx new file mode 100644 index 000000000..c4c249b60 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/AuthenticationManager.cxx @@ -0,0 +1,134 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/AuthenticationManager.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include "HelixDefs.h" + +#include + +#include "AuthenticationManager.h" + +using namespace LiveSupport::PlaylistExecutor; + + +/* =================================================== local data structures */ + + +/* ================================================ local constants & macros */ + + +/* =============================================== local function prototypes */ + + +/* ============================================================= module code */ + +/*------------------------------------------------------------------------------ + * Construct the Authentication manager + *----------------------------------------------------------------------------*/ +AuthenticationManager::AuthenticationManager() throw () + : lRefCount(0) +{ +} + + +/*------------------------------------------------------------------------------ + * Destruct the Authentication manager + *----------------------------------------------------------------------------*/ +AuthenticationManager::~AuthenticationManager() throw () +{ +} + + +// IUnknown methods + +/*------------------------------------------------------------------------------ + * Implement this to export the interfaces supported by your + * object. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AuthenticationManager::QueryInterface(REFIID riid, + void ** ppvObj) throw () +{ + if (IsEqualIID(riid, IID_IUnknown)) { + AddRef(); + *ppvObj = (IUnknown*)(IHXAuthenticationManager*)this; + return HXR_OK; + } else if (IsEqualIID(riid, IID_IHXAuthenticationManager)) { + AddRef(); + *ppvObj = (IHXAuthenticationManager*)this; + return HXR_OK; + } + + *ppvObj = NULL; + return HXR_NOINTERFACE; +} + + +/*------------------------------------------------------------------------------ + * Increase the refence count. + *----------------------------------------------------------------------------*/ +STDMETHODIMP_(UINT32) +AuthenticationManager::AddRef() throw () +{ + return InterlockedIncrement(&lRefCount); +} + + +/*------------------------------------------------------------------------------ + * Decreaese the refence count. + *----------------------------------------------------------------------------*/ +STDMETHODIMP_(UINT32) +AuthenticationManager::Release() throw () +{ + if (InterlockedDecrement(&lRefCount) > 0) { + return lRefCount; + } + + delete this; + return 0; +} + + +/*------------------------------------------------------------------------------ + * Handle an authentication request. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +AuthenticationManager::HandleAuthenticationRequest( + IHXAuthenticationManagerResponse* pResponse) + throw () +{ + // pass on anything + return HXR_OK; +} + diff --git a/livesupport/modules/playlistExecutor/src/AuthenticationManager.h b/livesupport/modules/playlistExecutor/src/AuthenticationManager.h new file mode 100644 index 000000000..841f92c33 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/AuthenticationManager.h @@ -0,0 +1,140 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/AuthenticationManager.h,v $ + +------------------------------------------------------------------------------*/ +#ifndef AuthenticationManager_h +#define AuthenticationManager_h + +#ifndef __cplusplus +#error This is a C++ include file +#endif + + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include + + +namespace LiveSupport { +namespace PlaylistExecutor { + +using namespace LiveSupport; + + +/* ================================================================ constants */ + + +/* =================================================================== macros */ + + +/* =============================================================== data types */ + +/** + * A Helix client authentication manager. + * + * @author $Author: maroy $ + * @version $Revision: 1.1 $ + */ +class AuthenticationManager : public IHXAuthenticationManager +{ + private: + /** + * The reference count of this object. + */ + INT32 lRefCount; + + + public: + /** + * Constructor. + */ + AuthenticationManager() throw (); + + /** + * Destructor. + */ + virtual + ~AuthenticationManager() throw (); + + // IUnknown methods + + /** + * Query the object to determine if it supports a specific interface. + * + * @param riid the reference identifier for the interface queried. + * @param ppvObj points to an interface pointer, that is filled + * if the requested interface is implemented. + */ + STDMETHOD(QueryInterface) (THIS_ + REFIID riid, + void** ppvObj) throw (); + + /** + * Increase the objects reference count by one. + * + * @return the new reference count. + */ + STDMETHOD_(ULONG32,AddRef) (THIS) throw (); + + /** + * Decreases the objects reference count by one. If the count + * reaches 0, the object is destroyed. + * + * @return the new value of the reference count. + */ + STDMETHOD_(ULONG32,Release) (THIS) throw (); + + + // IHXAuthenticationManager methods + + /** + * Get a user name and password, or other authentication parameters. + * + * @param pResponse Ponter to an IHXAuthenticationManagerResponse + * interface that manages the response. + */ + STDMETHOD(HandleAuthenticationRequest) + (IHXAuthenticationManagerResponse* pResponse) + throw (); +}; + + +/* ================================================= external data structures */ + + +/* ====================================================== function prototypes */ + + +} // namespace PlaylistExecutor +} // namespace LiveSupport + +#endif // AuthenticationManager_h + diff --git a/livesupport/modules/playlistExecutor/src/ClientContext.cxx b/livesupport/modules/playlistExecutor/src/ClientContext.cxx new file mode 100644 index 000000000..4e70d6de6 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/ClientContext.cxx @@ -0,0 +1,243 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/ClientContext.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include "HelixDefs.h" + +#include +#include +#include + +#include "ErrorSink.h" +#include "AuthenticationManager.h" +#include "ClientContext.h" + +using namespace LiveSupport::PlaylistExecutor; + + + +/* =================================================== local data structures */ + + +/* ================================================ local constants & macros */ + + +/* =============================================== local function prototypes */ + + +/* ============================================================= module code */ + +/*------------------------------------------------------------------------------ + * Construct the Client Context + *----------------------------------------------------------------------------*/ +ClientContext::ClientContext() throw () + : lRefCount(0) + , pClientSink(NULL) + , pErrorSink(NULL) + , pAuthMgr(NULL) + , pDefaultPrefs(NULL) +{ +} + + +/*------------------------------------------------------------------------------ + * Destruct the Client Context + *----------------------------------------------------------------------------*/ +ClientContext::~ClientContext() throw () +{ + Close(); +}; + + +/*------------------------------------------------------------------------------ + * Initialize the Client Context + *----------------------------------------------------------------------------*/ +void +ClientContext::Init(IUnknown * pUnknown, + IHXPreferences * pPreferences, + char * pszGUID) throw () +{ + char* pszCipher = NULL; + + pClientSink = new AdviseSink(pUnknown); + pErrorSink = new ErrorSink(pUnknown); + pAuthMgr = new AuthenticationManager(); + + if (pClientSink) { + pClientSink->AddRef(); + } + + if (pErrorSink) { + pErrorSink->AddRef(); + } + + if(pAuthMgr) { + pAuthMgr->AddRef(); + } + + if (pPreferences) { + pDefaultPrefs = pPreferences; + pDefaultPrefs->AddRef(); + } + + if (pszGUID && *pszGUID) { + // Encode GUID + pszCipher = Cipher(pszGUID); + SafeStrCpy(this->pszGUID, pszCipher, 256); + } else { + this->pszGUID[0] = '\0'; + } +} + + +/*------------------------------------------------------------------------------ + * De-Initialize the Client Context + *----------------------------------------------------------------------------*/ +void ClientContext::Close() throw () +{ + HX_RELEASE(pClientSink); + HX_RELEASE(pErrorSink); + HX_RELEASE(pAuthMgr); + HX_RELEASE(pDefaultPrefs); +} + + +// IUnknown methods + +/*------------------------------------------------------------------------------ + * Implement this to export the interfaces supported by your + * object. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +ClientContext::QueryInterface(REFIID riid, + void ** ppvObj) throw () +{ + if (IsEqualIID(riid, IID_IUnknown)) { + AddRef(); + *ppvObj = this; + return HXR_OK; + } else if (IsEqualIID(riid, IID_IHXPreferences)) { + AddRef(); + *ppvObj = (IHXPreferences*)this; + return HXR_OK; + } else if (pClientSink && + pClientSink->QueryInterface(riid, ppvObj) == HXR_OK) { + pClientSink->AddRef(); + *ppvObj = pClientSink; + return HXR_OK; + } else if (pErrorSink && + pErrorSink->QueryInterface(riid, ppvObj) == HXR_OK) { + pErrorSink->AddRef(); + *ppvObj = pErrorSink; + return HXR_OK; + } else if (pAuthMgr && + pAuthMgr->QueryInterface(riid, ppvObj) == HXR_OK) { + pErrorSink->AddRef(); + *ppvObj = pAuthMgr; + return HXR_OK; + } + + *ppvObj = NULL; + return HXR_NOINTERFACE; +} + + +/*------------------------------------------------------------------------------ + * Increase the refence count. + *----------------------------------------------------------------------------*/ +STDMETHODIMP_(ULONG32) +ClientContext::AddRef() throw () +{ + return InterlockedIncrement(&lRefCount); +} + + +/*------------------------------------------------------------------------------ + * Decreaese the refence count. + *----------------------------------------------------------------------------*/ +STDMETHODIMP_(ULONG32) +ClientContext::Release() throw () +{ + if (InterlockedDecrement(&lRefCount) > 0) { + return lRefCount; + } + + delete this; + return 0; +} + + +// IHXPreferences methods + +/*------------------------------------------------------------------------------ + * Read a Preference from the registry. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +ClientContext::ReadPref(const char * pPrekKey, + IHXBuffer *& pBuffer) throw () +{ + HX_RESULT hResult = HXR_OK; + + if ((stricmp(pPrekKey, CLIENT_GUID_REGNAME) == 0) && (*pszGUID)) { + // Create a Buffer + pBuffer = new CHXBuffer(); + pBuffer->AddRef(); + + // Copy the encoded GUID into the pBuffer + pBuffer->Set((UCHAR*)pszGUID, strlen(pszGUID) + 1); + } else if (pDefaultPrefs) { + hResult = pDefaultPrefs->ReadPref(pPrekKey, pBuffer); + } else { + hResult = HXR_NOTIMPL; + } + + return hResult; +} + + +/*------------------------------------------------------------------------------ + * Write a Preference to the registry. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +ClientContext::WritePref(const char * pPrekKey, + IHXBuffer * pBuffer) throw () +{ + if (pDefaultPrefs) { + return pDefaultPrefs->WritePref(pPrekKey, pBuffer); + } else { + return HXR_OK; + } +} + + diff --git a/livesupport/modules/playlistExecutor/src/ClientContext.h b/livesupport/modules/playlistExecutor/src/ClientContext.h new file mode 100644 index 000000000..5209483c3 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/ClientContext.h @@ -0,0 +1,214 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/ClientContext.h,v $ + +------------------------------------------------------------------------------*/ +#ifndef ClientContext_h +#define ClientContext_h + +#ifndef __cplusplus +#error This is a C++ include file +#endif + + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include +#include + +#include "AdviseSink.h" + +namespace LiveSupport { +namespace PlaylistExecutor { + +using namespace LiveSupport; + + +/* ================================================================ constants */ + + +/* =================================================================== macros */ + + +/* =============================================================== data types */ + +class ExampleErrorMessages; + +/** + * A Helix client context. + * + * @author $Author: maroy $ + * @version $Revision: 1.1 $ + */ +class ClientContext : public IHXPreferences +{ + private: + /** + * The reference count of this object. + */ + LONG32 lRefCount; + + /** + * The advise sink recieving event notifications. + */ + AdviseSink * pClientSink; + + /** + * The error sink, receiving error notifications. + */ + ErrorSink * pErrorSink; + + /** + * The authentication manager. + */ + AuthenticationManager * pAuthMgr; + + /** + * The preferences. + */ + IHXPreferences* pDefaultPrefs; + + /** + * The GUID for this context. + */ + char pszGUID[256]; /* Flawfinder: ignore */ + + + public: + + /** + * Constructor. + */ + ClientContext() throw (); + + /** + * Destructor. + */ + virtual + ~ClientContext() throw (); + + /** + * Initialize the client context. + * Always close a context by calling Close(). + * + * @param pUnknown pointer to the object this will be a context for. + * @param pPreferences pointer to the helix preferences used. + * @param pszGUID the globally unique ID, if any, for the context. + * @see #Close + */ + void + Init(IUnknown * pUnknown, + IHXPreferences * pPreferences, + char * pszGUID) throw (); + + /** + * De-Initialize the client context. + * + * @see #Init + */ + void Close() throw (); + + /** + * Return the ErrorSink object for this client context. + * + * @return the ErrorSink object for this client context. + */ + ErrorSink * + getErrorSink(void) const throw () + { + return pErrorSink; + } + + // IUnknown methods + + /** + * Query the object to determine if it supports a specific interface. + * + * @param riid the reference identifier for the interface queried. + * @param ppvObj points to an interface pointer, that is filled + * if the requested interface is implemented. + */ + STDMETHOD(QueryInterface) (THIS_ + REFIID riid, + void** ppvObj) throw (); + + /** + * Increase the objects reference count by one. + * + * @return the new reference count. + */ + STDMETHOD_(ULONG32,AddRef) (THIS) throw (); + + /** + * Decreases the objects reference count by one. If the count + * reaches 0, the object is destroyed. + * + * @return the new value of the reference count. + */ + STDMETHOD_(ULONG32,Release) (THIS) throw (); + + // IHXPreferences methods + + /** + * Reaad a preference from the registry or configuration file. + * + * @param pPrekKey pointer to the name of the preference. + * @param pBuffer return a pointer to an IHXBuffer interface + * that manages the value of the preference. + */ + STDMETHOD(ReadPref) (THIS_ + const char * pPrekKey, + IHXBuffer *& pBuffer) throw (); + + /** + * Writes a preference to the registry of configuration file. + * + * @param pPrekKey pointer to the name of the preference. + * @param pBuffer return a pointer to an IHXBuffer interface + * that manages the value of the preference. + */ + STDMETHOD(WritePref) (THIS_ + const char * pPrekKey, + IHXBuffer * pBuffer) throw (); + +}; + + +/* ================================================= external data structures */ + + +/* ====================================================== function prototypes */ + + +} // namespace PlaylistExecutor +} // namespace LiveSupport + +#endif // ClientContext_h + diff --git a/livesupport/modules/playlistExecutor/src/ErrorSink.cxx b/livesupport/modules/playlistExecutor/src/ErrorSink.cxx new file mode 100644 index 000000000..a9c852712 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/ErrorSink.cxx @@ -0,0 +1,150 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/ErrorSink.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include "HelixDefs.h" + +#include + +#include "ErrorSink.h" + +using namespace LiveSupport::PlaylistExecutor; + + +/* =================================================== local data structures */ + + +/* ================================================ local constants & macros */ + + +/* =============================================== local function prototypes */ + + +/* ============================================================= module code */ + +/*------------------------------------------------------------------------------ + * Construct the Error Sink + *----------------------------------------------------------------------------*/ +ErrorSink::ErrorSink(IUnknown* pUnknown) throw () + : lRefCount(0), + pPlayer(NULL), + lastHelixErrorCode(0) +{ + IHXClientEngine* pEngine = NULL; + pUnknown->QueryInterface(IID_IHXClientEngine, (void**)&pEngine ); + if( pEngine ) { + IUnknown* pTmp = NULL; + pEngine->GetPlayer(0, pTmp); + pPlayer = (IHXPlayer*)pTmp; + } + + HX_RELEASE( pEngine ); +// HX_ASSERT(pPlayer); +} + + +/*------------------------------------------------------------------------------ + * Destruct the Error Sink + *----------------------------------------------------------------------------*/ +ErrorSink::~ErrorSink() throw () +{ + HX_RELEASE(pPlayer); +} + +// IUnknown methods + +/*------------------------------------------------------------------------------ + * Implement this to export the interfaces supported by your + * object. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +ErrorSink::QueryInterface(REFIID riid, + void ** ppvObj) throw () +{ + if (IsEqualIID(riid, IID_IUnknown)) { + AddRef(); + *ppvObj = (IUnknown*)(IHXErrorSink*)this; + return HXR_OK; + } else if (IsEqualIID(riid, IID_IHXErrorSink)) { + AddRef(); + *ppvObj = (IHXErrorSink*) this; + return HXR_OK; + } + + *ppvObj = NULL; + return HXR_NOINTERFACE; +} + + +/*------------------------------------------------------------------------------ + * Increase the refence count. + *----------------------------------------------------------------------------*/ +STDMETHODIMP_(ULONG32) +ErrorSink::AddRef() throw () +{ + return InterlockedIncrement(&lRefCount); +} + + +/*------------------------------------------------------------------------------ + * Decreaese the refence count. + *----------------------------------------------------------------------------*/ +STDMETHODIMP_(ULONG32) +ErrorSink::Release() throw () +{ + if (InterlockedDecrement(&lRefCount) > 0) { + return lRefCount; + } + + delete this; + return 0; +} + +// IHXErrorSink methods + +/*------------------------------------------------------------------------------ + * Handle an error event. + *----------------------------------------------------------------------------*/ +STDMETHODIMP +ErrorSink::ErrorOccurred(const UINT8 unSeverity, + const ULONG32 ulHXCode, + const ULONG32 ulUserCode, + const char * pUserString, + const char * pMoreInfoURL) throw () +{ + lastHelixErrorCode = ulHXCode; + + return HXR_OK; +} + diff --git a/livesupport/modules/playlistExecutor/src/ErrorSink.h b/livesupport/modules/playlistExecutor/src/ErrorSink.h new file mode 100644 index 000000000..7db3d7442 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/ErrorSink.h @@ -0,0 +1,176 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/ErrorSink.h,v $ + +------------------------------------------------------------------------------*/ +#ifndef ErrorSink_h +#define ErrorSink_h + +#ifndef __cplusplus +#error This is a C++ include file +#endif + + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include +#include + + +namespace LiveSupport { +namespace PlaylistExecutor { + +using namespace LiveSupport; + + +/* ================================================================ constants */ + + +/* =================================================================== macros */ + + +/* =============================================================== data types */ + +/** + * A Helix error sink + * + * @author $Author: maroy $ + * @version $Revision: 1.1 $ + */ +class ErrorSink : public IHXErrorSink +{ + protected: + /** + * The reference count of this object. + */ + LONG32 lRefCount; + + /** + * The player this sink gets errors from. + */ + IHXPlayer * pPlayer; + + /** + * The last Helix error code receieved. + */ + UINT32 lastHelixErrorCode; + + + public: + + /** + * Constructor. + * + * @param pUnkown pointer to the object this is an erro sink for. + */ + ErrorSink(IUnknown* pUnknown) throw (); + + /** + * Destructor. + */ + virtual + ~ErrorSink() throw (); + + // IUnknown methods + + /** + * Query the object to determine if it supports a specific interface. + * + * @param riid the reference identifier for the interface queried. + * @param ppvObj points to an interface pointer, that is filled + * if the requested interface is implemented. + */ + STDMETHOD(QueryInterface) (THIS_ + REFIID riid, + void** ppvObj) throw (); + + /** + * Increase the objects reference count by one. + * + * @return the new reference count. + */ + STDMETHOD_(ULONG32,AddRef) (THIS) throw (); + + /** + * Decreases the objects reference count by one. If the count + * reaches 0, the object is destroyed. + * + * @return the new value of the reference count. + */ + STDMETHOD_(ULONG32,Release) (THIS) throw (); + + + // IHXErrorSink methods + + /** + * After you have registered your error sink with an + * IHXErrorSinkControl + * (either in the server or player core) this method will be called to + * report an error, event, or status message. + * + * @param unSeverity the type of report. + * @param ulHXCode Helix Architecture error code. + * @param ulUserCode User-specific error code. + * @param pUserString User-specific error string. + * @param pMoreInfoURL pointer to a user-specific URL for more info. + */ + STDMETHOD(ErrorOccurred) (THIS_ + const UINT8 unSeverity, + const ULONG32 ulHXCode, + const ULONG32 ulUserCode, + const char * pUserString, + const char * pMoreInfoURL) + throw (); + + /** + * Get the Helix error code for the last error occured. + * + * @return the Helix error code for the last error occured. + */ + ULONG32 + getLastErrorCode(void) const throw () + { + return lastHelixErrorCode; + } + +}; + + +/* ================================================= external data structures */ + + +/* ====================================================== function prototypes */ + + +} // namespace PlaylistExecutor +} // namespace LiveSupport + +#endif // ErrorSink_h + diff --git a/livesupport/modules/playlistExecutor/src/HelixDefs.h b/livesupport/modules/playlistExecutor/src/HelixDefs.h new file mode 100644 index 000000000..5c28b4af8 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/HelixDefs.h @@ -0,0 +1,524 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/HelixDefs.h,v $ + +------------------------------------------------------------------------------*/ +#ifndef HelixDefs_h +#define HelixDefs_h + +#ifndef __cplusplus +#error This is a C++ include file +#endif + + +/* ============================================================ include files */ + + +/* ================================================================ constants */ + + +/* =================================================================== macros */ + +/*------------------------------------------------------------------------------ + * This is a list of defines used by the Helix Library. + * Some of these are Linux-specific, watch out when porting to other + * platforms. + *----------------------------------------------------------------------------*/ +#ifndef HELIX_CONFIG_MS_PSDK +#define HELIX_CONFIG_MS_PSDK 1 +#endif +#ifndef HELIX_FEATURE_3GPP +#define HELIX_FEATURE_3GPP 1 +#endif +#ifndef HELIX_FEATURE_ADVANCEDGROUPMGR +#define HELIX_FEATURE_ADVANCEDGROUPMGR 1 +#endif +#ifndef HELIX_FEATURE_ALT_URL +#define HELIX_FEATURE_ALT_URL 1 +#endif +#ifndef HELIX_FEATURE_ASM +#define HELIX_FEATURE_ASM 1 +#endif +#ifndef HELIX_FEATURE_AUDIO +#define HELIX_FEATURE_AUDIO 1 +#endif +#ifndef HELIX_FEATURE_AUDIOHOOK +#define HELIX_FEATURE_AUDIOHOOK 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_AIFF +#define HELIX_FEATURE_AUDIO_AIFF 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_AU +#define HELIX_FEATURE_AUDIO_AU 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_28_8 +#define HELIX_FEATURE_AUDIO_CODEC_28_8 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_AMRNB +#define HELIX_FEATURE_AUDIO_CODEC_AMRNB 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_AMRWB +#define HELIX_FEATURE_AUDIO_CODEC_AMRWB 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_GECKO +#define HELIX_FEATURE_AUDIO_CODEC_GECKO 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_INTERLEAVE_ALL +#define HELIX_FEATURE_AUDIO_CODEC_INTERLEAVE_ALL 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_O5_6 +#define HELIX_FEATURE_AUDIO_CODEC_O5_6 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_QCELP +#define HELIX_FEATURE_AUDIO_CODEC_QCELP 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_RAAC +#define HELIX_FEATURE_AUDIO_CODEC_RAAC 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_SIPRO +#define HELIX_FEATURE_AUDIO_CODEC_SIPRO 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_CODEC_TOKYO +#define HELIX_FEATURE_AUDIO_CODEC_TOKYO 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_INACCURATESAMPLING +#define HELIX_FEATURE_AUDIO_INACCURATESAMPLING 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_INCOMPLETESAMPLE +#define HELIX_FEATURE_AUDIO_INCOMPLETESAMPLE 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_MPA_LAYER1 +#define HELIX_FEATURE_AUDIO_MPA_LAYER1 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_MPA_LAYER2 +#define HELIX_FEATURE_AUDIO_MPA_LAYER2 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_MPA_LAYER3 +#define HELIX_FEATURE_AUDIO_MPA_LAYER3 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_MPEG4 +#define HELIX_FEATURE_AUDIO_MPEG4 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_MULTIPLAYER_PAUSE +#define HELIX_FEATURE_AUDIO_MULTIPLAYER_PAUSE 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_POSTMIXHOOK +#define HELIX_FEATURE_AUDIO_POSTMIXHOOK 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_PREMIXHOOK +#define HELIX_FEATURE_AUDIO_PREMIXHOOK 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_RALF +#define HELIX_FEATURE_AUDIO_RALF 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_REAL +#define HELIX_FEATURE_AUDIO_REAL 1 +#endif +#ifndef HELIX_FEATURE_AUDIO_WAVE +#define HELIX_FEATURE_AUDIO_WAVE 1 +#endif +#ifndef HELIX_FEATURE_AUTHENTICATION +#define HELIX_FEATURE_AUTHENTICATION 1 +#endif +#ifndef HELIX_FEATURE_AUTOUPGRADE +#define HELIX_FEATURE_AUTOUPGRADE 1 +#endif +#ifndef HELIX_FEATURE_BASICGROUPMGR +#define HELIX_FEATURE_BASICGROUPMGR 1 +#endif +#ifndef HELIX_FEATURE_CHUNKRES +#define HELIX_FEATURE_CHUNKRES 1 +#endif +#ifndef HELIX_FEATURE_CLIENT +#define HELIX_FEATURE_CLIENT 1 +#endif +#ifndef HELIX_FEATURE_COOKIES +#define HELIX_FEATURE_COOKIES 1 +#endif +#ifndef HELIX_FEATURE_CORECOMM +#define HELIX_FEATURE_CORECOMM 1 +#endif +#ifndef HELIX_FEATURE_CROSSFADE +#define HELIX_FEATURE_CROSSFADE 1 +#endif +#ifndef HELIX_FEATURE_DBG_LOG +#define HELIX_FEATURE_DBG_LOG 1 +#endif +#ifndef HELIX_FEATURE_DIRECT_SOUND +#define HELIX_FEATURE_DIRECT_SOUND 1 +#endif +#ifndef HELIX_FEATURE_DRM +#define HELIX_FEATURE_DRM 1 +#endif +#ifndef HELIX_FEATURE_DTDR_AUDIO_DECODER +#define HELIX_FEATURE_DTDR_AUDIO_DECODER 1 +#endif +#ifndef HELIX_FEATURE_DTDR_DECRYPTER +#define HELIX_FEATURE_DTDR_DECRYPTER 1 +#endif +#ifndef HELIX_FEATURE_DTDR_ENCODER +#define HELIX_FEATURE_DTDR_ENCODER 1 +#endif +#ifndef HELIX_FEATURE_DTDR_MIXER +#define HELIX_FEATURE_DTDR_MIXER 1 +#endif +#ifndef HELIX_FEATURE_EVENTMANAGER +#define HELIX_FEATURE_EVENTMANAGER 1 +#endif +#ifndef HELIX_FEATURE_FIFOCACHE +#define HELIX_FEATURE_FIFOCACHE 1 +#endif +#ifndef HELIX_FEATURE_FILESYSTEMMGR +#define HELIX_FEATURE_FILESYSTEMMGR 1 +#endif +#ifndef HELIX_FEATURE_FRAGMENTBUFFER +#define HELIX_FEATURE_FRAGMENTBUFFER 1 +#endif +#ifndef HELIX_FEATURE_FULLGUID +#define HELIX_FEATURE_FULLGUID 1 +#endif +#ifndef HELIX_FEATURE_GAINTOOL +#define HELIX_FEATURE_GAINTOOL 1 +#endif +#ifndef HELIX_FEATURE_GIF_BROKENIMAGE +#define HELIX_FEATURE_GIF_BROKENIMAGE 1 +#endif +#ifndef HELIX_FEATURE_GROUPMGR +#define HELIX_FEATURE_GROUPMGR 1 +#endif +#ifndef HELIX_FEATURE_HTTPCLOAK +#define HELIX_FEATURE_HTTPCLOAK 1 +#endif +#ifndef HELIX_FEATURE_HTTP_GZIP +#define HELIX_FEATURE_HTTP_GZIP 1 +#endif +#ifndef HELIX_FEATURE_HYPER_NAVIGATE +#define HELIX_FEATURE_HYPER_NAVIGATE 1 +#endif +#ifndef HELIX_FEATURE_IGNORE_SIGPIPE +#define HELIX_FEATURE_IGNORE_SIGPIPE 1 +#endif +#ifndef HELIX_FEATURE_ISMA +#define HELIX_FEATURE_ISMA 1 +#endif +#ifndef HELIX_FEATURE_LIMITER +#define HELIX_FEATURE_LIMITER 1 +#endif +#ifndef HELIX_FEATURE_MASTERTAC +#define HELIX_FEATURE_MASTERTAC 1 +#endif +#ifndef HELIX_FEATURE_MEDIAMARKER +#define HELIX_FEATURE_MEDIAMARKER 1 +#endif +#ifndef HELIX_FEATURE_MEMMAP_IO +#define HELIX_FEATURE_MEMMAP_IO 1 +#endif +#ifndef HELIX_FEATURE_META +#define HELIX_FEATURE_META 1 +#endif +#ifndef HELIX_FEATURE_MIXER +#define HELIX_FEATURE_MIXER 1 +#endif +#ifndef HELIX_FEATURE_MP3FF_LENIENT +#define HELIX_FEATURE_MP3FF_LENIENT 1 +#endif +#ifndef HELIX_FEATURE_MP3FF_ONDEMANDMETAINFO +#define HELIX_FEATURE_MP3FF_ONDEMANDMETAINFO 1 +#endif +#ifndef HELIX_FEATURE_MP3FF_SHOUTCAST +#define HELIX_FEATURE_MP3FF_SHOUTCAST 1 +#endif +#ifndef HELIX_FEATURE_MP4_FILEFORMAT_ALTERNATES +#define HELIX_FEATURE_MP4_FILEFORMAT_ALTERNATES 1 +#endif +#ifndef HELIX_FEATURE_NESTEDMETA +#define HELIX_FEATURE_NESTEDMETA 1 +#endif +#ifndef HELIX_FEATURE_NETCHECK +#define HELIX_FEATURE_NETCHECK 1 +#endif +#ifndef HELIX_FEATURE_NETINTERFACES +#define HELIX_FEATURE_NETINTERFACES 1 +#endif +#ifndef HELIX_FEATURE_NETSERVICES_SHIM +#define HELIX_FEATURE_NETSERVICES_SHIM 1 +#endif +#ifndef HELIX_FEATURE_NEXTGROUPMGR +#define HELIX_FEATURE_NEXTGROUPMGR 1 +#endif +#ifndef HELIX_FEATURE_OPTIMIZED_SCHEDULER +#define HELIX_FEATURE_OPTIMIZED_SCHEDULER 1 +#endif +#ifndef HELIX_FEATURE_OVERLAYMGR +#define HELIX_FEATURE_OVERLAYMGR 1 +#endif +#ifndef HELIX_FEATURE_PAC +#define HELIX_FEATURE_PAC 1 +#endif +#ifndef HELIX_FEATURE_PACKETHOOKMGR +#define HELIX_FEATURE_PACKETHOOKMGR 1 +#endif +#ifndef HELIX_FEATURE_PLAYBACK_LOCAL +#define HELIX_FEATURE_PLAYBACK_LOCAL 1 +#endif +#ifndef HELIX_FEATURE_PLAYBACK_NET +#define HELIX_FEATURE_PLAYBACK_NET 1 +#endif +#ifndef HELIX_FEATURE_PLAYERNAVIGATOR +#define HELIX_FEATURE_PLAYERNAVIGATOR 1 +#endif +#ifndef HELIX_FEATURE_PLUGINHANDLER2 +#define HELIX_FEATURE_PLUGINHANDLER2 1 +#endif +#ifndef HELIX_FEATURE_PNA +#define HELIX_FEATURE_PNA 1 +#endif +#ifndef HELIX_FEATURE_PREFERENCES +#define HELIX_FEATURE_PREFERENCES 1 +#endif +#ifndef HELIX_FEATURE_PREFETCH +#define HELIX_FEATURE_PREFETCH 1 +#endif +#ifndef HELIX_FEATURE_PROGDOWN +#define HELIX_FEATURE_PROGDOWN 1 +#endif +#ifndef HELIX_FEATURE_PROXYMGR +#define HELIX_FEATURE_PROXYMGR 1 +#endif +#ifndef HELIX_FEATURE_RAREND_ADV_PACKET_FEEDER +#define HELIX_FEATURE_RAREND_ADV_PACKET_FEEDER 1 +#endif +#ifndef HELIX_FEATURE_RAREND_BANDWIDTH_LISTER +#define HELIX_FEATURE_RAREND_BANDWIDTH_LISTER 1 +#endif +#ifndef HELIX_FEATURE_RAREND_PREREDSTONE_SUPPORT +#define HELIX_FEATURE_RAREND_PREREDSTONE_SUPPORT 1 +#endif +#ifndef HELIX_FEATURE_RAREND_SURESTREAM +#define HELIX_FEATURE_RAREND_SURESTREAM 1 +#endif +#ifndef HELIX_FEATURE_RDT +#define HELIX_FEATURE_RDT 1 +#endif +#ifndef HELIX_FEATURE_RECORDCONTROL +#define HELIX_FEATURE_RECORDCONTROL 1 +#endif +#ifndef HELIX_FEATURE_REGISTRY +#define HELIX_FEATURE_REGISTRY 1 +#endif +#ifndef HELIX_FEATURE_RESAMPLER +#define HELIX_FEATURE_RESAMPLER 1 +#endif +#ifndef HELIX_FEATURE_RESOURCEMGR +#define HELIX_FEATURE_RESOURCEMGR 1 +#endif +#ifndef HELIX_FEATURE_REVERTER +#define HELIX_FEATURE_REVERTER 1 +#endif +#ifndef HELIX_FEATURE_RMFF_BANDWIDTH_NEGOTIATOR +#define HELIX_FEATURE_RMFF_BANDWIDTH_NEGOTIATOR 1 +#endif +#ifndef HELIX_FEATURE_RMFF_DYNAMICASM +#define HELIX_FEATURE_RMFF_DYNAMICASM 1 +#endif +#ifndef HELIX_FEATURE_RMFF_INDEXTABLE +#define HELIX_FEATURE_RMFF_INDEXTABLE 1 +#endif +#ifndef HELIX_FEATURE_RMFF_LEGACYAUDIO +#define HELIX_FEATURE_RMFF_LEGACYAUDIO 1 +#endif +#ifndef HELIX_FEATURE_RMFF_LICENSING +#define HELIX_FEATURE_RMFF_LICENSING 1 +#endif +#ifndef HELIX_FEATURE_RMFF_LIVEINFO +#define HELIX_FEATURE_RMFF_LIVEINFO 1 +#endif +#ifndef HELIX_FEATURE_RMFF_MULTIRATE +#define HELIX_FEATURE_RMFF_MULTIRATE 1 +#endif +#ifndef HELIX_FEATURE_RMFF_ONDEMANDMETAINFO +#define HELIX_FEATURE_RMFF_ONDEMANDMETAINFO 1 +#endif +#ifndef HELIX_FEATURE_RMFF_TIMEOFFSET_FIXUP +#define HELIX_FEATURE_RMFF_TIMEOFFSET_FIXUP 1 +#endif +#ifndef HELIX_FEATURE_RMFF_TIMEOFFSET_HANDLER +#define HELIX_FEATURE_RMFF_TIMEOFFSET_HANDLER 1 +#endif +#ifndef HELIX_FEATURE_RMFF_VIEWSOURCE +#define HELIX_FEATURE_RMFF_VIEWSOURCE 1 +#endif +#ifndef HELIX_FEATURE_RTP +#define HELIX_FEATURE_RTP 1 +#endif +#ifndef HELIX_FEATURE_SECURECONN +#define HELIX_FEATURE_SECURECONN 1 +#endif +#ifndef HELIX_FEATURE_SETSRCPROPS +#define HELIX_FEATURE_SETSRCPROPS 1 +#endif +#ifndef HELIX_FEATURE_SINKCONTROL +#define HELIX_FEATURE_SINKCONTROL 1 +#endif +#ifndef HELIX_FEATURE_SMARTERNETWORK +#define HELIX_FEATURE_SMARTERNETWORK 1 +#endif +#ifndef HELIX_FEATURE_SMIL1 +#define HELIX_FEATURE_SMIL1 1 +#endif +#ifndef HELIX_FEATURE_SMIL2 +#define HELIX_FEATURE_SMIL2 1 +#endif +#ifndef HELIX_FEATURE_SMIL2_ANIMATION +#define HELIX_FEATURE_SMIL2_ANIMATION 1 +#endif +#ifndef HELIX_FEATURE_SMIL2_BRUSH +#define HELIX_FEATURE_SMIL2_BRUSH 1 +#endif +#ifndef HELIX_FEATURE_SMIL2_MULTIWINDOWLAYOUT +#define HELIX_FEATURE_SMIL2_MULTIWINDOWLAYOUT 1 +#endif +#ifndef HELIX_FEATURE_SMIL2_TRANSITIONS +#define HELIX_FEATURE_SMIL2_TRANSITIONS 1 +#endif +#ifndef HELIX_FEATURE_SMIL2_VALIDATION +#define HELIX_FEATURE_SMIL2_VALIDATION 1 +#endif +#ifndef HELIX_FEATURE_SMIL_REPEAT +#define HELIX_FEATURE_SMIL_REPEAT 1 +#endif +#ifndef HELIX_FEATURE_SMIL_SITE +#define HELIX_FEATURE_SMIL_SITE 1 +#endif +#ifndef HELIX_FEATURE_SMIL_SOUNDLEVEL +#define HELIX_FEATURE_SMIL_SOUNDLEVEL 1 +#endif +#ifndef HELIX_FEATURE_STATS +#define HELIX_FEATURE_STATS 1 +#endif +#ifndef HELIX_FEATURE_SYSTEMREQUIRED +#define HELIX_FEATURE_SYSTEMREQUIRED 1 +#endif +#ifndef HELIX_FEATURE_THREADSAFE_MEMMAP_IO +#define HELIX_FEATURE_THREADSAFE_MEMMAP_IO 1 +#endif +#ifndef HELIX_FEATURE_TIMEDTEXT +#define HELIX_FEATURE_TIMEDTEXT 1 +#endif +#ifndef HELIX_FEATURE_TRANSPORT_MULTICAST +#define HELIX_FEATURE_TRANSPORT_MULTICAST 1 +#endif +#ifndef HELIX_FEATURE_TURBOPLAY +#define HELIX_FEATURE_TURBOPLAY 1 +#endif +#ifndef HELIX_FEATURE_VIDEO +#define HELIX_FEATURE_VIDEO 1 +#endif +#ifndef HELIX_FEATURE_VIDEO_CODEC_RV10 +#define HELIX_FEATURE_VIDEO_CODEC_RV10 1 +#endif +#ifndef HELIX_FEATURE_VIDEO_CODEC_RV20 +#define HELIX_FEATURE_VIDEO_CODEC_RV20 1 +#endif +#ifndef HELIX_FEATURE_VIDEO_CODEC_RV30 +#define HELIX_FEATURE_VIDEO_CODEC_RV30 1 +#endif +#ifndef HELIX_FEATURE_VIDEO_CODEC_RV40 +#define HELIX_FEATURE_VIDEO_CODEC_RV40 1 +#endif +#ifndef HELIX_FEATURE_VIDEO_H263 +#define HELIX_FEATURE_VIDEO_H263 1 +#endif +#ifndef HELIX_FEATURE_VIDEO_MPEG4 +#define HELIX_FEATURE_VIDEO_MPEG4 1 +#endif +#ifndef HELIX_FEATURE_VIDEO_REAL +#define HELIX_FEATURE_VIDEO_REAL 1 +#endif +#ifndef HELIX_FEATURE_VIDREND_OPTIMIZEDVIDEO +#define HELIX_FEATURE_VIDREND_OPTIMIZEDVIDEO 1 +#endif +#ifndef HELIX_FEATURE_VIDREND_SYNCSMOOTHING +#define HELIX_FEATURE_VIDREND_SYNCSMOOTHING 1 +#endif +#ifndef HELIX_FEATURE_VIEWPORT +#define HELIX_FEATURE_VIEWPORT 1 +#endif +#ifndef HELIX_FEATURE_VIEWSOURCE +#define HELIX_FEATURE_VIEWSOURCE 1 +#endif +#ifndef HELIX_FEATURE_VOLUME +#define HELIX_FEATURE_VOLUME 1 +#endif +#ifndef HELIX_FEATURE_XMLPARSER +#define HELIX_FEATURE_XMLPARSER 1 +#endif +#ifndef THREADS_SUPPORTED +#define THREADS_SUPPORTED 1 +#endif +#ifndef USE_XWINDOWS +#define USE_XWINDOWS 1 +#endif +#ifndef _GNU_SOURCE +#define _GNU_SOURCE 1 +#endif +#ifndef _LINUX +#define _LINUX 1 +#endif +#ifndef _LITTLE_ENDIAN +#define _LITTLE_ENDIAN 1 +#endif +#ifndef _RED_HAT_5_X_ +#define _RED_HAT_5_X_ 1 +#endif +#ifndef _REENTRANT +#define _REENTRANT 1 +#endif +#ifndef _TIMEDWAITS_RECURSIVE_MUTEXES +#define _TIMEDWAITS_RECURSIVE_MUTEXES 1 +#endif +#ifndef _UNIX +#define _UNIX 1 +#endif +#ifndef _UNIX_THREADED_NETWORK_IO +#define _UNIX_THREADED_NETWORK_IO 1 +#endif +#ifndef _UNIX_THREADS_SUPPORTED +#define _UNIX_THREADS_SUPPORTED 1 +#endif + + +/* =============================================================== data types */ + + +/* ================================================= external data structures */ + + +/* ====================================================== function prototypes */ + + +#endif // HelixDefs_h + diff --git a/livesupport/modules/playlistExecutor/src/HelixIIDs.cxx b/livesupport/modules/playlistExecutor/src/HelixIIDs.cxx new file mode 100644 index 000000000..d4d2b9085 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/HelixIIDs.cxx @@ -0,0 +1,57 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/HelixIIDs.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +// this is just a file that by including the ones below defines some IIDs +// needed by the Helix library. + +#include "HelixDefs.h" + + +#define INITGUID +#define NCIHACK +#include +#include +#include +#include + + +/* =================================================== local data structures */ + + +/* ================================================ local constants & macros */ + + +/* =============================================== local function prototypes */ + + +/* ============================================================= module code */ + + diff --git a/livesupport/modules/playlistExecutor/src/HelixPlayer.cxx b/livesupport/modules/playlistExecutor/src/HelixPlayer.cxx new file mode 100644 index 000000000..05c2c3513 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/HelixPlayer.cxx @@ -0,0 +1,308 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/HelixPlayer.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include "HelixDefs.h" + +#include "HelixPlayer.h" + + +using namespace LiveSupport::Core; +using namespace LiveSupport::PlaylistExecutor; + +/* =================================================== local data structures */ + +/** + * Function pointer type for the SetDLLAccessPath function. + */ +typedef HX_RESULT (HXEXPORT_PTR FPRMSETDLLACCESSPATH) (const char*); + + +/* ================================================ local constants & macros */ + +/** + * The shared object access path. + */ +static DLLAccessPath accessPath; + + +/*------------------------------------------------------------------------------ + * The name of the config element for this class + *----------------------------------------------------------------------------*/ +const std::string HelixPlayer::configElementNameStr = "helixPlayer"; + + +/** + * The name of the attribute to get shared object path. + */ +static const std::string dllPathName = "dllPath"; + +/** + * The name of the client core shared object, as found under dllPath + */ +static const std::string clntcoreName = "/clntcore.so"; + + +/* =============================================== local function prototypes */ + +/*------------------------------------------------------------------------------ + * The main thread function for handling Helix events. + *----------------------------------------------------------------------------*/ +void * +LiveSupport::PlaylistExecutor::eventHandlerThread(void * helixPlayer) + throw () +{ + HelixPlayer * hPlayer = (HelixPlayer *) helixPlayer; + + while (hPlayer->handleEvents) { + struct _HXxEvent * event = 0; + hPlayer->clientEngine->EventOccurred(event); + usleep(10000); + } + + pthread_exit(0); +} + + +/* ============================================================= module code */ + +/*------------------------------------------------------------------------------ + * Configure the Helix Player. + *----------------------------------------------------------------------------*/ +void +HelixPlayer :: configure(const xmlpp::Element & element) + throw (std::invalid_argument, + std::logic_error) +{ + if (element.get_name() != configElementNameStr) { + std::string eMsg = "Bad configuration element "; + eMsg += element.get_name(); + throw std::invalid_argument(eMsg); + } + + const xmlpp::Attribute * attribute; + + if (!(attribute = element.get_attribute(dllPathName))) { + std::string eMsg = "Missing attribute "; + eMsg += dllPathName; + throw std::invalid_argument(eMsg); + } + dllPath = attribute->get_value(); +} + + +/*------------------------------------------------------------------------------ + * Initialize the Helix Player + *----------------------------------------------------------------------------*/ +void +HelixPlayer :: initialize(void) throw (std::exception) +{ + // open the Helix Client Core shared object + std::string staticLibPath(dllPath); + staticLibPath += clntcoreName; + if (DLLAccess::DLL_OK != dllAccess.open(staticLibPath.c_str())) { + throw std::exception(); + } + + // get the main entry function pointers + FPRMSETDLLACCESSPATH setDLLAccessPath; + + createEngine = (FPRMCREATEENGINE) dllAccess.getSymbol("CreateEngine"); + closeEngine = (FPRMCLOSEENGINE) dllAccess.getSymbol("CloseEngine"); + setDLLAccessPath = + (FPRMSETDLLACCESSPATH) dllAccess.getSymbol("SetDLLAccessPath"); + + if (!createEngine || !closeEngine || !setDLLAccessPath) { + throw std::exception(); + } + + // set the DLL access path + std::string str = ""; + str += "DT_Common="; + str += dllPath; + str += '\0'; + str += "DT_Plugins="; + str += dllPath; + str += '\0'; + str += "DT_Codecs="; + str += dllPath; + + setDLLAccessPath(str.c_str()); + + // create the client engine and the player + if (HXR_OK != createEngine(&clientEngine)) { + throw std::exception(); + } + + if (HXR_OK != clientEngine->CreatePlayer(player)) { + throw std::exception(); + } + + // create and attach the client context + clientContext = new ClientContext(); + clientContext->AddRef(); + + IHXPreferences * preferences = 0; + player->QueryInterface(IID_IHXPreferences, (void**) &preferences); + clientContext->Init(player, preferences, ""); + player->SetClientContext(clientContext); + HX_RELEASE(preferences); + + // create and attach the error sink + IHXErrorSinkControl * errorSinkControl; + player->QueryInterface(IID_IHXErrorSinkControl, + (void**) &errorSinkControl); + if (errorSinkControl) { + IHXErrorSink * errorSink; + clientContext->QueryInterface(IID_IHXErrorSink, (void**) &errorSink); + if (errorSink) { + errorSinkControl->AddErrorSink(errorSink, + HXLOG_EMERG, + HXLOG_DEBUG); + HX_RELEASE(errorSink); + } + HX_RELEASE(errorSinkControl); + } + + // start the event handling thread + handleEvents = true; + int ret; + if ((ret = pthread_create(&eventHandlingThread, + NULL, + eventHandlerThread, + (void *) this))) { + // TODO: signal return code + throw std::exception(); + } + + // set up other variables + playing = false; +} + + +/*------------------------------------------------------------------------------ + * De-initialize the Helix Player + *----------------------------------------------------------------------------*/ +void +HelixPlayer :: deInitialize(void) +{ + // signal stop to and wait for the event handling thread to stop + handleEvents = false; + pthread_join(eventHandlingThread, 0); + + // release Helix resources + clientContext->Release(); + + clientEngine->ClosePlayer(player); + player->Release(); + + closeEngine(clientEngine); + + dllAccess.close(); +} + + +/*------------------------------------------------------------------------------ + * Specify which file to play + *----------------------------------------------------------------------------*/ +void +HelixPlayer :: playThis(const std::string fileUrl) + throw (std::invalid_argument) +{ + // the only way to check if this is a valid URL is to see if the + // source count increases for the player. + UINT16 sourceCount = player->GetSourceCount(); + if (HXR_OK != player->OpenURL(fileUrl.c_str())) { + throw std::invalid_argument("can't open URL"); + } + if (sourceCount == player->GetSourceCount()) { + throw std::invalid_argument("can't open URL"); + } +} + + +/*------------------------------------------------------------------------------ + * Start playing + *----------------------------------------------------------------------------*/ +void +HelixPlayer :: start(void) throw (std::logic_error) +{ + if (player->GetSourceCount() == 0) { + throw std::logic_error("HelixPlayer::playThis() not called yet"); + } + player->Begin(); + playing = true; +} + + +/*------------------------------------------------------------------------------ + * Tell if we're playing + *----------------------------------------------------------------------------*/ +bool +HelixPlayer :: isPlaying(void) throw () +{ + if (playing) { + playing = !player->IsDone(); + } + + return playing; +} + + +/*------------------------------------------------------------------------------ + * Stop playing + *----------------------------------------------------------------------------*/ +void +HelixPlayer :: stop(void) throw (std::logic_error) +{ + if (!isPlaying()) { + throw std::logic_error("HelixPlayer is not yet playing, can't stop it"); + } + player->Stop(); + + playing = false; + // TODO: gather error info from the ErrorSink +} + + +/*------------------------------------------------------------------------------ + * A global function needed by the Helix library, this will return the + * access path to shared objects. + *----------------------------------------------------------------------------*/ +DLLAccessPath* GetDLLAccessPath(void) +{ + return &accessPath; +} + + diff --git a/livesupport/modules/playlistExecutor/src/HelixPlayer.h b/livesupport/modules/playlistExecutor/src/HelixPlayer.h new file mode 100644 index 000000000..df4330b32 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/HelixPlayer.h @@ -0,0 +1,278 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/HelixPlayer.h,v $ + +------------------------------------------------------------------------------*/ +#ifndef HelixPlayer_h +#define HelixPlayer_h + +#ifndef __cplusplus +#error This is a C++ include file +#endif + + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + + +#include + +#include +#include + +#include "LiveSupport/Core/Configurable.h" + +#include "AdviseSink.h" +#include "ErrorSink.h" +#include "AuthenticationManager.h" +#include "ClientContext.h" + + +namespace LiveSupport { +namespace PlaylistExecutor { + +using namespace LiveSupport; +using namespace LiveSupport::Core; + +/* ================================================================ constants */ + + +/* =================================================================== macros */ + + +/* =============================================================== data types */ + +/** + * A class to play audio files and SMIL files through the Helix + * Community Library. + * + * @author $Author: maroy $ + * @version $Revision: 1.1 $ + */ +class HelixPlayer : + virtual public Configurable +{ + friend void * eventHandlerThread(void *) throw(); + + private: + /** + * The name of the configuration XML elmenent used by HelixPlayer + */ + static const std::string configElementNameStr; + + /** + * The full path to the Helix library shared objects. + */ + std::string dllPath; + + /** + * The shared object access point. + */ + DLLAccess dllAccess; + + /** + * Function pointer to create the Helix engine. + */ + FPRMCREATEENGINE createEngine; + + /** + * Function pointer to close the Helix engine. + */ + FPRMCLOSEENGINE closeEngine; + + /** + * The Helix Client engine. + */ + IHXClientEngine * clientEngine; + + /** + * The Helix player. + */ + IHXPlayer * player; + + /** + * The example client context. + */ + ClientContext * clientContext; + + /** + * The URL to play. + */ + std::string url; + + /** + * The event handling thread. + */ + pthread_t eventHandlingThread; + + /** + * Flag to mark if the event handling thread should be running + * and handling events. + * This is set by the HelixPlayer object, and read by the thread + * to determine when to stop. + */ + bool handleEvents; + + /** + * Flag to indicate if the player is currently playing. + * Make sure no to rely on this flag, as it's not aware of + * the case that the playing has ended naturally. Always + * call isPlaying() instead. + */ + bool playing; + + + public: + /** + * A virtual destructor, as this class has virtual functions. + */ + virtual + ~HelixPlayer(void) throw () + { + } + + /** + * Return the name of the XML element this object expects + * to be sent to a call to configure(). + * + * @return the name of the expected XML configuration element. + */ + static const std::string + getConfigElementName(void) throw () + { + return configElementNameStr; + } + + /** + * Configure the object based on the XML element supplied. + * + * @param element the XML element to configure the object from. + * @exception std::invalid_argument if the supplied XML element + * contains bad configuraiton information + * @exception std::logic_error if the scheduler daemon has already + * been configured, and can not be reconfigured. + */ + virtual void + configure(const xmlpp::Element & element) + throw (std::invalid_argument, + std::logic_error); + + /** + * Initialize the Helix Player object, so that it is ready to + * play audio files. + * + * @exception std::exception on initialization problems. + */ + virtual void + initialize(void) throw (std::exception); + + /** + * De-initialize the Helix Player object. + */ + virtual void + deInitialize(void); + + /** + * Specify which audio resource to play. + * The file may be a playlist, referencing other files, which + * will be accessed automatically. + * Note: this call will not start playing! You will + * have to call the start() function to begin playing. + * + * @param fileUrl a URL to a file + * @exception std::invalid_argument if the supplied fileUrl + * seems to be invalid. + * @see #start + */ + virtual void + playThis(const std::string fileUrl) throw (std::invalid_argument); + + /** + * Start playing. + * This call will start playing the active playlist, which was + * set by a previous call to playThis(). + * Playing can be stopped by calling stop(). + * + * @exception std::logic_error if there was no previous call to + * playThis(). + * @see #playThis + * @see #stop + */ + virtual void + start(void) throw (std::logic_error); + + /** + * Tell if we're currently playing. + * + * @return true of the player is currently playing, false + * otherwise. + */ + virtual bool + isPlaying(void) throw (); + + /** + * Stop playing. + * + * @exception std::logic_error if there was no previous call to + * start() + */ + virtual void + stop(void) throw (std::logic_error); +}; + + +/* ================================================= external data structures */ + + +/* ====================================================== function prototypes */ + +/** + * The main function of the thread that calls for handling of events + * in the createEngine all the time. + * + * @param helixPlayer a pointer to the HelixPlayer object that started + * this thread. + * @return always 0 + */ +void * +eventHandlerThread(void * helixPlayer) throw (); + + +} // namespace PlaylistExecutor +} // namespace LiveSupport + +/** + * A global function returning the shared object access path to + * the Helix library. + */ +DLLAccessPath* GetDLLAccessPath(void); + + +#endif // HelixPlayer_h + diff --git a/livesupport/modules/playlistExecutor/src/HelixPlayerTest.cxx b/livesupport/modules/playlistExecutor/src/HelixPlayerTest.cxx new file mode 100644 index 000000000..5eac7cb34 --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/HelixPlayerTest.cxx @@ -0,0 +1,188 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/HelixPlayerTest.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#if HAVE_UNISTD_H +#include +#else +#error "Need unistd.h" +#endif + + +#include +#include + +#include "HelixPlayer.h" +#include "HelixPlayerTest.h" + + +using namespace LiveSupport::PlaylistExecutor; + +/* =================================================== local data structures */ + + +/* ================================================ local constants & macros */ + +CPPUNIT_TEST_SUITE_REGISTRATION(HelixPlayerTest); + +/** + * The name of the configuration file for the Helix player. + */ +static const std::string configFileName = "etc/helixPlayer.xml"; + + +/* =============================================== local function prototypes */ + + +/* ============================================================= module code */ + +/*------------------------------------------------------------------------------ + * Set up the test environment + *----------------------------------------------------------------------------*/ +void +HelixPlayerTest :: setUp(void) throw () +{ + try { + Ptr::Ref parser( + new xmlpp::DomParser(configFileName, true)); + const xmlpp::Document * document = parser->get_document(); + const xmlpp::Element * root = document->get_root_node(); + + helixPlayer.reset(new HelixPlayer()); + helixPlayer->configure(*root); + + } catch (std::invalid_argument &e) { + std::cerr << "semantic error in configuration file" << std::endl; + } catch (xmlpp::exception &e) { + std::cerr << e.what() << std::endl; + } +} + + +/*------------------------------------------------------------------------------ + * Clean up the test environment + *----------------------------------------------------------------------------*/ +void +HelixPlayerTest :: tearDown(void) throw () +{ + helixPlayer.reset(); +} + + +/*------------------------------------------------------------------------------ + * Test to see if the HelixPlayer engine can be started and stopped + *----------------------------------------------------------------------------*/ +void +HelixPlayerTest :: firstTest(void) + throw (CPPUNIT_NS::Exception) +{ + try { + helixPlayer->initialize(); + CPPUNIT_ASSERT(!helixPlayer->isPlaying()); + helixPlayer->deInitialize(); + } catch (std::exception &e) { + CPPUNIT_FAIL("failed to initialize or de-initialize HelixPlayer"); + } +} + + +/*------------------------------------------------------------------------------ + * Play something simple + *----------------------------------------------------------------------------*/ +void +HelixPlayerTest :: simplePlayTest(void) + throw (CPPUNIT_NS::Exception) +{ + helixPlayer->initialize(); + helixPlayer->playThis("file:var/test.mp3"); + CPPUNIT_ASSERT(!helixPlayer->isPlaying()); + helixPlayer->start(); + CPPUNIT_ASSERT(helixPlayer->isPlaying()); + while (helixPlayer->isPlaying()) { + usleep(10000); + } + CPPUNIT_ASSERT(!helixPlayer->isPlaying()); + helixPlayer->deInitialize(); +} + + +/*------------------------------------------------------------------------------ + * Check for error conditions + *----------------------------------------------------------------------------*/ +void +HelixPlayerTest :: checkErrorConditions(void) + throw (CPPUNIT_NS::Exception) +{ + helixPlayer->initialize(); + + bool gotException; + + CPPUNIT_ASSERT(!helixPlayer->isPlaying()); + + gotException = false; + try { + helixPlayer->start(); + } catch (std::logic_error &e) { + gotException = true; + } + CPPUNIT_ASSERT(gotException); + + gotException = false; + try { + helixPlayer->stop(); + } catch (std::logic_error &e) { + gotException = true; + } + CPPUNIT_ASSERT(gotException); + + gotException = false; + try { + helixPlayer->playThis("totally/bad/URL"); + } catch (std::invalid_argument &e) { + gotException = true; + } + CPPUNIT_ASSERT(gotException); + + gotException = false; + try { + helixPlayer->start(); + } catch (std::logic_error &e) { + gotException = true; + } + CPPUNIT_ASSERT(gotException); + + helixPlayer->deInitialize(); +} + + diff --git a/livesupport/modules/playlistExecutor/src/HelixPlayerTest.h b/livesupport/modules/playlistExecutor/src/HelixPlayerTest.h new file mode 100644 index 000000000..4671825ea --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/HelixPlayerTest.h @@ -0,0 +1,132 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/Attic/HelixPlayerTest.h,v $ + +------------------------------------------------------------------------------*/ +#ifndef HelixPlayerTest_h +#define HelixPlayerTest_h + +#ifndef __cplusplus +#error This is a C++ include file +#endif + + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#include + + +namespace LiveSupport { +namespace PlaylistExecutor { + +/* ================================================================ constants */ + + +/* =================================================================== macros */ + + +/* =============================================================== data types */ + +/** + * Unit test for the HelixPlayer class. + * + * @author $Author: maroy $ + * @version $Revision: 1.1 $ + * @see HelixPlayer + */ +class HelixPlayerTest : public CPPUNIT_NS::TestFixture +{ + CPPUNIT_TEST_SUITE(HelixPlayerTest); + CPPUNIT_TEST(firstTest); + CPPUNIT_TEST(simplePlayTest); + CPPUNIT_TEST(checkErrorConditions); + CPPUNIT_TEST_SUITE_END(); + + private: + + /** + * The helix player to use for the tests. + */ + Ptr::Ref helixPlayer; + + + protected: + + /** + * A simple test. + * + * @exception CPPUNIT_NS::Exception on test failures. + */ + void + firstTest(void) throw (CPPUNIT_NS::Exception); + + /** + * Play something simple. + * + * @exception CPPUNIT_NS::Exception on test failures. + */ + void + simplePlayTest(void) throw (CPPUNIT_NS::Exception); + + /** + * Check for error conditions. + * + * @exception CPPUNIT_NS::Exception on test failures. + */ + void + checkErrorConditions(void) throw (CPPUNIT_NS::Exception); + + public: + + /** + * Set up the environment for the test case. + */ + void + setUp(void) throw (); + + /** + * Clean up the environment after the test case. + */ + void + tearDown(void) throw (); +}; + + +/* ================================================= external data structures */ + + +/* ====================================================== function prototypes */ + + +} // namespace PlaylistExecutor +} // namespace LiveSupport + +#endif // HelixPlayerTest_h + diff --git a/livesupport/modules/playlistExecutor/src/TestRunner.cxx b/livesupport/modules/playlistExecutor/src/TestRunner.cxx new file mode 100644 index 000000000..0ab739cdc --- /dev/null +++ b/livesupport/modules/playlistExecutor/src/TestRunner.cxx @@ -0,0 +1,281 @@ +/*------------------------------------------------------------------------------ + + Copyright (c) 2004 Media Development Loan Fund + + This file is part of the LiveSupport project. + http://livesupport.campware.org/ + To report bugs, send an e-mail to bugs@campware.org + + LiveSupport 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. + + LiveSupport 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 LiveSupport; if not, write to the Free Software + Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + + + Author : $Author: maroy $ + Version : $Revision: 1.1 $ + Location : $Source: /home/paul/cvs2svn-livesupport/newcvsrepo/livesupport/modules/playlistExecutor/src/TestRunner.cxx,v $ + +------------------------------------------------------------------------------*/ + +/* ============================================================ include files */ + +#ifdef HAVE_CONFIG_H +#include "configure.h" +#endif + +#if HAVE_UNISTD_H +#include +#else +#error "Need unistd.h" +#endif + +#if HAVE_GETOPT_H +#include +#else +#error "Need getopt.h" +#endif + +#include + +#include +#include +#include +#include +#include +#include +#include + +#include "LiveSupport/Core/Ptr.h" + + +using namespace LiveSupport::Core; + +/* =================================================== local data structures */ + + +/* ================================================ local constants & macros */ + +/** + * Our copyright notice, should be at most 80 columns + */ +static const char copyrightNotice[] = + "Copyright (c) 2004 Media Development Loan Fund under the GNU GPL"; + +/** + * String describing the short options. + */ +static const char options[] = "ho:s:v"; + +/** + * Structure describing the long options + */ +static const struct option longOptions[] = { + { "help", no_argument, 0, 'h' }, + { "output", required_argument, 0, 'o' }, + { "stylesheet", required_argument, 0, 's' }, + { "version", no_argument, 0, 'v' }, + { 0, 0, 0, 0 } +}; + +/** + * The encoding to use for the output file. + */ +static const std::string encoding = "utf-8"; + +/** + * The output XML file name. + */ +static Ptr::Ref xmlOutFileName; + +/** + * The XSLT attached to the output file. + */ +static Ptr::Ref xsltFileName; + + +/* =============================================== local function prototypes */ + +/** + * Print program version. + * + * @param os the std::ostream to print to. + */ +static void +printVersion ( std::ostream & os ); + +/** + * Print program usage information. + * + * @param invocation the command line command used to invoke this program. + * @param os the std::ostream to print to. + */ +static void +printUsage ( const char invocation[], + std::ostream & os ); + +/** + * Process command line arguments. + * + * @param argc the number of arguments. + * @param argv the arguments themselves. + * @return true of all went well, false in case the program should exit + * after this call. + */ +static bool +processArguments(int argc, char *argv[]); + + +/* ============================================================= module code */ + +/*------------------------------------------------------------------------------ + * Run all tests + *----------------------------------------------------------------------------*/ +int +main( int argc, + char * argv[] ) throw () +{ + if (!processArguments(argc, argv)) { + return 0; + } + + // Create the event manager and test controller + CPPUNIT_NS::TestResult controller; + + // Add a listener that colllects test result + CPPUNIT_NS::TestResultCollector result; + controller.addListener( &result ); + + // Add a listener that print dots as test run. + CPPUNIT_NS::BriefTestProgressListener progress; + controller.addListener( &progress ); + + // Add the top suite to the test runner + CPPUNIT_NS::TestRunner runner; + runner.addTest( CPPUNIT_NS::TestFactoryRegistry::getRegistry().makeTest() ); + runner.run( controller ); + + // Print test in a compiler compatible format. + CPPUNIT_NS::CompilerOutputter outputter( &result, std::cerr ); + outputter.setLocationFormat("%p:%l:"); + outputter.write(); + + // also generate an XML document as an output + std::ofstream xmlOutFile(xmlOutFileName->c_str()); + CPPUNIT_NS::XmlOutputter xmlOutputter(&result, xmlOutFile, encoding); + xmlOutputter.setStandalone(false); + if (xsltFileName) { + xmlOutputter.setStyleSheet(*xsltFileName); + } + xmlOutputter.write(); + xmlOutFile.flush(); + xmlOutFile.close(); + + return result.wasSuccessful() ? 0 : 1; +} + + +/*------------------------------------------------------------------------------ + * Process command line arguments. + *----------------------------------------------------------------------------*/ +static bool +processArguments(int argc, char *argv[]) +{ + int i; + + while ((i = getopt_long(argc, argv, options, longOptions, 0)) != -1) { + switch (i) { + case 'h': + printUsage(argv[0], std::cout); + return false; + + case 'o': + xmlOutFileName.reset(new std::string(optarg)); + break; + + case 's': + xsltFileName.reset(new std::string(optarg)); + break; + + case 'v': + printVersion(std::cout); + return false; + + default: + printUsage(argv[0], std::cout); + return false; + } + } + + if (optind < argc) { + std::cerr << "error processing command line arguments" << std::endl; + printUsage(argv[0], std::cout); + return false; + } + + if (!xmlOutFileName) { + std::cerr << "mandatory option output file name not specified" + << std::endl; + printUsage(argv[0], std::cout); + return false; + } + + std::cerr << "writing output to '" << *xmlOutFileName << '\'' << std::endl; + if (xsltFileName) { + std::cerr << "using XSLT file '" << *xsltFileName << '\'' << std::endl; + } + + return true; +} + + +/*------------------------------------------------------------------------------ + * Print program version. + *----------------------------------------------------------------------------*/ +static void +printVersion ( std::ostream & os ) +{ + os << PACKAGE_NAME << ' ' << PACKAGE_VERSION << std::endl + << "Unit test runner" << std::endl + << copyrightNotice << std::endl; +} + + +/*------------------------------------------------------------------------------ + * Print program usage. + *----------------------------------------------------------------------------*/ +static void +printUsage ( const char invocation[], + std::ostream & os ) +{ + os << PACKAGE_NAME << ' ' << PACKAGE_VERSION << std::endl + << "Unit test runner" << std::endl + << std::endl + << "Usage: " << invocation << " [OPTION]" + << std::endl + << " mandatory options:" << std::endl + << " -o, --output=file.name write test results into this XML file" + << std::endl + << " optional options:" << std::endl + << " -s, --stylesheet specify this XSLT for the output file" + << std::endl + << " this is either an absolute URI, or a" + << std::endl + << " relative path for the output document" + << std::endl + << " -h, --help display this help and exit" << std::endl + << " -v, --version display version information and exit" + << std::endl + << std::endl + << "Report bugs to " << PACKAGE_BUGREPORT << std::endl; +} + diff --git a/livesupport/modules/playlistExecutor/tmp/.keepme b/livesupport/modules/playlistExecutor/tmp/.keepme new file mode 100644 index 000000000..e0808fa16 --- /dev/null +++ b/livesupport/modules/playlistExecutor/tmp/.keepme @@ -0,0 +1 @@ +keep me diff --git a/livesupport/modules/playlistExecutor/var/test.mp3 b/livesupport/modules/playlistExecutor/var/test.mp3 new file mode 100644 index 000000000..f774c2164 Binary files /dev/null and b/livesupport/modules/playlistExecutor/var/test.mp3 differ