summaryrefslogtreecommitdiff
path: root/gr-blocks/include/gnuradio/blocks/file_source.h
diff options
context:
space:
mode:
Diffstat (limited to 'gr-blocks/include/gnuradio/blocks/file_source.h')
-rw-r--r--gr-blocks/include/gnuradio/blocks/file_source.h31
1 files changed, 20 insertions, 11 deletions
diff --git a/gr-blocks/include/gnuradio/blocks/file_source.h b/gr-blocks/include/gnuradio/blocks/file_source.h
index c8138339fd..cd73c97d02 100644
--- a/gr-blocks/include/gnuradio/blocks/file_source.h
+++ b/gr-blocks/include/gnuradio/blocks/file_source.h
@@ -1,6 +1,6 @@
/* -*- c++ -*- */
/*
- * Copyright 2012 Free Software Foundation, Inc.
+ * Copyright 2012, 2018 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
@@ -46,32 +46,41 @@ namespace gr {
* 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.
+ * 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.
*
- * \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
+ * 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);
+ static sptr make(size_t itemsize, const char *filename, bool repeat = false,
+ size_t offset = 0, size_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)
+ * \param seek_point sample offset in file
+ * \param whence one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek)
*/
virtual bool seek(long 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 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) = 0;
+ virtual void open(const char *filename, bool repeat, size_t offset = 0, size_t len = 0) = 0;
/*!
* \brief Close the file handle.