]> sigrok.org Git - pulseview.git/blobdiff - pv/session.cpp
Random simplifications, cosmetics/whitespace/consistency fixes.
[pulseview.git] / pv / session.cpp
index 773cf8047956d9cd062d5e3d65b3c2e11ecd0c7e..d00ff97a0bbe78ae7a9e55a82e2913b36c602807 100644 (file)
@@ -14,8 +14,7 @@
  * 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
+ * along with this program; if not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifdef _WIN32
@@ -23,8 +22,6 @@
 #define NOGDI
 #define NORESOURCE
 #endif
-#include <boost/thread/locks.hpp>
-#include <boost/thread/shared_mutex.hpp>
 
 #include <QFileInfo>
 
 #include <libsigrokdecode/libsigrokdecode.h>
 #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::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;
@@ -83,22 +82,16 @@ 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;
 
 namespace pv {
 Session::Session(DeviceManager &device_manager, QString name) :
@@ -106,7 +99,8 @@ Session::Session(DeviceManager &device_manager, QString name) :
        default_name_(name),
        name_(name),
        capture_state_(Stopped),
-       cur_samplerate_(0)
+       cur_samplerate_(0),
+       data_saved_(true)
 {
 }
 
@@ -153,17 +147,17 @@ void Session::set_name(QString name)
        name_changed();
 }
 
-const std::list< std::shared_ptr<views::ViewBase> > Session::views() const
+const list< shared_ptr<views::ViewBase> > Session::views() const
 {
        return views_;
 }
 
-std::shared_ptr<views::ViewBase> Session::main_view() const
+shared_ptr<views::ViewBase> Session::main_view() const
 {
        return main_view_;
 }
 
-void Session::set_main_bar(std::shared_ptr<pv::toolbars::MainBar> main_bar)
+void Session::set_main_bar(shared_ptr<pv::toolbars::MainBar> main_bar)
 {
        main_bar_ = main_bar;
 }
@@ -173,6 +167,11 @@ shared_ptr<pv::toolbars::MainBar> Session::main_bar() const
        return main_bar_;
 }
 
+bool Session::data_saved() const
+{
+       return data_saved_;
+}
+
 void Session::save_settings(QSettings &settings) const
 {
        map<string, string> dev_info;
@@ -187,11 +186,11 @@ 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_);
 
