Work on creating a new data source structure

Author: ChristianFeldmann

YUViewLib/YUViewLib.pro

@@ -12,6 +12,7 @@ HEADERS += $$files(src/*.h, true)
 FORMS += $$files(ui/*.ui, false)
 
 INCLUDEPATH += src/
+INCLUDEPATH += $$top_srcdir/submodules
 
 RESOURCES += \
     images/images.qrc \

YUViewLib/src/common/FileInfo.h renamed to YUViewLib/src/common/InfoItemAndData.h

@@ -37,26 +37,14 @@
 #include <QString>
 
 /*
- * An info item has a name, a text and an optional toolTip. These are used to show them in the
- * fileInfoWidget. For example: ["File Name", "file.yuv"] or ["Number Frames", "123"] Another option
- * is to show a button. If the user clicks on it, the callback function infoListButtonPressed() for
- * the corresponding playlist item is called.
+ * An info item has a name, a text and an optional description. These are used to show them in the
+ * fileInfoWidget. For example: ["File Name", "file.yuv"] or ["Number Frames", "123"].
  */
 struct InfoItem
 {
-  InfoItem(const QString &name,
-           const QString &text,
-           const QString &toolTip  = QString(),
-           bool           button   = false,
-           int            buttonID = -1)
-      : name(name), text(text), button(button), buttonID(buttonID), toolTip(toolTip)
-  {
-  }
-  QString name{};
-  QString text{};
-  bool    button{};
-  int     buttonID{};
-  QString toolTip{};
+  std::string name{};
+  std::string text{};
+  std::string description{};
 };
 
 struct InfoData

YUViewLib/src/filesource/DataSourceLocalFile.cpp

@@ -0,0 +1,102 @@
+/*  This file is part of YUView - The YUV player with advanced analytics toolset
+ *   <https://github.com/IENT/YUView>
+ *   Copyright (C) 2015  Institut für Nachrichtentechnik, RWTH Aachen University, GERMANY
+ *
+ *   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 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   In addition, as a special exception, the copyright holders give
+ *   permission to link the code of portions of this program with the
+ *   OpenSSL library under certain conditions as described in each
+ *   individual source file, and distribute linked combinations including
+ *   the two.
+ *
+ *   You must obey the GNU General Public License in all respects for all
+ *   of the code used other than OpenSSL. If you modify file(s) with this
+ *   exception, you may extend this exception to your version of the
+ *   file(s), but you are not obligated to do so. If you do not wish to do
+ *   so, delete this exception statement from your version. If you delete
+ *   this exception statement from all source files in the program, then
+ *   also delete it here.
+ *
+ *   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, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "DataSourceLocalFile.h"
+
+DataSourceLocalFile::DataSourceLocalFile(const std::filesystem::path &filePath)
+{
+  this->file.open(filePath.string(), std::ios_base::in | std::ios_base::binary);
+}
+
+std::vector<InfoItem> DataSourceLocalFile::getInfoList() const
+{
+  if (!this->isReady())
+    return {};
+
+  std::vector<InfoItem> infoList;
+  infoList.push_back(
+      InfoItem({"File path", this->filePath.string(), "The absolute path of the local file"}));
+  if (const auto size = this->fileSize())
+    infoList.push_back(InfoItem({"File Size", std::to_string(*size)}));
+
+  return infoList;
+}
+
+bool DataSourceLocalFile::atEnd() const
+{
+  return this->file.eof();
+}
+
+bool DataSourceLocalFile::isReady() const
+{
+  return !this->file.fail();
+}
+
+std::int64_t DataSourceLocalFile::position() const
+{
+  return this->filePosition;
+}
+
+std::optional<std::int64_t> DataSourceLocalFile::fileSize() const
+{
+  if (!this->isFileOpened)
+    return {};
+
+  const auto size = std::filesystem::file_size(this->filePath);
+  return static_cast<std::int64_t>(size);
+}
+
+bool DataSourceLocalFile::seek(const std::int64_t pos)
+{
+  if (!this->isReady())
+    return false;
+
+  this->file.seekg(static_cast<std::streampos>(pos));
+  return this->isReady();
+}
+
+std::int64_t DataSourceLocalFile::read(ByteVector &buffer, const std::int64_t nrBytes)
+{
+  if (!this->isReady())
+    return 0;
+
+  const auto usize = static_cast<size_t>(nrBytes);
+  if (buffer.size() < nrBytes)
+    buffer.resize(usize);
+
+  this->file.read(reinterpret_cast<char *>(buffer.data()), usize);
+
+  const auto bytesRead = this->file.gcount();
+
+  this->filePosition += bytesRead;
+  return static_cast<std::int64_t>(bytesRead);
+}

YUViewLib/src/filesource/DataSourceLocalFile.h

@@ -0,0 +1,60 @@
+/*  This file is part of YUView - The YUV player with advanced analytics toolset
+ *   <https://github.com/IENT/YUView>
+ *   Copyright (C) 2015  Institut für Nachrichtentechnik, RWTH Aachen University, GERMANY
+ *
+ *   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 3 of the License, or
+ *   (at your option) any later version.
+ *
+ *   In addition, as a special exception, the copyright holders give
+ *   permission to link the code of portions of this program with the
+ *   OpenSSL library under certain conditions as described in each
+ *   individual source file, and distribute linked combinations including
+ *   the two.
+ *
+ *   You must obey the GNU General Public License in all respects for all
+ *   of the code used other than OpenSSL. If you modify file(s) with this
+ *   exception, you may extend this exception to your version of the
+ *   file(s), but you are not obligated to do so. If you do not wish to do
+ *   so, delete this exception statement from your version. If you delete
+ *   this exception statement from all source files in the program, then
+ *   also delete it here.
+ *
+ *   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, see <http://www.gnu.org/licenses/>.
+ */
+
+#pragma once
+
+#include "IDataSource.h"
+
+#include <filesystem>
+#include <fstream>
+
+class DataSourceLocalFile : public IDataSource
+{
+public:
+  DataSourceLocalFile(const std::filesystem::path &filePath);
+
+  virtual [[nodiscard]] std::vector<InfoItem>       getInfoList() const override;
+  virtual [[nodiscard]] bool                        atEnd() const override;
+  virtual [[nodiscard]] bool                        isReady() const override;
+  virtual [[nodiscard]] std::int64_t                position() const override;
+  virtual [[nodiscard]] std::optional<std::int64_t> fileSize() const;
+
+  virtual [[nodiscard]] bool         seek(const std::int64_t pos) override;
+  virtual [[nodiscard]] std::int64_t read(ByteVector &buffer, const std::int64_t nrBytes) override;
+
+protected:
+  std::filesystem::path filePath{};
+  bool                  isFileOpened{};
+
+  std::ifstream file{};
+  std::int64_t  filePosition{};
+};