X-Git-Url: https://sigrok.org/gitweb/?p=pulseview.git;a=blobdiff_plain;f=pv%2Fsession.cpp;h=a8047f7da7f51ad9417f7861e447e465a2a77f94;hp=2e98c8f73f40c08a70f451c60716824a1b348bbb;hb=4640a84e926ac4b82e2a1b6ef9fc80ef44c2bd3c;hpb=efdec55aec1a137460fa362a381ed1904182bfed diff --git a/pv/session.cpp b/pv/session.cpp index 2e98c8f7..a8047f7d 100644 --- a/pv/session.cpp +++ b/pv/session.cpp @@ -17,32 +17,28 @@ * along with this program; if not, see . */ -#ifdef _WIN32 -// Windows: Avoid boost/thread namespace pollution (which includes windows.h). -#define NOGDI -#define NORESOURCE -#endif -#include -#include - -#include - #include +#include #include #include #include -#include "session.hpp" +#include +#include +#include + #include "devicemanager.hpp" +#include "mainwindow.hpp" +#include "session.hpp" +#include "util.hpp" #include "data/analog.hpp" #include "data/analogsegment.hpp" -#include "data/decoderstack.hpp" +#include "data/decode/decoder.hpp" #include "data/logic.hpp" #include "data/logicsegment.hpp" #include "data/signalbase.hpp" -#include "data/decode/decoder.hpp" #include "devices/hardwaredevice.hpp" #include "devices/inputfile.hpp" @@ -50,69 +46,98 @@ #include "toolbars/mainbar.hpp" -#include "view/analogsignal.hpp" -#include "view/decodetrace.hpp" -#include "view/logicsignal.hpp" -#include "view/signal.hpp" -#include "view/view.hpp" +#include "views/trace/analogsignal.hpp" +#include "views/trace/decodetrace.hpp" +#include "views/trace/logicsignal.hpp" +#include "views/trace/signal.hpp" +#include "views/trace/view.hpp" #include +#ifdef ENABLE_FLOW +#include +#include +#endif + #ifdef ENABLE_DECODE #include +#include "data/decodesignal.hpp" #endif -using boost::shared_lock; -using boost::shared_mutex; -using boost::unique_lock; - +using std::bad_alloc; using std::dynamic_pointer_cast; +using std::find_if; using std::function; -using std::lock_guard; using std::list; +using std::lock_guard; +using std::make_pair; +using std::make_shared; using std::map; +using std::max; +using std::move; using std::mutex; using std::pair; using std::recursive_mutex; -using std::set; +using std::runtime_error; using std::shared_ptr; using std::string; -using std::unordered_set; +#ifdef ENABLE_FLOW +using std::unique_lock; +#endif +using std::unique_ptr; using std::vector; using sigrok::Analog; using sigrok::Channel; -using sigrok::ChannelType; using sigrok::ConfigKey; using sigrok::DatafeedCallbackFunction; using sigrok::Error; -using sigrok::Header; using sigrok::InputFormat; using sigrok::Logic; using sigrok::Meta; -using sigrok::OutputFormat; using sigrok::Packet; -using sigrok::PacketPayload; using sigrok::Session; -using sigrok::SessionDevice; using Glib::VariantBase; -using Glib::Variant; + +#ifdef ENABLE_FLOW +using Gst::Bus; +using Gst::ElementFactory; +using Gst::Pipeline; +#endif + +using pv::data::SignalGroup; +using pv::util::Timestamp; +using pv::views::trace::Signal; +using pv::views::trace::AnalogSignal; +using pv::views::trace::LogicSignal; namespace pv { + +shared_ptr Session::sr_context; + Session::Session(DeviceManager &device_manager, QString name) : + shutting_down_(false), device_manager_(device_manager), default_name_(name), name_(name), capture_state_(Stopped), - cur_samplerate_(0) + cur_samplerate_(0), + data_saved_(true) { } Session::~Session() { + shutting_down_ = true; + // Stop and join to the thread stop_capture(); + + for (SignalGroup* group : signal_groups_) { + group->clear(); + delete group; + } } DeviceManager& Session::device_manager() @@ -152,17 +177,27 @@ void Session::set_name(QString name) name_changed(); } -const std::list< std::shared_ptr > Session::views() const +QString Session::save_path() const +{ + return save_path_; +} + +void Session::set_save_path(QString path) +{ + save_path_ = path; +} + +const vector< shared_ptr > Session::views() const { return views_; } -std::shared_ptr Session::main_view() const +shared_ptr Session::main_view() const { return main_view_; } -void Session::set_main_bar(std::shared_ptr main_bar) +void Session::set_main_bar(shared_ptr main_bar) { main_bar_ = main_bar; } @@ -172,11 +207,94 @@ shared_ptr Session::main_bar() const return main_bar_; } +bool Session::data_saved() const +{ + return data_saved_; +} + +void Session::save_setup(QSettings &settings) const +{ + int i = 0; + + // Save channels and decoders + for (const shared_ptr& base : signalbases_) { +#ifdef ENABLE_DECODE + if (base->is_decode_signal()) { + settings.beginGroup("decode_signal" + QString::number(i++)); + base->save_settings(settings); + settings.endGroup(); + } else +#endif + { + settings.beginGroup(base->internal_name()); + base->save_settings(settings); + settings.endGroup(); + } + } + + settings.setValue("decode_signals", i); + + // Save view states and their signal settings + // Note: main_view must be saved as view0 + i = 0; + settings.beginGroup("view" + QString::number(i++)); + main_view_->save_settings(settings); + settings.endGroup(); + + for (const shared_ptr& view : views_) { + if (view != main_view_) { + settings.beginGroup("view" + QString::number(i++)); + settings.setValue("type", view->get_type()); + view->save_settings(settings); + settings.endGroup(); + } + } + + settings.setValue("views", i); + + int view_id = 0; + i = 0; + for (const shared_ptr& vb : views_) { + shared_ptr tv = dynamic_pointer_cast(vb); + if (tv) { + for (const shared_ptr& time_item : tv->time_items()) { + + const shared_ptr flag = + dynamic_pointer_cast(time_item); + if (flag) { + if (!flag->enabled()) + continue; + + settings.beginGroup("meta_obj" + QString::number(i++)); + settings.setValue("type", "time_marker"); + settings.setValue("assoc_view", view_id); + GlobalSettings::store_timestamp(settings, "time", flag->time()); + settings.setValue("text", flag->get_text()); + settings.endGroup(); + } + } + + if (tv->cursors_shown()) { + settings.beginGroup("meta_obj" + QString::number(i++)); + settings.setValue("type", "selection"); + settings.setValue("assoc_view", view_id); + const shared_ptr cp = tv->cursors(); + GlobalSettings::store_timestamp(settings, "start_time", cp->first()->time()); + GlobalSettings::store_timestamp(settings, "end_time", cp->second()->time()); + settings.endGroup(); + } + } + + view_id++; + } + + settings.setValue("meta_objs", i); +} + void Session::save_settings(QSettings &settings) const { map dev_info; list key_list; - int stacks = 0, views = 0; if (device_) { shared_ptr hw_device = @@ -186,15 +304,15 @@ void Session::save_settings(QSettings &settings) const settings.setValue("device_type", "hardware"); settings.beginGroup("device"); - key_list.push_back("vendor"); - key_list.push_back("model"); - key_list.push_back("version"); - key_list.push_back("serial_num"); - key_list.push_back("connection_id"); + key_list.emplace_back("vendor"); + key_list.emplace_back("model"); + key_list.emplace_back("version"); + key_list.emplace_back("serial_num"); + key_list.emplace_back("connection_id"); dev_info = device_manager_.get_device_info(device_); - for (string key : key_list) { + for (string& key : key_list) { if (dev_info.count(key)) settings.setValue(QString::fromUtf8(key.c_str()), QString::fromUtf8(dev_info.at(key).c_str())); @@ -205,56 +323,109 @@ void Session::save_settings(QSettings &settings) const settings.endGroup(); } - shared_ptr sessionfile_device = - dynamic_pointer_cast< devices::SessionFile >(device_); - - if (sessionfile_device) { + // Having saved the data to srzip overrides the current device. This is + // a crappy hack around the fact that saving e.g. an imported file to + // srzip would require changing the underlying libsigrok device + if (!save_path_.isEmpty()) { + QFileInfo fi = QFileInfo(QDir(save_path_), name_); settings.setValue("device_type", "sessionfile"); settings.beginGroup("device"); - settings.setValue("filename", QString::fromStdString( - sessionfile_device->full_name())); + settings.setValue("filename", fi.absoluteFilePath()); settings.endGroup(); - } - - // Save channels and decoders - for (shared_ptr base : signalbases_) { -#ifdef ENABLE_DECODE - if (base->is_decode_signal()) { - shared_ptr decoder_stack = - base->decoder_stack(); - std::shared_ptr top_decoder = - decoder_stack->stack().front(); - - settings.beginGroup("decoder_stack" + QString::number(stacks++)); - settings.setValue("id", top_decoder->decoder()->id); - settings.setValue("name", top_decoder->decoder()->name); + } else { + shared_ptr sessionfile_device = + dynamic_pointer_cast(device_); + + if (sessionfile_device) { + settings.setValue("device_type", "sessionfile"); + settings.beginGroup("device"); + settings.setValue("filename", QString::fromStdString( + sessionfile_device->full_name())); settings.endGroup(); - } else -#endif - { - settings.beginGroup(base->internal_name()); - base->save_settings(settings); + } + + shared_ptr inputfile_device = + dynamic_pointer_cast(device_); + + if (inputfile_device) { + settings.setValue("device_type", "inputfile"); + settings.beginGroup("device"); + inputfile_device->save_meta_to_settings(settings); settings.endGroup(); } } - settings.setValue("decoder_stacks", stacks); + save_setup(settings); + } +} + +void Session::restore_setup(QSettings &settings) +{ + // Restore channels + for (shared_ptr base : signalbases_) { + settings.beginGroup(base->internal_name()); + base->restore_settings(settings); + settings.endGroup(); + } - // Save view states and their signal settings - // Note: main_view must be saved as view0 - settings.beginGroup("view" + QString::number(views++)); - main_view_->save_settings(settings); + // Restore decoders +#ifdef ENABLE_DECODE + int decode_signals = settings.value("decode_signals").toInt(); + + for (int i = 0; i < decode_signals; i++) { + settings.beginGroup("decode_signal" + QString::number(i)); + shared_ptr signal = add_decode_signal(); + signal->restore_settings(settings); settings.endGroup(); + } +#endif - for (shared_ptr view : views_) { - if (view != main_view_) { - settings.beginGroup("view" + QString::number(views++)); - view->save_settings(settings); - settings.endGroup(); - } + // Restore views + int views = settings.value("views").toInt(); + + for (int i = 0; i < views; i++) { + settings.beginGroup("view" + QString::number(i)); + + if (i > 0) { + views::ViewType type = (views::ViewType)settings.value("type").toInt(); + add_view(type, this); + views_.back()->restore_settings(settings); + } else + main_view_->restore_settings(settings); + + settings.endGroup(); + } + + // Restore meta objects like markers and cursors + int meta_objs = settings.value("meta_objs").toInt(); + + for (int i = 0; i < meta_objs; i++) { + settings.beginGroup("meta_obj" + QString::number(i)); + + shared_ptr vb; + shared_ptr tv; + if (settings.contains("assoc_view")) + vb = views_.at(settings.value("assoc_view").toInt()); + + if (vb) + tv = dynamic_pointer_cast(vb); + + const QString type = settings.value("type").toString(); + + if ((type == "time_marker") && tv) { + Timestamp ts = GlobalSettings::restore_timestamp(settings, "time"); + shared_ptr flag = tv->add_flag(ts); + flag->set_text(settings.value("text").toString()); + } + + if ((type == "selection") && tv) { + Timestamp start = GlobalSettings::restore_timestamp(settings, "start_time"); + Timestamp end = GlobalSettings::restore_timestamp(settings, "end_time"); + tv->set_cursors(start, end); + tv->show_cursors(); } - settings.setValue("views", views); + settings.endGroup(); } } @@ -262,7 +433,7 @@ void Session::restore_settings(QSettings &settings) { shared_ptr device; - QString device_type = settings.value("device_type").toString(); + const QString device_type = settings.value("device_type").toString(); if (device_type == "hardware") { map dev_info; @@ -270,11 +441,11 @@ void Session::restore_settings(QSettings &settings) // Re-select last used device if possible but only if it's not demo settings.beginGroup("device"); - key_list.push_back("vendor"); - key_list.push_back("model"); - key_list.push_back("version"); - key_list.push_back("serial_num"); - key_list.push_back("connection_id"); + key_list.emplace_back("vendor"); + key_list.emplace_back("model"); + key_list.emplace_back("version"); + key_list.emplace_back("serial_num"); + key_list.emplace_back("connection_id"); for (string key : key_list) { const QString k = QString::fromStdString(key); @@ -283,7 +454,7 @@ void Session::restore_settings(QSettings &settings) const string value = settings.value(k).toString().toStdString(); if (!value.empty()) - dev_info.insert(std::make_pair(key, value)); + dev_info.insert(make_pair(key, value)); } if (dev_info.count("model") > 0) @@ -295,61 +466,48 @@ void Session::restore_settings(QSettings &settings) settings.endGroup(); } - if (device_type == "sessionfile") { - settings.beginGroup("device"); - QString filename = settings.value("filename").toString(); - settings.endGroup(); - - if (QFileInfo(filename).isReadable()) { - device = std::make_shared(device_manager_.context(), - filename.toStdString()); - set_device(device); - // TODO Perform error handling - start_capture([](QString infoMessage) { (void)infoMessage; }); + QString filename; + if ((device_type == "sessionfile") || (device_type == "inputfile")) { + if (device_type == "sessionfile") { + settings.beginGroup("device"); + filename = settings.value("filename").toString(); + settings.endGroup(); - set_name(QFileInfo(filename).fileName()); + if (QFileInfo(filename).isReadable()) + device = make_shared(device_manager_.context(), + filename.toStdString()); } - } - if (device) { - // Restore channels - for (shared_ptr base : signalbases_) { - settings.beginGroup(base->internal_name()); - base->restore_settings(settings); + if (device_type == "inputfile") { + settings.beginGroup("device"); + device = make_shared(device_manager_.context(), + settings); settings.endGroup(); } - // Restore decoders -#ifdef ENABLE_DECODE - int stacks = settings.value("decoder_stacks").toInt(); - - for (int i = 0; i < stacks; i++) { - settings.beginGroup("decoder_stack" + QString::number(i++)); - - QString id = settings.value("id").toString(); - add_decoder(srd_decoder_get_by_id(id.toStdString().c_str())); - - settings.endGroup(); - } -#endif + if (device) { + set_device(device); - // Restore views - int views = settings.value("views").toInt(); + start_capture([](QString infoMessage) { + // TODO Emulate noquote() + qDebug() << "Session error:" << infoMessage; }); - for (int i = 0; i < views; i++) { - settings.beginGroup("view" + QString::number(i)); + set_name(QString::fromStdString( + dynamic_pointer_cast(device)->display_name(device_manager_))); - if (i > 0) { - views::ViewType type = (views::ViewType)settings.value("type").toInt(); - add_view(name_, type, this); - views_.back()->restore_settings(settings); - } else - main_view_->restore_settings(settings); + if (!filename.isEmpty()) { + // Only set the save path if we load an srzip file + if (device_type == "sessionfile") + set_save_path(QFileInfo(filename).absolutePath()); - settings.endGroup(); + set_name(QFileInfo(filename).fileName()); + } } } + + if (device) + restore_setup(settings); } void Session::select_device(shared_ptr device) @@ -360,8 +518,7 @@ void Session::select_device(shared_ptr device) else set_default_device(); } catch (const QString &e) { - main_bar_->session_error(tr("Failed to Select Device"), - tr("Failed to Select Device")); + MainWindow::show_session_error(tr("Failed to select device"), e); } } @@ -377,24 +534,33 @@ void Session::set_device(shared_ptr device) device_.reset(); - // Revert name back to default name (e.g. "Untitled-1") as the data is gone + // Revert name back to default name (e.g. "Session 1") as the data is gone name_ = default_name_; name_changed(); - // Remove all stored data - for (std::shared_ptr view : views_) { - view->clear_signals(); + // Remove all stored data and reset all views + for (shared_ptr view : views_) { + view->clear_signalbases(); #ifdef ENABLE_DECODE view->clear_decode_signals(); #endif + view->reset_view_state(); + } + + for (SignalGroup* group : signal_groups_) { + group->clear(); + delete group; } - for (const shared_ptr d : all_signal_data_) + signal_groups_.clear(); + + for (const shared_ptr& d : all_signal_data_) d->clear(); + all_signal_data_.clear(); signalbases_.clear(); cur_logic_segment_.reset(); - for (auto entry : cur_analog_segments_) { + for (auto& entry : cur_analog_segments_) { shared_ptr(entry.first).reset(); shared_ptr(entry.second).reset(); } @@ -403,22 +569,24 @@ void Session::set_device(shared_ptr device) signals_changed(); - device_ = std::move(device); + device_ = move(device); try { device_->open(); } catch (const QString &e) { device_.reset(); - device_changed(); - throw; + MainWindow::show_session_error(tr("Failed to open device"), e); } - device_->session()->add_datafeed_callback([=] - (shared_ptr device, shared_ptr packet) { - data_feed_in(device, packet); - }); + if (device_) { + device_->session()->add_datafeed_callback([=] + (shared_ptr device, shared_ptr packet) { + data_feed_in(device, packet); + }); + + update_signals(); + } - update_signals(); device_changed(); } @@ -431,43 +599,111 @@ void Session::set_default_device() return; // Try and find the demo device and select that by default - const auto iter = std::find_if(devices.begin(), devices.end(), + const auto iter = find_if(devices.begin(), devices.end(), [] (const shared_ptr &d) { - return d->hardware_device()->driver()->name() == - "demo"; }); + return d->hardware_device()->driver()->name() == "demo"; }); set_device((iter == devices.end()) ? devices.front() : *iter); } -void Session::load_init_file(const std::string &file_name, - const std::string &format) +bool Session::using_file_device() const +{ + shared_ptr sessionfile_device = + dynamic_pointer_cast(device_); + + shared_ptr inputfile_device = + dynamic_pointer_cast(device_); + + return (sessionfile_device || inputfile_device); +} + +/** + * Convert generic options to data types that are specific to InputFormat. + * + * @param[in] user_spec Vector of tokenized words, string format. + * @param[in] fmt_opts Input format's options, result of InputFormat::options(). + * + * @return Map of options suitable for InputFormat::create_input(). + */ +map +Session::input_format_options(vector user_spec, + map> fmt_opts) +{ + map result; + + for (auto& entry : user_spec) { + /* + * Split key=value specs. Accept entries without separator + * (for simplified boolean specifications). + */ + string key, val; + size_t pos = entry.find("="); + if (pos == std::string::npos) { + key = entry; + val = ""; + } else { + key = entry.substr(0, pos); + val = entry.substr(pos + 1); + } + + /* + * Skip user specifications that are not a member of the + * format's set of supported options. Have the text input + * spec converted to the required input format specific + * data type. + */ + auto found = fmt_opts.find(key); + if (found == fmt_opts.end()) { + qCritical() << "Supplied input option" << QString::fromStdString(key) << + "is not a valid option for this input module, it will be ignored!"; + continue; + } + + shared_ptr