Imported Upstream version 3.0
[debian/gnuradio] / gr-audio-portaudio / src / audio_portaudio_sink.h
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006 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 2, 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 #ifndef INCLUDED_AUDIO_PORTAUDIO_SINK_H
23 #define INCLUDED_AUDIO_PORTAUDIO_SINK_H
24
25 #include <gr_sync_block.h>
26 #include <gr_buffer.h>
27 #include <omnithread.h>
28 #include <string>
29 #include <portaudio.h>
30 #include <stdexcept>
31 #include <gri_logger.h>
32
33 class audio_portaudio_sink;
34 typedef boost::shared_ptr<audio_portaudio_sink> audio_portaudio_sink_sptr;
35
36 /*!
37  * \PORTAUDIO audio sink.
38  * \param sampling_rate sampling rate in Hz
39  * \param dev PORTAUDIO device name, e.g., "pa:"
40  * \param ok_to_block   true if it's ok for us to block
41  */
42 audio_portaudio_sink_sptr
43 audio_portaudio_make_sink (int sampling_rate,
44                            const std::string dev = "",
45                            bool ok_to_block = true);
46
47 PaStreamCallback portaudio_sink_callback;
48
49
50 /*!
51  * \ Audio sink using PORTAUDIO
52  *
53  * Input samples must be in the range [-1,1].
54  */
55 class audio_portaudio_sink : public gr_sync_block {
56   friend audio_portaudio_sink_sptr
57   audio_portaudio_make_sink (int sampling_rate,
58                              const std::string device_name,
59                              bool ok_to_block);
60
61   friend PaStreamCallback portaudio_sink_callback;
62
63
64   unsigned int          d_sampling_rate;
65   std::string           d_device_name;
66   bool                  d_ok_to_block;
67   bool                  d_verbose;
68
69   unsigned int          d_portaudio_buffer_size_frames; // number of frames in a portaudio buffer
70
71   PaStream              *d_stream;
72   PaStreamParameters    d_output_parameters;
73
74   gr_buffer_sptr        d_writer;               // buffer used between work and callback
75   gr_buffer_reader_sptr d_reader;
76   omni_semaphore        d_ringbuffer_ready;     // binary semaphore
77
78
79   // random stats
80   int                   d_nunderuns;            // count of underruns
81   gri_logger_sptr       d_log;                  // handle to non-blocking logging instance
82
83   void output_error_msg (const char *msg, int err);
84   void bail (const char *msg, int err) throw (std::runtime_error);
85   void create_ringbuffer();
86
87
88  protected:
89   audio_portaudio_sink (int sampling_rate, const std::string device_name,
90                         bool ok_to_block);
91
92  public:
93   ~audio_portaudio_sink ();
94   
95   bool check_topology (int ninputs, int noutputs);
96
97   int work (int noutput_items,
98             gr_vector_const_void_star &input_items,
99             gr_vector_void_star &output_items);
100 };
101
102 #endif /* INCLUDED_AUDIO_PORTAUDIO_SINK_H */