sigsession.h 7.86 KB
Newer Older
DreamSourceLab's avatar
DreamSourceLab committed
1
/*
DreamSourceLab's avatar
DreamSourceLab committed
2 3
 * This file is part of the DSView project.
 * DSView is based on PulseView.
DreamSourceLab's avatar
DreamSourceLab committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
 *
 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
 * Copyright (C) 2013 DreamSourceLab <dreamsourcelab@dreamsourcelab.com>
 *
 * This program 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 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */


DreamSourceLab's avatar
DreamSourceLab committed
24 25
#ifndef DSVIEW_PV_SIGSESSION_H
#define DSVIEW_PV_SIGSESSION_H
DreamSourceLab's avatar
DreamSourceLab committed
26 27 28 29 30 31 32 33

#include <boost/function.hpp>
#include <boost/shared_ptr.hpp>
#include <boost/weak_ptr.hpp>
#include <boost/thread.hpp>

#include <string>
#include <utility>
DreamSourceLab's avatar
DreamSourceLab committed
34 35 36
#include <map>
#include <set>
#include <string>
DreamSourceLab's avatar
DreamSourceLab committed
37
#include <vector>
38
#include <stdint.h>
DreamSourceLab's avatar
DreamSourceLab committed
39 40 41 42 43 44 45

#include <QObject>
#include <QString>
#include <QLine>
#include <QVector>
#include <QMap>
#include <QVariant>
DreamSourceLab's avatar
DreamSourceLab committed
46
#include <QTimer>
47
#include <QtConcurrent/QtConcurrent>
48
#include <QJsonObject>
DreamSourceLab's avatar
DreamSourceLab committed
49

DreamSourceLab's avatar
DreamSourceLab committed
50
#include <libsigrok4DSL/libsigrok.h>
51
#include <libusb.h>
DreamSourceLab's avatar
DreamSourceLab committed
52

DreamSourceLab's avatar
DreamSourceLab committed
53 54 55
struct srd_decoder;
struct srd_channel;

DreamSourceLab's avatar
DreamSourceLab committed
56 57 58 59 60
namespace pv {

class DeviceManager;

namespace data {
DreamSourceLab's avatar
DreamSourceLab committed
61
class SignalData;
DreamSourceLab's avatar
DreamSourceLab committed
62 63
class Analog;
class AnalogSnapshot;
64 65
class Dso;
class DsoSnapshot;
DreamSourceLab's avatar
DreamSourceLab committed
66 67 68 69 70 71
class Logic;
class LogicSnapshot;
class Group;
class GroupSnapshot;
}

DreamSourceLab's avatar
DreamSourceLab committed
72 73 74 75
namespace device {
class DevInst;
}

DreamSourceLab's avatar
DreamSourceLab committed
76 77
namespace view {
class Signal;
DreamSourceLab's avatar
DreamSourceLab committed
78 79
class GroupSignal;
class DecodeTrace;
DreamSourceLab's avatar
DreamSourceLab committed
80 81 82 83 84 85 86 87 88 89 90 91
}

namespace decoder {
class Decoder;
class DecoderFactory;
}

class SigSession : public QObject
{
        Q_OBJECT

private:
92
    static constexpr float Oversampling = 2.0f;
DreamSourceLab's avatar
DreamSourceLab committed
93
    static const int ViewTime = 800;
94
    static const int RefreshTime = 500;
95
	bool saveFileThreadRunning = false;
DreamSourceLab's avatar
DreamSourceLab committed
96 97 98 99 100 101 102 103 104 105 106 107 108

public:
	enum capture_state {
        Init,
		Stopped,
		Running
	};

public:
	SigSession(DeviceManager &device_manager);

	~SigSession();

DreamSourceLab's avatar
DreamSourceLab committed
109
    boost::shared_ptr<device::DevInst> get_device() const;
DreamSourceLab's avatar
DreamSourceLab committed
110 111 112 113

