GNU Radio Manual and C++ API Reference 3.8.5.0
The Free & Open Software Radio Ecosystem
 
Loading...
Searching...
No Matches
wavfile_source.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004,2008,2013 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23#ifndef INCLUDED_GR_WAVFILE_SOURCE_H
24#define INCLUDED_GR_WAVFILE_SOURCE_H
25
26#include <gnuradio/blocks/api.h>
27#include <gnuradio/sync_block.h>
28
29namespace gr {
30namespace blocks {
31
32/*!
33 * \brief Read stream from a Microsoft PCM (.wav) file, output floats
34 * \ingroup audio_blk
35 *
36 * \details
37 * Unless otherwise called, values are within [-1;1].
38 * Check gr_make_wavfile_source() for extra info.
39 */
40class BLOCKS_API wavfile_source : virtual public sync_block
41{
42public:
43 // gr::blocks::wavfile_source::sptr
44 typedef boost::shared_ptr<wavfile_source> sptr;
45
46 static sptr make(const char* filename, bool repeat = false);
47
48 /*!
49 * \brief Read the sample rate as specified in the wav file header
50 */
51 virtual unsigned int sample_rate() const = 0;
52
53 /*!
54 * \brief Return the number of bits per sample as specified in
55 * the wav file header. Only 8 or 16 bit are supported here.
56 */
57 virtual int bits_per_sample() const = 0;
58
59 /*!
60 * \brief Return the number of channels in the wav file as
61 * specified in the wav file header. This is also the max number
62 * of outputs you can have.
63 */
64 virtual int channels() const = 0;
65};
66
67} /* namespace blocks */
68} /* namespace gr */
69
70#endif /* INCLUDED_GR_WAVFILE_SOURCE_H */
repeat each input repeat times
Definition repeat.h:42
Read stream from a Microsoft PCM (.wav) file, output floats.
Definition wavfile_source.h:41
boost::shared_ptr< wavfile_source > sptr
Definition wavfile_source.h:44
static sptr make(const char *filename, bool repeat=false)
virtual int channels() const =0
Return the number of channels in the wav file as specified in the wav file header....
virtual unsigned int sample_rate() const =0
Read the sample rate as specified in the wav file header.
virtual int bits_per_sample() const =0
Return the number of bits per sample as specified in the wav file header. Only 8 or 16 bit are suppor...
synchronous 1:1 input to output with history
Definition sync_block.h:38
#define BLOCKS_API
Definition gr-blocks/include/gnuradio/blocks/api.h:30
GNU Radio logging wrapper for log4cpp library (C++ port of log4j)
Definition basic_block.h:46