Skip to content

Commit

Permalink
Update docs concerning BMFF-based files (#2404)
Browse files Browse the repository at this point in the history
* Update docs concerning BMFF-based files

* Fix minor issues in documentation
  • Loading branch information
postscript-dev committed Nov 2, 2022
1 parent cbf549b commit eae83b4
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 8 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The file ReadMe.txt in a build bundle describes how to install the library on th
16. [Cross Platform Build and Test on Linux for MinGW](#2-16)
17. [Building with C++11 and other compilers](#2-17)
18. [Static and Shared Libraries](#2-18)
19. [Support for bmff files (CR3, HEIF, HEIC, and AVIF)](#2-19)
19. [Support for BMFF files (e.g., CR3, HEIF, HEIC, AVIF, and JPEG XL)](#2-19)
3. [License and Support](#3)
1. [License](#3-1)
2. [Support](#3-2)
Expand Down Expand Up @@ -620,7 +620,7 @@ int main(int argc, const char* argv[])
...
}
```
The use of the _**thread unsafe function**_ Exiv2::enableBMFF(true) is discussed in [2.19 Support for bmff files](#2-19)
The use of the _**thread unsafe function**_ Exiv2::enableBMFF(true) is discussed in [2.19 Support for BMFF files (e.g., CR3, HEIF, HEIC, AVIF, and JPEG XL)](#2-19)
[TOC](#TOC)
<div id="2-15">
Expand Down Expand Up @@ -806,19 +806,19 @@ This is discussed: [https://github.com/Exiv2/exiv2/issues/1230](https://github.c
[TOC](#TOC)
<div id="2-19">
### 2.19 Support for bmff files (CR3, HEIF, HEIC, and AVIF)
### 2.19 Support for BMFF files (e.g., CR3, HEIF, HEIC, AVIF, and JPEG XL)
**Attention is drawn to the possibility that bmff support may be the subject of patent rights. _Exiv2 shall not be held responsible for identifying any or all such patent rights. Exiv2 shall not be held responsible for the legal consequences of the use of this code_.**
**Attention is drawn to the possibility that BMFF support may be the subject of patent rights. _Exiv2 shall not be held responsible for identifying any or all such patent rights. Exiv2 shall not be held responsible for the legal consequences of the use of this code_.**
Access to the bmff code is guarded in two ways. Firstly, you have to build the library with the cmake option: `-DEXIV2_ENABLE_BMFF=On`. Secondly, the application must enable bmff support at run-time by calling the following function.
Access to the BMFF code is guarded in two ways. Firstly, you have to build the library with the cmake option: `-DEXIV2_ENABLE_BMFF=On`. Secondly, the application must enable BMFF support at run-time by calling the following function.
```cpp
EXIV2API bool enableBMFF(bool enable);
```
The return value from `enableBMFF()` is true if the library has been build with bmff support (cmake option -DEXIV2_ANABLE_BMFF=On).
The return value from `enableBMFF()` is true if the library has been build with BMFF support (cmake option -DEXIV2_ANABLE_BMFF=On).
Applications may wish to provide a preference setting to enable bmff support and thereby place the responsibility for the use of this code with the user of the application.
Applications may wish to provide a preference setting to enable BMFF support and thereby place the responsibility for the use of this code with the user of the application.
[TOC](#TOC)
<div id="3">
Expand Down
16 changes: 15 additions & 1 deletion man/man1/exiv2.1
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH EXIV2 1 "August 10, 2021"
.TH EXIV2 1 "November 02, 2022"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
Expand Down Expand Up @@ -53,6 +53,7 @@ HEIC Read Read Read - -
HEIF Read Read Read - -
JP2 Read/Write Read/Write Read/Write - Read/Write
JPEG Read/Write Read/Write Read/Write Read/Write Read/Write
JPEG XL Read Read Read - -
MRW Read Read Read - -
NEF Read/Write Read/Write Read/Write - Read/Write
ORF Read/Write Read/Write Read/Write - -
Expand All @@ -76,6 +77,19 @@ image are determined.
.IP \(bu 2
Reading other TIFF-like RAW image formats, which are not listed in the
table, may also work.
.IP \(bu 2
Support for BMFF file types such as CR3, HEIF, HEIC, AVIF, and
JPEG XL is a build option. To check if this is enabled, use:
.PP
.in +4n
.EX
$ exiv2 --version --verbose | grep bmff
enable_bmff=1
.EE
.in
.PP
.IP \(bu 2
Naked codestream JPEG XL files do not contain Exif, IPTC, or XMP metadata.
.SH ACTIONS
The \fIaction\fP argument is only required if it is not clear from the
\fIoptions\fP which action is implied.
Expand Down

0 comments on commit eae83b4

Please sign in to comment.