summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio/blocks/wavfile_sink.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/wavfile_sink.h')
-rw-r--r--gr-blocks/include/gnuradio/blocks/wavfile_sink.h96
1 files changed, 48 insertions, 48 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/wavfile_sink.h b/gr-blocks/include/gnuradio/blocks/wavfile_sink.h
index d841a8b303..c9d9501ebf 100644
--- a/gr-blocks/include/gnuradio/blocks/wavfile_sink.h
+++ b/gr-blocks/include/gnuradio/blocks/wavfile_sink.h
@@ -27,61 +27,61 @@
#include <gnuradio/sync_block.h>
namespace gr {
- namespace blocks {
+namespace blocks {
- /*!
- * \brief Write stream to a Microsoft PCM (.wav) file.
- * \ingroup audio_blk
- *
- * \details
- * Values must be floats within [-1;1].
- * Check gr_make_wavfile_sink() for extra info.
- */
- class BLOCKS_API wavfile_sink : virtual public sync_block
- {
- public:
- // gr::blocks::wavfile_sink::sptr
- typedef boost::shared_ptr<wavfile_sink> sptr;
+/*!
+ * \brief Write stream to a Microsoft PCM (.wav) file.
+ * \ingroup audio_blk
+ *
+ * \details
+ * Values must be floats within [-1;1].
+ * Check gr_make_wavfile_sink() for extra info.
+ */
+class BLOCKS_API wavfile_sink : virtual public sync_block
+{
+public:
+ // gr::blocks::wavfile_sink::sptr
+ typedef boost::shared_ptr<wavfile_sink> sptr;
- /*
- * \param filename The .wav file to be opened
- * \param n_channels Number of channels (2 = stereo or I/Q output)
- * \param sample_rate Sample rate [S/s]
- * \param bits_per_sample 16 or 8 bit, default is 16
- */
- static sptr make(const char *filename,
- int n_channels,
- unsigned int sample_rate,
- int bits_per_sample = 16);
+ /*
+ * \param filename The .wav file to be opened
+ * \param n_channels Number of channels (2 = stereo or I/Q output)
+ * \param sample_rate Sample rate [S/s]
+ * \param bits_per_sample 16 or 8 bit, default is 16
+ */
+ static sptr make(const char* filename,
+ int n_channels,
+ unsigned int sample_rate,
+ int bits_per_sample = 16);
- /*!
- * \brief Opens a new file and writes a WAV header. Thread-safe.
- */
- virtual bool open(const char* filename) = 0;
+ /*!
+ * \brief Opens a new file and writes a WAV header. Thread-safe.
+ */
+ virtual bool open(const char* filename) = 0;
- /*!
- * \brief Closes the currently active file and completes the WAV
- * header. Thread-safe.
- */
- virtual void close() = 0;
+ /*!
+ * \brief Closes the currently active file and completes the WAV
+ * header. Thread-safe.
+ */
+ virtual void close() = 0;
- /*!
- * \brief Set the sample rate. This will not affect the WAV file
- * currently opened. Any following open() calls will use this new
- * sample rate.
- */
- virtual void set_sample_rate(unsigned int sample_rate) = 0;
+ /*!
+ * \brief Set the sample rate. This will not affect the WAV file
+ * currently opened. Any following open() calls will use this new
+ * sample rate.
+ */
+ virtual void set_sample_rate(unsigned int sample_rate) = 0;
- /*!
- * \brief Set bits per sample. This will not affect the WAV file
- * currently opened (see set_sample_rate()). If the value is
- * neither 8 nor 16, the call is ignored and the current value
- * is kept.
- */
- virtual void set_bits_per_sample(int bits_per_sample) = 0;
- };
+ /*!
+ * \brief Set bits per sample. This will not affect the WAV file
+ * currently opened (see set_sample_rate()). If the value is
+ * neither 8 nor 16, the call is ignored and the current value
+ * is kept.
+ */
+ virtual void set_bits_per_sample(int bits_per_sample) = 0;
+};
- } /* namespace blocks */
+} /* namespace blocks */
} /* namespace gr */
#endif /* INCLUDED_GR_WAVFILE_SINK_H */