/******************************************************************************
 * 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 "CaptureContext.h"
#include <QApplication>
#include <QDir>
#include <QFileInfo>
#include <QLabel>
#include <QMenu>
#include <QMessageBox>
#include <QMetaObject>
#include <QProgressDialog>
#include <QStandardPaths>
#include <QTimer>
#include "Windows/APIInspector.h"
#include "Windows/BufferViewer.h"
#include "Windows/DebugMessageView.h"
#include "Windows/Dialogs/CaptureDialog.h"
#include "Windows/Dialogs/LiveCapture.h"
#include "Windows/EventBrowser.h"
#include "Windows/MainWindow.h"
#include "Windows/PipelineState/PipelineStateViewer.h"
#include "Windows/StatisticsViewer.h"
#include "Windows/TextureViewer.h"
#include "QRDUtils.h"

CaptureContext::CaptureContext(QString paramFilename, QString remoteHost, uint32_t remoteIdent,
                               bool temp, PersistantConfig &cfg)
    : Config(cfg)
{
  m_LogLoaded = false;
  m_LoadInProgress = false;

  m_EventID = 0;

  memset(&m_APIProps, 0, sizeof(m_APIProps));

  qApp->setApplicationVersion(RENDERDOC_GetVersionString());

  m_Icon = new QIcon();
  m_Icon->addFile(QStringLiteral(":/icon.ico"), QSize(), QIcon::Normal, QIcon::Off);

  m_MainWindow = new MainWindow(*this);
  m_MainWindow->show();

  if(remoteIdent != 0)
  {
    m_MainWindow->ShowLiveCapture(
        new LiveCapture(*this, remoteHost, remoteIdent, m_MainWindow, m_MainWindow));
  }

  if(!paramFilename.isEmpty())
  {
    QFileInfo fi(paramFilename);

    m_MainWindow->LoadFromFilename(paramFilename);
  }
}

CaptureContext::~CaptureContext()
{
  delete m_Icon;
  m_Renderer.CloseThread();
  delete m_MainWindow;
}

bool CaptureContext::isRunning()
{
  return m_MainWindow && m_MainWindow->isVisible();
}

QString CaptureContext::ConfigFile(const QString &filename)
{
  QString path = QStandardPaths::writableLocation(QStandardPaths::AppDataLocation);

  QDir dir(path);
  if(!dir.exists())
    dir.mkdir(".");

  return QDir::cleanPath(dir.absoluteFilePath(filename));
}

QString CaptureContext::TempLogFilename(QString appname)
{
  QString folder = Config.TemporaryCaptureDirectory;

  QDir dir(folder);

  if(folder == "" || !dir.exists())
  {
    dir = QDir(QDir::tempPath());

    dir.mkdir("RenderDoc");

    dir = QDir(dir.absoluteFilePath("RenderDoc"));
  }

  return dir.absoluteFilePath(
      appname + "_" + QDateTime::currentDateTimeUtc().toString("yyyy.MM.dd_HH.mm.ss") + ".rdc");
}

void CaptureContext::LoadLogfile(const QString &logFile, const QString &origFilename,
                                 bool temporary, bool local)
{
  m_LoadInProgress = true;

  LambdaThread *thread = new LambdaThread([this, logFile, origFilename, temporary, local]() {
    LoadLogfileThreaded(logFile, origFilename, temporary, local);
  });
  thread->selfDelete(true);
  thread->start();

  ShowProgressDialog(
      m_MainWindow, QApplication::translate("CaptureContext", "Loading Log: %1").arg(origFilename),
      [this]() { return !m_LoadInProgress; }, [this]() { return UpdateLoadProgress(); });

  m_MainWindow->setProgress(-1.0f);

  if(m_LogLoaded)
  {
    QVector<ILogViewerForm *> logviewers(m_LogViewers);

    // make sure we're on a consistent event before invoking log viewer forms
    const FetchDrawcall *draw = &m_Drawcalls.back();
    while(!draw->children.empty())
      draw = &draw->children.back();

    SetEventID(logviewers, draw->eventID, true);

    GUIInvoke::blockcall([&logviewers]() {
      // notify all the registers log viewers that a log has been loaded
      for(ILogViewerForm *logviewer : logviewers)
      {
        if(logviewer)
          logviewer->OnLogfileLoaded();
      }
    });
  }
}

float CaptureContext::UpdateLoadProgress()
{
  float val = 0.8f * m_LoadProgress + 0.19f * m_PostloadProgress + 0.01f;

  m_MainWindow->setProgress(val);

  return val;
}

void CaptureContext::LoadLogfileThreaded(const QString &logFile, const QString &origFilename,
                                         bool temporary, bool local)
{
  m_LogFile = origFilename;

  m_LogLocal = local;

  Config.Save();

  m_LoadProgress = 0.0f;
  m_PostloadProgress = 0.0f;

  // this function call will block until the log is either loaded, or there's some failure
  m_Renderer.OpenCapture(logFile, &m_LoadProgress);

  // if the renderer isn't running, we hit a failure case so display an error message
  if(!m_Renderer.IsRunning())
  {
    QString errmsg = "Unknown error message";
    errmsg = ToQStr(m_Renderer.GetCreateStatus());

    RDDialog::critical(NULL, "Error opening log",
                       QString("%1\nFailed to open logfile for replay: %2.\n\n"
                               "Check diagnostic log in Help menu for more details.")
                           .arg(logFile)
                           .arg(errmsg));

    m_LoadInProgress = false;
    return;
  }

  if(!temporary)
  {
    PersistantConfig::AddRecentFile(Config.RecentLogFiles, origFilename, 10);

    Config.Save();
  }

  m_EventID = 0;

  // fetch initial data like drawcalls, textures and buffers
  m_Renderer.BlockInvoke([this](IReplayRenderer *r) {
    r->GetFrameInfo(&m_FrameInfo);

    m_APIProps = r->GetAPIProperties();

    m_PostloadProgress = 0.2f;

    r->GetDrawcalls(&m_Drawcalls);

    AddFakeProfileMarkers();

    m_PostloadProgress = 0.4f;

    r->GetSupportedWindowSystems(&m_WinSystems);

#if defined(RENDERDOC_PLATFORM_WIN32)
    m_CurWinSystem = eWindowingSystem_Win32;
#elif defined(RENDERDOC_PLATFORM_LINUX)
    m_CurWinSystem = eWindowingSystem_Xlib;

    // prefer XCB, if supported
    for(WindowingSystem sys : m_WinSystems)
    {
      if(sys == eWindowingSystem_XCB)
      {
        m_CurWinSystem = eWindowingSystem_XCB;
        break;
      }
    }

    if(m_CurWinSystem == eWindowingSystem_XCB)
      m_XCBConnection = QX11Info::connection();
    else
      m_X11Display = QX11Info::display();
#endif

    r->GetBuffers(&m_BufferList);
    for(FetchBuffer &b : m_BufferList)
      m_Buffers[b.ID] = &b;

    m_PostloadProgress = 0.8f;

    r->GetTextures(&m_TextureList);
    for(FetchTexture &t : m_TextureList)
      m_Textures[t.ID] = &t;

    m_PostloadProgress = 0.9f;

    r->GetD3D11PipelineState(&CurD3D11PipelineState);
    r->GetD3D12PipelineState(&CurD3D12PipelineState);
    r->GetGLPipelineState(&CurGLPipelineState);
    r->GetVulkanPipelineState(&CurVulkanPipelineState);
    CurPipelineState.SetStates(m_APIProps, &CurD3D11PipelineState, &CurD3D12PipelineState,
                               &CurGLPipelineState, &CurVulkanPipelineState);

    UnreadMessageCount = 0;
    AddMessages(m_FrameInfo.debugMessages);

    m_PostloadProgress = 1.0f;
  });

  QThread::msleep(20);

  QDateTime today = QDateTime::currentDateTimeUtc();
  QDateTime compare = today.addDays(-21);

  if(compare > Config.DegradedLog_LastUpdate && m_APIProps.degraded)
  {
    Config.DegradedLog_LastUpdate = today;

    RDDialog::critical(
        NULL, "Degraded support of log",
        QString(
            "%1\nThis log opened with degraded support - "
            "this could mean missing hardware support caused a fallback to software rendering.\n\n"
            "This warning will not appear every time this happens, "
            "check debug errors/warnings window for more details.")
            .arg(origFilename));
  }

  m_LoadInProgress = false;
  m_LogLoaded = true;
}

bool CaptureContext::PassEquivalent(const FetchDrawcall &a, const FetchDrawcall &b)
{
  // executing command lists can have children
  if(!a.children.empty() || !b.children.empty())
    return false;

  // don't group draws and compute executes
  if((a.flags & eDraw_Dispatch) != (b.flags & eDraw_Dispatch))
    return false;

  // don't group present with anything
  if((a.flags & eDraw_Present) != (b.flags & eDraw_Present))
    return false;

  // don't group things with different depth outputs
  if(a.depthOut != b.depthOut)
    return false;

  int numAOuts = 0, numBOuts = 0;
  for(int i = 0; i < 8; i++)
  {
    if(a.outputs[i] != ResourceId())
      numAOuts++;
    if(b.outputs[i] != ResourceId())
      numBOuts++;
  }

  int numSame = 0;

  if(a.depthOut != ResourceId())
  {
    numAOuts++;
    numBOuts++;
    numSame++;
  }

  for(int i = 0; i < 8; i++)
  {
    if(a.outputs[i] != ResourceId())
    {
      for(int j = 0; j < 8; j++)
      {
        if(a.outputs[i] == b.outputs[j])
        {
          numSame++;
          break;
        }
      }
    }
    else if(b.outputs[i] != ResourceId())
    {
      for(int j = 0; j < 8; j++)
      {
        if(a.outputs[j] == b.outputs[i])
        {
          numSame++;
          break;
        }
      }
    }
  }

  // use a kind of heuristic to group together passes where the outputs are similar enough.
  // could be useful for example if you're rendering to a gbuffer and sometimes you render
  // without one target, but the draws are still batched up.
  if(numSame > qMax(numAOuts, numBOuts) / 2 && qMax(numAOuts, numBOuts) > 1)
    return true;

  if(numSame == qMax(numAOuts, numBOuts))
    return true;

  return false;
}

bool CaptureContext::ContainsMarker(const rdctype::array<FetchDrawcall> &draws)
{
  bool ret = false;

  for(const FetchDrawcall &d : draws)
  {
    ret |= (d.flags & eDraw_PushMarker) && !(d.flags & eDraw_CmdList) && !d.children.empty();
    ret |= ContainsMarker(d.children);

    if(ret)
      break;
  }

  return ret;
}

void CaptureContext::AddFakeProfileMarkers()
{
  rdctype::array<FetchDrawcall> &draws = m_Drawcalls;

  if(ContainsMarker(draws))
    return;

  QList<FetchDrawcall> ret;

  int depthpassID = 1;
  int copypassID = 1;
  int computepassID = 1;
  int passID = 1;

  int start = 0;
  int refdraw = 0;

  uint32_t drawFlags = eDraw_Copy | eDraw_Resolve | eDraw_SetMarker | eDraw_CmdList;

  for(int i = 1; i < draws.count; i++)
  {
    if(draws[refdraw].flags & drawFlags)
    {
      refdraw = i;
      continue;
    }

    if(draws[i].flags & drawFlags)
      continue;

    if(PassEquivalent(draws[i], draws[refdraw]))
      continue;

    int end = i - 1;

    if(end - start < 2 || !draws[i].children.empty() || !draws[refdraw].children.empty())
    {
      for(int j = start; j <= end; j++)
        ret.push_back(draws[j]);

      start = i;
      refdraw = i;
      continue;
    }

    int minOutCount = 100;
    int maxOutCount = 0;
    bool copyOnly = true;

    for(int j = start; j <= end; j++)
    {
      int outCount = 0;

      if(!(draws[j].flags & (eDraw_Copy | eDraw_Resolve | eDraw_Clear)))
        copyOnly = false;

      for(ResourceId o : draws[j].outputs)
        if(o != ResourceId())
          outCount++;
      minOutCount = qMin(minOutCount, outCount);
      maxOutCount = qMax(maxOutCount, outCount);
    }

    FetchDrawcall mark;

    mark.eventID = draws[start].eventID;
    mark.drawcallID = draws[start].drawcallID;

    mark.flags = eDraw_PushMarker;
    memcpy(mark.outputs, draws[end].outputs, sizeof(mark.outputs));
    mark.depthOut = draws[end].depthOut;

    mark.name = "Guessed Pass";

    minOutCount = qMax(1, minOutCount);

    if(copyOnly)
      mark.name = QApplication::translate("CaptureContext", "Copy/Clear Pass #%1")
                      .arg(copypassID++)
                      .toUtf8()
                      .data();
    else if(draws[refdraw].flags & eDraw_Dispatch)
      mark.name = QApplication::translate("CaptureContext", "Compute Pass #%1")
                      .arg(computepassID++)
                      .toUtf8()
                      .data();
    else if(maxOutCount == 0)
      mark.name = QApplication::translate("CaptureContext", "Depth-only Pass #%1")
                      .arg(depthpassID++)
                      .toUtf8()
                      .data();
    else if(minOutCount == maxOutCount)
      mark.name = QApplication::translate("CaptureContext", "Colour Pass #%1 (%2 Targets%3)")
                      .arg(passID++)
                      .arg(minOutCount)
                      .arg(draws[end].depthOut == ResourceId() ? "" : " + Depth")
                      .toUtf8()
                      .data();
    else
      mark.name = QApplication::translate("CaptureContext", "Colour Pass #%1 (%2-%3 Targets%4)")
                      .arg(passID++)
                      .arg(minOutCount)
                      .arg(maxOutCount)
                      .arg(draws[end].depthOut == ResourceId() ? "" : " + Depth")
                      .toUtf8()
                      .data();

    mark.children.create(end - start + 1);

    for(int j = start; j <= end; j++)
    {
      mark.children[j - start] = draws[j];
      draws[j].parent = mark.eventID;
    }

    ret.push_back(mark);

    start = i;
    refdraw = i;
  }

  if(start < draws.count)
  {
    for(int j = start; j < draws.count; j++)
      ret.push_back(draws[j]);
  }

  m_Drawcalls.clear();
  m_Drawcalls.create(ret.count());
  for(int i = 0; i < ret.count(); i++)
    m_Drawcalls[i] = ret[i];
}

void CaptureContext::CloseLogfile()
{
  if(!m_LogLoaded)
    return;

  m_LogFile = "";

  m_Renderer.CloseThread();

  memset(&m_APIProps, 0, sizeof(m_APIProps));
  memset(&m_FrameInfo, 0, sizeof(m_FrameInfo));
  m_Buffers.clear();
  m_BufferList.clear();
  m_Textures.clear();
  m_TextureList.clear();

  CurD3D11PipelineState = D3D11PipelineState();
  CurD3D12PipelineState = D3D12PipelineState();
  CurGLPipelineState = GLPipelineState();
  CurVulkanPipelineState = VulkanPipelineState();
  CurPipelineState.SetStates(m_APIProps, NULL, NULL, NULL, NULL);

  DebugMessages.clear();
  UnreadMessageCount = 0;

  m_LogLoaded = false;

  QVector<ILogViewerForm *> logviewers(m_LogViewers);

  for(ILogViewerForm *logviewer : logviewers)
  {
    if(logviewer)
      logviewer->OnLogfileClosed();
  }
}

void CaptureContext::SetEventID(const QVector<ILogViewerForm *> &exclude, uint32_t selectedEventID,
                                uint32_t eventID, bool force)
{
  uint32_t prevSelectedEventID = m_SelectedEventID;
  m_SelectedEventID = selectedEventID;
  uint32_t prevEventID = m_EventID;
  m_EventID = eventID;

  m_Renderer.BlockInvoke([this, eventID, force](IReplayRenderer *r) {
    r->SetFrameEvent(eventID, force);
    r->GetD3D11PipelineState(&CurD3D11PipelineState);
    r->GetD3D12PipelineState(&CurD3D12PipelineState);
    r->GetGLPipelineState(&CurGLPipelineState);
    r->GetVulkanPipelineState(&CurVulkanPipelineState);
    CurPipelineState.SetStates(m_APIProps, &CurD3D11PipelineState, &CurD3D12PipelineState,
                               &CurGLPipelineState, &CurVulkanPipelineState);
  });

  for(ILogViewerForm *logviewer : m_LogViewers)
  {
    if(exclude.contains(logviewer))
      continue;

    if(force || prevSelectedEventID != selectedEventID)
      logviewer->OnSelectedEventChanged(selectedEventID);
    if(force || prevEventID != eventID)
      logviewer->OnEventChanged(eventID);
  }
}

void *CaptureContext::FillWindowingData(WId widget)
{
#if defined(WIN32)

  return (void *)widget;

#elif defined(RENDERDOC_PLATFORM_LINUX)

  static XCBWindowData xcb;
  static XlibWindowData xlib;

  if(m_CurWinSystem == eWindowingSystem_XCB)
  {
    xcb.connection = m_XCBConnection;
    xcb.window = (xcb_window_t)widget;
    return &xcb;
  }
  else
  {
    xlib.display = m_X11Display;
    xlib.window = (Drawable)widget;
    return &xlib;
  }

#elif defined(RENDERDOC_PLATFORM_APPLE)

  return (void *)widget;

#else

#error "Unknown platform"

#endif
}

EventBrowser *CaptureContext::eventBrowser()
{
  if(m_EventBrowser)
    return m_EventBrowser;

  m_EventBrowser = new EventBrowser(*this, m_MainWindow);
  m_EventBrowser->setObjectName("eventBrowser");
  setupDockWindow(m_EventBrowser);

  return m_EventBrowser;
}

APIInspector *CaptureContext::apiInspector()
{
  if(m_APIInspector)
    return m_APIInspector;

  m_APIInspector = new APIInspector(*this, m_MainWindow);
  m_APIInspector->setObjectName("apiInspector");
  setupDockWindow(m_APIInspector);

  return m_APIInspector;
}

TextureViewer *CaptureContext::textureViewer()
{
  if(m_TextureViewer)
    return m_TextureViewer;

  m_TextureViewer = new TextureViewer(*this, m_MainWindow);
  m_TextureViewer->setObjectName("textureViewer");
  setupDockWindow(m_TextureViewer);

  return m_TextureViewer;
}

BufferViewer *CaptureContext::meshPreview()
{
  if(m_MeshPreview)
    return m_MeshPreview;

  m_MeshPreview = new BufferViewer(*this, true, m_MainWindow);
  m_MeshPreview->setObjectName("meshPreview");
  setupDockWindow(m_MeshPreview);

  return m_MeshPreview;
}

PipelineStateViewer *CaptureContext::pipelineViewer()
{
  if(m_PipelineViewer)
    return m_PipelineViewer;

  m_PipelineViewer = new PipelineStateViewer(*this, m_MainWindow);
  m_PipelineViewer->setObjectName("pipelineViewer");
  setupDockWindow(m_PipelineViewer);

  return m_PipelineViewer;
}

CaptureDialog *CaptureContext::captureDialog()
{
  if(m_CaptureDialog)
    return m_CaptureDialog;

  m_CaptureDialog = new CaptureDialog(
      *this,
      [this](const QString &exe, const QString &workingDir, const QString &cmdLine,
             const QList<EnvironmentModification> &env, CaptureOptions opts) {
        return m_MainWindow->OnCaptureTrigger(exe, workingDir, cmdLine, env, opts);
      },
      [this](uint32_t PID, const QList<EnvironmentModification> &env, const QString &name,
             CaptureOptions opts) { return m_MainWindow->OnInjectTrigger(PID, env, name, opts); },
      m_MainWindow);
  m_CaptureDialog->setObjectName("capDialog");
  m_CaptureDialog->setWindowIcon(*m_Icon);

  return m_CaptureDialog;
}

DebugMessageView *CaptureContext::debugMessageView()
{
  if(m_DebugMessageView)
    return m_DebugMessageView;

  m_DebugMessageView = new DebugMessageView(*this, m_MainWindow);
  m_DebugMessageView->setObjectName("debugMessageView");
  setupDockWindow(m_DebugMessageView);

  return m_DebugMessageView;
}

StatisticsViewer *CaptureContext::statisticsViewer()
{
  if(m_StatisticsViewer)
    return m_StatisticsViewer;

  m_StatisticsViewer = new StatisticsViewer(*this, m_MainWindow);
  m_StatisticsViewer->setObjectName("statisticsViewer");
  setupDockWindow(m_StatisticsViewer);

  return m_StatisticsViewer;
}

void CaptureContext::showEventBrowser()
{
  m_MainWindow->showEventBrowser();
}

void CaptureContext::showAPIInspector()
{
  m_MainWindow->showAPIInspector();
}

void CaptureContext::showTextureViewer()
{
  m_MainWindow->showTextureViewer();
}

void CaptureContext::showMeshPreview()
{
  m_MainWindow->showMeshPreview();
}

void CaptureContext::showPipelineViewer()
{
  m_MainWindow->showPipelineViewer();
}

void CaptureContext::showCaptureDialog()
{
  m_MainWindow->showCaptureDialog();
}

void CaptureContext::showDebugMessageView()
{
  m_MainWindow->showDebugMessageView();
}

void CaptureContext::showStatisticsViewer()
{
  m_MainWindow->showStatisticsViewer();
}

QWidget *CaptureContext::createToolWindow(const QString &objectName)
{
  if(objectName == "textureViewer")
  {
    return textureViewer();
  }
  else if(objectName == "eventBrowser")
  {
    return eventBrowser();
  }
  else if(objectName == "pipelineViewer")
  {
    return pipelineViewer();
  }
  else if(objectName == "meshPreview")
  {
    return meshPreview();
  }
  else if(objectName == "apiInspector")
  {
    return apiInspector();
  }
  else if(objectName == "capDialog")
  {
    return captureDialog();
  }
  else if(objectName == "debugMessageView")
  {
    return debugMessageView();
  }
  else if(objectName == "statisticsViewer")
  {
    return statisticsViewer();
  }

  return NULL;
}

void CaptureContext::windowClosed(QWidget *window)
{
  if((QWidget *)m_EventBrowser == window)
    m_EventBrowser = NULL;
  else if((QWidget *)m_TextureViewer == window)
    m_TextureViewer = NULL;
  else if((QWidget *)m_CaptureDialog == window)
    m_CaptureDialog = NULL;
  else if((QWidget *)m_APIInspector == window)
    m_APIInspector = NULL;
  else if((QWidget *)m_PipelineViewer == window)
    m_PipelineViewer = NULL;
  else if((QWidget *)m_MeshPreview == window)
    m_MeshPreview = NULL;
  else if((QWidget *)m_DebugMessageView == window)
    m_DebugMessageView = NULL;
  else if((QWidget *)m_StatisticsViewer == window)
    m_StatisticsViewer = NULL;
  else
    qCritical() << "Unrecognised window being closed: " << window;
}

void CaptureContext::setupDockWindow(QWidget *shad)
{
  shad->setWindowIcon(*m_Icon);
}