diff options
| -rw-r--r-- | src/qmmp/abstractengine.h | 2 | ||||
| -rw-r--r-- | src/qmmp/audioconverter.cpp | 2 | ||||
| -rw-r--r-- | src/qmmp/audioconverter.h | 25 | ||||
| -rw-r--r-- | src/qmmp/audioparameters.cpp | 2 | ||||
| -rw-r--r-- | src/qmmp/audioparameters.h | 9 | ||||
| -rw-r--r-- | src/qmmp/qmmp.h | 2 | ||||
| -rw-r--r-- | src/qmmp/qmmpsettings.h | 22 | ||||
| -rw-r--r-- | src/qmmp/soundcore.h | 7 |
8 files changed, 52 insertions, 19 deletions
diff --git a/src/qmmp/abstractengine.h b/src/qmmp/abstractengine.h index 2722b0743..14628f5ca 100644 --- a/src/qmmp/abstractengine.h +++ b/src/qmmp/abstractengine.h @@ -40,7 +40,7 @@ class AbstractEngine : public QThread Q_OBJECT public: /*! - * Object contsructor. + * Object constructor. * @param parent Parent object. */ AbstractEngine(QObject *parent = 0); diff --git a/src/qmmp/audioconverter.cpp b/src/qmmp/audioconverter.cpp index eeeebb9f7..2c74108d4 100644 --- a/src/qmmp/audioconverter.cpp +++ b/src/qmmp/audioconverter.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2010-2014 by Ilya Kotov * + * Copyright (C) 2010-2016 by Ilya Kotov * * forkotov02@hotmail.ru * * * * This program is free software; you can redistribute it and/or modify * diff --git a/src/qmmp/audioconverter.h b/src/qmmp/audioconverter.h index b15b4cced..ad581d985 100644 --- a/src/qmmp/audioconverter.h +++ b/src/qmmp/audioconverter.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2010-2015 by Ilya Kotov * + * Copyright (C) 2010-2016 by Ilya Kotov * * forkotov02@hotmail.ru * * * * This program is free software; you can redistribute it and/or modify * @@ -24,16 +24,35 @@ #include <stddef.h> #include "qmmp.h" -/*! +/*! @brief The AbstractEngine class provides the internal audio converter * @author Ilya Kotov <forkotov02@hotmail.ru> */ class AudioConverter { public: + /*! + * Object constructor. + */ AudioConverter(); - + /*! + * Sets working audio format. + * This function should be called before object usage. + * \param f Audio format. + */ void configure(Qmmp::AudioFormat f); + /*! + * Converts samples from specified working format to \b Qmmp::PCM_FLOAT format. + * \param in Input buffer. + * \param out Output buffer. + * \param samples Number of samples. + */ void toFloat(const unsigned char *in, float *out, size_t samples); + /*! + * Converts samples from \b Qmmp::PCM_FLOAT format to specified working format. + * \param in Input buffer. + * \param out Output buffer. + * \param samples Number of samples. + */ void fromFloat(const float *in, const unsigned char *out, size_t samples); diff --git a/src/qmmp/audioparameters.cpp b/src/qmmp/audioparameters.cpp index 60295ccb5..9924479f6 100644 --- a/src/qmmp/audioparameters.cpp +++ b/src/qmmp/audioparameters.cpp @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2009-2015 by Ilya Kotov * + * Copyright (C) 2009-2016 by Ilya Kotov * * forkotov02@hotmail.ru * * * * This program is free software; you can redistribute it and/or modify * diff --git a/src/qmmp/audioparameters.h b/src/qmmp/audioparameters.h index c8e5c8d9d..beb13dd61 100644 --- a/src/qmmp/audioparameters.h +++ b/src/qmmp/audioparameters.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2009-2014 by Ilya Kotov * + * Copyright (C) 2009-2016 by Ilya Kotov * * forkotov02@hotmail.ru * * * * This program is free software; you can redistribute it and/or modify * @@ -32,7 +32,7 @@ class AudioParameters { public: /*! - * Contsructor. + * Constructor. */ AudioParameters(); /*! @@ -78,7 +78,10 @@ public: * Returns sample size in bytes. */ int sampleSize() const; - + /*! + * Returns string represention of the audio parameters. + * May be useful for debug purposes. + */ const QString toString() const; /*! * Returns sample size in bytes of the given pcm data \b format. diff --git a/src/qmmp/qmmp.h b/src/qmmp/qmmp.h index df6015052..8f949ab14 100644 --- a/src/qmmp/qmmp.h +++ b/src/qmmp/qmmp.h @@ -105,7 +105,7 @@ public: PCM_S32BE, /*!< Signed 32 bit Big Endian */ PCM_U32LE, /*!< Unsigned 32 bit Little Endian */ PCM_U32BE, /*!< Unsigned 32 bit Big Endian */ - PCM_FLOAT /*!< Float 32 bit Native Endian, Range -1.0 to 1.0 */ + PCM_FLOAT /*!< Float 32 bit Native Endian, range: -1.0 to 1.0 */ }; /*! diff --git a/src/qmmp/qmmpsettings.h b/src/qmmp/qmmpsettings.h index 5d4732a59..6385509ee 100644 --- a/src/qmmp/qmmpsettings.h +++ b/src/qmmp/qmmpsettings.h @@ -145,7 +145,7 @@ public: */ EqSettings eqSettings() const; /*! - * Changes equalizer settings to \b settings + * Changes equalizer settings to \b settings. */ void setEqSettings(const EqSettings &settings); /*! @@ -154,21 +154,27 @@ public: */ void readEqSettings(int bands = EqSettings::EQ_BANDS_10); /*! - * Returns buffer size in milliseconds + * Returns buffer size in milliseconds. */ int bufferSize() const; /*! - * Sets buffer size - * @param msec Buffer size in milliseconds + * Sets buffer size. + * @param msec Buffer size in milliseconds. */ void setBufferSize(int msec); - + /*! + * Sets volume adjustment step. + * \param step Volume adjustment step in percent. + */ void setVolumeStep(int step); + /*! + * Returns volume adjustment step. + */ int volumeStep() const; /*! - * Enables/Disables file type determination by content - * @param enabled State of the content based type determination - * (\b true - enabled, \b false - disabled) + * Enables/Disables file type determination by content. + * @param enabled State of the content based type determination. + * (\b true - enabled, \b false - disabled). */ void setDetermineFileTypeByContent(bool enabled); /*! diff --git a/src/qmmp/soundcore.h b/src/qmmp/soundcore.h index 63095b2bc..781380f25 100644 --- a/src/qmmp/soundcore.h +++ b/src/qmmp/soundcore.h @@ -151,9 +151,14 @@ public slots: * @param volume volume of the left and right channels \b [0..100]. */ void setVolume(int volume); + /*! + * Increases volume by volume adjustment step. + */ void volumeUp(); + /*! + * Decreases volume by volume adjustment step. + */ void volumeDown(); - /*! * Sets the balance between left and right channels. * @param balance balance between left and right channels \b [-100..100]. |