199 lines
8.0 KiB
C++
199 lines
8.0 KiB
C++
// Copyright 2014 Google LLC. All rights reserved.
|
|
//
|
|
// Use of this source code is governed by a BSD-style
|
|
// license that can be found in the LICENSE file or at
|
|
// https://developers.google.com/open-source/licenses/bsd
|
|
|
|
#ifndef PACKAGER_FILE_FILE_H_
|
|
#define PACKAGER_FILE_FILE_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <string>
|
|
|
|
#include "packager/file/public/buffer_callback_params.h"
|
|
#include "packager/macros.h"
|
|
#include "packager/status/status.h"
|
|
|
|
namespace shaka {
|
|
|
|
extern const char* kCallbackFilePrefix;
|
|
extern const char* kLocalFilePrefix;
|
|
extern const char* kMemoryFilePrefix;
|
|
extern const char* kUdpFilePrefix;
|
|
extern const char* kHttpFilePrefix;
|
|
const int64_t kWholeFile = -1;
|
|
|
|
/// Define an abstract file interface.
|
|
class SHAKA_EXPORT File {
|
|
public:
|
|
/// Open the specified file.
|
|
/// This is a file factory method, it opens a proper file automatically
|
|
/// based on prefix, e.g. "file://" for LocalFile.
|
|
/// @param file_name contains the name of the file to be accessed.
|
|
/// @param mode contains file access mode. Implementation dependent.
|
|
/// @return A File pointer on success, false otherwise.
|
|
static File* Open(const char* file_name, const char* mode);
|
|
|
|
/// Open the specified file in direct-access mode (no buffering).
|
|
/// This is a file factory method, it opens a proper file automatically
|
|
/// based on prefix, e.g. "file://" for LocalFile.
|
|
/// @param file_name contains the name of the file to be accessed.
|
|
/// @param mode contains file access mode. Implementation dependent.
|
|
/// @return A File pointer on success, false otherwise.
|
|
static File* OpenWithNoBuffering(const char* file_name, const char* mode);
|
|
|
|
/// Delete the specified file.
|
|
/// @param file_name contains the path of the file to be deleted.
|
|
/// @return true if successful, false otherwise.
|
|
static bool Delete(const char* file_name);
|
|
|
|
/// Flush() and de-allocate resources associated with this file, and
|
|
/// delete this File object. THIS IS THE ONE TRUE WAY TO DEALLOCATE
|
|
/// THIS OBJECT.
|
|
/// @return true on success. For writable files, returning false MAY
|
|
/// INDICATE DATA LOSS.
|
|
virtual bool Close() = 0;
|
|
|
|
/// Read data and return it in buffer.
|
|
/// @param[out] buffer points to a block of memory with a size of at least
|
|
/// @a length bytes.
|
|
/// @param length indicates number of bytes to be read.
|
|
/// @return Number of bytes read, or a value < 0 on error.
|
|
/// Zero on end-of-file, or if 'length' is zero.
|
|
virtual int64_t Read(void* buffer, uint64_t length) = 0;
|
|
|
|
/// Write block of data.
|
|
/// @param buffer points to a block of memory with at least @a length bytes.
|
|
/// @param length indicates number of bytes to write.
|
|
/// @return Number of bytes written, or a value < 0 on error.
|
|
virtual int64_t Write(const void* buffer, uint64_t length) = 0;
|
|
|
|
/// @return Size of the file in bytes. A return value less than zero
|
|
/// indicates a problem getting the size.
|
|
virtual int64_t Size() = 0;
|
|
|
|
/// Flush the file so that recently written data will survive an
|
|
/// application crash (but not necessarily an OS crash). For
|
|
/// instance, in LocalFile the data is flushed into the OS but not
|
|
/// necessarily to disk.
|
|
/// @return true on success, false otherwise.
|
|
virtual bool Flush() = 0;
|
|
|
|
/// Seek to the specifield position in the file.
|
|
/// @param position is the position to seek to.
|
|
/// @return true on success, false otherwise.
|
|
virtual bool Seek(uint64_t position) = 0;
|
|
|
|
/// Get the current file position.
|
|
/// @param position is a pointer to contain the current file position upon
|
|
/// successful return.
|
|
/// @return true on succcess, false otherwise.
|
|
virtual bool Tell(uint64_t* position) = 0;
|
|
|
|
/// @return The file name. Note that the file type prefix has been stripped
|
|
/// off.
|
|
const std::string& file_name() const { return file_name_; }
|
|
|
|
// ************************************************************
|
|
// * Static Methods: File-on-the-filesystem status
|
|
// ************************************************************
|
|
|
|
/// @return The size of a file in bytes on success, a value < 0 otherwise.
|
|
/// The file will be opened and closed in the process.
|
|
static int64_t GetFileSize(const char* file_name);
|
|
|
|
/// Read the contents of a file into string.
|
|
/// @param file_name is the file to be read. It should be a valid file.
|
|
/// @param contents[out] points to the output string. Should not be NULL.
|
|
/// @return true on success, false otherwise.
|
|
static bool ReadFileToString(const char* file_name, std::string* contents);
|
|
|
|
/// Writes the data to file.
|
|
/// @param file_name is the file to write to.
|
|
/// @param contents is the data to write.
|
|
/// @return true on success, false otherwise.
|
|
static bool WriteStringToFile(const char* file_name,
|
|
const std::string& contents);
|
|
|
|
/// Save `contents` to `file_name` in an atomic manner.
|
|
/// @param file_name is the destination file name.
|
|
/// @param contents is the data to be saved.
|
|
/// @return true on success, false otherwise.
|
|
static bool WriteFileAtomically(const char* file_name,
|
|
const std::string& contents);
|
|
|
|
/// Copies files. This is not good for copying huge files. Although not
|
|
/// recommended, it is safe to have source file and destination file name be
|
|
/// the same.
|
|
/// @param from_file_name is the source file name.
|
|
/// @param to_file_name is the destination file name.
|
|
/// @return true on success, false otherwise.
|
|
static bool Copy(const char* from_file_name, const char* to_file_name);
|
|
|
|
/// Copies the contents from source to destination.
|
|
/// @param source The file to copy from.
|
|
/// @param destination The file to copy to.
|
|
/// @return Number of bytes written, or a value < 0 on error.
|
|
static int64_t Copy(File* source, File* destination);
|
|
|
|
/// Copies the contents from source to destination.
|
|
/// @param source The file to copy from.
|
|
/// @param destination The file to copy to.
|
|
/// @param max_copy The maximum number of bytes to copy; < 0 to copy to EOF.
|
|
/// @return Number of bytes written, or a value < 0 on error.
|
|
static int64_t Copy(File* source, File* destination, int64_t max_copy);
|
|
|
|
/// @param file_name is the name of the file to be checked.
|
|
/// @return true if `file_name` is a local and regular file.
|
|
static bool IsLocalRegularFile(const char* file_name);
|
|
|
|
/// Generate callback file name.
|
|
/// NOTE: THE GENERATED NAME IS ONLY VAID WHILE @a callback_params IS VALID.
|
|
/// @param callback_params references BufferCallbackParams, which will be
|
|
/// embedded in the generated callback file name.
|
|
/// @param name is the name of the buffer, which will be embedded in the
|
|
/// generated callback file name.
|
|
static std::string MakeCallbackFileName(
|
|
const BufferCallbackParams& callback_params,
|
|
const std::string& name);
|
|
|
|
/// Parse and extract callback params.
|
|
/// @param callback_file_name is the name of the callback file which contains
|
|
/// @a callback_params and @a name.
|
|
/// @param callback_params points to the parsed BufferCallbackParams pointer.
|
|
/// @param name points to the parsed name.
|
|
/// @return true on success, false otherwise.
|
|
static bool ParseCallbackFileName(
|
|
const std::string& callback_file_name,
|
|
const BufferCallbackParams** callback_params,
|
|
std::string* name);
|
|
|
|
protected:
|
|
explicit File(const std::string& file_name) : file_name_(file_name) {}
|
|
/// Do *not* call the destructor directly (with the "delete" keyword)
|
|
/// nor use std::unique_ptr; instead use Close().
|
|
virtual ~File() {}
|
|
|
|
/// Internal open. Should not be used directly.
|
|
virtual bool Open() = 0;
|
|
|
|
private:
|
|
friend class ThreadedIoFile;
|
|
|
|
// This is a file factory method, it creates a proper file, e.g.
|
|
// LocalFile, MemFile based on prefix.
|
|
static File* Create(const char* file_name, const char* mode);
|
|
|
|
static File* CreateInternalFile(const char* file_name, const char* mode);
|
|
|
|
// Note that the file type prefix has been stripped off.
|
|
std::string file_name_;
|
|
|
|
DISALLOW_COPY_AND_ASSIGN(File);
|
|
};
|
|
|
|
} // namespace shaka
|
|
|
|
#endif // PACKAGER_FILE_FILE_H_
|