144523647c2f8c48caaf862f4358af17df2e5f06
[vlc.git] / modules / video_filter / deinterlace / common.h
1 /*****************************************************************************
2  * common.h : Common macros for the VLC deinterlacer
3  *****************************************************************************
4  * Copyright (C) 2000-2017 VLC authors and VideoLAN
5  *
6  * Author: Sam Hocevar <sam@zoy.org>
7  *         Steve Lhomme <robux4@gmail.com>
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 #ifndef VLC_DEINTERLACE_COMMON_H
25 #define VLC_DEINTERLACE_COMMON_H 1
26
27 #include <vlc_common.h>
28 #include <vlc_filter.h>
29
30 #include <assert.h>
31
32 /**
33  * \file
34  * Common macros for the VLC deinterlacer.
35  */
36
37 /* Needed for Yadif, but also some others. */
38 #define FFMAX(a,b)      __MAX(a,b)
39 #define FFMAX3(a,b,c)   FFMAX(FFMAX(a,b),c)
40 #define FFMIN(a,b)      __MIN(a,b)
41 #define FFMIN3(a,b,c)   FFMIN(FFMIN(a,b),c)
42
43 /**
44  * Metadata history structure, used for framerate doublers.
45  * This is used for computing field duration in Deinterlace().
46  * @see Deinterlace()
47  */
48 typedef struct {
49     vlc_tick_t pi_date;
50     int     pi_nb_fields;
51     bool    pb_top_field_first;
52 } metadata_history_t;
53
54 #define METADATA_SIZE (3)
55 #define HISTORY_SIZE (3)
56
57 typedef struct  {
58     bool b_double_rate;       /**< Shall we double the framerate? */
59     bool b_use_frame_history; /**< Use the input frame history buffer? */
60     bool b_custom_pts;        /**< for inverse telecine */
61     bool b_half_height;       /**< Shall be divide the height by 2 */
62 } deinterlace_algo;
63
64 struct deinterlace_ctx
65 {
66     /* Algorithm behaviour flags */
67     deinterlace_algo   settings;
68
69     /**
70      * Metadata history (PTS, nb_fields, TFF). Used for framerate doublers.
71      * @see metadata_history_t
72      */
73     metadata_history_t meta[METADATA_SIZE];
74
75     /** Output frame timing / framerate doubler control
76         (see extra documentation in deinterlace.h) */
77     int i_frame_offset;
78
79     /** Input frame history buffer for algorithms with temporal filtering. */
80     picture_t *pp_history[HISTORY_SIZE];
81
82     union {
83         /**
84          * @param i_order Temporal field number: 0 = first, 1 = second, 2 = repeat first.
85          * @param i_field Keep which field? 0 = top field, 1 = bottom field.
86          */
87         int (*pf_render_ordered)(filter_t *, picture_t *p_dst, picture_t *p_pic,
88                                  int order, int i_field);
89         int (*pf_render_single_pic)(filter_t *, picture_t *p_dst, picture_t *p_pic);
90     };
91 };
92
93 #define DEINTERLACE_DST_SIZE 3
94
95 void InitDeinterlacingContext( struct deinterlace_ctx * );
96
97 /**
98  * @brief Get the field duration based on the previous fields or the frame rate
99  * @param fmt output format of the deinterlacer with the frame rate
100  * @param p_pic the picture which field we want the duration
101  * @return the duration of the field or 0 if there's no known framerate
102  */
103 vlc_tick_t GetFieldDuration( const struct deinterlace_ctx *,
104                           const video_format_t *fmt, const picture_t *p_pic );
105
106 /**
107  * @brief Get the output video_format_t configured for the deinterlacer
108  * @param p_dst video_format_t to fill
109  * @param p_src source video_format_t
110  */
111 void GetDeinterlacingOutput( const struct deinterlace_ctx *,
112                              video_format_t *p_dst, const video_format_t *p_src );
113
114 /**
115  * @brief Do the deinterlacing of the picture using pf_render_ordered() or pf_render_single_pic() calls.
116  * @return The deinterlaced picture or NULL if it failed
117  */
118 picture_t *DoDeinterlacing( filter_t *, struct deinterlace_ctx *, picture_t * );
119
120 /**
121  * @brief Flush the deinterlacer context
122  */
123 void FlushDeinterlacing( struct deinterlace_ctx * );
124
125 picture_t *AllocPicture( filter_t * );
126
127 #endif