	/**
	 * Sets device instance that will be used in the next capture session.
	 */
DreamSourceLab's avatar
DreamSourceLab committed
114 115
    void set_device(boost::shared_ptr<device::DevInst> dev_inst)
        throw(QString);
DreamSourceLab's avatar
DreamSourceLab committed
116

DreamSourceLab's avatar
DreamSourceLab committed
117 118
    void set_file(const std::string &name)
        throw(QString);
DreamSourceLab's avatar
DreamSourceLab committed
119 120 121

    void save_file(const std::string &name);

DreamSourceLab's avatar
DreamSourceLab committed
122
    void set_default_device(boost::function<void (const QString)> error_handler);
123 124 125
    void export_file(const std::string &name, QWidget* parent, const std::string &ext);

    void set_default_device();
DreamSourceLab's avatar
DreamSourceLab committed
126 127 128

    void release_device(device::DevInst *dev_inst);

DreamSourceLab's avatar
DreamSourceLab committed
129 130
	capture_state get_capture_state() const;

DreamSourceLab's avatar
DreamSourceLab committed
131
    void start_capture(bool instant,
DreamSourceLab's avatar
DreamSourceLab committed
132 133 134 135
		boost::function<void (const QString)> error_handler);

	void stop_capture();

DreamSourceLab's avatar
DreamSourceLab committed
136 137
    std::set< boost::shared_ptr<data::SignalData> > get_data() const;

DreamSourceLab's avatar
DreamSourceLab committed
138 139 140
	std::vector< boost::shared_ptr<view::Signal> >
		get_signals();

DreamSourceLab's avatar
DreamSourceLab committed
141 142
    std::vector< boost::shared_ptr<view::GroupSignal> >
        get_group_signals();
143
    QList<QString> getSuportedExportFormats();
DreamSourceLab's avatar
DreamSourceLab committed
144

DreamSourceLab's avatar
DreamSourceLab committed
145 146
#ifdef ENABLE_DECODE
    bool add_decoder(srd_decoder *const dec);
DreamSourceLab's avatar
DreamSourceLab committed
147

DreamSourceLab's avatar
DreamSourceLab committed
148 149
    std::vector< boost::shared_ptr<view::DecodeTrace> >
        get_decode_signals() const;
DreamSourceLab's avatar
DreamSourceLab committed
150

DreamSourceLab's avatar
DreamSourceLab committed
151
    void remove_decode_signal(view::DecodeTrace *signal);
DreamSourceLab's avatar
DreamSourceLab committed
152

DreamSourceLab's avatar
DreamSourceLab committed
153
    void remove_decode_signal(int index);
DreamSourceLab's avatar
DreamSourceLab committed
154

DreamSourceLab's avatar
DreamSourceLab committed
155
    void rst_decoder(int index);
DreamSourceLab's avatar
DreamSourceLab committed
156

DreamSourceLab's avatar
DreamSourceLab committed
157
    void rst_decoder(view::DecodeTrace *signal);
DreamSourceLab's avatar
DreamSourceLab committed
158

DreamSourceLab's avatar
DreamSourceLab committed
159
#endif
DreamSourceLab's avatar
DreamSourceLab committed
160

DreamSourceLab's avatar
DreamSourceLab committed
161
    void init_signals();
DreamSourceLab's avatar
DreamSourceLab committed
162

DreamSourceLab's avatar
DreamSourceLab committed
163
    void add_group();
DreamSourceLab's avatar
DreamSourceLab committed
164

DreamSourceLab's avatar
DreamSourceLab committed
165
    void del_group();
DreamSourceLab's avatar
DreamSourceLab committed
166

DreamSourceLab's avatar
DreamSourceLab committed
167
    void* get_buf(int& unit_size, uint64_t& length);
DreamSourceLab's avatar
DreamSourceLab committed
168

169 170
    void start_hotplug_proc(boost::function<void (const QString)> error_handler);
    void stop_hotplug_proc();
DreamSourceLab's avatar
DreamSourceLab committed
171
	void register_hotplug_callback();
172
    void deregister_hotplug_callback();
DreamSourceLab's avatar
DreamSourceLab committed
173 174 175

