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:
@@ -524,14 +524,137 @@ $(function(){initNavTree('blocks_2metadata_8c_source.html','',''); });
|
||||
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno"> 539</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting process_aaru_metadata_json_block()"</span>);</div>
|
||||
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno"> 540</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno"> 541</span></div>
|
||||
<div class="foldopen" id="foldopen00618" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno"><a class="line" href="decls_8h.html#aa9ed74c6988c035d9ba0d11965d5cf10"> 618</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="blocks_2metadata_8c.html#aa9ed74c6988c035d9ba0d11965d5cf10">aaruf_get_readable_sector_tags</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, uint8_t *buffer, <span class="keywordtype">size_t</span> *length)</div>
|
||||
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno"> 619</span>{</div>
|
||||
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno"> 620</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Entering aaruf_get_readable_sector_tags(%p, %p, %zu)"</span>, context, buffer, (length ? *length : 0));</div>
|
||||
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno"> 621</span> </div>
|
||||
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno"> 622</span> <span class="comment">// Check context is correct AaruFormat context</span></div>
|
||||
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno"> 623</span> <span class="keywordflow">if</span>(context == NULL)</div>
|
||||
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno"> 624</span> {</div>
|
||||
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno"> 625</span> <a class="code hl_define" href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a>(<span class="stringliteral">"Invalid context"</span>);</div>
|
||||
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno"> 626</span> </div>
|
||||
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno"> 627</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_sector_tags() = AARUF_ERROR_NOT_AARUFORMAT"</span>);</div>
|
||||
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno"> 628</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#abb63e240b11d790da83bd34507b57851">AARUF_ERROR_NOT_AARUFORMAT</a>;</div>
|
||||
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno"> 629</span> }</div>
|
||||
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno"> 630</span> </div>
|
||||
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno"> 631</span> <span class="keyword">const</span> <a class="code hl_struct" href="structaaruformat__context.html">aaruformat_context</a> *ctx = context;</div>
|
||||
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno"> 632</span> </div>
|
||||
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno"> 633</span> <span class="comment">// Not a libaaruformat context</span></div>
|
||||
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno"> 634</span> <span class="keywordflow">if</span>(ctx-><a class="code hl_variable" href="structaaruformat__context.html#a7dc0a0fe0bf6223ff4587fd01c360b76">magic</a> != <a class="code hl_define" href="consts_8h.html#a3c3ba66fe2b547655c9e4b16a1ba519a">AARU_MAGIC</a>)</div>
|
||||
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno"> 635</span> {</div>
|
||||
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno"> 636</span> <a class="code hl_define" href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a>(<span class="stringliteral">"Invalid context"</span>);</div>
|
||||
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno"> 637</span> </div>
|
||||
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno"> 638</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_sector_tags() = AARUF_ERROR_NOT_AARUFORMAT"</span>);</div>
|
||||
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno"> 639</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#abb63e240b11d790da83bd34507b57851">AARUF_ERROR_NOT_AARUFORMAT</a>;</div>
|
||||
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno"> 640</span> }</div>
|
||||
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno"> 641</span> </div>
|
||||
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno"> 642</span> <span class="keywordflow">if</span>(ctx-><a class="code hl_variable" href="structaaruformat__context.html#ad3d5494e23b07418e9fbd22c3771e534">readableSectorTags</a> == NULL)</div>
|
||||
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno"> 643</span> {</div>
|
||||
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno"> 644</span> <a class="code hl_define" href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a>(<span class="stringliteral">"Image contains no readable sector tags"</span>);</div>
|
||||
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno"> 645</span> </div>
|
||||
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno"> 646</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_sector_tags() = AARUF_ERROR_METADATA_NOT_PRESENT"</span>);</div>
|
||||
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno"> 647</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#a99ff8f6884fd5e21840b2e35240bc265">AARUF_ERROR_METADATA_NOT_PRESENT</a>;</div>
|
||||
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno"> 648</span> }</div>
|
||||
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno"> 649</span> </div>
|
||||
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno"> 650</span> <span class="keywordtype">size_t</span> required_length = <span class="keyword">sizeof</span>(bool) * (<a class="code hl_enumvalue" href="group__SectorTags.html#ggaf863e81d172ce7a216d8687a8a23293aa81dbcd4677b6377bce5351ad92fc4d64">MaxSectorTag</a> + 1);</div>
|
||||
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno"> 651</span> </div>
|
||||
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno"> 652</span> <span class="keywordflow">if</span>(buffer == NULL || length == NULL || *length < required_length)</div>
|
||||
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno"> 653</span> {</div>
|
||||
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno"> 654</span> <span class="keywordflow">if</span>(length) *length = required_length;</div>
|
||||
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno"> 655</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Buffer too small for readable sector tags, required %zu bytes"</span>, required_length);</div>
|
||||
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno"> 656</span> </div>
|
||||
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno"> 657</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_sector_tags() = AARUF_ERROR_BUFFER_TOO_SMALL"</span>);</div>
|
||||
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno"> 658</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#ae7eea5936a22100db46aac3e4312cdae">AARUF_ERROR_BUFFER_TOO_SMALL</a>;</div>
|
||||
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno"> 659</span> }</div>
|
||||
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno"> 660</span> </div>
|
||||
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno"> 661</span> memcpy(buffer, ctx-><a class="code hl_variable" href="structaaruformat__context.html#ad3d5494e23b07418e9fbd22c3771e534">readableSectorTags</a>, required_length);</div>
|
||||
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno"> 662</span> *length = required_length;</div>
|
||||
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno"> 663</span> </div>
|
||||
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno"> 664</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_sector_tags(%p, %p, %zu) = AARUF_STATUS_OK"</span>, context, buffer, *length);</div>
|
||||
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno"> 665</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#a1d6e49f7e8a1fa489efa0a582e90b5de">AARUF_STATUS_OK</a>;</div>
|
||||
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno"> 666</span>}</div>
|
||||
</div>
|
||||
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno"> 667</span></div>
|
||||
<div class="foldopen" id="foldopen00706" data-start="{" data-end="}">
|
||||
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno"><a class="line" href="decls_8h.html#a9cfc80d1cfa399bfea980b6ac4e2208a"> 706</a></span><a class="code hl_define" href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a> int32_t <a class="code hl_define" href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a> <a class="code hl_function" href="blocks_2metadata_8c.html#a9cfc80d1cfa399bfea980b6ac4e2208a">aaruf_get_readable_media_tags</a>(<span class="keyword">const</span> <span class="keywordtype">void</span> *context, uint8_t *buffer, <span class="keywordtype">size_t</span> *length)</div>
|
||||
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno"> 707</span>{</div>
|
||||
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno"> 708</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Entering aaruf_get_readable_media_tags(%p, %p, %zu)"</span>, context, buffer, (length ? *length : 0));</div>
|
||||
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno"> 709</span> </div>
|
||||
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno"> 710</span> <span class="comment">// Check context is correct AaruFormat context</span></div>
|
||||
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno"> 711</span> <span class="keywordflow">if</span>(context == NULL)</div>
|
||||
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno"> 712</span> {</div>
|
||||
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno"> 713</span> <a class="code hl_define" href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a>(<span class="stringliteral">"Invalid context"</span>);</div>
|
||||
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno"> 714</span> </div>
|
||||
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno"> 715</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_media_tags() = AARUF_ERROR_NOT_AARUFORMAT"</span>);</div>
|
||||
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno"> 716</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#abb63e240b11d790da83bd34507b57851">AARUF_ERROR_NOT_AARUFORMAT</a>;</div>
|
||||
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno"> 717</span> }</div>
|
||||
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno"> 718</span> </div>
|
||||
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno"> 719</span> <span class="keyword">const</span> <a class="code hl_struct" href="structaaruformat__context.html">aaruformat_context</a> *ctx = context;</div>
|
||||
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno"> 720</span> </div>
|
||||
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno"> 721</span> <span class="comment">// Not a libaaruformat context</span></div>
|
||||
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno"> 722</span> <span class="keywordflow">if</span>(ctx-><a class="code hl_variable" href="structaaruformat__context.html#a7dc0a0fe0bf6223ff4587fd01c360b76">magic</a> != <a class="code hl_define" href="consts_8h.html#a3c3ba66fe2b547655c9e4b16a1ba519a">AARU_MAGIC</a>)</div>
|
||||
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno"> 723</span> {</div>
|
||||
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno"> 724</span> <a class="code hl_define" href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a>(<span class="stringliteral">"Invalid context"</span>);</div>
|
||||
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno"> 725</span> </div>
|
||||
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno"> 726</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_media_tags() = AARUF_ERROR_NOT_AARUFORMAT"</span>);</div>
|
||||
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno"> 727</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#abb63e240b11d790da83bd34507b57851">AARUF_ERROR_NOT_AARUFORMAT</a>;</div>
|
||||
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno"> 728</span> }</div>
|
||||
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno"> 729</span> </div>
|
||||
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno"> 730</span> <span class="comment">// Required size: one byte for each MediaTagType (0 to MaxMediaTag)</span></div>
|
||||
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno"> 731</span> <span class="keywordtype">size_t</span> required_length = <a class="code hl_enumvalue" href="group__MediaTags.html#ggabdd09c559df8f34ae68fcb2ff1892ebeacd570dfe827abf5d93ff1c36b44efa33">MaxMediaTag</a> + 1;</div>
|
||||
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno"> 732</span> </div>
|
||||
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno"> 733</span> <span class="keywordflow">if</span>(buffer == NULL || length == NULL || *length < required_length)</div>
|
||||
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno"> 734</span> {</div>
|
||||
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno"> 735</span> <span class="keywordflow">if</span>(length) *length = required_length;</div>
|
||||
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno"> 736</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Buffer too small for readable media tags, required %zu bytes"</span>, required_length);</div>
|
||||
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno"> 737</span> </div>
|
||||
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno"> 738</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_media_tags() = AARUF_ERROR_BUFFER_TOO_SMALL"</span>);</div>
|
||||
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno"> 739</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#ae7eea5936a22100db46aac3e4312cdae">AARUF_ERROR_BUFFER_TOO_SMALL</a>;</div>
|
||||
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno"> 740</span> }</div>
|
||||
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno"> 741</span> </div>
|
||||
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno"> 742</span> <span class="comment">// Initialize all bytes to false (0)</span></div>
|
||||
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno"> 743</span> memset(buffer, 0, required_length);</div>
|
||||
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno"> 744</span> </div>
|
||||
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno"> 745</span> <span class="comment">// Iterate through all media tag types and mark present ones as true</span></div>
|
||||
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno"> 746</span> <span class="keywordflow">for</span>(int32_t tag_type = 0; tag_type <= <a class="code hl_enumvalue" href="group__MediaTags.html#ggabdd09c559df8f34ae68fcb2ff1892ebeacd570dfe827abf5d93ff1c36b44efa33">MaxMediaTag</a>; tag_type++)</div>
|
||||
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno"> 747</span> {</div>
|
||||
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno"> 748</span> <a class="code hl_struct" href="structmediaTagEntry.html">mediaTagEntry</a> *item = NULL;</div>
|
||||
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno"> 749</span> HASH_FIND_INT(ctx-><a class="code hl_variable" href="structaaruformat__context.html#a8b769e9fb9467aa11d4a2936cf5cf5ed">mediaTags</a>, &tag_type, item);</div>
|
||||
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno"> 750</span> </div>
|
||||
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno"> 751</span> <span class="keywordflow">if</span>(item != NULL)</div>
|
||||
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno"> 752</span> {</div>
|
||||
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno"> 753</span> buffer[tag_type] = 1;</div>
|
||||
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno"> 754</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Media tag type %d is present"</span>, tag_type);</div>
|
||||
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno"> 755</span> }</div>
|
||||
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno"> 756</span> }</div>
|
||||
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno"> 757</span> </div>
|
||||
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno"> 758</span> *length = required_length;</div>
|
||||
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno"> 759</span> </div>
|
||||
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno"> 760</span> <a class="code hl_define" href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a>(<span class="stringliteral">"Exiting aaruf_get_readable_media_tags(%p, %p, %zu) = AARUF_STATUS_OK"</span>, context, buffer, *length);</div>
|
||||
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno"> 761</span> <span class="keywordflow">return</span> <a class="code hl_define" href="errors_8h.html#a1d6e49f7e8a1fa489efa0a582e90b5de">AARUF_STATUS_OK</a>;</div>
|
||||
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno"> 762</span>}</div>
|
||||
</div>
|
||||
<div class="ttc" id="aaaruformat_8h_html"><div class="ttname"><a href="aaruformat_8h.html">aaruformat.h</a></div></div>
|
||||
<div class="ttc" id="ablocks_2metadata_8c_html_a43974d4c183240be30d49ff09ef7b8c2"><div class="ttname"><a href="blocks_2metadata_8c.html#a43974d4c183240be30d49ff09ef7b8c2">process_metadata_block</a></div><div class="ttdeci">void process_metadata_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="#l00035">metadata.c:35</a></div></div>
|
||||
<div class="ttc" id="ablocks_2metadata_8c_html_a5e0397faed8aea27c5a6a3881875de54"><div class="ttname"><a href="blocks_2metadata_8c.html#a5e0397faed8aea27c5a6a3881875de54">process_cicm_block</a></div><div class="ttdeci">void process_cicm_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a CICM XML metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="#l00306">metadata.c:306</a></div></div>
|
||||
<div class="ttc" id="ablocks_2metadata_8c_html_a81d410de6727d95a85b827067e1a8bc6"><div class="ttname"><a href="blocks_2metadata_8c.html#a81d410de6727d95a85b827067e1a8bc6">process_geometry_block</a></div><div class="ttdeci">void process_geometry_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a logical geometry block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="#l00246">metadata.c:246</a></div></div>
|
||||
<div class="ttc" id="ablocks_2metadata_8c_html_a84003ec881425a7b28ec24cb48d19f02"><div class="ttname"><a href="blocks_2metadata_8c.html#a84003ec881425a7b28ec24cb48d19f02">process_aaru_metadata_json_block</a></div><div class="ttdeci">void process_aaru_metadata_json_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes an Aaru metadata JSON block from the image stream during image opening.</div><div class="ttdef"><b>Definition</b> <a href="#l00470">metadata.c:470</a></div></div>
|
||||
<div class="ttc" id="ablocks_2metadata_8c_html_a9cfc80d1cfa399bfea980b6ac4e2208a"><div class="ttname"><a href="blocks_2metadata_8c.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="#l00706">metadata.c:706</a></div></div>
|
||||
<div class="ttc" id="ablocks_2metadata_8c_html_aa9ed74c6988c035d9ba0d11965d5cf10"><div class="ttname"><a href="blocks_2metadata_8c.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="#l00618">metadata.c:618</a></div></div>
|
||||
<div class="ttc" id="aconsts_8h_html_a3c3ba66fe2b547655c9e4b16a1ba519a"><div class="ttname"><a href="consts_8h.html#a3c3ba66fe2b547655c9e4b16a1ba519a">AARU_MAGIC</a></div><div class="ttdeci">#define AARU_MAGIC</div><div class="ttdoc">Magic identifier for AaruFormat container (ASCII "AARUFRMT").</div><div class="ttdef"><b>Definition</b> <a href="consts_8h_source.html#l00064">consts.h:64</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a018e0da1c1f7e4f6187a982c0e40e056"><div class="ttname"><a href="decls_8h.html#a018e0da1c1f7e4f6187a982c0e40e056">AARU_CALL</a></div><div class="ttdeci">#define AARU_CALL</div><div class="ttdef"><b>Definition</b> <a href="decls_8h_source.html#l00045">decls.h:45</a></div></div>
|
||||
<div class="ttc" id="adecls_8h_html_a9001412c35f3c92d3a9320d27b0d97f9"><div class="ttname"><a href="decls_8h.html#a9001412c35f3c92d3a9320d27b0d97f9">AARU_EXPORT</a></div><div class="ttdeci">#define AARU_EXPORT</div><div class="ttdef"><b>Definition</b> <a href="decls_8h_source.html#l00054">decls.h:54</a></div></div>
|
||||
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a76691ea3f772bf28e7446d171e205db2"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a76691ea3f772bf28e7446d171e205db2">GeometryBlock</a></div><div class="ttdeci">@ GeometryBlock</div><div class="ttdoc">Block containing logical geometry.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00148">enums.h:148</a></div></div>
|
||||
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3a8ac77889f0c345ed861ed653a3063032"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3a8ac77889f0c345ed861ed653a3063032">AaruMetadataJsonBlock</a></div><div class="ttdeci">@ AaruMetadataJsonBlock</div><div class="ttdoc">Block containing JSON version of Aaru Metadata.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00159">enums.h:159</a></div></div>
|
||||
<div class="ttc" id="aenums_8h_html_a54420623f26ab6bb61042b41cccf37a3aa90947995922dcd8b27c998978aba359"><div class="ttname"><a href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3aa90947995922dcd8b27c998978aba359">CicmBlock</a></div><div class="ttdeci">@ CicmBlock</div><div class="ttdoc">Block containing CICM XML metadata.</div><div class="ttdef"><b>Definition</b> <a href="enums_8h_source.html#l00151">enums.h:151</a></div></div>
|
||||
<div class="ttc" id="aerrors_8h_html_a1d6e49f7e8a1fa489efa0a582e90b5de"><div class="ttname"><a href="errors_8h.html#a1d6e49f7e8a1fa489efa0a582e90b5de">AARUF_STATUS_OK</a></div><div class="ttdeci">#define AARUF_STATUS_OK</div><div class="ttdoc">Sector present and read without uncorrectable errors.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00075">errors.h:75</a></div></div>
|
||||
<div class="ttc" id="aerrors_8h_html_a99ff8f6884fd5e21840b2e35240bc265"><div class="ttname"><a href="errors_8h.html#a99ff8f6884fd5e21840b2e35240bc265">AARUF_ERROR_METADATA_NOT_PRESENT</a></div><div class="ttdeci">#define AARUF_ERROR_METADATA_NOT_PRESENT</div><div class="ttdoc">Requested metadata not present in image.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00069">errors.h:69</a></div></div>
|
||||
<div class="ttc" id="aerrors_8h_html_abb63e240b11d790da83bd34507b57851"><div class="ttname"><a href="errors_8h.html#abb63e240b11d790da83bd34507b57851">AARUF_ERROR_NOT_AARUFORMAT</a></div><div class="ttdeci">#define AARUF_ERROR_NOT_AARUFORMAT</div><div class="ttdoc">Input file/stream failed magic or structural validation.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00040">errors.h:40</a></div></div>
|
||||
<div class="ttc" id="aerrors_8h_html_ae7eea5936a22100db46aac3e4312cdae"><div class="ttname"><a href="errors_8h.html#ae7eea5936a22100db46aac3e4312cdae">AARUF_ERROR_BUFFER_TOO_SMALL</a></div><div class="ttdeci">#define AARUF_ERROR_BUFFER_TOO_SMALL</div><div class="ttdoc">Caller-supplied buffer insufficient for data.</div><div class="ttdef"><b>Definition</b> <a href="errors_8h_source.html#l00049">errors.h:49</a></div></div>
|
||||
<div class="ttc" id="agroup__MediaTags_html_ggabdd09c559df8f34ae68fcb2ff1892ebeacd570dfe827abf5d93ff1c36b44efa33"><div class="ttname"><a href="group__MediaTags.html#ggabdd09c559df8f34ae68fcb2ff1892ebeacd570dfe827abf5d93ff1c36b44efa33">MaxMediaTag</a></div><div class="ttdeci">@ MaxMediaTag</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l01011">aaru.h:1011</a></div></div>
|
||||
<div class="ttc" id="agroup__SectorTags_html_ggaf863e81d172ce7a216d8687a8a23293aa81dbcd4677b6377bce5351ad92fc4d64"><div class="ttname"><a href="group__SectorTags.html#ggaf863e81d172ce7a216d8687a8a23293aa81dbcd4677b6377bce5351ad92fc4d64">MaxSectorTag</a></div><div class="ttdeci">@ MaxSectorTag</div><div class="ttdef"><b>Definition</b> <a href="aaru_8h_source.html#l00918">aaru.h:918</a></div></div>
|
||||
<div class="ttc" id="alog_8h_html"><div class="ttname"><a href="log_8h.html">log.h</a></div></div>
|
||||
<div class="ttc" id="alog_8h_html_a053d6037d543b84ce59308ce71d15cd1"><div class="ttname"><a href="log_8h.html#a053d6037d543b84ce59308ce71d15cd1">FATAL</a></div><div class="ttdeci">#define FATAL(fmt,...)</div><div class="ttdef"><b>Definition</b> <a href="log_8h_source.html#l00040">log.h:40</a></div></div>
|
||||
<div class="ttc" id="alog_8h_html_a21cc0459b78d5f2d7bd737e5aae1278a"><div class="ttname"><a href="log_8h.html#a21cc0459b78d5f2d7bd737e5aae1278a">TRACE</a></div><div class="ttdeci">#define TRACE(fmt,...)</div><div class="ttdef"><b>Definition</b> <a href="log_8h_source.html#l00025">log.h:25</a></div></div>
|
||||
@@ -593,6 +716,8 @@ $(function(){initNavTree('blocks_2metadata_8c_source.html','',''); });
|
||||
<div class="ttc" id="astructaaruformat__context_html_a614d6f01d563ea57650ce0bbfecfa08d"><div class="ttname"><a href="structaaruformat__context.html#a614d6f01d563ea57650ce0bbfecfa08d">aaruformat_context::drive_manufacturer</a></div><div class="ttdeci">uint8_t * drive_manufacturer</div><div class="ttdoc">Manufacturer of the drive used to read the media represented by the image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00224">context.h:224</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_a73005ba88069ba590ffc9660dc2bc7a5"><div class="ttname"><a href="structaaruformat__context.html#a73005ba88069ba590ffc9660dc2bc7a5">aaruformat_context::cicm_block_header</a></div><div class="ttdeci">CicmMetadataBlock cicm_block_header</div><div class="ttdoc">CICM metadata header (if present).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00231">context.h:231</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_a77d9c8c852de1d955bceb4cfc50557ce"><div class="ttname"><a href="structaaruformat__context.html#a77d9c8c852de1d955bceb4cfc50557ce">aaruformat_context::drive_model</a></div><div class="ttdeci">uint8_t * drive_model</div><div class="ttdoc">Model of the drive used to read the media represented by the image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00225">context.h:225</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_a7dc0a0fe0bf6223ff4587fd01c360b76"><div class="ttname"><a href="structaaruformat__context.html#a7dc0a0fe0bf6223ff4587fd01c360b76">aaruformat_context::magic</a></div><div class="ttdeci">uint64_t magic</div><div class="ttdoc">File magic (AARU_MAGIC) post-open.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00174">context.h:174</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_a8b769e9fb9467aa11d4a2936cf5cf5ed"><div class="ttname"><a href="structaaruformat__context.html#a8b769e9fb9467aa11d4a2936cf5cf5ed">aaruformat_context::mediaTags</a></div><div class="ttdeci">mediaTagEntry * mediaTags</div><div class="ttdoc">Hash table of extra media tags (uthash root).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00264">context.h:264</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_a9ac9d12e8fde7a69c01cdf2dc32f33bd"><div class="ttname"><a href="structaaruformat__context.html#a9ac9d12e8fde7a69c01cdf2dc32f33bd">aaruformat_context::geometry_block</a></div><div class="ttdeci">GeometryBlockHeader geometry_block</div><div class="ttdoc">Logical geometry block (if present).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00229">context.h:229</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_a9e7ebc6897142938452338bc5a882dd8"><div class="ttname"><a href="structaaruformat__context.html#a9e7ebc6897142938452338bc5a882dd8">aaruformat_context::json_block</a></div><div class="ttdeci">uint8_t * json_block</div><div class="ttdoc">JSON metadata block payload (UTF-8).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00215">context.h:215</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_aa3d0670124a4fbe88c485c2b67d1ddbc"><div class="ttname"><a href="structaaruformat__context.html#aa3d0670124a4fbe88c485c2b67d1ddbc">aaruformat_context::media_part_number</a></div><div class="ttdeci">uint8_t * media_part_number</div><div class="ttdoc">Part number of the media represented by the image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00223">context.h:223</a></div></div>
|
||||
@@ -602,10 +727,12 @@ $(function(){initNavTree('blocks_2metadata_8c_source.html','',''); });
|
||||
<div class="ttc" id="astructaaruformat__context_html_ab213059edf055cf1c3e2021bc395c78e"><div class="ttname"><a href="structaaruformat__context.html#ab213059edf055cf1c3e2021bc395c78e">aaruformat_context::heads</a></div><div class="ttdeci">uint32_t heads</div><div class="ttdoc">Heads of the media represented by the image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00235">context.h:235</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_ab516fae594bde4f76b75488d0a3ca3a8"><div class="ttname"><a href="structaaruformat__context.html#ab516fae594bde4f76b75488d0a3ca3a8">aaruformat_context::imageStream</a></div><div class="ttdeci">FILE * imageStream</div><div class="ttdoc">Underlying FILE* stream (binary mode).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00176">context.h:176</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_ac970291b3449c04221827b9c2c18ac70"><div class="ttname"><a href="structaaruformat__context.html#ac970291b3449c04221827b9c2c18ac70">aaruformat_context::image_info</a></div><div class="ttdeci">ImageInfo image_info</div><div class="ttdoc">Exposed high-level image info summary.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00260">context.h:260</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_ad3d5494e23b07418e9fbd22c3771e534"><div class="ttname"><a href="structaaruformat__context.html#ad3d5494e23b07418e9fbd22c3771e534">aaruformat_context::readableSectorTags</a></div><div class="ttdeci">bool * readableSectorTags</div><div class="ttdoc">Per-sector boolean array (optical tags read successfully?).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00263">context.h:263</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_ae0df8ced37e331df99560d9773d7bad8"><div class="ttname"><a href="structaaruformat__context.html#ae0df8ced37e331df99560d9773d7bad8">aaruformat_context::metadata_block</a></div><div class="ttdeci">uint8_t * metadata_block</div><div class="ttdoc">Raw metadata UTF-16LE concatenated strings.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00213">context.h:213</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_aeb5bda76e0ea176598a04be97b7d5683"><div class="ttname"><a href="structaaruformat__context.html#aeb5bda76e0ea176598a04be97b7d5683">aaruformat_context::media_title</a></div><div class="ttdeci">uint8_t * media_title</div><div class="ttdoc">Title of the media represented by the image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00217">context.h:217</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_aee966d0d920ef43cfadb0830c444b986"><div class="ttname"><a href="structaaruformat__context.html#aee966d0d920ef43cfadb0830c444b986">aaruformat_context::last_media_sequence</a></div><div class="ttdeci">int32_t last_media_sequence</div><div class="ttdoc">Last media of the sequence the media represented by the image corresponds to.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00239">context.h:239</a></div></div>
|
||||
<div class="ttc" id="astructaaruformat__context_html_afd13345e6ab5072d97d9b3bbe238ecea"><div class="ttname"><a href="structaaruformat__context.html#afd13345e6ab5072d97d9b3bbe238ecea">aaruformat_context::media_manufacturer</a></div><div class="ttdeci">uint8_t * media_manufacturer</div><div class="ttdoc">Manufacturer of the media represented by the image.</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00219">context.h:219</a></div></div>
|
||||
<div class="ttc" id="astructmediaTagEntry_html"><div class="ttname"><a href="structmediaTagEntry.html">mediaTagEntry</a></div><div class="ttdoc">Hash table entry for an arbitrary media tag (e.g., proprietary drive/medium descriptor).</div><div class="ttdef"><b>Definition</b> <a href="context_8h_source.html#l00118">context.h:119</a></div></div>
|
||||
</div><!-- fragment --></div><!-- contents -->
|
||||
</div><!-- doc-content -->
|
||||
</div><!-- container -->
|
||||
|
||||
Reference in New Issue
Block a user