/*****************************************************************************

 * picture.c : picture management functions

 *****************************************************************************

 * Copyright (C) 2000-2010 VLC authors and VideoLAN

 * Copyright (C) 2009-2010 Laurent Aimar

 *

 * Authors: Vincent Seguin <seguin@via.ecp.fr>

 *          Samuel Hocevar <sam@zoy.org>

 *          Laurent Aimar <fenrir _AT_ videolan _DOT_ org>

 *

 * This program 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.1 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.

 *****************************************************************************/

/*****************************************************************************

 * Preamble

 *****************************************************************************/

#ifdef HAVE_CONFIG_H

# include "config.h"

#endif

#include <assert.h>

#include <limits.h>

#include <stdckdint.h>

#include <vlc_common.h>

#include "picture.h"

#include <vlc_image.h>

#include <vlc_block.h>

#include <vlc_ancillary.h>

static void PictureDestroyContext( picture_t *p_picture )

{

    picture_context_t *ctx = p_picture->context;

    if (ctx != NULL)

    {

        vlc_video_context *vctx = ctx->vctx;

        ctx->destroy(ctx);

        if (vctx)

            vlc_video_context_Release(vctx);

        p_picture->context = NULL;

    }

}

/**

 * Destroys a picture allocated by picture_NewFromResource() but without

 * a custom destruction callback.

 */

static void picture_DestroyDummy( picture_t *p_picture )

{

    (void) p_picture;

}

/**

 * Destroys a picture allocated with picture_NewFromFormat().

 */

static void picture_DestroyFromFormat(picture_t *pic)

{

    picture_buffer_t *res = pic->p_sys;

    if (res != NULL)

        picture_Deallocate(res->fd, res->base, res->size);

}

VLC_WEAK void *picture_Allocate(int *restrict fdp, size_t size)

{

    assert((size % 64) == 0);

    *fdp = -1;

    return aligned_alloc(64, size);

}

VLC_WEAK void picture_Deallocate(int fd, void *base, size_t size)

{

    assert(fd == -1);

    aligned_free(base);

    assert((size % 64) == 0);

}

/*****************************************************************************

 *

 *****************************************************************************/

void picture_Reset( picture_t *p_picture )

{

    /* */

    p_picture->date = VLC_TICK_INVALID;

    p_picture->b_force = false;

    p_picture->b_still = false;

    p_picture->b_progressive = false;

    p_picture->i_nb_fields = 2;

    p_picture->b_top_field_first = false;

    PictureDestroyContext( p_picture );

    picture_priv_t *priv = container_of(p_picture, picture_priv_t, picture);

    vlc_ancillary_array_Clear(&priv->ancillaries);

}

/*****************************************************************************

 *

 *****************************************************************************/

static int LCM( int a, int b )

{

    return a * b / GCD( a, b );

}

int picture_Setup( picture_t *p_picture, const video_format_t *restrict fmt )

