From: atx23 Date: Fri, 2 Jan 2009 11:25:10 +0000 (+0000) Subject: Added documentation for DVBSocketController X-Git-Url: http://g0dil.de/git?a=commitdiff_plain;h=797cc66c49bb69e0bd084d1b7ec4269ba52de50d;p=senf.git Added documentation for DVBSocketController Changed configfile access in DVBConfigParser. Now it opens for each lookup the file and afterwards closing it git-svn-id: https://svn.berlios.de/svnroot/repos/senf/trunk@1033 270642c3-0616-0410-b53a-bc976706d245 --- diff --git a/Socket/Protocols/DVB/DVBConfigParser.cc b/Socket/Protocols/DVB/DVBConfigParser.cc index 2fc87ae..23a88ee 100644 --- a/Socket/Protocols/DVB/DVBConfigParser.cc +++ b/Socket/Protocols/DVB/DVBConfigParser.cc @@ -82,17 +82,21 @@ prefix_ void senf::DVBConfigParser::initConfigFile(string configFilePath_){ } configFilePath_ = configPath; } - configFile.open( configFilePath_.c_str(), ios_base::in); + configFile.open( configFilePath.c_str(), ios_base::in); if(configFile.bad()) - SENF_THROW_SYSTEM_EXCEPTION("Could not read configfile: ") << configFilePath_ << "."; + SENF_LOG((senf::log::IMPORTANT) ("Could not open channels file"<< configFilePath << "." )); + configFile.close(); } prefix_ string senf::DVBConfigParser::getConfigLine(string channel) { string configLine; size_t pos; transform(channel.begin(), channel.end(), channel.begin(), ::toupper); - if(configFile.bad()) - SENF_THROW_SYSTEM_EXCEPTION("Could not read file."); + + configFile.open( configFilePath.c_str(), ios_base::in); + if(configFile.bad()) + SENF_THROW_SYSTEM_EXCEPTION("Could not read channels file: ") << configFilePath << "."; + configFile.seekg(0); while (configFile.good()){ getline( configFile, configLine ); @@ -101,10 +105,11 @@ prefix_ string senf::DVBConfigParser::getConfigLine(string channel) pos = configLine.find(channel); if(pos != string::npos && pos == 0){ // only first matching number should be interpreted as channel number - configFile.seekg(0); + configFile.close(); return configLine; // Line found! } } + configFile.close(); SENF_THROW_SYSTEM_EXCEPTION("Channel \"")<< channel << "\" not found!"; return channel; } diff --git a/Socket/Protocols/DVB/DVBConfigParser.hh b/Socket/Protocols/DVB/DVBConfigParser.hh index da2a91a..bdd3d92 100644 --- a/Socket/Protocols/DVB/DVBConfigParser.hh +++ b/Socket/Protocols/DVB/DVBConfigParser.hh @@ -62,6 +62,7 @@ namespace senf { private: fe_type_t type; + std::string configFilePath; std::ifstream configFile; void initConfigFile(std::string _configFilePath); diff --git a/Socket/Protocols/DVB/DVBFrontendHandle.cc b/Socket/Protocols/DVB/DVBFrontendHandle.cc index 55c48d0..491cf49 100644 --- a/Socket/Protocols/DVB/DVBFrontendHandle.cc +++ b/Socket/Protocols/DVB/DVBFrontendHandle.cc @@ -3,6 +3,7 @@ // Copyright (C) 2007 // Fraunhofer Institute for Open Communication Systems (FOKUS) // Competence Center NETwork research (NET), St. Augustin, GERMANY +// Anton Gillert // Thorsten Horstmann // // This program is free software; you can redistribute it and/or modify diff --git a/Socket/Protocols/DVB/DVBFrontendHandle.hh b/Socket/Protocols/DVB/DVBFrontendHandle.hh index f128f64..831c336 100644 --- a/Socket/Protocols/DVB/DVBFrontendHandle.hh +++ b/Socket/Protocols/DVB/DVBFrontendHandle.hh @@ -4,6 +4,7 @@ // Fraunhofer Institute for Open Communication Systems (FOKUS) // Competence Center NETwork research (NET), St. Augustin, GERMANY // Thorsten Horstmann +// Anton Gillert // // This program is free software; you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by diff --git a/Socket/Protocols/DVB/DVBSocketController.cc b/Socket/Protocols/DVB/DVBSocketController.cc index 03981a0..85b5222 100644 --- a/Socket/Protocols/DVB/DVBSocketController.cc +++ b/Socket/Protocols/DVB/DVBSocketController.cc @@ -1,3 +1,26 @@ +// $Id$ +// +// Copyright (C) 2007 +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY +// Anton Gillert +// +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; either version 2 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program; if not, write to the +// Free Software Foundation, Inc., +// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + #include "senf/Utils/Exception.hh" #include "senf/Utils/Logger/Logger.hh" #include "senf/Utils/membind.hh" @@ -24,20 +47,20 @@ senf::DVBSocketController::DVBSocketController(DVBFrontendHandle frontendHandle_ prefix_ senf::DVBSocketController::~DVBSocketController() { } -prefix_ void senf::DVBSocketController::tuneToCMD(const string & configLine, const string & mode){ +prefix_ void senf::DVBSocketController::tuneToCMD(const string & input, const string & mode){ struct dvb_frontend_parameters frontend; // no valid configline, so it will be treaten like a channel name - if (configLine.find(":")==string::npos){ + if (input.find(":")==string::npos){ if (mode.c_str()[0]=='a') - tuneTo(configLine); + tuneTo(input); else - tuneTo_sync(configLine); + tuneTo_sync(input); return; } - // add psydo name to complete configline syntax - frontend = parser.getFrontendParam("foo:"+configLine); + // add psydo name "foo" to complete configline syntax + frontend = parser.getFrontendParam("foo:"+input); if (mode.c_str()[0]=='a'){ switch (type) { diff --git a/Socket/Protocols/DVB/DVBSocketController.hh b/Socket/Protocols/DVB/DVBSocketController.hh index d37dbac..6e731df 100644 --- a/Socket/Protocols/DVB/DVBSocketController.hh +++ b/Socket/Protocols/DVB/DVBSocketController.hh @@ -1,3 +1,26 @@ +// $Id$ +// +// Copyright (C) 2007 +// Fraunhofer Institute for Open Communication Systems (FOKUS) +// Competence Center NETwork research (NET), St. Augustin, GERMANY +// Anton Gillert +// +// This program is free software; you can redistribute it and/or modify +// it under the terms of the GNU General Public License as published by +// the Free Software Foundation; either version 2 of the License, or +// (at your option) any later version. +// +// This program is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +// GNU General Public License for more details. +// +// You should have received a copy of the GNU General Public License +// along with this program; if not, write to the +// Free Software Foundation, Inc., +// 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. + + #ifndef DVBSOCKETCONTROLLER_HH_ #define DVBSOCKETCONTROLLER_HH_ @@ -13,24 +36,37 @@ #define MPE_TABLEID 62 namespace senf { - std::string status2String(fe_status_t status); + /** \brief Helperclass for configuration and controlling DVB devices.

