mirror of
https://github.com/aaru-dps/libaaruformat.git
synced 2025-12-16 19:24:40 +00:00
Update documentation.
This commit is contained in:
@@ -161,7 +161,7 @@ $(function(){initNavTree('decls_8h_source.html','',''); });
|
||||
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span> </div>
|
||||
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> <span class="keywordtype">int</span> <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="decls_8h.html#a6f30353aff3ece1e889542c26f7146e2">aaruf_identify_stream</a>(FILE *image_stream);</div>
|
||||
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
||||
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> <span class="keywordtype">void</span> *<a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="decls_8h.html#afc4932cdc795ffb2ef3a33d5b8c57656">aaruf_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filepath);</div>
|
||||
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="decls_8h.html#aefe69fae905b957bb4349ac59fad9bc7"> 70</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> <span class="keywordtype">void</span> *<a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="decls_8h.html#aefe69fae905b957bb4349ac59fad9bc7">aaruf_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filepath, <span class="keywordtype">bool</span> resume_mode, <span class="keywordtype">char</span> *options);</div>
|
||||
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span> </div>
|
||||
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> <span class="keywordtype">void</span> *<a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="decls_8h.html#a7065a9fefcaabfecc4184528f01ef013">aaruf_create</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filepath, uint32_t media_type, uint32_t sector_size,</div>
|
||||
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> uint64_t user_sectors, uint64_t negative_sectors, uint64_t overflow_sectors,</div>
|
||||
@@ -432,9 +432,9 @@ $(function(){initNavTree('decls_8h_source.html','',''); });
|
||||
<div class="ttc" id="adecls_8h_html_a66567ca64e31a687d4982cb254b45196"><div class="ttname"><a href="decls_8h.html#a66567ca64e31a687d4982cb254b45196">aaruf_crc64_init</a></div><div class="ttdeci">crc64_ctx * aaruf_crc64_init()</div><div class="ttdoc">Initializes a CRC64 context.</div><div class="ttdef"><b>Definition</b> <a href="crc64_8c_source.html#l00032">crc64.c:32</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a67c65c3f2ca5cdf1596c16fa35558df1"><div class="ttname"><a href="decls_8h.html#a67c65c3f2ca5cdf1596c16fa35558df1">aaruf_edc_cd_compute</a></div><div class="ttdeci">uint32_t aaruf_edc_cd_compute(void *context, uint32_t edc, const uint8_t *src, int size, int pos)</div><div class="ttdoc">Computes the EDC (Error Detection Code) for a CD sector.</div><div class="ttdef"><b>Definition</b> <a href="ecc__cd_8c_source.html#l00547">ecc_cd.c:547</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a680150d4b3df13261af758c504a1f848"><div class="ttname"><a href="decls_8h.html#a680150d4b3df13261af758c504a1f848">fuzzy_engine_step</a></div><div class="ttdeci">void fuzzy_engine_step(spamsum_ctx *ctx, uint8_t c)</div><div class="ttdef"><b>Definition</b> <a href="spamsum_8c_source.html#l00084">spamsum.c:84</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a6823e139f81a9dfd08efcb0e9b213a49"><div class="ttname"><a href="decls_8h.html#a6823e139f81a9dfd08efcb0e9b213a49">aaruf_close</a></div><div class="ttdeci">int aaruf_close(void *context)</div><div class="ttdoc">Close an Aaru image context, flushing pending data structures and releasing resources.</div><div class="ttdef"><b>Definition</b> <a href="close_8c_source.html#l03995">close.c:3995</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a69ca66242c0becf7640b3d1cc8da8f9c"><div class="ttname"><a href="decls_8h.html#a69ca66242c0becf7640b3d1cc8da8f9c">aaruf_write_sector_long</a></div><div class="ttdeci">int32_t aaruf_write_sector_long(void *context, uint64_t sector_address, bool negative, const uint8_t *data, uint8_t sector_status, uint32_t length)</div><div class="ttdoc">Writes a full ("long") raw sector from optical or block media, parsing structure and validating conte...</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l00532">write.c:532</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a6a8994cd006711347fb03cec465eafa6"><div class="ttname"><a href="decls_8h.html#a6a8994cd006711347fb03cec465eafa6">aaruf_write_sector_tag</a></div><div class="ttdeci">int32_t aaruf_write_sector_tag(void *context, uint64_t sector_address, bool negative, const uint8_t *data, size_t length, int32_t tag)</div><div class="ttdoc">Writes per-sector tag data (auxiliary metadata) for a specific sector.</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l02059">write.c:2059</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a6823e139f81a9dfd08efcb0e9b213a49"><div class="ttname"><a href="decls_8h.html#a6823e139f81a9dfd08efcb0e9b213a49">aaruf_close</a></div><div class="ttdeci">int aaruf_close(void *context)</div><div class="ttdoc">Close an Aaru image context, flushing pending data structures and releasing resources.</div><div class="ttdef"><b>Definition</b> <a href="close_8c_source.html#l03997">close.c:3997</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a69ca66242c0becf7640b3d1cc8da8f9c"><div class="ttname"><a href="decls_8h.html#a69ca66242c0becf7640b3d1cc8da8f9c">aaruf_write_sector_long</a></div><div class="ttdeci">int32_t aaruf_write_sector_long(void *context, uint64_t sector_address, bool negative, const uint8_t *data, uint8_t sector_status, uint32_t length)</div><div class="ttdoc">Writes a full ("long") raw sector from optical or block media, parsing structure and validating conte...</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l00537">write.c:537</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a6a8994cd006711347fb03cec465eafa6"><div class="ttname"><a href="decls_8h.html#a6a8994cd006711347fb03cec465eafa6">aaruf_write_sector_tag</a></div><div class="ttdeci">int32_t aaruf_write_sector_tag(void *context, uint64_t sector_address, bool negative, const uint8_t *data, size_t length, int32_t tag)</div><div class="ttdoc">Writes per-sector tag data (auxiliary metadata) for a specific sector.</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l02069">write.c:2069</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a6b98055d07ba51f0daef5b03ce2fe725"><div class="ttname"><a href="decls_8h.html#a6b98055d07ba51f0daef5b03ce2fe725">aaruf_md5_final</a></div><div class="ttdeci">void aaruf_md5_final(md5_ctx *ctx, unsigned char *result)</div><div class="ttdef"><b>Definition</b> <a href="md5_8c_source.html#l00485">md5.c:485</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a6e19e853bea5db901de83fa2fa29055c"><div class="ttname"><a href="decls_8h.html#a6e19e853bea5db901de83fa2fa29055c">aaruf_md5_update</a></div><div class="ttdeci">void aaruf_md5_update(md5_ctx *ctx, const void *data, unsigned long size)</div><div class="ttdef"><b>Definition</b> <a href="md5_8c_source.html#l00447">md5.c:447</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a6f30353aff3ece1e889542c26f7146e2"><div class="ttname"><a href="decls_8h.html#a6f30353aff3ece1e889542c26f7146e2">aaruf_identify_stream</a></div><div class="ttdeci">int aaruf_identify_stream(FILE *image_stream)</div><div class="ttdoc">Identifies a file as an AaruFormat image using an open stream.</div><div class="ttdef"><b>Definition</b> <a href="identify_8c_source.html#l00163">identify.c:163</a></div></div>
|
||||
@@ -464,7 +464,7 @@ $(function(){initNavTree('decls_8h_source.html','',''); });
|
||||
<div class="ttc" id="adecls_8h_html_a9cfc80d1cfa399bfea980b6ac4e2208a"><div class="ttname"><a href="decls_8h.html#a9cfc80d1cfa399bfea980b6ac4e2208a">aaruf_get_readable_media_tags</a></div><div class="ttdeci">int32_t aaruf_get_readable_media_tags(const void *context, uint8_t *buffer, size_t *length)</div><div class="ttdoc">Retrieves which media tags are present in the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00706">metadata.c:706</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a9daeeb54c74dd2707d95ab47e8ab0a00"><div class="ttname"><a href="decls_8h.html#a9daeeb54c74dd2707d95ab47e8ab0a00">aaruf_set_tape_partition</a></div><div class="ttdeci">int32_t aaruf_set_tape_partition(void *context, uint8_t partition, uint64_t starting_block, uint64_t ending_block)</div><div class="ttdoc">Sets or updates the block range for a specific tape partition in an Aaru tape image.</div><div class="ttdef"><b>Definition</b> <a href="tape_8c_source.html#l01196">tape.c:1196</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a9f287da4a58c0d3ab8f0243de5fe3f8d"><div class="ttname"><a href="decls_8h.html#a9f287da4a58c0d3ab8f0243de5fe3f8d">roll_hash</a></div><div class="ttdeci">void roll_hash(spamsum_ctx *ctx, uint8_t c)</div><div class="ttdef"><b>Definition</b> <a href="spamsum_8c_source.html#l00137">spamsum.c:137</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_aa041a789fbae70c1e1ec3e38f1ab369d"><div class="ttname"><a href="decls_8h.html#aa041a789fbae70c1e1ec3e38f1ab369d">aaruf_write_media_tag</a></div><div class="ttdeci">int32_t aaruf_write_media_tag(void *context, const uint8_t *data, int32_t type, uint32_t length)</div><div class="ttdoc">Writes a media tag to the AaruFormat image, storing medium-specific metadata and descriptors.</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l01790">write.c:1790</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_aa041a789fbae70c1e1ec3e38f1ab369d"><div class="ttname"><a href="decls_8h.html#aa041a789fbae70c1e1ec3e38f1ab369d">aaruf_write_media_tag</a></div><div class="ttdeci">int32_t aaruf_write_media_tag(void *context, const uint8_t *data, int32_t type, uint32_t length)</div><div class="ttdoc">Writes a media tag to the AaruFormat image, storing medium-specific metadata and descriptors.</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l01800">write.c:1800</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_aa683ff7387ba3f505b1756da1b408f7e"><div class="ttname"><a href="decls_8h.html#aa683ff7387ba3f505b1756da1b408f7e">aaruf_get_media_sequence</a></div><div class="ttdeci">int32_t aaruf_get_media_sequence(const void *context, int32_t *sequence, int32_t *last_sequence)</div><div class="ttdoc">Retrieves the media sequence metadata for multi-volume image sets.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l02340">metadata.c:2340</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_aa6d7ceaf960a4e8d4494424f11815fcb"><div class="ttname"><a href="decls_8h.html#aa6d7ceaf960a4e8d4494424f11815fcb">aaruf_clear_drive_serial_number</a></div><div class="ttdeci">int32_t aaruf_clear_drive_serial_number(void *context)</div><div class="ttdoc">Clears the drive serial number from the image metadata.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l04773">metadata.c:4773</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_aa9ed74c6988c035d9ba0d11965d5cf10"><div class="ttname"><a href="decls_8h.html#aa9ed74c6988c035d9ba0d11965d5cf10">aaruf_get_readable_sector_tags</a></div><div class="ttdeci">int32_t aaruf_get_readable_sector_tags(const void *context, uint8_t *buffer, size_t *length)</div><div class="ttdoc">Retrieves which sector tags are readable in the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00618">metadata.c:618</a></div></div>
|
||||
@@ -488,11 +488,11 @@ $(function(){initNavTree('decls_8h_source.html','',''); });
|
||||
<div class="ttc" id="adecls_8h_html_aed40c9ebc6d963b2a8ed5ebec1fed3c5"><div class="ttname"><a href="decls_8h.html#aed40c9ebc6d963b2a8ed5ebec1fed3c5">aaruf_read_sector_long</a></div><div class="ttdeci">int32_t aaruf_read_sector_long(void *context, uint64_t sector_address, bool negative, uint8_t *data, uint32_t *length, uint8_t *sector_status)</div><div class="ttdoc">Reads a complete sector with all metadata from the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="read_8c_source.html#l00826">read.c:826</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_aeeae64b120a10bac5e3d757a07a9691a"><div class="ttname"><a href="decls_8h.html#aeeae64b120a10bac5e3d757a07a9691a">aaruf_get_overflow_sectors</a></div><div class="ttdeci">int32_t aaruf_get_overflow_sectors(const void *context, uint16_t *sectors)</div><div class="ttdoc">Retrieves the number of overflow (post-gap) sectors in the AaruFormat image.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l03555">metadata.c:3555</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_aef269305958754978beedf4c44618d98"><div class="ttname"><a href="decls_8h.html#aef269305958754978beedf4c44618d98">aaruf_set_drive_serial_number</a></div><div class="ttdeci">int32_t aaruf_set_drive_serial_number(void *context, const uint8_t *data, int32_t length)</div><div class="ttdoc">Sets the drive serial number for the image.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l01660">metadata.c:1660</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_aefe69fae905b957bb4349ac59fad9bc7"><div class="ttname"><a href="decls_8h.html#aefe69fae905b957bb4349ac59fad9bc7">aaruf_open</a></div><div class="ttdeci">void * aaruf_open(const char *filepath, bool resume_mode, char *options)</div></div>
|
||||
<div class="ttc" id="adecls_8h_html_af0ff6ad1495d50a8fa0ce0005be69471"><div class="ttname"><a href="decls_8h.html#af0ff6ad1495d50a8fa0ce0005be69471">aaruf_flac_decode_redbook_buffer</a></div><div class="ttdeci">size_t aaruf_flac_decode_redbook_buffer(uint8_t *dst_buffer, size_t dst_size, const uint8_t *src_buffer, size_t src_size)</div><div class="ttdoc">Decodes a FLAC-compressed Red Book audio buffer.</div><div class="ttdef"><b>Definition</b> <a href="flac_8c_source.html#l00048">flac.c:48</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_af1ca27c052c6cde38a8d6d71e10936db"><div class="ttname"><a href="decls_8h.html#af1ca27c052c6cde38a8d6d71e10936db">aaruf_get_media_title</a></div><div class="ttdeci">int32_t aaruf_get_media_title(const void *context, uint8_t *buffer, int32_t *length)</div><div class="ttdoc">Retrieves the media title or label captured during image creation.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l02549">metadata.c:2549</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_af7fcca1ab5ff0422ec81ec6e99001b38"><div class="ttname"><a href="decls_8h.html#af7fcca1ab5ff0422ec81ec6e99001b38">aaruf_set_comments</a></div><div class="ttdeci">int32_t aaruf_set_comments(void *context, const uint8_t *data, int32_t length)</div><div class="ttdoc">Sets user comments or notes for the image.</div><div class="ttdef"><b>Definition</b> <a href="metadata_8c_source.html#l00609">metadata.c:609</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_afbc09e16b1a654de04706e07c3212ecb"><div class="ttname"><a href="decls_8h.html#afbc09e16b1a654de04706e07c3212ecb">aaruf_ecc_cd_is_suffix_correct</a></div><div class="ttdeci">bool aaruf_ecc_cd_is_suffix_correct(void *context, const uint8_t *sector)</div><div class="ttdoc">Checks if the suffix (EDC/ECC) of a CD sector is correct (Mode 1).</div><div class="ttdef"><b>Definition</b> <a href="ecc__cd_8c_source.html#l00101">ecc_cd.c:101</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_afc4932cdc795ffb2ef3a33d5b8c57656"><div class="ttname"><a href="decls_8h.html#afc4932cdc795ffb2ef3a33d5b8c57656">aaruf_open</a></div><div class="ttdeci">void * aaruf_open(const char *filepath)</div><div class="ttdoc">Opens an existing AaruFormat image file.</div><div class="ttdef"><b>Definition</b> <a href="open_8c_source.html#l00125">open.c:125</a></div></div>
|
||||
<div class="ttc" id="amd5_8h_html"><div class="ttname"><a href="md5_8h.html">md5.h</a></div></div>
|
||||
<div class="ttc" id="aoptical_8h_html"><div class="ttname"><a href="optical_8h.html">optical.h</a></div><div class="ttdoc">On-disk structures describing optical disc tracks (Track list block).</div></div>
|
||||
<div class="ttc" id="asha1_8h_html"><div class="ttname"><a href="sha1_8h.html">sha1.h</a></div></div>
|
||||
|
||||
Reference in New Issue
Block a user