libvips/libvips/foreign/heifsave.c

439 lines
10 KiB
C

/* save to heif
*
* 5/7/18
* - from niftisave.c
*/
/*
This file is part of VIPS.
VIPS is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301 USA
*/
/*
These files are distributed with VIPS - http://www.vips.ecs.soton.ac.uk
*/
/*
#define DEBUG_VERBOSE
#define DEBUG
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif /*HAVE_CONFIG_H*/
#include <vips/intl.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <vips/vips.h>
#include <vips/internal.h>
#ifdef HAVE_HEIF
#include <libheif/heif.h>
#include "pforeign.h"
typedef struct _VipsForeignSaveHeif {
VipsForeignSave parent_object;
/* Filename for save.
*/
char *filename;
/* Coding quality factor (1-100).
*/
int Q;
/* Lossless compression.
*/
gboolean lossless;
int page_width;
int page_height;
int n_pages;
struct heif_context *ctx;
struct heif_encoder *encoder;
/* The current page we are writing.
*/
struct heif_image_handle *handle;
/* The current page in memory which we build as we scan down the
* image.
*/
struct heif_image *img;
/* The libheif memory area will fill with pixels from the libvips
* pipe.
*/
uint8_t *data;
int stride;
} VipsForeignSaveHeif;
typedef VipsForeignSaveClass VipsForeignSaveHeifClass;
G_DEFINE_TYPE( VipsForeignSaveHeif, vips_foreign_save_heif,
VIPS_TYPE_FOREIGN_SAVE );
static void
vips_foreign_save_heif_dispose( GObject *gobject )
{
VipsForeignSaveHeif *heif = (VipsForeignSaveHeif *) gobject;
VIPS_FREEF( heif_image_release, heif->img );
VIPS_FREEF( heif_image_handle_release, heif->handle );
VIPS_FREEF( heif_encoder_release, heif->encoder );
VIPS_FREEF( heif_context_free, heif->ctx );
G_OBJECT_CLASS( vips_foreign_save_heif_parent_class )->
dispose( gobject );
}
typedef struct heif_error (*libheif_metadata_fn)( struct heif_context *,
const struct heif_image_handle *,
const void *, int );
struct _VipsForeignSaveHeifMetadata {
const char *name;
libheif_metadata_fn saver;
} libheif_metadata[] = {
{ VIPS_META_EXIF_NAME, heif_context_add_exif_metadata },
{ VIPS_META_XMP_NAME, heif_context_add_XMP_metadata }
};
static int
vips_foreign_save_heif_write_page( VipsForeignSaveHeif *heif )
{
VipsForeignSave *save = (VipsForeignSave *) heif;
struct heif_encoding_options *options;
struct heif_error error;
int i;
if( vips_image_get_typeof( save->ready, VIPS_META_ICC_NAME ) ) {
const void *data;
size_t length;
#ifdef DEBUG
printf( "attaching profile ..\n" );
#endif /*DEBUG*/
if( vips_image_get_blob( save->ready,
VIPS_META_ICC_NAME, &data, &length ) )
return( -1 );
/* FIXME .. also see heif_image_set_nclx_color_profile()
*/
error = heif_image_set_raw_color_profile( heif->img,
"rICC", data, length );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
}
options = heif_encoding_options_alloc();
/* FIXME .. should be an option, though I don't know of any way to
* test it
*/
options->save_alpha_channel = 1;
#ifdef DEBUG
printf( "encoding ..\n" );
#endif /*DEBUG*/
error = heif_context_encode_image( heif->ctx,
heif->img, heif->encoder, NULL, &heif->handle );
heif_encoding_options_free( options );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
/* FIXME ... do this for heif-primary.
error = heif_context_set_primary_image( heif->ctx, heif->handle );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
*/
for( i = 0; i < VIPS_NUMBER( libheif_metadata ); i++ )
if( vips_image_get_typeof( save->ready,
libheif_metadata[i].name ) ) {
const void *data;
size_t length;
#ifdef DEBUG
printf( "attaching %s ..\n",
libheif_metadata[i].name );
#endif /*DEBUG*/
if( vips_image_get_blob( save->ready,
VIPS_META_EXIF_NAME, &data, &length ) )
return( -1 );
error = libheif_metadata[i].saver( heif->ctx,
heif->handle, data, length );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
}
VIPS_FREEF( heif_image_handle_release, heif->handle );
return( 0 );
}
static int
vips_foreign_save_heif_write_block( VipsRegion *region, VipsRect *area,
void *a )
{
VipsForeignSaveHeif *heif = (VipsForeignSaveHeif *) a;
int y;
#ifdef DEBUG
printf( "vips_foreign_save_heif_write_block: y = %d\n", area->top );
#endif /*DEBUG*/
/* Copy a line at a time into our output image, write each time the
* image fills.
*/
for( y = 0; y < area->height; y++ ) {
/* Y in page.
*/
int line = (area->top + y) % heif->page_height;
VipsPel *p = VIPS_REGION_ADDR( region, 0, area->top + y );
VipsPel *q = heif->data + line * heif->stride;
memcpy( q, p, VIPS_IMAGE_SIZEOF_LINE( region->im ) );
/* Did we just write the final line? Write as a new page
* into the output.
*/
if( line == heif->page_height - 1 )
if( vips_foreign_save_heif_write_page( heif ) )
return( -1 );
}
return( 0 );
}
static int
vips_foreign_save_heif_build( VipsObject *object )
{
VipsForeignSave *save = (VipsForeignSave *) object;
VipsForeignSaveHeif *heif = (VipsForeignSaveHeif *) object;
struct heif_error error;
if( VIPS_OBJECT_CLASS( vips_foreign_save_heif_parent_class )->
build( object ) )
return( -1 );
/* TODO ... should be a param? the other useful one is AVC.
*/
error = heif_context_get_encoder_for_format( heif->ctx,
heif_compression_HEVC, &heif->encoder );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
error = heif_encoder_set_lossy_quality( heif->encoder, heif->Q );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
error = heif_encoder_set_lossless( heif->encoder, heif->lossless );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
/* TODO .. support extra per-encoder params with
* heif_encoder_list_parameters().
*/
heif->page_width = save->ready->Xsize;
if( vips_image_get_typeof( save->ready, VIPS_META_PAGE_HEIGHT ) ) {
if( vips_image_get_int( save->ready,
VIPS_META_PAGE_HEIGHT, &heif->page_height ) )
return( -1 );
}
else
heif->page_height = save->ready->Ysize;
if( heif->page_height == 0 ||
save->ready->Ysize % heif->page_height != 0 )
heif->page_height = save->ready->Ysize;
heif->n_pages = save->ready->Ysize / heif->page_height;
/* Make a heif image the size of a page. We repeatedly fill this with
* sink_disc() and write a frame each time it fills.
*/
error = heif_image_create( heif->page_width, heif->page_height,
heif_colorspace_RGB, heif_chroma_interleaved_RGB, &heif->img );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
error = heif_image_add_plane( heif->img, heif_channel_interleaved,
heif->page_width, heif->page_height, 24 );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
heif->data = heif_image_get_plane( heif->img,
heif_channel_interleaved, &heif->stride );
/* Just do this once, so we don't rebuild exif on every page.
*/
if( vips_image_get_typeof( save->ready, VIPS_META_EXIF_NAME ) )
if( vips__exif_update( save->ready ) )
return( -1 );
/* Write data.
*/
if( vips_sink_disc( save->ready,
vips_foreign_save_heif_write_block, heif ) )
return( -1 );
/* This has to come right at the end :-( so there's no support for
* incremental writes.
*/
error = heif_context_write_to_file( heif->ctx, heif->filename );
if( error.code ) {
vips__heif_error( &error );
return( -1 );
}
return( 0 );
}
/* Save a bit of typing.
*/
#define UC VIPS_FORMAT_UCHAR
static int vips_heif_bandfmt[10] = {
/* UC C US S UI I F X D DX */
UC, UC, UC, UC, UC, UC, UC, UC, UC, UC
};
static void
vips_foreign_save_heif_class_init( VipsForeignSaveHeifClass *class )
{
GObjectClass *gobject_class = G_OBJECT_CLASS( class );
VipsObjectClass *object_class = (VipsObjectClass *) class;
VipsForeignClass *foreign_class = (VipsForeignClass *) class;
VipsForeignSaveClass *save_class = (VipsForeignSaveClass *) class;
gobject_class->dispose = vips_foreign_save_heif_dispose;
gobject_class->set_property = vips_object_set_property;
gobject_class->get_property = vips_object_get_property;
object_class->nickname = "heifsave";
object_class->description = _( "save image to heif file" );
object_class->build = vips_foreign_save_heif_build;
foreign_class->suffs = vips__heif_suffs;
save_class->saveable = VIPS_SAVEABLE_RGB;
save_class->format_table = vips_heif_bandfmt;
VIPS_ARG_STRING( class, "filename", 1,
_( "Filename" ),
_( "Filename to save to" ),
VIPS_ARGUMENT_REQUIRED_INPUT,
G_STRUCT_OFFSET( VipsForeignSaveHeif, filename ),
NULL );
VIPS_ARG_INT( class, "Q", 10,
_( "Q" ),
_( "Q factor" ),
VIPS_ARGUMENT_OPTIONAL_INPUT,
G_STRUCT_OFFSET( VipsForeignSaveHeif, Q ),
1, 100, 30 );
VIPS_ARG_BOOL( class, "lossless", 13,
_( "Lossless" ),
_( "Enable lossless compression" ),
VIPS_ARGUMENT_OPTIONAL_INPUT,
G_STRUCT_OFFSET( VipsForeignSaveHeif, lossless ),
FALSE );
}
static void
vips_foreign_save_heif_init( VipsForeignSaveHeif *heif )
{
heif->ctx = heif_context_alloc();
heif->Q = 30;
}
#endif /*HAVE_HEIF*/
/**
* vips_heifsave: (method)
* @in: image to save
* @filename: file to write to
* @...: %NULL-terminated list of optional named arguments
*
* Optional arguments:
*
* * @Q: %gint, quality factor
* * @lossless: %gboolean, enable lossless encoding
*
* Write a VIPS image to a file in HEIF format.
*
* Use @Q to set the compression factor. Default 30, which gives roughly the
* same quality as JPEG Q 75.
*
* Set @lossless %TRUE to switch to lossless compression.
*
* See also: vips_image_write_to_file(), vips_heifload().
*
* Returns: 0 on success, -1 on error.
*/
int
vips_heifsave( VipsImage *in, const char *filename, ... )
{
va_list ap;
int result;
va_start( ap, filename );
result = vips_call_split( "heifsave", ap, in, filename );
va_end( ap );
return( result );
}