    void set_adv_trigger(bool adv_trigger);

DreamSourceLab's avatar
DreamSourceLab committed
176
    uint16_t get_ch_num(int type);
DreamSourceLab's avatar
DreamSourceLab committed
177
    
DreamSourceLab's avatar
DreamSourceLab committed
178
    bool get_instant();
DreamSourceLab's avatar
v0.3  
DreamSourceLab committed
179

180 181
    bool get_data_lock();

DreamSourceLab's avatar
DreamSourceLab committed
182 183 184
private:
	void set_capture_state(capture_state state);

DreamSourceLab's avatar
DreamSourceLab committed
185 186
    void read_sample_rate(const sr_dev_inst *const sdi);

DreamSourceLab's avatar
DreamSourceLab committed
187
private:
DreamSourceLab's avatar
DreamSourceLab committed
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
    /**
     * Attempts to autodetect the format. Failing that
     * @param filename The filename of the input file.
     * @return A pointer to the 'struct sr_input_format' that should be
     * 	used, or NULL if no input format was selected or
     * 	auto-detected.
     */
    static sr_input_format* determine_input_file_format(
        const std::string &filename);

    static sr_input* load_input_file_format(
        const std::string &filename,
        boost::function<void (const QString)> error_handler,
        sr_input_format *format = NULL);

    void sample_thread_proc(boost::shared_ptr<device::DevInst> dev_inst,
                            boost::function<void (const QString)> error_handler);
DreamSourceLab's avatar
DreamSourceLab committed
205

DreamSourceLab's avatar
v0.3  
DreamSourceLab committed
206
    // data feed
DreamSourceLab's avatar
DreamSourceLab committed
207 208 209
	void feed_in_header(const sr_dev_inst *sdi);
	void feed_in_meta(const sr_dev_inst *sdi,
		const sr_datafeed_meta &meta);
DreamSourceLab's avatar
v0.3  
DreamSourceLab committed
210
    void feed_in_trigger(const ds_trigger_pos &trigger_pos);
DreamSourceLab's avatar
DreamSourceLab committed
211
	void feed_in_logic(const sr_datafeed_logic &logic);
DreamSourceLab's avatar
v0.3  
DreamSourceLab committed
212
    void feed_in_dso(const sr_datafeed_dso &dso);
DreamSourceLab's avatar
DreamSourceLab committed
213 214
	void feed_in_analog(const sr_datafeed_analog &analog);
	void data_feed_in(const struct sr_dev_inst *sdi,
DreamSourceLab's avatar
v0.3  
DreamSourceLab committed
215 216 217
		const struct sr_datafeed_packet *packet);
	static void data_feed_in_proc(const struct sr_dev_inst *sdi,
		const struct sr_datafeed_packet *packet, void *cb_data);
DreamSourceLab's avatar
DreamSourceLab committed
218

DreamSourceLab's avatar
DreamSourceLab committed
219
    // thread for hotplug
DreamSourceLab's avatar
DreamSourceLab committed
220 221 222
    void hotplug_proc(boost::function<void (const QString)> error_handler);
    static int hotplug_callback(struct libusb_context *ctx, struct libusb_device *dev,
                                libusb_hotplug_event event, void *user_data);
DreamSourceLab's avatar
v0.3  
DreamSourceLab committed
223

DreamSourceLab's avatar
DreamSourceLab committed
224 225 226 227 228 229
private:
	DeviceManager &_device_manager;

	/**
	 * The device instance that will be used in the next capture session.
	 */
DreamSourceLab's avatar
DreamSourceLab committed
230
    boost::shared_ptr<device::DevInst> _dev_inst;
DreamSourceLab's avatar
DreamSourceLab committed
231 232 233

	mutable boost::mutex _sampling_mutex;
	capture_state _capture_state;
DreamSourceLab's avatar
DreamSourceLab committed
234
    bool _instant;
DreamSourceLab's avatar
DreamSourceLab committed
235 236 237

