Merge branch 'master' of github.com:strukturag/libheif

examples/Makefile.am

@@ -9,11 +9,14 @@ examples_noinst = \
   heif-test \
   test-c-api
 
+dist_man_MANS =
+
 heif_convert_DEPENDENCIES = ../libheif/libheif.la
 heif_convert_CXXFLAGS = -I$(top_srcdir) -I$(top_builddir)/.
 heif_convert_LDFLAGS =
 heif_convert_LDADD = ../libheif/libheif.la
 heif_convert_SOURCES = encoder.cc encoder.h heif_convert.cc encoder_y4m.cc encoder_y4m.h
+dist_man_MANS += heif-convert.1
 
 
 if HAVE_LIBPNG
@@ -23,6 +26,7 @@ heif_thumbnailer_CXXFLAGS = -I$(top_srcdir) -I$(top_builddir) $(libpng_CFLAGS)
 heif_thumbnailer_LDFLAGS = $(libpng_LIBS)
 heif_thumbnailer_LDADD = ../libheif/libheif.la
 heif_thumbnailer_SOURCES = encoder.cc encoder.h heif_thumbnailer.cc encoder_png.cc encoder_png.h
+dist_man_MANS += heif-thumbnailer.1
 endif
 
 if HAVE_LIBJPEG
@@ -42,12 +46,14 @@ heif_info_CXXFLAGS = -I$(top_srcdir) -I$(top_builddir)
 heif_info_LDFLAGS =
 heif_info_LDADD = ../libheif/libheif.la
 heif_info_SOURCES = heif_info.cc
+dist_man_MANS += heif-info.1
 
 heif_enc_DEPENDENCIES = ../libheif/libheif.la
 heif_enc_CXXFLAGS = -I$(top_srcdir) -I$(top_builddir)
 heif_enc_LDFLAGS =
 heif_enc_LDADD = ../libheif/libheif.la
 heif_enc_SOURCES = heif_enc.cc
+dist_man_MANS += heif-enc.1
 
 if HAVE_LIBJPEG
 heif_enc_CXXFLAGS += $(libjpeg_CFLAGS)

examples/heif-convert.1

@@ -0,0 +1,38 @@
+.TH HEIF-THUMBNAILER 1
+.SH NAME
+heif-convert \- convert HEIC/HEIF image
+.SH SYNOPSIS
+.B heif-convert
+[\fB\-q\fR \fIQUALITY\fR]
+.IR filename
+.IR output[.jpg|.png|.y4m]
+.SH DESCRIPTION
+.B heif-convert
+Convert HEIC/HEIF image to a different image format.
+.SH OPTIONS
+.TP
+.BR \-q\fR\ \fIQUALITY\fR
+Defines quality level between 0 and 100 for the generated output file.
+.SH EXIT STATUS
+.PP
+\fB0\fR
+.RS 4
+Success
+.RE
+.PP
+\fB1\fR
+.RS 4
+Failure (syntax or usage error; error while loading, converting or writing image).
+.RE
+.SH NOTES
+The available output formats depend on the libraries that were available at
+compile time. Supported are JPEG, PNG and Y4M, the file type is determined based
+on the extension of the output file.
+.SH BUGS
+Please reports bugs or issues at https://github.com/strukturag/libheif
+.SH AUTHORS
+Joachim Bauch, struktur AG
+.br
+Dirk Farin, struktur AG
+.SH COPYRIGHT
+Copyright \[co] 2017 struktur AG

examples/heif-enc.1