{

    const vlc_chroma_description_t *p_dsc =

        vlc_fourcc_GetChromaDescription( fmt->i_chroma );

    if( unlikely(!p_dsc) )

        return VLC_EGENERIC;

    /* Store default values */

    p_picture->i_planes = 0;

    for( unsigned i = 0; i < ARRAY_SIZE(p_picture->p); i++ )

    {

        plane_t *p = &p_picture->p[i];

        p->p_pixels = NULL;

        p->i_pixel_pitch = 0;

    }

    p_picture->i_nb_fields = 2;

    video_format_Setup( &p_picture->format, fmt->i_chroma, fmt->i_width, fmt->i_height,

                        fmt->i_visible_width, fmt->i_visible_height,

                        fmt->i_sar_num, fmt->i_sar_den );

    if( fmt->i_x_offset < fmt->i_width &&

        fmt->i_y_offset < fmt->i_height &&

        fmt->i_visible_width  > 0 && fmt->i_x_offset + fmt->i_visible_width  <= fmt->i_width &&

        fmt->i_visible_height > 0 && fmt->i_y_offset + fmt->i_visible_height <= fmt->i_height )

        video_format_CopyCrop( &p_picture->format, fmt );

    /* We want V (width/height) to respect:

        (V * p_dsc->p[i].w.i_num) % p_dsc->p[i].w.i_den == 0

        (V * p_dsc->p[i].w.i_num/p_dsc->p[i].w.i_den * p_dsc->i_pixel_size) % 16 == 0

       Which is respected if you have

       V % lcm( p_dsc->p[0..planes].w.i_den * 16) == 0

    */

    unsigned i_modulo_w = 1;

    unsigned i_modulo_h = 1;

    unsigned i_ratio_h  = 1;

    for( unsigned i = 0; i < p_dsc->plane_count; i++ )

    {

        i_modulo_w = LCM( i_modulo_w, 64 * p_dsc->p[i].w.den );

        i_modulo_h = LCM( i_modulo_h, 16 * p_dsc->p[i].h.den );

        if( i_ratio_h < p_dsc->p[i].h.den )

            i_ratio_h = p_dsc->p[i].h.den;

    }

    i_modulo_h = LCM( i_modulo_h, 32 );

    unsigned width, height;

    if (unlikely(ckd_add(&width, fmt->i_width, i_modulo_w - 1))

     || unlikely(ckd_add(&height, fmt->i_height, i_modulo_h - 1)))

        return VLC_EGENERIC;

    width = width / i_modulo_w * i_modulo_w;

    height = height / i_modulo_h * i_modulo_h;

    /* plane_t uses 'int'. */

    if (unlikely(width > INT_MAX) || unlikely(height > INT_MAX))

        return VLC_EGENERIC;

    for( unsigned i = 0; i < p_dsc->plane_count; i++ )

    {

        plane_t *p = &p_picture->p[i];

        const vlc_rational_t *h = &p_dsc->p[i].h;

        const vlc_rational_t *w = &p_dsc->p[i].w;

        /* A plane cannot be over-sampled. This could lead to overflow. */

        assert(h->den >= h->num);

        assert(w->den >= w->num);

        p->i_lines = height * h->num / h->den;

        p->i_visible_lines = (fmt->i_visible_height + (h->den - 1)) / h->den * h->num;

        p->i_pitch = width * w->num / w->den * p_dsc->pixel_size;

        p->i_visible_pitch = (fmt->i_visible_width + (w->den - 1)) / w->den * w->num

                             * p_dsc->pixel_size;

        p->i_pixel_pitch = p_dsc->pixel_size;

        assert( (p->i_pitch % 64) == 0 );

    }

    p_picture->i_planes = p_dsc->plane_count;

    return VLC_SUCCESS;

}

/*****************************************************************************

 *

 *****************************************************************************/

static bool picture_InitPrivate(const video_format_t *restrict p_fmt,

                                picture_priv_t *priv,

                                const picture_resource_t *p_resource)

{

    picture_t *p_picture = &priv->picture;

    memset( p_picture, 0, sizeof( *p_picture ) );

    p_picture->date = VLC_TICK_INVALID;

    video_format_Copy(&p_picture->format, p_fmt);

    /* Make sure the real dimensions are a multiple of 16 */

    if( picture_Setup( p_picture, p_fmt ) )

    {

        video_format_Clean(&p_picture->format);

        return false;

    }

    vlc_atomic_rc_init(&p_picture->refs);

    priv->gc.opaque = NULL;

    p_picture->p_sys = p_resource->p_sys;

    if( p_resource->pf_destroy != NULL )

        priv->gc.destroy = p_resource->pf_destroy;

    else

        priv->gc.destroy = picture_DestroyDummy;

    priv->pool = NULL;

    vlc_ancillary_array_Init(&priv->ancillaries);

    return true;

}

picture_t *picture_NewFromResource( const video_format_t *p_fmt, const picture_resource_t *p_resource )

{

    assert(p_resource != NULL);

    picture_priv_t *priv = malloc(sizeof(*priv));

    if (unlikely(priv == NULL))

        return NULL;

    if (!picture_InitPrivate(p_fmt, priv, p_resource))

    {

        free(priv);

        return NULL;

    }

    picture_t *p_picture = &priv->picture;

    for( int i = 0; i < p_picture->i_planes; i++ )

    {

        p_picture->p[i].p_pixels = p_resource->p[i].p_pixels;

        p_picture->p[i].i_lines  = p_resource->p[i].i_lines;

        p_picture->p[i].i_pitch  = p_resource->p[i].i_pitch;

    }

    return p_picture;

}

#define PICTURE_SW_SIZE_MAX (UINT32_C(1) << 28) /* 256MB: 8K * 8K * 4*/

