/* -*- c++ -*- */
/*
 * Copyright 2005-2011,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_AUDIO_JACK_SINK_H
#define INCLUDED_AUDIO_JACK_SINK_H

#include <gnuradio/audio/sink.h>
#include <jack/jack.h>
#include <jack/ringbuffer.h>
#include <stdexcept>
#include <string>

namespace gr {
namespace audio {

int sink_process(jack_nframes_t nframes, void* arg);

/*!
 * \brief audio sink using JACK
 * \ingroup audio_blk
 *
 * The sink has one input stream of floats.
 *
 * Input samples must be in the range [-1,1].
 */
class jack_sink : public sink
{
    friend int jack_sink_process(jack_nframes_t nframes, void* arg);

    // typedef for pointer to class work method
    typedef int (jack_sink::*work_t)(int noutput_items,
                                     gr_vector_const_void_star& input_items,
                                     gr_vector_void_star& output_items);

    unsigned int d_sampling_rate;
    std::string d_device_name;
    bool d_ok_to_block;

    jack_client_t* d_jack_client;
    static const int MAX_PORTS = 10;
    int d_portcount;
    jack_port_t* d_jack_output_port[MAX_PORTS];
    jack_ringbuffer_t* d_ringbuffer[MAX_PORTS];
    jack_nframes_t d_jack_buffer_size;
    pthread_cond_t d_ringbuffer_ready;
    pthread_mutex_t d_jack_process_lock;

    // random stats
    int d_nunderuns; // count of underruns

    void output_error_msg(const char* msg, int err);
    void bail(const char* msg, int err);

public:
    jack_sink(int sampling_rate, const std::string device_name, bool ok_to_block);
    ~jack_sink();

    bool check_topology(int ninputs, int noutputs);

    int work(int noutput_items,
             gr_vector_const_void_star& input_items,
             gr_vector_void_star& output_items);
};

} /* namespace audio */
} /* namespace gr */

#endif /* INCLUDED_AUDIO_JACK_SINK_H */