@@ -0,0 +1,82 @@
+.TH HEIF-ENC 1
+.SH NAME
+heif-enc \- convert image to HEIC/HEIF
+.SH SYNOPSIS
+.B heif-enc
+[\fB\-h\fR|\fB--help\fR]
+[\fB\-q\fR \fIQUALITY\fR|\fB--quality\fR \fIQUALITY\fR]
+[\fB\-L\fR|\fB--lossless\fR]
+[\fB\-t\fR \fISIZE\fR|\fB--thumb\fR \fISIZE\fR]
+[\fB--no-alpha\fR]
+[\fB--no-thumb-alpha\fR]
+[\fB\-o\fR \fIFILENAME\fR|\fB--output\fR \fIFILENAME\fR]
+[\fB\-v\fR|\fB--verbose\fR]
+[\fB\-P\fR|\fB--params\fR]
+[\fB\-b\fR \fIDEPTH\fR]
+[\fB\-p\fR \fINAME\fR\fB=\fR\fIVALUE\fR]
+.IR filename[.jpg|.png|.y4m]
+.SH DESCRIPTION
+.B heif-enc
+Convert image to HEIC/HEIF.
+.SH OPTIONS
+.TP
+.BR \-q\fR\ \fIQUALITY\fR ", " \-\-quality\fR\ \fIQUALITY\fR
+Defines quality level between 0 and 100 for the generated output file.
+.TP
+.BR \-L ", "\-\-lossless\fR
+Generate lossless output (\fB-q\fR has no effect)
+.TP
+.BR \-t\fR\ \fISIZE\fR ", " \-\-thumb\fR\ \fISIZE\fR
+Generate thumbnail with maximum size \fISIZE\fR pixels (default: off).
+.TP
+.BR \-\-no-alpha\fR
+Do not save alpha channel.
+.TP
+.BR \-\-no-thumb-alpha\fR
+Do not save alpha channel in thumbnail image.
+.TP
+.BR \-o\fR\ \fIFILENAME\fR ", " \-\-output\fR\ \fIFILENAME\fR
+Output filename (optional).
+.TP
+.BR \-v ", "\-\-verbose\fR
+Enable logging output (more \fB\-v\fR will increase logging level).
+.TP
+.BR \-P ", "\-\-params\fR
+Show all encoder parameters.
+.TP
+.BR \-b\fR\ \fIDEPTH\fR
+Bit-depth of generated HEIF file when using 16-bit PNG input (default: 10 bit).
+.TP
+.BR \-p\fR\ \fINAME\fR\fB=\fR\fIVALUE\fR
+Set additional encoder parameters. See \fBNOTES\fR below.
+.SH EXIT STATUS
+.PP
+\fB0\fR
+.RS 4
+Success
+.RE
+.PP
+\fB1\fR
+.RS 4
+Failure (syntax or usage error; error while loading, converting or writing image).
+.RE
+.SH NOTES
+The available input formats depend on the libraries that were available at
+compile time. Supported are JPEG, PNG and Y4M, the file type is determined based
+on the extension of the input file.
+
+When specifying multiple source images, they will all be saved into the same
+HEIF file.
+
+When using the x265 encoder, you may pass it any of its parameters by
+prefixing the parameter name with \fBx265:\fR.
+Hence, to set the \fBctu\fR parameter, you will have to set \fBx265:ctu\fR
+in libheif (e.g.: \fB-p x265:ctu=64\fR).
+
+Note that there is no checking for valid parameters when using the prefix.
+.SH BUGS
+Please reports bugs or issues at https://github.com/strukturag/libheif
+.SH AUTHORS
+Dirk Farin, struktur AG
+.SH COPYRIGHT
+Copyright \[co] 2017 struktur AG

examples/heif-info.1

@@ -0,0 +1,35 @@
+.TH HEIF-INFO 1
+.SH NAME
+heif-info \- show information on HEIC/HEIF file
+.SH SYNOPSIS
+.B heif-info
+[\fB\-d\fR|\fB--dump-boxes\fR]
+[\fB\-h\fR|\fB--help\fR]
+.IR filename
+.SH DESCRIPTION
+.B heif-info
+Show information on HEIC/HEIF file.
+.SH OPTIONS
+.TP
+.BR \-d ", " \-\-dump-boxes\fR
+Show a low-level dump of all MP4 file boxes.
+.TP
+.BR \-help ", " \-\-help\fR
+Show help.
+.SH EXIT STATUS
+.PP
+\fB0\fR
+.RS 4
+Success
+.RE
+.PP
+\fB1\fR
+.RS 4
+Failure (syntax or usage error; error while loading image).
+.RE
+.SH BUGS
+Please reports bugs or issues at https://github.com/strukturag/libheif
+.SH AUTHORS
+Dirk Farin, struktur AG
+.SH COPYRIGHT
+Copyright \[co] 2017 struktur AG

examples/heif-thumbnailer.1

@@ -0,0 +1,33 @@
+.TH HEIF-THUMBNAILER 1
+.SH NAME
+heif-thumbnailer \- create thumbnails from HEIC/HEIF files
+.SH SYNOPSIS
+.B heif-thumbnailer
+[\fB\-s\fR \fISIZE\fR]
+.IR filename
+.IR output
+.SH DESCRIPTION
+.B heif-thumbnailer
+Create thumbnail images from HEIC/HEIF files that can be used for example by Nautilus.
+.SH OPTIONS
+.TP
+.BR \-s\fR\ \fISIZE\fR
+Defines the maximum width and height of the thumbnail to generate.
+Default is 512 pixel.
+.SH EXIT STATUS
+.PP
+\fB0\fR
+.RS 4
+Success
+.RE
+.PP
+\fB1\fR
+.RS 4
+Failure (syntax or usage error; error while loading, converting or writing image).
+.RE
+.SH BUGS
+Please reports bugs or issues at https://github.com/strukturag/libheif
+.SH AUTHORS
+Dirk Farin, struktur AG
+.SH COPYRIGHT
+Copyright \[co] 2018 struktur AG