struct picture_priv_buffer_t {

    picture_priv_t   priv;

    picture_buffer_t res;

};

picture_t *picture_NewFromFormat(const video_format_t *restrict fmt)

{

    static_assert(offsetof(struct picture_priv_buffer_t, priv)==0,

                  "misplaced picture_priv_t, destroy won't work");

    struct picture_priv_buffer_t *privbuf = malloc(sizeof(*privbuf));

    if (unlikely(privbuf == NULL))

        return NULL;

    picture_buffer_t *res = &privbuf->res;

    picture_resource_t pic_res = {

        .p_sys = res,

        .pf_destroy = picture_DestroyFromFormat,

    };

    picture_priv_t *priv = &privbuf->priv;

    if (!picture_InitPrivate(fmt, priv, &pic_res))

        goto error;

    picture_t *pic = &priv->picture;

    if (pic->i_planes == 0) {

        pic->p_sys = NULL; // not compatible with picture_DestroyFromFormat

        return pic;

    }

    /* Calculate how big the new image should be */

    assert(pic->i_planes <= PICTURE_PLANE_MAX);

    size_t plane_sizes[PICTURE_PLANE_MAX];

    size_t pic_size = 0;

    for (int i = 0; i < pic->i_planes; i++)

    {

        const plane_t *p = &pic->p[i];

        if (unlikely(ckd_mul(&plane_sizes[i], p->i_pitch, p->i_lines))

         || unlikely(ckd_add(&pic_size, pic_size, plane_sizes[i])))

            goto error;

    }

    if (unlikely(pic_size >= PICTURE_SW_SIZE_MAX))

        goto error;

    unsigned char *buf = picture_Allocate(&res->fd, pic_size);

    if (unlikely(buf == NULL))

        goto error;

    res->base = buf;

    res->size = pic_size;

    res->offset = 0;

    /* Fill the p_pixels field for each plane */

    for (int i = 0; i < pic->i_planes; i++)

    {

        pic->p[i].p_pixels = buf;

        buf += plane_sizes[i];

    }

    return pic;

error:

    video_format_Clean(&priv->picture.format);

    free(privbuf);

    return NULL;

}

picture_t *picture_New( vlc_fourcc_t i_chroma, int i_width, int i_height, int i_sar_num, int i_sar_den )

{

    video_format_t fmt;

    video_format_Init( &fmt, 0 );

    video_format_Setup( &fmt, i_chroma, i_width, i_height,

                        i_width, i_height, i_sar_num, i_sar_den );

    return picture_NewFromFormat( &fmt );

}

/*****************************************************************************

 *

 *****************************************************************************/

void picture_Destroy(picture_t *picture)

{

    assert(vlc_atomic_rc_get(&picture->refs) == 0);

    PictureDestroyContext(picture);

    picture_priv_t *priv = container_of(picture, picture_priv_t, picture);

    assert(priv->gc.destroy != NULL);

    priv->gc.destroy(picture);

    vlc_ancillary_array_Clear(&priv->ancillaries);

    video_format_Clean(&picture->format);

    free(priv);

}

/*****************************************************************************

 *

 *****************************************************************************/

void plane_CopyPixels( plane_t *p_dst, const plane_t *p_src )

{

    const unsigned i_width  = __MIN( p_dst->i_visible_pitch,

                                     p_src->i_visible_pitch );

    const unsigned i_height = __MIN( p_dst->i_visible_lines,

                                     p_src->i_visible_lines );

    /* The 2x visible pitch check does two things:

       1) Makes field plane_t's work correctly (see the deinterlacer module)

       2) Moves less data if the pitch and visible pitch differ much.

    */

    if( p_src->i_pitch == p_dst->i_pitch  &&

        p_src->i_pitch < 2*p_src->i_visible_pitch )

    {

        /* There are margins, but with the same width : perfect ! */

        memcpy( p_dst->p_pixels, p_src->p_pixels,

                    p_src->i_pitch * i_height );

    }

    else

    {

        /* We need to proceed line by line */

        uint8_t *p_in = p_src->p_pixels;

        uint8_t *p_out = p_dst->p_pixels;

        assert( p_in );

        assert( p_out );

        for( int i_line = i_height; i_line--; )

        {

            memcpy( p_out, p_in, i_width );

            p_in += p_src->i_pitch;

            p_out += p_dst->i_pitch;

        }

    }

}

