io/serialization/Serialization.h

Go to the documentation of this file.

/*
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */
 
#ifndef META_OCEAN_IO_SERIALIZATION_SERIALIZATION_H
#define META_OCEAN_IO_SERIALIZATION_SERIALIZATION_H
 
#include "ocean/io/IO.h"
 
namespace Ocean
{
 
namespace IO
{
 
namespace Serialization
{
 
/**
 * @ingroup io
 * @defgroup ioserialization Ocean IO Serialization Library
 * @{
 * The Ocean IO Serialization Library provides functionalities for data serialization and deserialization.
 * The library supports streaming binary data with timestamps and channels for recording and playback.
 *
 * The library is organized around the following core components:<br>
 * - DataSerializer: The abstract base class for all serializers, defining the channel and sample management interface.<br>
 * - OutputDataSerializer: Serializes data samples to a stream (e.g., file or network) for recording purposes.<br>
 * - InputDataSerializer: Deserializes data samples from a stream for playback with configurable speed control.<br>
 * - DataSample: The abstract base class for all data samples, containing timestamps for both recording and playback.<br>
 * - DataTimestamp: A flexible timestamp class supporting both double and int64_t representations.<br>
 * - MediaSerializer: Provides specialized data samples for media content, e.g., DataSampleFrame for Ocean::Frame objects with optional camera models.<br>
 * - VectorOutputStream: A memory-based output stream implementation for in-memory buffering.
 *
 * Typical usage involves creating an output serializer to record data samples into channels, or creating an input serializer to play back previously recorded data with timing control.
 * @}
 */
 
/**
 * @namespace Ocean::IO::Serialization
 * @brief Namespace of the Ocean IO Serialization library.
 *
 * The Namespace Ocean::IO::Serialization is used in the entire Ocean IO Serialization library.
 */
 
// Defines OCEAN_IO_SERIALIZATION_EXPORT for dll export and import.
#if defined(_WINDOWS) && defined(OCEAN_RUNTIME_SHARED)
    #ifdef USE_OCEAN_IO_SERIALIZATION_EXPORT
        #define OCEAN_IO_SERIALIZATION_EXPORT __declspec(dllexport)
    #else
        #define OCEAN_IO_SERIALIZATION_EXPORT __declspec(dllimport)
    #endif
#else
    #define OCEAN_IO_SERIALIZATION_EXPORT
#endif
 
}
 
}
 
}
 
#endif // META_OCEAN_IO_SERIALIZATION_SERIALIZATION_H