+ * + * The DVB API provides two methods for tuning. The first method is + * synchronous, which means e.g. "tuneTo_sync" will return when the tuning operation on the card succeed, + * no matter how long it takes. The second (preferred) method is to tune asynchronous. The call "tuneTo" will return + * immediately and (if a callback was set) call the callback when the tuning operation succeeds. + * + */ class DVBSocketController : boost::noncopyable { public: senf::console::ScopedDirectory dir; - typedef boost::function Callback; + typedef boost::function Callback; ///< Callback which is called when an asynchronous tuning succeeds. + /**< Callback which is called when an asynchronous tuning succeeds.*/ DVBSocketController(DVBFrontendHandle frontendHandle_ = DVBFrontendHandle(0,0), DVBDemuxSectionHandle sectionHandle_ = DVBDemuxSectionHandle(0,0), const Callback & cb = NULL); ~DVBSocketController(); - void tuneToCMD( const std::string & channel, const std::string & mode = "async"); - - void tuneTo(const std::string & channel); + void tuneToCMD( const std::string & input, const std::string & mode = "async");///< Tunes a DVB device given by the type of the DVBFrontendHandle + /**< Tunes a DVB device by a channel name or complete configuration line. + \param[in] input A channel name or a complete configuration line. If a channel name is given it would be searched in the config file. + \param[in] mode The mode in which it will tune "sync" or "async"*/ + void tuneTo(const std::string & channel); + ///< Tunes a DVB device given by the type of the DVBFrontendHandle + /**< Tunes a DVB device, given by the type of the DVBFrontendHandle, by a channel name in asynchronous mode + \param[in] channel A channel name which will be looked up in config file.*/ void tuneDVB_S(unsigned int frequency, fe_spectral_inversion_t inversion, unsigned int symbole_rate, fe_code_rate_t code_rate); ///< Tunes a DVB-S device - /**< Tunes a DVB-S device. Needs full configuration */ + /**< Tunes a DVB-S device in asynchronous mode and calls the callback if existing. Needs full configuration */ void tuneDVB_T(unsigned int frequency, fe_spectral_inversion_t inversion, fe_bandwidth_t bandwidth, fe_code_rate_t code_rate_HP, /* high priority stream code rate */ @@ -38,17 +74,22 @@ public: fe_modulation_t constellation, /* modulation type (see above) */ fe_transmit_mode_t transmission_mode, fe_guard_interval_t guard_interval, - fe_hierarchy_t hierarchy_information); ///< Tunes a DVB-T device - /**< Tunes a DVB-T device. Needs full configuration */ + fe_hierarchy_t hierarchy_information); ///< Tunes a DVB-T device + /**< Tunes a DVB-T device in asynchronous mode and calls the callback if existing. Needs full configuration. */ void tuneDVB_C(unsigned int frequency, fe_spectral_inversion_t inversion, unsigned int symbol_rate, fe_code_rate_t fec_inner, fe_modulation_t modulation); + ///< Tunes a DVB-C device + /**< Tunes a DVB-C device in asynchronous mode and calls the callback if existing. Needs full configuration. */ dvb_frontend_event tuneTo_sync( const std::string & channel ); + ///< Tunes a DVB device given by the type of the DVBFrontendHandle + /**< Tunes a DVB device, given by the type of the DVBFrontendHandle, by a channel name in synchronous mode + \param[in] channel A channel name which will be looked up in config file.*/ dvb_frontend_event tuneDVB_S_sync(unsigned int frequency, fe_spectral_inversion_t inversion, unsigned int symbole_rate, fe_code_rate_t code_rate); ///< Tunes a DVB-S device - /**< Tunes a DVB-S device. Needs full configuration */ + /**< Tunes a DVB-S device in synchronous mode. Needs full configuration */ dvb_frontend_event tuneDVB_T_sync(unsigned int frequency, fe_spectral_inversion_t inversion, fe_bandwidth_t bandwidth, fe_code_rate_t code_rate_HP, /* high priority stream code rate */ @@ -56,20 +97,35 @@ public: fe_modulation_t constellation, /* modulation type (see above) */ fe_transmit_mode_t transmission_mode, fe_guard_interval_t guard_interval, - fe_hierarchy_t hierarsourcechy_information); ///< Tunes a DVB-T device - /**< Tunes a DVB-T device. Needs full configuration */ + fe_hierarchy_t hierarsourcechy_information); + ///< Tunes a DVB-T device + /**< Tunes a DVB-T device in synchronous mode. Needs full configuration */ dvb_frontend_event tuneDVB_C_sync(unsigned int frequency, fe_spectral_inversion_t inversion, unsigned int symbol_rate, fe_code_rate_t fec_inner, fe_modulation_t modulation); + ///< Tunes a DVB-C device + /**< Tunes a DVB-C device in synchronous mode. Needs full configuration */ - fe_type_t getType(); + fe_type_t getType(); ///< Returns the type of the card. The type is defined in frontend.h - std::string getTypeString(); + std::string getTypeString(); ///< Returns the type of the card. + /**< Returns the type of the card but human readable e.g. "DVB-S", "DVB-T" or "DVB-C"*/ std::string status2String(fe_status_t status); - unsigned int bitErrorRate(); + ///< Returns a human readable status information + /**< Returns a human readable version of fe_status_t (defined by frontend.h)*/ + + unsigned int bitErrorRate(); ///< Returns the bit error rate + /**< Returns the bit error rate. + \note This function may not be implemented by your specific driver implementation. In this case the output is random.*/ unsigned int signalToNoiseRatio(); + ///< Returns the signal to noise ratio + /**< Returns the signal to noise ratio + \note This function may not be implemented by your specific driver implementation. In this case the output is random.*/ unsigned int signalStrength(); + ///< Returns the signal strength + /**< Returns the signal to noise ratio + \note This function may not be implemented by your specific driver implementation. In this case the output is random.*/ void setSectionFilter(unsigned short int pid, u_int8_t filter = MPE_TABLEID, @@ -77,25 +133,31 @@ public: u_int8_t mask = 0xff, u_int8_t mode = 0, unsigned int timeout = 0); + ///< Set the section filter + /**< Set the section filter.*/ void setBufferSize(unsigned long size); - ///< set the size of the circular buffer used for filtered data. + ///< Set the size of the circular buffer used for filtered data. /**< The default size is two maximum sized sections, i.e. if this function is not called a buffer size of 2 * 4096 bytes will be used. \param[in] size Size of circular buffer. */ - void startFiltering(); + void startFiltering(); + ///< Starts filtering + /**< Starts filtering.*/ void stopFiltering(); + ///< Stops filtering + /**< Stops filtering.*/ std::string getTuneInfo(const std::string & conf ="Ssbuf"); ///< Returns a string which shows actual tuning status /**< Returns a string which shows actual tuning status. - "S" prints signal strength (in hex) - "s" prints singal to noise ration (in hex) - "b" prints bit error rate (in hex) - "u" prints uncorrected blocks (in hex) - "f" prints readable overal status e.g. "Has Lock" +
"S" prints signal strength (in hex) +
"s" prints singal to noise ration (in hex) +
"b" prints bit error rate (in hex) +
"u" prints uncorrected blocks (in hex) +
"f" prints readable overal status e.g. "Has Lock"
These characters can be used to form the output. Be aware, some features may not be supported be your current driver implementation and could end in throwing an exception!*/