void picture_CopyProperties( picture_t *p_dst, const picture_t *p_src )

{

    p_dst->date = p_src->date;

    p_dst->b_force = p_src->b_force;

    p_dst->b_still = p_src->b_still;

    p_dst->b_progressive = p_src->b_progressive;

    p_dst->i_nb_fields = p_src->i_nb_fields;

    p_dst->b_top_field_first = p_src->b_top_field_first;

    const picture_priv_t *src_priv = container_of(p_src, picture_priv_t, picture);

    picture_priv_t *dst_priv = container_of(p_dst, picture_priv_t, picture);

    vlc_ancillary_array_Merge(&dst_priv->ancillaries, &src_priv->ancillaries);

}

void picture_CopyPixels( picture_t *p_dst, const picture_t *p_src )

{

    for( int i = 0; i < p_src->i_planes ; i++ )

        plane_CopyPixels( p_dst->p+i, p_src->p+i );

    assert( p_dst->context == NULL );

    if( p_src->context != NULL )

        p_dst->context = p_src->context->copy( p_src->context );

}

void picture_Copy( picture_t *p_dst, const picture_t *p_src )

{

    picture_CopyPixels( p_dst, p_src );

    picture_CopyProperties( p_dst, p_src );

}

static void picture_DestroyClone(picture_t *clone)

{

    picture_priv_t *clone_priv = container_of(clone, picture_priv_t, picture);

    picture_t *picture = clone_priv->gc.opaque;

    picture_Release(picture);

}

picture_t *picture_InternalClone(picture_t *picture,

                                 void (*pf_destroy)(picture_t *), void *opaque)

{

    picture_resource_t res = {

        .p_sys = picture->p_sys,

        .pf_destroy = pf_destroy,

    };

    for (int i = 0; i < picture->i_planes; i++) {

        res.p[i].p_pixels = picture->p[i].p_pixels;

        res.p[i].i_lines = picture->p[i].i_lines;

        res.p[i].i_pitch = picture->p[i].i_pitch;

    }

    picture_t *clone = picture_NewFromResource(&picture->format, &res);

    if (likely(clone != NULL)) {

        picture_priv_t *clone_priv = container_of(clone, picture_priv_t, picture);

        clone_priv->gc.opaque = opaque;

        /* The picture context is responsible for potentially holding the

         * video context attached to the picture if needed. */

        if (picture->context != NULL)

            clone->context = picture->context->copy(picture->context);

        picture_Hold(picture);

    }

    return clone;

}

picture_t *picture_Clone(picture_t *picture)

{

    picture_t *clone = picture_InternalClone(picture, picture_DestroyClone, picture);

    if (clone == NULL)

        return NULL;

    const picture_priv_t *priv = container_of(picture, picture_priv_t, picture);

    picture_priv_t *clone_priv = container_of(clone, picture_priv_t, picture);

    vlc_ancillary_array_Merge(&clone_priv->ancillaries, &priv->ancillaries);

    return clone;

}

int

picture_MergeAncillaries(picture_t *pic, const vlc_ancillary_array *src_array)

{

    picture_priv_t *priv = container_of(pic, picture_priv_t, picture);

    return vlc_ancillary_array_Merge(&priv->ancillaries, src_array);

}

int

picture_MergeAndClearAncillaries(picture_t *pic, vlc_ancillary_array *src_array)

{

    picture_priv_t *priv = container_of(pic, picture_priv_t, picture);

    return vlc_ancillary_array_MergeAndClear(&priv->ancillaries, src_array);

}

int

picture_AttachAncillary(picture_t *pic, struct vlc_ancillary *ancillary)

{

    picture_priv_t *priv = container_of(pic, picture_priv_t, picture);

    return vlc_ancillary_array_Insert(&priv->ancillaries, ancillary);

}

void *

picture_AttachNewAncillary(picture_t *pic, vlc_ancillary_id id, size_t size)

{

    void *data = malloc(size);

    if (!data)

        return NULL;

    struct vlc_ancillary *ancillary = vlc_ancillary_Create(data, id);

    if (!ancillary) {

        free(data);

        return NULL;

    }

    if (picture_AttachAncillary(pic, ancillary) != 0) {

        vlc_ancillary_Release(ancillary);

        return NULL;

    }

    vlc_ancillary_Release(ancillary);

    return data;

}

