diff options
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/file_source.h')
| -rw-r--r-- | gr-blocks/include/gnuradio/blocks/file_source.h | 121 |
1 files changed, 62 insertions, 59 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/file_source.h b/gr-blocks/include/gnuradio/blocks/file_source.h index bb1ea84a8a..f8ed700e5c 100644 --- a/gr-blocks/include/gnuradio/blocks/file_source.h +++ b/gr-blocks/include/gnuradio/blocks/file_source.h @@ -27,73 +27,76 @@ #include <gnuradio/sync_block.h> namespace gr { - namespace blocks { +namespace blocks { + +/*! + * \brief Read stream from file + * \ingroup file_operators_blk + */ +class BLOCKS_API file_source : virtual public sync_block +{ +public: + // gr::blocks::file_source::sptr + typedef boost::shared_ptr<file_source> sptr; /*! - * \brief Read stream from file - * \ingroup file_operators_blk + * \brief Create a file source. + * + * Opens \p filename as a source of items into a flowgraph. The + * data is expected to be in binary format, item after item. The + * \p itemsize of the block determines the conversion from bits + * to items. The first \p offset items (default 0) will be + * skipped. + * + * If \p repeat is turned on, the file will repeat the file after + * it's reached the end. + * + * If \p len is non-zero, only items (offset, offset+len) will + * be produced. + * + * \param itemsize the size of each item in the file, in bytes + * \param filename name of the file to source from + * \param repeat repeat file from start + * \param offset begin this many items into file + * \param len produce only items (offset, offset+len) */ - class BLOCKS_API file_source : virtual public sync_block - { - public: - - // gr::blocks::file_source::sptr - typedef boost::shared_ptr<file_source> sptr; + static sptr make(size_t itemsize, + const char* filename, + bool repeat = false, + uint64_t offset = 0, + uint64_t len = 0); - /*! - * \brief Create a file source. - * - * Opens \p filename as a source of items into a flowgraph. The - * data is expected to be in binary format, item after item. The - * \p itemsize of the block determines the conversion from bits - * to items. The first \p offset items (default 0) will be - * skipped. - * - * If \p repeat is turned on, the file will repeat the file after - * it's reached the end. - * - * If \p len is non-zero, only items (offset, offset+len) will - * be produced. - * - * \param itemsize the size of each item in the file, in bytes - * \param filename name of the file to source from - * \param repeat repeat file from start - * \param offset begin this many items into file - * \param len produce only items (offset, offset+len) - */ - static sptr make(size_t itemsize, const char *filename, bool repeat = false, - uint64_t offset = 0, uint64_t len = 0); - - /*! - * \brief seek file to \p seek_point relative to \p whence - * - * \param seek_point sample offset in file - * \param whence one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek) - */ - virtual bool seek(int64_t seek_point, int whence) = 0; + /*! + * \brief seek file to \p seek_point relative to \p whence + * + * \param seek_point sample offset in file + * \param whence one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek) + */ + virtual bool seek(int64_t seek_point, int whence) = 0; - /*! - * \brief Opens a new file. - * - * \param filename name of the file to source from - * \param repeat repeat file from start - * \param offset begin this many items into file - * \param len produce only items [offset, offset+len) - */ - virtual void open(const char *filename, bool repeat, uint64_t offset = 0, uint64_t len = 0) = 0; + /*! + * \brief Opens a new file. + * + * \param filename name of the file to source from + * \param repeat repeat file from start + * \param offset begin this many items into file + * \param len produce only items [offset, offset+len) + */ + virtual void + open(const char* filename, bool repeat, uint64_t offset = 0, uint64_t len = 0) = 0; - /*! - * \brief Close the file handle. - */ - virtual void close() = 0; + /*! + * \brief Close the file handle. + */ + virtual void close() = 0; - /*! - * \brief Add a stream tag to the first sample of the file if true - */ - virtual void set_begin_tag(pmt::pmt_t val) = 0; - }; + /*! + * \brief Add a stream tag to the first sample of the file if true + */ + virtual void set_begin_tag(pmt::pmt_t val) = 0; +}; - } /* namespace blocks */ +} /* namespace blocks */ } /* namespace gr */ #endif /* INCLUDED_BLOCKS_FILE_SOURCE_H */ |