aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add function to retrieve deep copy of ImageInfo structure from AaruFormat image

Browse Source
This commit is contained in:
Natalia Portillo
2025-10-09 15:39:22 +01:00
parent e4c9b3f295
commit 791a7f8879
2 changed files with 103 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
include/aaruformat/decls.h
View File

@@ -161,24 +161,25 @@ AARU_EXPORT int32_t AARU_CALL aaruf_set_drive_model(void *context, const uint8_t
AARU_EXPORT int32_t AARU_CALL aaruf_set_drive_serial_number(void *context, const uint8_t *data, int32_t length);
AARU_EXPORT int32_t AARU_CALL aaruf_set_drive_firmware_revision(void *context, const uint8_t *data, int32_t length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_sequence(const void *context, int32_t *sequence, int32_t *last_sequence);
AARU_EXPORT int32_t AARU_CALL aaruf_get_creator(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_creator(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_comments(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_title(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_manufacturer(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_model(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_title(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_manufacturer(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_model(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_serial_number(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_barcode(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_part_number(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_drive_manufacturer(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_barcode(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_media_part_number(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_drive_manufacturer(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_drive_model(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_drive_serial_number(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_drive_firmware_revision(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_drive_serial_number(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_drive_firmware_revision(const void *context, uint8_t *buffer, int32_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_cicm_metadata(const void *context, uint8_t *buffer, size_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_aaru_json_metadata(const void *context, uint8_t *buffer, size_t *length);
AARU_EXPORT int32_t AARU_CALL aaruf_set_aaru_json_metadata(void *context, uint8_t *data, size_t length);
AARU_EXPORT int32_t AARU_CALL aaruf_get_user_sectors(const void *context, uint64_t *sectors);
AARU_EXPORT int32_t AARU_CALL aaruf_get_negative_sectors(const void *context, uint16_t *sectors);
AARU_EXPORT int32_t AARU_CALL aaruf_get_overflow_sectors(const void *context, uint16_t *sectors);
AARU_EXPORT int32_t AARU_CALL aaruf_get_image_info(const void *context, ImageInfo *image_info);
AARU_EXPORT int32_t AARU_CALL aaruf_get_tape_file(const void *context, uint8_t partition, uint32_t file,
uint64_t *starting_block, uint64_t *ending_block);

94
src/metadata.c
View File

@@ -3280,7 +3280,8 @@ int32_t aaruf_get_drive_firmware_revision(const void *context, uint8_t *buffer,
* - When reading/writing sectors with aaruf_read_sector() or aaruf_write_sector():
* - Set negative=false and use sector_address in range [0, user_sectors - 1]
* - For negative sectors: set negative=true, sector_address in [0, negative_sectors - 1]
* - For overflow sectors: set negative=false, sector_address in [user_sectors, user_sectors + overflow_sectors - 1]
* - For overflow sectors: set negative=false, sector_address in [user_sectors, user_sectors + overflow_sectors
* - 1]
*
* @note Relationship to Image Creation:
* - The user_sectors value is specified when calling aaruf_create()
@@ -3577,3 +3578,94 @@ int32_t aaruf_get_overflow_sectors(const void *context, uint16_t *sectors)
TRACE("Exiting aaruf_get_overflow_sectors(%p, %u) = AARUF_STATUS_OK", context, *sectors);
return AARUF_STATUS_OK;
}
/**
* @brief Retrieves a deep copy of the ImageInfo structure from the AaruFormat image.
*
* Returns a complete copy of the high-level image information summary containing
* metadata such as image size, sector count, sector size, version information,
* creation timestamps, and media type. This function performs a deep copy of all
* fields including string buffers, ensuring the caller receives a complete,
* independent copy of the image information.
*
* @param context Pointer to the aaruformat context (must be a valid, opened image context).
* @param image_info Pointer to an ImageInfo structure to receive the copied data.
* Must be a valid pointer to allocated memory.
*
* @return Returns one of the following status codes:
* @retval AARUF_STATUS_OK (0) Successfully copied image info. The image_info parameter
* contains a complete copy of all fields including:
* - HasPartitions: Whether image contains partitions/tracks
* - HasSessions: Whether image contains multiple sessions
* - ImageSize: Size of image payload in bytes
* - Sectors: Total count of addressable sectors/blocks
* - SectorSize: Size of each logical sector in bytes
* - Version: Image format version string (NUL-terminated)
* - Application: Creating application name (NUL-terminated)
* - ApplicationVersion: Application version string (NUL-terminated)
* - CreationTime: Image creation timestamp (Windows FILETIME)
* - LastModificationTime: Last modification timestamp (Windows FILETIME)
* - MediaType: Media type identifier
* - MetadataMediaType: Media type for sidecar generation
*
* @retval AARUF_ERROR_NOT_AARUFORMAT (-1) The context is invalid. This occurs when:
* - The context parameter is NULL
* - The context magic number doesn't match AARU_MAGIC
* - The context was not properly initialized
*
* @note The ImageInfo structure contains fixed-size character arrays that are
* properly NUL-terminated, making it safe to use as C strings.
*
* @note This function performs a complete deep copy using memcpy, copying all
* fields including strings, integers, and timestamps.
*
* @note The caller is responsible for allocating the ImageInfo structure before
* calling this function. The structure is not dynamically allocated by
* this function.
*
* @warning The image_info parameter must point to valid, allocated memory of
* at least sizeof(ImageInfo) bytes. Passing NULL or invalid pointers
* will result in undefined behavior.
*
* @warning This function reads from the in-memory image_info loaded during
* aaruf_open() or populated during aaruf_create(). It does not perform
* file I/O operations.
*/
int32_t aaruf_get_image_info(const void *context, ImageInfo *image_info)
{
TRACE("Entering aaruf_get_image_info(%p, %p)", context, image_info);
// Check context is correct AaruFormat context
if(context == NULL)
{
FATAL("Invalid context");
TRACE("Exiting aaruf_get_image_info() = AARUF_ERROR_NOT_AARUFORMAT");
return AARUF_ERROR_NOT_AARUFORMAT;
}
const aaruformat_context *ctx = context;
// Not a libaaruformat context
if(ctx->magic != AARU_MAGIC)
{
FATAL("Invalid context");
TRACE("Exiting aaruf_get_image_info() = AARUF_ERROR_NOT_AARUFORMAT");
return AARUF_ERROR_NOT_AARUFORMAT;
}
if(image_info == NULL)
{
FATAL("image_info parameter is NULL");
TRACE("Exiting aaruf_get_image_info() = AARUF_ERROR_INCORRECT_DATA_SIZE");
return AARUF_ERROR_INCORRECT_DATA_SIZE;
}
// Perform deep copy of the image_info structure
memcpy(image_info, &ctx->image_info, sizeof(ImageInfo));
TRACE("Exiting aaruf_get_image_info() = AARUF_STATUS_OK");
return AARUF_STATUS_OK;
}