renderdoc/qrenderdoc/Windows/Dialogs/PerformanceCounterSelection.cpp

/******************************************************************************
 * The MIT License (MIT)
 *
 * Copyright (c) 2016-2017 Baldur Karlsson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 ******************************************************************************/

#include "PerformanceCounterSelection.h"
#include "Code/CaptureContext.h"
#include "Code/Interface/QRDInterface.h"
#include "ui_PerformanceCounterSelection.h"

#include <unordered_map>

namespace
{
enum class CounterFamily
{
  Unknown,
  Generic,
  AMD,
  Intel,
  NVIDIA,
};

CounterFamily GetCounterFamily(GPUCounter counter)
{
  if(IsAMDCounter(counter))
  {
    return CounterFamily::AMD;
  }
  else if(IsIntelCounter(counter))
  {
    return CounterFamily::Intel;
  }
  else if(IsNvidiaCounter(counter))
  {
    return CounterFamily::NVIDIA;
  }

  return CounterFamily::Generic;
}

const char *ToString(CounterFamily family)
{
  switch(family)
  {
    case CounterFamily::AMD: return "AMD";
    case CounterFamily::Generic: return "Generic";
    case CounterFamily::Intel: return "Intel";
    case CounterFamily::NVIDIA: return "NVIDIA";
    case CounterFamily::Unknown: return "Unknown";
  }

  return nullptr;
}
}

PerformanceCounterSelection::PerformanceCounterSelection(ICaptureContext &ctx, QWidget *parent)
    : QDialog(parent), ui(new Ui::PerformanceCounterSelection), m_Ctx(ctx)
{
  ui->setupUi(this);

  connect(ui->counterTree, &QTreeWidget::itemEntered, [&](QTreeWidgetItem *item, int) -> void {
    const auto d = item->data(0, Qt::UserRole + 1);

    if(d.isValid())
    {
      ui->counterDescription->setText(
          QString(QLatin1String("<b>%1</b><hr>%2")).arg(item->text(0)).arg(d.toString()));
    }
  });

  connect(ui->counterTree, &QTreeWidget::itemChanged, [&](QTreeWidgetItem *item, int) -> void {
    const auto d = item->data(0, Qt::UserRole + 2);

    if(d.isValid())
    {
      if(item->checkState(0) == Qt::Checked)
      {
        // Add
        auto listItem = new QListWidgetItem(ui->enabledCounters);
        listItem->setText(item->text(0));
        m_SelectedCounters.insert(d.toUInt(), listItem);
      }
      else
      {
        // Remove
        auto listItem = m_SelectedCounters.take(d.toUInt());
        delete listItem;
      }
    }
  });

  connect(ui->sampleCounters, &QPushButton::pressed, [&]() -> void { this->accept(); });

  ui->counterTree->setMouseTracking(true);

  auto showCounters = [&](const QVector<CounterDescription> &counters) -> void {
    ui->counterTree->clear();
    ui->enabledCounters->clear();

    QTreeWidgetItem *currentRoot = NULL;
    CounterFamily currentFamily = CounterFamily::Unknown;

    std::unordered_map<std::string, QTreeWidgetItem *> categories;

    for(const auto desc : counters)
    {
      const CounterFamily family = GetCounterFamily(desc.counterID);
      if(family != currentFamily)
      {
        currentRoot = new QTreeWidgetItem(ui->counterTree);
        currentRoot->setText(0, QLatin1String{ToString(family)});

        categories.clear();

        currentFamily = family;
      }

      QTreeWidgetItem *categoryItem = nullptr;

      const auto category = std::string{desc.category};
      auto categoryIterator = categories.find(category);

      if(categoryIterator == categories.end())
      {
        auto item = new QTreeWidgetItem{currentRoot};
        item->setText(0, desc.category);
        categories[category] = item;
        categoryItem = item;
      }
      else
      {
        categoryItem = categoryIterator->second;
      }

      auto counterItem = new QTreeWidgetItem{categoryItem};
      counterItem->setText(0, desc.name);
      counterItem->setData(0, Qt::UserRole + 1, desc.description);
      counterItem->setData(0, Qt::UserRole + 2, (uint32_t)desc.counterID);
      counterItem->setCheckState(0, Qt::Unchecked);
    }
  };

  ctx.Replay().AsyncInvoke([=](IReplayController *controller) -> void {
    QVector<CounterDescription> desc;
    for(const auto counter : controller->EnumerateCounters())
    {
      desc.append(controller->DescribeCounter(counter));
    }

    GUIInvoke::call([=]() -> void { showCounters(desc); });
  });
}

PerformanceCounterSelection::~PerformanceCounterSelection()
{
  delete ui;
}

QList<uint32_t> PerformanceCounterSelection::GetSelectedCounters() const
{
  return m_SelectedCounters.keys();
}