@@ -223,7 +222,7 @@ void Session::save_settings(QSettings &settings) const
                        if (base->is_decode_signal()) {
                                shared_ptr<pv::data::DecoderStack> decoder_stack =
                                                base->decoder_stack();
-                               std::shared_ptr<data::decode::Decoder> top_decoder =
+                               shared_ptr<data::decode::Decoder> top_decoder =
                                                decoder_stack->stack().front();
 
                                settings.beginGroup("decoder_stack" + QString::number(stacks++));
@@ -271,11 +270,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);
@@ -284,7 +283,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)
@@ -302,7 +301,7 @@ void Session::restore_settings(QSettings &settings)
                settings.endGroup();
 
                if (QFileInfo(filename).isReadable()) {
-                       device = std::make_shared<devices::SessionFile>(device_manager_.context(),
+                       device = make_shared<devices::SessionFile>(device_manager_.context(),
                                filename.toStdString());
                        set_device(device);
 
@@ -378,12 +377,12 @@ void Session::set_device(shared_ptr<devices::Device> 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<views::ViewBase> view : views_) {
+       for (shared_ptr<views::ViewBase> view : views_) {
                view->clear_signals();
 #ifdef ENABLE_DECODE
                view->clear_decode_signals();
@@ -404,22 +403,23 @@ void Session::set_device(shared_ptr<devices::Device> device)
 
        signals_changed();
 
-       device_ = std::move(device);
+       device_ = move(device);
 
        try {
                device_->open();
        } catch (const QString &e) {
                device_.reset();
-               device_changed();
-               throw;
        }
 
-       device_->session()->add_datafeed_callback([=]
-               (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
-                       data_feed_in(device, packet);
-               });
+       if (device_) {
+               device_->session()->add_datafeed_callback([=]
+                       (shared_ptr<sigrok::Device> device, shared_ptr<Packet> packet) {
+                               data_feed_in(device, packet);
+                       });
+
+               update_signals();
+       }
 
-       update_signals();
        device_changed();
 }
 
@@ -432,15 +432,13 @@ 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<devices::HardwareDevice> &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)
+void Session::load_init_file(const string &file_name, const string &format)
 {
        shared_ptr<InputFormat> input_format;
 
@@ -463,8 +461,8 @@ void Session::load_init_file(const std::string &file_name,
 }
 
 void Session::load_file(QString file_name,
-       std::shared_ptr<sigrok::InputFormat> format,
-       const std::map<std::string, Glib::VariantBase> &options)
+       shared_ptr<sigrok::InputFormat> format,
+       const map<string, Glib::VariantBase> &options)
 {
        const QString errorMessage(
                QString("Failed to load file %1").arg(file_name));
@@ -515,7 +513,7 @@ void Session::start_capture(function<void (const QString)> error_handler)
        const shared_ptr<sigrok::Device> sr_dev = device_->device();
        if (sr_dev) {
                const auto channels = sr_dev->channels();
-               if (!std::any_of(channels.begin(), channels.end(),
+               if (!any_of(channels.begin(), channels.end(),
                        [](shared_ptr<Channel> channel) {
                                return channel->enabled(); })) {
                        error_handler(tr("No channels enabled."));
@@ -527,9 +525,15 @@ void Session::start_capture(function<void (const QString)> error_handler)
        for (const shared_ptr<data::SignalData> d : all_signal_data_)
                d->clear();
 
-       // Revert name back to default name (e.g. "Untitled-1") as the data is gone
-       name_ = default_name_;
-       name_changed();
+       // Revert name back to default name (e.g. "Session 1") for real devices
+       // as the (possibly saved) data is gone. File devices keep their name.
+       shared_ptr<devices::HardwareDevice> hw_device =
+               dynamic_pointer_cast< devices::HardwareDevice >(device_);
+
+       if (hw_device) {
+               name_ = default_name_;
+               name_changed();
+       }
 
        // Begin the session
        sampling_thread_ = std::thread(
@@ -546,7 +550,7 @@ void Session::stop_capture()
                sampling_thread_.join();
 }
 
-void Session::register_view(std::shared_ptr<views::ViewBase> view)
+void Session::register_view(shared_ptr<views::ViewBase> view)
 {
        if (views_.empty()) {
                main_view_ = view;
@@ -557,10 +561,9 @@ void Session::register_view(std::shared_ptr<views::ViewBase> view)
        update_signals();
 }
 
-void Session::deregister_view(std::shared_ptr<views::ViewBase> view)
+void Session::deregister_view(shared_ptr<views::ViewBase> view)
 {
-       views_.remove_if([&](std::shared_ptr<views::ViewBase> v) {
-               return v == view; });
+       views_.remove_if([&](shared_ptr<views::ViewBase> v) { return v == view; });
 
        if (views_.empty()) {
                main_view_.reset();
@@ -570,9 +573,9 @@ void Session::deregister_view(std::shared_ptr<views::ViewBase> view)
        }
 }
 
-bool Session::has_view(std::shared_ptr<views::ViewBase> view)
+bool Session::has_view(shared_ptr<views::ViewBase> view)
 {
-       for (std::shared_ptr<views::ViewBase> v : views_)
+       for (shared_ptr<views::ViewBase> v : views_)
                if (v == view)
                        return true;
 
@@ -588,7 +591,7 @@ double Session::get_samplerate() const
                const vector< shared_ptr<pv::data::Segment> > segments =
                        d->segments();
                for (const shared_ptr<pv::data::Segment> &s : segments)
-                       samplerate = std::max(samplerate, s->samplerate());
+                       samplerate = max(samplerate, s->samplerate());
        }
        // If there is no sample rate given we use samples as unit
        if (samplerate == 0.0)
@@ -597,8 +600,7 @@ double Session::get_samplerate() const
        return samplerate;
 }
 
-const std::unordered_set< std::shared_ptr<data::SignalBase> >
-       Session::signalbases() const
+const unordered_set< shared_ptr<data::SignalBase> > Session::signalbases() const
 {
        return signalbases_;
 }
@@ -606,16 +608,18 @@ const std::unordered_set< std::shared_ptr<data::SignalBase> >
 #ifdef ENABLE_DECODE
 bool Session::add_decoder(srd_decoder *const dec)
 {
+       if (!dec)
+               return false;
+
        map<const srd_channel*, shared_ptr<data::SignalBase> > channels;
        shared_ptr<data::DecoderStack> decoder_stack;
 
        try {
                // Create the decoder
-               decoder_stack = shared_ptr<data::DecoderStack>(
-                       new data::DecoderStack(*this, dec));
+               decoder_stack = make_shared<data::DecoderStack>(*this, dec);
 
                // Make a list of all the channels
-               std::vector<const srd_channel*> all_channels;
+               vector<const srd_channel*> all_channels;
                for (const GSList *i = dec->channels; i; i = i->next)
                        all_channels.push_back((const srd_channel*)i->data);
                for (const GSList *i = dec->opt_channels; i; i = i->next)
@@ -624,7 +628,7 @@ bool Session::add_decoder(srd_decoder *const dec)
                // Auto select the initial channels
                for (const srd_channel *pdch : all_channels)
                        for (shared_ptr<data::SignalBase> b : signalbases_) {
-                               if (b->type() == ChannelType::LOGIC) {
+                               if (b->logic_data()) {
                                        if (QString::fromUtf8(pdch->name).toLower().
                                                contains(b->name().toLower()))
                                                channels[pdch] = b;
@@ -638,14 +642,14 @@ bool Session::add_decoder(srd_decoder *const dec)
 
                // Create the decode signal
                shared_ptr<data::SignalBase> signalbase =
-                       shared_ptr<data::SignalBase>(new data::SignalBase(nullptr));
+                       make_shared<data::SignalBase>(nullptr, data::SignalBase::DecodeChannel);
 
                signalbase->set_decoder_stack(decoder_stack);
                signalbases_.insert(signalbase);
 
-               for (std::shared_ptr<views::ViewBase> view : views_)
+               for (shared_ptr<views::ViewBase> view : views_)
                        view->add_decode_signal(signalbase);
-       } catch (std::runtime_error e) {
+       } catch (runtime_error e) {
                return false;
        }
 
@@ -661,7 +665,7 @@ void Session::remove_decode_signal(shared_ptr<data::SignalBase> signalbase)
 {
        signalbases_.erase(signalbase);
 
-       for (std::shared_ptr<views::ViewBase> view : views_)
+       for (shared_ptr<views::ViewBase> view : views_)
                view->remove_decode_signal(signalbase);
 
        signals_changed();
@@ -687,7 +691,7 @@ void Session::update_signals()
        if (!device_) {
                signalbases_.clear();
                logic_data_.reset();
-               for (std::shared_ptr<views::ViewBase> view : views_) {
+               for (shared_ptr<views::ViewBase> view : views_) {
                        view->clear_signals();
 #ifdef ENABLE_DECODE
                        view->clear_decode_signals();
@@ -702,7 +706,7 @@ void Session::update_signals()
        if (!sr_dev) {
                signalbases_.clear();
                logic_data_.reset();
-               for (std::shared_ptr<views::ViewBase> view : views_) {
+               for (shared_ptr<views::ViewBase> view : views_) {
                        view->clear_signals();
 #ifdef ENABLE_DECODE
                        view->clear_decode_signals();
@@ -713,10 +717,10 @@ void Session::update_signals()
 
        // Detect what data types we will receive
        auto channels = sr_dev->channels();
-       unsigned int logic_channel_count = std::count_if(
+       unsigned int logic_channel_count = count_if(
                channels.begin(), channels.end(),
                [] (shared_ptr<Channel> channel) {
-                       return channel->type() == ChannelType::LOGIC; });
+                       return channel->type() == sigrok::ChannelType::LOGIC; });
 
        // Create data containers for the logic data segments
        {
@@ -733,7 +737,7 @@ void Session::update_signals()
        }
 
        // Make the signals list
-       for (std::shared_ptr<views::ViewBase> viewbase : views_) {
+       for (shared_ptr<views::ViewBase> viewbase : views_) {
                views::TraceView::View *trace_view =
                        qobject_cast<views::TraceView::View*>(viewbase.get());
 
@@ -747,7 +751,7 @@ void Session::update_signals()
                                shared_ptr<views::TraceView::Signal> signal;
 
                                // Find the channel in the old signals
-                               const auto iter = std::find_if(
+                               const auto iter = find_if(
                                        prev_sigs.cbegin(), prev_sigs.cend(),
                                        [&](const shared_ptr<views::TraceView::Signal> &s) {
                                                return s->base()->channel() == channel;
@@ -766,12 +770,15 @@ void Session::update_signals()
                                        switch(channel->type()->id()) {
                                        case SR_CHANNEL_LOGIC:
                                                if (!signalbase) {
-                                                       signalbase = shared_ptr<data::SignalBase>(
-                                                               new data::SignalBase(channel));
+                                                       signalbase = make_shared<data::SignalBase>(channel,
+                                                               data::SignalBase::LogicChannel);
                                                        signalbases_.insert(signalbase);
 
                                                        all_signal_data_.insert(logic_data_);
                                                        signalbase->set_data(logic_data_);
+
+                                                       connect(this, SIGNAL(capture_state_changed(int)),
+                                                               signalbase.get(), SLOT(on_capture_state_changed(int)));
                                                }
 
                                                signal = shared_ptr<views::TraceView::Signal>(
@@ -783,13 +790,16 @@ void Session::update_signals()
                                        case SR_CHANNEL_ANALOG:
                                        {
                                                if (!signalbase) {
-                                                       signalbase = shared_ptr<data::SignalBase>(
-                                                               new data::SignalBase(channel));
+                                                       signalbase = make_shared<data::SignalBase>(channel,
+                                                               data::SignalBase::AnalogChannel);
                                                        signalbases_.insert(signalbase);
 
                                                        shared_ptr<data::Analog> data(new data::Analog());
                                                        all_signal_data_.insert(data);
                                                        signalbase->set_data(data);
+
+                                                       connect(this, SIGNAL(capture_state_changed(int)),
+                                                               signalbase.get(), SLOT(on_capture_state_changed(int)));
                                                }
 
                                                signal = shared_ptr<views::TraceView::Signal>(
@@ -800,7 +810,7 @@ void Session::update_signals()
                                        }
 
                                        default:
-                                               assert(0);
+                                               assert(false);
                                                break;
                                        }
                                }
@@ -849,13 +859,34 @@ void Session::sample_thread_proc(function<void (const QString)> error_handler)
        // Confirm that SR_DF_END was received
        if (cur_logic_segment_) {
                qDebug("SR_DF_END was not received.");
-               assert(0);
+               assert(false);
        }
 
+       // Optimize memory usage
+       free_unused_memory();
+
+       // We now have unsaved data unless we just "captured" from a file
+       shared_ptr<devices::File> file_device =
+               dynamic_pointer_cast<devices::File>(device_);
+
+       if (!file_device)
+               data_saved_ = false;
+
        if (out_of_memory_)
                error_handler(tr("Out of memory, acquisition stopped."));
 }
 
+void Session::free_unused_memory()
+{
+       for (shared_ptr<data::SignalData> data : all_signal_data_) {
+               const vector< shared_ptr<data::Segment> > segments = data->segments();
+
+               for (shared_ptr<data::Segment> segment : segments) {
+                       segment->free_unused_memory();
+               }
+       }
+}
+
 void Session::feed_in_header()
 {
        cur_samplerate_ = device_->read_config<uint64_t>(ConfigKey::SAMPLERATE);
@@ -915,8 +946,6 @@ void Session::feed_in_logic(shared_ptr<Logic> logic)
 {
        lock_guard<recursive_mutex> lock(data_mutex_);
 
-       const size_t sample_count = logic->data_length() / logic->unit_size();
-
        if (!logic_data_) {
                // The only reason logic_data_ would not have been created is
                // if it was not possible to determine the signals when the
@@ -929,9 +958,8 @@ void Session::feed_in_logic(shared_ptr<Logic> logic)
                set_capture_state(Running);
 
                // Create a new data segment
-               cur_logic_segment_ = shared_ptr<data::LogicSegment>(
-                       new data::LogicSegment(
-                               logic, cur_samplerate_, sample_count));
+               cur_logic_segment_ = make_shared<data::LogicSegment>(
+                       *logic_data_, logic->unit_size(), cur_samplerate_);
                logic_data_->push_segment(cur_logic_segment_);
 
                // @todo Putting this here means that only listeners querying
@@ -939,11 +967,10 @@ void Session::feed_in_logic(shared_ptr<Logic> logic)
                // frame_began is DecoderStack, but in future we need to signal
                // this after both analog and logic sweeps have begun.
                frame_began();
-       } else {
-               // Append to the existing data segment
-               cur_logic_segment_->append_payload(logic);
        }
 
+       cur_logic_segment_->append_payload(logic);
+
        data_received();
 }
 
@@ -974,12 +1001,6 @@ void Session::feed_in_analog(shared_ptr<Analog> analog)
                        // in the sweep containing this segment.
                        sweep_beginning = true;
 
-                       // Create a segment, keep it in the maps of channels
-                       segment = shared_ptr<data::AnalogSegment>(
-                               new data::AnalogSegment(
-                                       cur_samplerate_, sample_count));
-                       cur_analog_segments_[channel] = segment;
-
                        // Find the analog data associated with the channel
                        shared_ptr<data::SignalBase> base = signalbase_from_channel(channel);
                        assert(base);
@@ -987,6 +1008,11 @@ void Session::feed_in_analog(shared_ptr<Analog> analog)
                        shared_ptr<data::Analog> data(base->analog_data());
                        assert(data);
 
+                       // Create a segment, keep it in the maps of channels
+                       segment = make_shared<data::AnalogSegment>(
+                               *data, cur_samplerate_);
+                       cur_analog_segments_[channel] = segment;
+
                        // Push the segment into the analog data.
                        data->push_segment(segment);
                }
@@ -1009,6 +1035,8 @@ void Session::feed_in_analog(shared_ptr<Analog> analog)
 void Session::data_feed_in(shared_ptr<sigrok::Device> device,
        shared_ptr<Packet> packet)
 {
+       static bool frame_began = false;
+
        (void)device;
 
        assert(device);
@@ -1030,12 +1058,13 @@ void Session::data_feed_in(shared_ptr<sigrok::Device> device,
 
        case SR_DF_FRAME_BEGIN:
                feed_in_frame_begin();
+               frame_began = true;
                break;
 
        case SR_DF_LOGIC:
                try {
                        feed_in_logic(dynamic_pointer_cast<Logic>(packet->payload()));
-               } catch (std::bad_alloc) {
+               } catch (bad_alloc) {
                        out_of_memory_ = true;
                        device_->stop();
                }
@@ -1044,12 +1073,13 @@ void Session::data_feed_in(shared_ptr<sigrok::Device> device,
        case SR_DF_ANALOG:
                try {
                        feed_in_analog(dynamic_pointer_cast<Analog>(packet->payload()));
-               } catch (std::bad_alloc) {
+               } catch (bad_alloc) {
                        out_of_memory_ = true;
                        device_->stop();
                }
                break;
 
+       case SR_DF_FRAME_END:
        case SR_DF_END:
        {
                {
@@ -1057,7 +1087,10 @@ void Session::data_feed_in(shared_ptr<sigrok::Device> device,
                        cur_logic_segment_.reset();
                        cur_analog_segments_.clear();
                }
-               frame_ended();
+               if (frame_began) {
+                       frame_began = false;
+                       frame_ended();
+               }
                break;
        }
        default:
@@ -1065,4 +1098,9 @@ void Session::data_feed_in(shared_ptr<sigrok::Device> device,
        }
 }
 
+void Session::on_data_saved()
+{
+       data_saved_ = true;
+}
+
 } // namespace pv