/*
 * Copyright © 2018-2026, VideoLAN and dav2d authors
 * Copyright © 2018-2026, Two Orioles, LLC
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 *    list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef DAV2D_COMMON_H
#define DAV2D_COMMON_H

#include <errno.h>
#include <stddef.h>
#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

#ifndef DAV2D_API
    #if defined _WIN32
      #if defined DAV2D_BUILDING_DLL
        #define DAV2D_API __declspec(dllexport)
      #else
        #define DAV2D_API
      #endif
    #elif defined __OS2__
        #define DAV2D_API __declspec(dllexport)
    #else
      #if __GNUC__ >= 4
        #define DAV2D_API __attribute__ ((visibility ("default")))
      #else
        #define DAV2D_API
      #endif
    #endif
#endif

#if EPERM > 0
#define DAV2D_ERR(e) (-(e)) ///< Negate POSIX error code.
#else
#define DAV2D_ERR(e) (e)
#endif

#define DAV2D_EOF -('E' | ('O' << 8) | ('F' << 16))

/**
 * A reference-counted object wrapper for a user-configurable pointer.
 */
typedef struct Dav2dUserData {
    const uint8_t *data; ///< data pointer
    struct Dav2dRef *ref; ///< allocation origin
} Dav2dUserData;

/**
 * Input packet metadata which are copied from the input data used to
 * decode each image into the matching structure of the output image
 * returned back to the user. Since these are metadata fields, they
 * can be used for other purposes than the documented ones, they will
 * still be passed from input data to output picture without being
 * used internally.
 */
typedef struct Dav2dDataProps {
    int64_t timestamp; ///< container timestamp of input data, INT64_MIN if unknown (default)
    int64_t duration; ///< container duration of input data, 0 if unknown (default)
    int64_t offset; ///< stream offset of input data, -1 if unknown (default)
    size_t size; ///< packet size, default Dav2dData.sz
    struct Dav2dUserData user_data; ///< user-configurable data, default NULL members
} Dav2dDataProps;

/**
 * Release reference to a Dav2dDataProps.
 */
DAV2D_API void dav2d_data_props_unref(Dav2dDataProps *props);

#ifdef __cplusplus
} /* extern "C" */
#endif

#endif /* DAV2D_COMMON_H */
