cli: Use memory-mapped input frames for yuv and y4m
[x264/x264-sandbox.git] / input / input.h
1 /*****************************************************************************
2  * input.h: file input
3  *****************************************************************************
4  * Copyright (C) 2003-2015 x264 project
5  *
6  * Authors: Laurent Aimar <fenrir@via.ecp.fr>
7  *          Loren Merritt <lorenm@u.washington.edu>
8  *          Steven Walters <kemuri9@gmail.com>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111, USA.
23  *
24  * This program is also available under a commercial proprietary license.
25  * For more information, contact us at licensing@x264.com.
26  *****************************************************************************/
27
28 #ifndef X264_INPUT_H
29 #define X264_INPUT_H
30
31 #include "x264cli.h"
32
33 /* options that are used by only some demuxers */
34 typedef struct
35 {
36     char *index_file;
37     char *format;
38     char *resolution;
39     char *colorspace;
40     int bit_depth;
41     char *timebase;
42     int seek;
43     int progress;
44     int output_csp; /* convert to this csp, if applicable */
45     int output_range; /* user desired output range */
46     int input_range; /* user override input range */
47 } cli_input_opt_t;
48
49 /* properties of the source given by the demuxer */
50 typedef struct
51 {
52     int csp;         /* colorspace of the input */
53     uint32_t fps_num;
54     uint32_t fps_den;
55     int fullrange;   /* has 2^bit_depth-1 instead of 219*2^(bit_depth-8) ranges (YUV only) */
56     int width;
57     int height;
58     int interlaced;
59     int num_frames;
60     uint32_t sar_width;
61     uint32_t sar_height;
62     int tff;
63     int thread_safe; /* demuxer is thread_input safe */
64     uint32_t timebase_num;
65     uint32_t timebase_den;
66     int vfr;
67 } video_info_t;
68
69 /* image data type used by x264cli */
70 typedef struct
71 {
72     int     csp;       /* colorspace */
73     int     width;     /* width of the picture */
74     int     height;    /* height of the picture */
75     int     planes;    /* number of planes */
76     uint8_t *plane[4]; /* pointers for each plane */
77     int     stride[4]; /* strides for each plane */
78 } cli_image_t;
79
80 typedef struct
81 {
82     cli_image_t img;
83     int64_t pts;       /* input pts */
84     int64_t duration;  /* frame duration - used for vfr */
85     void    *opaque;   /* opaque handle */
86 } cli_pic_t;
87
88 typedef struct
89 {
90     int (*open_file)( char *psz_filename, hnd_t *p_handle, video_info_t *info, cli_input_opt_t *opt );
91     int (*picture_alloc)( cli_pic_t *pic, hnd_t handle, int csp, int width, int height );
92     int (*read_frame)( cli_pic_t *pic, hnd_t handle, int i_frame );
93     int (*release_frame)( cli_pic_t *pic, hnd_t handle );
94     void (*picture_clean)( cli_pic_t *pic, hnd_t handle );
95     int (*close_file)( hnd_t handle );
96 } cli_input_t;
97
98 extern const cli_input_t raw_input;
99 extern const cli_input_t y4m_input;
100 extern const cli_input_t avs_input;
101 extern const cli_input_t thread_input;
102 extern const cli_input_t lavf_input;
103 extern const cli_input_t ffms_input;
104 extern const cli_input_t timecode_input;
105
106 extern cli_input_t cli_input;
107
108 /* extended colorspace list that isn't supported by libx264 but by the cli */
109 #define X264_CSP_CLI_MAX        X264_CSP_MAX     /* end of list         */
110 #define X264_CSP_OTHER          0x4000           /* non x264 colorspace */
111
112 typedef struct
113 {
114     const char *name;
115     int planes;
116     float width[4];
117     float height[4];
118     int mod_width;
119     int mod_height;
120 } x264_cli_csp_t;
121
122 extern const x264_cli_csp_t x264_cli_csps[];
123
124 int      x264_cli_csp_is_invalid( int csp );
125 int      x264_cli_csp_depth_factor( int csp );
126 int      x264_cli_pic_alloc( cli_pic_t *pic, int csp, int width, int height );
127 int      x264_cli_pic_alloc_aligned( cli_pic_t *pic, int csp, int width, int height );
128 int      x264_cli_pic_init_noalloc( cli_pic_t *pic, int csp, int width, int height );
129 void     x264_cli_pic_clean( cli_pic_t *pic );
130 uint64_t x264_cli_pic_plane_size( int csp, int width, int height, int plane );
131 uint64_t x264_cli_pic_size( int csp, int width, int height );
132 const x264_cli_csp_t *x264_cli_get_csp( int csp );
133
134 typedef struct
135 {
136     int align_mask;
137 #ifdef _WIN32
138     void *map_handle;
139 #elif HAVE_MMAP
140     int fd;
141 #endif
142 } cli_mmap_t;
143
144 int x264_cli_mmap_init( cli_mmap_t *h, FILE *fh );
145 void *x264_cli_mmap( cli_mmap_t *h, int64_t offset, size_t size );
146 int x264_cli_munmap( cli_mmap_t *h, void *addr, size_t size );
147 void x264_cli_mmap_close( cli_mmap_t *h );
148
149 #endif