Imported Upstream version 3.2.2
[debian/gnuradio] / gnuradio-core / src / lib / io / gr_file_source.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 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_FILE_SOURCE_H
24 #define INCLUDED_GR_FILE_SOURCE_H
25
26 #include <gr_sync_block.h>
27
28 class gr_file_source;
29 typedef boost::shared_ptr<gr_file_source> gr_file_source_sptr;
30
31 gr_file_source_sptr
32 gr_make_file_source (size_t itemsize, const char *filename, bool repeat = false);
33
34 /*!
35  * \brief Read stream from file
36  * \ingroup source_blk
37  */
38
39 class gr_file_source : public gr_sync_block
40 {
41   friend gr_file_source_sptr gr_make_file_source (size_t itemsize,
42                                                   const char *filename,
43                                                   bool repeat);
44  private:
45   size_t        d_itemsize;
46   void         *d_fp;
47   bool          d_repeat;
48
49  protected:
50   gr_file_source (size_t itemsize, const char *filename, bool repeat);
51
52  public:
53   ~gr_file_source ();
54
55   int work (int noutput_items,
56             gr_vector_const_void_star &input_items,
57             gr_vector_void_star &output_items);
58
59   /*!
60    * \brief seek file to \p seek_point relative to \p whence
61    *
62    * \param seek_point  sample offset in file
63    * \param whence      one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek)
64    */
65   bool seek (long seek_point, int whence);
66 };
67
68 #endif /* INCLUDED_GR_FILE_SOURCE_H */