blocks: moved file sink and base and descriptor source/sink to gr-blocks.

author: Tom Rondeau <trondeau@vt.edu> 2013-03-10 22:45:00 -0400
committer: Tom Rondeau <trondeau@vt.edu> 2013-03-10 22:45:00 -0400
commit: 45f9c0a5792526279ebf5ffa6a4853c7e2de6dd6 (patch)
tree: 454906e3eb7109a56a3ffa471ac2dfdb1727fd50 /gr-blocks/include
parent: bd2e8bc700d0a78c682a9caa4a506e8ae9f631ef (diff)
5 files changed, 254 insertions, 0 deletions
diff --git a/gr-blocks/include/blocks/CMakeLists.txt b/gr-blocks/include/blocks/CMakeLists.txt
index 7e9c396daf..16df3cac1a 100644
--- a/gr-blocks/include/blocks/CMakeLists.txt
+++ b/gr-blocks/include/blocks/CMakeLists.txt
@@ -101,6 +101,7 @@ install(FILES
     api.h
     control_loop.h
     count_bits.h
+    file_sink_base.h
     fxpt.h
     fxpt_nco.h
     fxpt_vco.h
@@ -123,6 +124,9 @@ install(FILES
     conjugate_cc.h
     deinterleave.h
     delay.h
+    file_descriptor_sink.h
+    file_descriptor_source.h
+    file_sink.h
     file_source.h
     file_meta_sink.h
     file_meta_source.h
diff --git a/gr-blocks/include/blocks/file_descriptor_sink.h b/gr-blocks/include/blocks/file_descriptor_sink.h
new file mode 100644
index 0000000000..df59e24c0a
--- /dev/null
+++ b/gr-blocks/include/blocks/file_descriptor_sink.h
@@ -0,0 +1,54 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2004,2013 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef INCLUDED_GR_FILE_DESCRIPTOR_SINK_H
+#define INCLUDED_GR_FILE_DESCRIPTOR_SINK_H
+
+#include <blocks/api.h>
+#include <gr_sync_block.h>
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief Write stream to file descriptor.
+     * \ingroup sink_blk
+     */
+    class BLOCKS_API file_descriptor_sink : virtual public gr_sync_block
+    {
+    public:
+      // gr::blocks::file_descriptor_sink::sptr
+      typedef boost::shared_ptr<file_descriptor_sink> sptr;
+
+      /*!
+       * Build a file descriptor sink block.
+       *
+       * \param itemsize item size of the incoming data stream.
+       * \param fd file descriptor (as an integer).
+       */
+      static sptr make(size_t itemsize, int fd);
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* INCLUDED_GR_FILE_DESCRIPTOR_SINK_H */
diff --git a/gr-blocks/include/blocks/file_descriptor_source.h b/gr-blocks/include/blocks/file_descriptor_source.h
new file mode 100644
index 0000000000..ff4f14792b
--- /dev/null
+++ b/gr-blocks/include/blocks/file_descriptor_source.h
@@ -0,0 +1,61 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2004,2013 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H
+#define INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H
+
+#include <blocks/api.h>
+#include <gr_sync_block.h>
+
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief Read stream from file descriptor.
+     * \ingroup source_blk
+     */
+    class BLOCKS_API file_descriptor_source : virtual public gr_sync_block
+    {
+    protected:
+      virtual int read_items(char *buf, int nitems) = 0;
+      virtual int handle_residue(char *buf, int nbytes_read) = 0;
+      virtual void flush_residue() = 0;
+
+    public:
+      // gr::blocks::file_descriptor_source::sptr
+      typedef boost::shared_ptr<file_descriptor_source> sptr;
+
+      /*!
+       * Build a file descriptor source block.
+       *
+       * \param itemsize item size of the incoming data stream.
+       * \param fd file descriptor (as an integer).
+       * \param repeat repeat the data stream continuously.
+       */
+      static sptr make(size_t itemsize, int fd, bool repeat);
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* INCLUDED_GR_FILE_DESCRIPTOR_SOURCE_H */
diff --git a/gr-blocks/include/blocks/file_sink.h b/gr-blocks/include/blocks/file_sink.h
new file mode 100644
index 0000000000..08c2adf1f7
--- /dev/null
+++ b/gr-blocks/include/blocks/file_sink.h
@@ -0,0 +1,55 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2004,2007,2013 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef INCLUDED_GR_FILE_SINK_H
+#define INCLUDED_GR_FILE_SINK_H
+
+#include <blocks/api.h>
+#include <blocks/file_sink_base.h>
+#include <gr_sync_block.h>
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief Write stream to file.
+     * \ingroup sink_blk
+     */
+    class BLOCKS_API file_sink : virtual public gr_sync_block,
+                                 virtual public file_sink_base
+    {
+    public:
+      // gr::blocks::file_sink::sptr
+      typedef boost::shared_ptr<file_sink> sptr;
+
+      /*!
+       * \brief Make a file sink.
+       * \param itemsize size of the input data items.
+       * \param filename name of the file to open and write output to.
+       */
+      static sptr make(size_t itemsize, const char *filename);
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* INCLUDED_GR_FILE_SINK_H */
diff --git a/gr-blocks/include/blocks/file_sink_base.h b/gr-blocks/include/blocks/file_sink_base.h
new file mode 100644
index 0000000000..3eeb0e63da
--- /dev/null
+++ b/gr-blocks/include/blocks/file_sink_base.h
@@ -0,0 +1,80 @@
+/* -*- c++ -*- */
+/*
+ * Copyright 2004,2007,2008,2013 Free Software Foundation, Inc.
+ *
+ * This file is part of GNU Radio
+ *
+ * GNU Radio is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3, or (at your option)
+ * any later version.
+ *
+ * GNU Radio is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GNU Radio; see the file COPYING.  If not, write to
+ * the Free Software Foundation, Inc., 51 Franklin Street,
+ * Boston, MA 02110-1301, USA.
+ */
+
+#ifndef INCLUDED_GR_FILE_SINK_BASE_H
+#define INCLUDED_GR_FILE_SINK_BASE_H
+
+#include <blocks/api.h>
+#include <boost/thread.hpp>
+#include <cstdio>
+
+namespace gr {
+  namespace blocks {
+
+    /*!
+     * \brief Common base class for file sinks
+     */
+    class BLOCKS_API file_sink_base
+    {
+    protected:
+      FILE        *d_fp;        // current FILE pointer
+      FILE        *d_new_fp;    // new FILE pointer
+      bool         d_updated;   // is there a new FILE pointer?
+      bool         d_is_binary;
+      boost::mutex d_mutex;
+      bool         d_unbuffered;
+
+    protected:
+      file_sink_base(const char *filename, bool is_binary);
+
+    public:
+      file_sink_base() {}
+      ~file_sink_base();
+
+      /*!
+       * \brief Open filename and begin output to it.
+       */
+      bool open(const char *filename);
+
+      /*!
+       * \brief Close current output file.
+       *
+       * Closes current output file and ignores any output until
+       * open is called to connect to another file.
+       */
+      void close();
+
+      /*!
+       * \brief if we've had an update, do it now.
+       */
+      void do_update();
+
+      /*!
+       * \brief turn on unbuffered writes for slower outputs
+       */
+      void set_unbuffered(bool unbuffered);
+    };
+
+  } /* namespace blocks */
+} /* namespace gr */
+
+#endif /* INCLUDED_GR_FILE_SINK_BASE_H */
author	Tom Rondeau <trondeau@vt.edu>	2013-03-10 22:45:00 -0400
committer	Tom Rondeau <trondeau@vt.edu>	2013-03-10 22:45:00 -0400
commit	45f9c0a5792526279ebf5ffa6a4853c7e2de6dd6 (patch)
tree	454906e3eb7109a56a3ffa471ac2dfdb1727fd50 /gr-blocks/include
parent	bd2e8bc700d0a78c682a9caa4a506e8ae9f631ef (diff)