xbmc/guilib/XBTFReader.cpp

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #include <inttypes.h>
  10 #include <stdio.h>
  11 #include <string.h>
  12 #include <sys/stat.h>
  13
  14 #include "XBTFReader.h"
  15 #include "guilib/XBTF.h"
  16 #include "utils/EndianSwap.h"
  17
  18 #ifdef TARGET_WINDOWS
  19 #include "filesystem/SpecialProtocol.h"
  20 #include "utils/CharsetConverter.h"
  21 #include "platform/win32/PlatformDefs.h"
  22 #endif
  23
  24 static bool ReadString(FILE* file, char* str, size_t max_length)
  25 {
  26   if (file == nullptr || str == nullptr || max_length <= 0)
  27     return false;
  28
  29   return (fread(str, max_length, 1, file) == 1);
  30 }
  31
  32 static bool ReadChar(FILE* file, char& value)
  33 {
  34   if (file == nullptr)
  35     return false;
  36
  37   if (fread(&value, sizeof(char), 1, file) != 1)
  38     return false;
  39
  40   return true;
  41 }
  42
  43 static bool ReadUInt32(FILE* file, uint32_t& value)
  44 {
  45   if (file == nullptr)
  46     return false;
  47
  48   if (fread(&value, sizeof(uint32_t), 1, file) != 1)
  49     return false;
  50
  51   value = Endian_SwapLE32(value);
  52   return true;
  53 }
  54
  55 static bool ReadUInt64(FILE* file, uint64_t& value)
  56 {
  57   if (file == nullptr)
  58     return false;
  59
  60   if (fread(&value, sizeof(uint64_t), 1, file) != 1)
  61     return false;
  62
  63   value = Endian_SwapLE64(value);
  64   return true;
  65 }
  66
  67 CXBTFReader::CXBTFReader()
  68   : CXBTFBase(),
  69     m_path()
  70 { }
  71
  72 CXBTFReader::~CXBTFReader()
  73 {
  74   Close();
  75 }
  76
  77 bool CXBTFReader::Open(const std::string& path)
  78 {
  79   if (path.empty())
  80     return false;
  81
  82   m_path = path;
  83
  84 #ifdef TARGET_WINDOWS
  85   std::wstring strPathW;
  86   g_charsetConverter.utf8ToW(CSpecialProtocol::TranslatePath(m_path), strPathW, false);
  87   m_file = _wfopen(strPathW.c_str(), L"rb");
  88 #else
  89   m_file = fopen(m_path.c_str(), "rb");
  90 #endif
  91   if (m_file == nullptr)
  92     return false;
  93
  94   // read the magic word
  95   char magic[4];
  96   if (!ReadString(m_file, magic, sizeof(magic)))
  97     return false;
  98
  99   if (strncmp(XBTF_MAGIC.c_str(), magic, sizeof(magic)) != 0)
 100     return false;
 101
 102   // read the version
 103   char version;
 104   if (!ReadChar(m_file, version))
 105     return false;
 106
 107   if (version < XBTF_VERSION_MIN)
 108     return false;
 109
 110   unsigned int nofFiles;
 111   if (!ReadUInt32(m_file, nofFiles))
 112     return false;
 113
 114   for (uint32_t i = 0; i < nofFiles; i++)
 115   {
 116     CXBTFFile xbtfFile;
 117     uint32_t u32;
 118     uint64_t u64;
 119
 120     // one extra char to null terminate the string
 121     char path[CXBTFFile::MaximumPathLength + 1] = {};
 122     if (!ReadString(m_file, path, sizeof(path) - 1))
 123       return false;
 124     xbtfFile.SetPath(path);
 125
 126     if (!ReadUInt32(m_file, u32))
 127       return false;
 128     xbtfFile.SetLoop(u32);
 129
 130     unsigned int nofFrames;
 131     if (!ReadUInt32(m_file, nofFrames))
 132       return false;
 133
 134     for (uint32_t j = 0; j < nofFrames; j++)
 135     {
 136       CXBTFFrame frame;
 137
 138       if (!ReadUInt32(m_file, u32))
 139         return false;
 140       frame.SetWidth(u32);
 141
 142       if (!ReadUInt32(m_file, u32))
 143         return false;
 144       frame.SetHeight(u32);
 145
 146       if (!ReadUInt32(m_file, u32))
 147         return false;
 148       frame.SetFormat(static_cast<XB_FMT>(u32));
 149
 150       if (!ReadUInt64(m_file, u64))
 151         return false;
 152       frame.SetPackedSize(u64);
 153
 154       if (!ReadUInt64(m_file, u64))
 155         return false;
 156       frame.SetUnpackedSize(u64);
 157
 158       if (!ReadUInt32(m_file, u32))
 159         return false;
 160       frame.SetDuration(u32);
 161
 162       if (!ReadUInt64(m_file, u64))
 163         return false;
 164       frame.SetOffset(u64);
 165
 166       xbtfFile.GetFrames().push_back(frame);
 167     }
 168
 169     AddFile(xbtfFile);
 170   }
 171
 172   // Sanity check
 173   uint64_t pos = static_cast<uint64_t>(ftell(m_file));
 174   if (pos != GetHeaderSize())
 175     return false;
 176
 177   return true;
 178 }
 179
 180 bool CXBTFReader::IsOpen() const
 181 {
 182   return m_file != nullptr;
 183 }
 184
 185 void CXBTFReader::Close()
 186 {
 187   if (m_file != nullptr)
 188   {
 189     fclose(m_file);
 190     m_file = nullptr;
 191   }
 192
 193   m_path.clear();
 194   m_files.clear();
 195 }
 196
 197 time_t CXBTFReader::GetLastModificationTimestamp() const
 198 {
 199   if (m_file == nullptr)
 200     return 0;
 201
 202   struct stat fileStat;
 203   if (fstat(fileno(m_file), &fileStat) == -1)
 204     return 0;
 205
 206   return fileStat.st_mtime;
 207 }
 208
 209 bool CXBTFReader::Load(const CXBTFFrame& frame, unsigned char* buffer) const
 210 {
 211   if (m_file == nullptr)
 212     return false;
 213
 214 #if defined(TARGET_DARWIN) || defined(TARGET_FREEBSD)
 215   if (fseeko(m_file, static_cast<off_t>(frame.GetOffset()), SEEK_SET) == -1)
 216 #elif defined(TARGET_ANDROID)
 217   if (fseek(m_file, static_cast<long>(frame.GetOffset()), SEEK_SET) == -1)  // No fseeko64 before N
 218 #else
 219   if (fseeko64(m_file, static_cast<off_t>(frame.GetOffset()), SEEK_SET) == -1)
 220 #endif
 221     return false;
 222
 223   if (fread(buffer, 1, static_cast<size_t>(frame.GetPackedSize()), m_file) != frame.GetPackedSize())
 224     return false;
 225
 226   return true;
 227 }