Mercurial > hg > aimc
diff trunk/src/Modules/Input/ModuleFileInput.h @ 280:e55d0c225a57
- Lots of changes to make cpplint happy. It still complains about header guards, but that's pretty much it now.
author | tomwalters |
---|---|
date | Thu, 18 Feb 2010 21:12:41 +0000 |
parents | f469d936337f |
children | ef14c9f2c1d2 |
line wrap: on
line diff
--- a/trunk/src/Modules/Input/ModuleFileInput.h Thu Feb 18 20:04:04 2010 +0000 +++ b/trunk/src/Modules/Input/ModuleFileInput.h Thu Feb 18 21:12:41 2010 +0000 @@ -37,7 +37,7 @@ namespace aimc { class ModuleFileInput : public Module { public: - ModuleFileInput(Parameters *pParam); + explicit ModuleFileInput(Parameters *pParam); virtual ~ModuleFileInput(); /*! \brief Initializes this input device using an audio file @@ -46,29 +46,36 @@ */ bool LoadFile(const char *sFilename); - //! \brief Process the loaded file. + /*! \brief Process the loaded file. + */ void Process(); - //! \brief Dummy Initialize function. Call LoadFile instead. + /*! \brief Dummy Initialize function. Call LoadFile instead. + */ virtual bool Initialize(const SignalBank &input); - //! \brief Dummy funciton to comply with the Module specification. Gives an - // error message when called. + /*! \brief Dummy funciton to comply with the Module specification. Gives an + * error message when called. + */ virtual void Process(const SignalBank &input); private: - //! \brief Prepare the module - //! \param input Input SignalBank - //! \param output true on success false on failure + /*! \brief Prepare the module + * \param input Input SignalBank + * \param output true on success false on failure + */ virtual bool InitializeInternal(const SignalBank &input); - //! \brief Rewind to the start of the file + /*! \brief Rewind to the start of the file + */ virtual void ResetInternal(); - //! \brief File descriptor + /*! \brief File descriptor + */ SNDFILE *file_handle_; - //! \brief Current position in time of the file + /*! \brief Current position in time of the file + */ int file_position_samples_; bool file_loaded_; int audio_channels_; @@ -77,4 +84,4 @@ }; } // namespace aimc -#endif // _AIMC_MODULES_INPUT_FILE_H_ +#endif // _AIMC_MODULES_INPUT_FILE_H_