struct vlc_ancillary *

picture_GetAncillary(const picture_t *pic, vlc_ancillary_id id)

{

    picture_priv_t *priv = container_of(pic, picture_priv_t, picture);

    return vlc_ancillary_array_Get(&priv->ancillaries, id);

}

/*****************************************************************************

 *

 *****************************************************************************/

int picture_Export( vlc_object_t *p_obj,

                    block_t **pp_image,

                    video_format_t *p_fmt,

                    picture_t *p_picture,

                    vlc_fourcc_t i_codec,

                    int i_override_width, int i_override_height,

                    bool b_crop )

{

    /* */

    video_format_t fmt_in = p_picture->format;

    if( fmt_in.i_sar_num <= 0 || fmt_in.i_sar_den <= 0 )

    {

        fmt_in.i_sar_num =

        fmt_in.i_sar_den = 1;

    }

    /* */

    video_format_t fmt_out;

    memset( &fmt_out, 0, sizeof(fmt_out) );

    fmt_out.i_sar_num =

    fmt_out.i_sar_den = 1;

    /* compute original width/height */

    unsigned int i_width, i_height, i_original_width, i_original_height;

    if( fmt_in.i_visible_width > 0 && fmt_in.i_visible_height > 0 )

    {

        i_width = fmt_in.i_visible_width;

        i_height = fmt_in.i_visible_height;

    }

    else

    {

        i_width = fmt_in.i_width;

        i_height = fmt_in.i_height;

    }

    if( fmt_in.i_sar_num >= fmt_in.i_sar_den )

    {

        i_original_width = (int64_t)i_width * fmt_in.i_sar_num / fmt_in.i_sar_den;

        i_original_height = i_height;

    }

    else

    {

        i_original_width =  i_width;

        i_original_height = i_height * fmt_in.i_sar_den / fmt_in.i_sar_num;

    }

    /* */

    if( b_crop && i_override_width > 0 && i_override_height > 0 )

    {

        float f_ar_dest = (float)i_override_width / i_override_height;

        float f_ar_src = (float)i_width / i_height;

        unsigned int i_crop_width, i_crop_height;

        if ( f_ar_dest > f_ar_src )

        {

            i_crop_width = i_width;

            i_crop_height = (float)i_crop_width / f_ar_dest;

        }

        else

        {

            i_crop_height = i_height;

            i_crop_width = (float)i_crop_height * f_ar_dest;

        }

        fmt_out.i_width = i_override_width;

        fmt_out.i_height = i_override_height;

        fmt_in.i_visible_width = i_crop_width;

        fmt_in.i_visible_height = i_crop_height;

        fmt_in.i_x_offset += (i_width - i_crop_width) / 2;

        fmt_in.i_y_offset += (i_height - i_crop_height) / 2;

    }

    else

    {

        fmt_out.i_width  = ( i_override_width < 0 ) ?

                           i_original_width : (unsigned)i_override_width;

        fmt_out.i_height = ( i_override_height < 0 ) ?

                           i_original_height : (unsigned)i_override_height;

    }

    /* scale if only one direction is provided */

    if( fmt_out.i_height == 0 && fmt_out.i_width > 0 )

    {

        fmt_out.i_height = i_height * fmt_out.i_width

                         * fmt_in.i_sar_den / fmt_in.i_width / fmt_in.i_sar_num;

    }

    else if( fmt_out.i_width == 0 && fmt_out.i_height > 0 )

    {

        fmt_out.i_width  = i_width * fmt_out.i_height

                         * fmt_in.i_sar_num / fmt_in.i_height / fmt_in.i_sar_den;

    }

    fmt_out.i_visible_width = fmt_out.i_width;

    fmt_out.i_visible_height = fmt_out.i_height;

    image_handler_t *p_image = image_HandlerCreate( p_obj );

    if( !p_image )

        return VLC_ENOMEM;

    vlc_tick_t date = p_picture->date;

    block_t *p_block = image_Write( p_image, p_picture, &fmt_in, i_codec, &fmt_out );

    image_HandlerDelete( p_image );

    if( !p_block )

        return VLC_EGENERIC;

    p_block->i_pts =

    p_block->i_dts = date;

    if( p_fmt )

        *p_fmt = fmt_out;

    *pp_image = p_block;

    return VLC_SUCCESS;

}