	mutable boost::mutex _signals_mutex;
	std::vector< boost::shared_ptr<view::Signal> > _signals;
DreamSourceLab's avatar
DreamSourceLab committed
238
    std::vector< boost::shared_ptr<view::GroupSignal> > _group_traces;
DreamSourceLab's avatar
DreamSourceLab committed
239
#ifdef ENABLE_DECODE
DreamSourceLab's avatar
DreamSourceLab committed
240
    std::vector< boost::shared_ptr<view::DecodeTrace> > _decode_traces;
DreamSourceLab's avatar
DreamSourceLab committed
241
#endif
DreamSourceLab's avatar
DreamSourceLab committed
242

DreamSourceLab's avatar
DreamSourceLab committed
243
    mutable boost::mutex _data_mutex;
DreamSourceLab's avatar
DreamSourceLab committed
244 245
	boost::shared_ptr<data::Logic> _logic_data;
	boost::shared_ptr<data::LogicSnapshot> _cur_logic_snapshot;
246 247
    boost::shared_ptr<data::Dso> _dso_data;
    boost::shared_ptr<data::DsoSnapshot> _cur_dso_snapshot;
DreamSourceLab's avatar
DreamSourceLab committed
248 249 250 251 252 253 254 255
	boost::shared_ptr<data::Analog> _analog_data;
	boost::shared_ptr<data::AnalogSnapshot> _cur_analog_snapshot;
    boost::shared_ptr<data::Group> _group_data;
    boost::shared_ptr<data::GroupSnapshot> _cur_group_snapshot;
    int _group_cnt;

	std::auto_ptr<boost::thread> _sampling_thread;

DreamSourceLab's avatar
DreamSourceLab committed
256
	libusb_hotplug_callback_handle _hotplug_handle;
257
    std::auto_ptr<boost::thread> _hotplug;
DreamSourceLab's avatar
DreamSourceLab committed
258 259 260 261 262
    bool _hot_attach;
    bool _hot_detach;

    bool _adv_trigger;

DreamSourceLab's avatar
DreamSourceLab committed
263
    QTimer _view_timer;
264 265
    QTimer _refresh_timer;
    bool _data_lock;
DreamSourceLab's avatar
DreamSourceLab committed
266

DreamSourceLab's avatar
DreamSourceLab committed
267 268 269 270 271 272 273
signals:
	void capture_state_changed(int state);

	void signals_changed();

	void data_updated();

DreamSourceLab's avatar
DreamSourceLab committed
274
    void start_timer(int);
DreamSourceLab's avatar
DreamSourceLab committed
275 276 277 278 279 280 281 282 283 284

    void receive_data(quint64 length);

    void device_attach();
    void device_detach();

    void test_data_error();

    void receive_trigger(quint64 trigger_pos);

DreamSourceLab's avatar
v0.3  
DreamSourceLab committed
285 286
    void dso_ch_changed(uint16_t num);

DreamSourceLab's avatar
DreamSourceLab committed
287 288 289
    void frame_began();

    void data_received();
DreamSourceLab's avatar
DreamSourceLab committed
290

DreamSourceLab's avatar
DreamSourceLab committed
291 292 293 294
    void frame_ended();

    void device_setted();

DreamSourceLab's avatar
DreamSourceLab committed
295 296 297
    void malloc_error();

    void zero_adj();
298
    void progressSaveFileValueChanged(int percent);
DreamSourceLab's avatar
DreamSourceLab committed
299

DreamSourceLab's avatar
DreamSourceLab committed
300 301
public slots:
    void reload();
302
    void refresh(int holdtime);
DreamSourceLab's avatar
DreamSourceLab committed
303

304 305
private slots:
    void cancelSaveFile();
306
    void data_unlock();
307

DreamSourceLab's avatar
DreamSourceLab committed
308 309 310 311 312 313 314 315 316
private:
	// TODO: This should not be necessary. Multiple concurrent
	// sessions should should be supported and it should be
	// possible to associate a pointer with a ds_session.
	static SigSession *_session;
};

} // namespace pv

DreamSourceLab's avatar
DreamSourceLab committed
317
#endif // DSVIEW_PV_SIGSESSION_H