1
0
mirror of https://github.com/mpv-player/mpv synced 2024-12-11 09:25:56 +00:00
mpv/video/out/opengl/lcms.c
Niklas Haas 86b5f1463c lcms: don't warn/error on 3dlut cache misses
Cache misses are a normal and expected part of the operation of a cache.
It doesn't really make sense to show a user-visible warning for them.

To work-around this, just skip trying to open the cache if it doesn't
exist yet.
2016-05-04 12:10:55 +02:00

455 lines
14 KiB
C

/*
* This file is part of mpv.
*
* mpv 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.
*
* mpv 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 mpv. If not, see <http://www.gnu.org/licenses/>.
*/
#include <string.h>
#include <math.h>
#include "mpv_talloc.h"
#include "config.h"
#include "stream/stream.h"
#include "common/common.h"
#include "misc/bstr.h"
#include "common/msg.h"
#include "options/m_option.h"
#include "options/path.h"
#include "video.h"
#include "lcms.h"
#include "osdep/io.h"
#if HAVE_LCMS2
#include <lcms2.h>
#include <libavutil/sha.h>
#include <libavutil/mem.h>
struct gl_lcms {
void *icc_data;
size_t icc_size;
char *icc_path;
bool changed;
enum mp_csp_prim prev_prim;
enum mp_csp_trc prev_trc;
struct mp_log *log;
struct mpv_global *global;
struct mp_icc_opts opts;
};
static bool parse_3dlut_size(const char *arg, int *p1, int *p2, int *p3)
{
if (sscanf(arg, "%dx%dx%d", p1, p2, p3) != 3)
return false;
for (int n = 0; n < 3; n++) {
int s = ((int[]) { *p1, *p2, *p3 })[n];
if (s < 2 || s > 512 || ((s - 1) & s))
return false;
}
return true;
}
static int validate_3dlut_size_opt(struct mp_log *log, const m_option_t *opt,
struct bstr name, struct bstr param)
{
int p1, p2, p3;
char s[20];
snprintf(s, sizeof(s), "%.*s", BSTR_P(param));
return parse_3dlut_size(s, &p1, &p2, &p3);
}
#define OPT_BASE_STRUCT struct mp_icc_opts
const struct m_sub_options mp_icc_conf = {
.opts = (const m_option_t[]) {
OPT_STRING("icc-profile", profile, 0),
OPT_FLAG("icc-profile-auto", profile_auto, 0),
OPT_STRING("icc-cache-dir", cache_dir, 0),
OPT_INT("icc-intent", intent, 0),
OPT_INTRANGE("icc-contrast", contrast, 0, 0, 100000),
OPT_STRING_VALIDATE("3dlut-size", size_str, 0, validate_3dlut_size_opt),
OPT_REMOVED("icc-cache", "see icc-cache-dir"),
{0}
},
.size = sizeof(struct mp_icc_opts),
.defaults = &(const struct mp_icc_opts) {
.size_str = "128x256x64",
.intent = INTENT_RELATIVE_COLORIMETRIC,
},
};
static void lcms2_error_handler(cmsContext ctx, cmsUInt32Number code,
const char *msg)
{
struct gl_lcms *p = cmsGetContextUserData(ctx);
MP_ERR(p, "lcms2: %s\n", msg);
}
static bool load_profile(struct gl_lcms *p)
{
if (p->icc_data && p->icc_size)
return true;
if (!p->icc_path)
return false;
char *fname = mp_get_user_path(NULL, p->global, p->icc_path);
MP_VERBOSE(p, "Opening ICC profile '%s'\n", fname);
struct bstr iccdata = stream_read_file(fname, p, p->global,
100000000); // 100 MB
talloc_free(fname);
if (!iccdata.len)
return false;
p->icc_data = iccdata.start;
p->icc_size = iccdata.len;
return true;
}
struct gl_lcms *gl_lcms_init(void *talloc_ctx, struct mp_log *log,
struct mpv_global *global)
{
struct gl_lcms *p = talloc_ptrtype(talloc_ctx, p);
*p = (struct gl_lcms) {
.global = global,
.log = log,
.changed = true,
};
return p;
}
void gl_lcms_set_options(struct gl_lcms *p, struct mp_icc_opts *opts)
{
p->opts = *opts;
p->icc_path = talloc_strdup(p, p->opts.profile);
load_profile(p);
p->changed = true; // probably
}
// Warning: profile.start must point to a ta allocation, and the function
// takes over ownership.
void gl_lcms_set_memory_profile(struct gl_lcms *p, bstr *profile)
{
if (!p->opts.profile_auto) {
talloc_free(profile->start);
return;
}
if (!p->icc_path && p->icc_data && profile->start &&
profile->len == p->icc_size &&
memcmp(profile->start, p->icc_data, p->icc_size) == 0)
{
talloc_free(profile->start);
return;
}
p->changed = true;
talloc_free(p->icc_path);
p->icc_path = NULL;
talloc_free(p->icc_data);
p->icc_data = talloc_steal(p, profile->start);
p->icc_size = profile->len;
}
// Return and _reset_ whether the profile or config has changed since the last
// call. If it has changed, gl_lcms_get_lut3d() should be called.
bool gl_lcms_has_changed(struct gl_lcms *p, enum mp_csp_prim prim,
enum mp_csp_trc trc)
{
bool change = p->changed || p->prev_prim != prim || p->prev_trc != trc;
p->changed = false;
p->prev_prim = prim;
p->prev_trc = trc;
return change;
}
static cmsHPROFILE get_vid_profile(struct gl_lcms *p, cmsContext cms,
cmsHPROFILE disp_profile,
enum mp_csp_prim prim, enum mp_csp_trc trc)
{
// The input profile for the transformation is dependent on the video
// primaries and transfer characteristics
struct mp_csp_primaries csp = mp_get_csp_primaries(prim);
cmsCIExyY wp_xyY = {csp.white.x, csp.white.y, 1.0};
cmsCIExyYTRIPLE prim_xyY = {
.Red = {csp.red.x, csp.red.y, 1.0},
.Green = {csp.green.x, csp.green.y, 1.0},
.Blue = {csp.blue.x, csp.blue.y, 1.0},
};
cmsToneCurve *tonecurve[3] = {0};
switch (trc) {
case MP_CSP_TRC_LINEAR: tonecurve[0] = cmsBuildGamma(cms, 1.0); break;
case MP_CSP_TRC_GAMMA18: tonecurve[0] = cmsBuildGamma(cms, 1.8); break;
case MP_CSP_TRC_GAMMA22: tonecurve[0] = cmsBuildGamma(cms, 2.2); break;
case MP_CSP_TRC_GAMMA28: tonecurve[0] = cmsBuildGamma(cms, 2.8); break;
case MP_CSP_TRC_SRGB:
// Values copied from Little-CMS
tonecurve[0] = cmsBuildParametricToneCurve(cms, 4,
(double[5]){2.40, 1/1.055, 0.055/1.055, 1/12.92, 0.04045});
break;
case MP_CSP_TRC_PRO_PHOTO:
tonecurve[0] = cmsBuildParametricToneCurve(cms, 4,
(double[5]){1.8, 1.0, 0.0, 1/16.0, 0.03125});
break;
case MP_CSP_TRC_BT_1886: {
// To build an appropriate BT.1886 transformation we need access to
// the display's black point, so we LittleCMS' detection function.
// Relative colorimetric is used since we want to approximate the
// BT.1886 to the target device's actual black point even in e.g.
// perceptual mode
const int intent = MP_INTENT_RELATIVE_COLORIMETRIC;
cmsCIEXYZ bp_XYZ;
if (!cmsDetectBlackPoint(&bp_XYZ, disp_profile, intent, 0))
return false;
// Map this XYZ value back into the (linear) source space
cmsToneCurve *linear = cmsBuildGamma(cms, 1.0);
cmsHPROFILE rev_profile = cmsCreateRGBProfileTHR(cms, &wp_xyY, &prim_xyY,
(cmsToneCurve*[3]){linear, linear, linear});
cmsHPROFILE xyz_profile = cmsCreateXYZProfile();
cmsHTRANSFORM xyz2src = cmsCreateTransformTHR(cms,
xyz_profile, TYPE_XYZ_DBL, rev_profile, TYPE_RGB_DBL,
intent, 0);
cmsFreeToneCurve(linear);
cmsCloseProfile(rev_profile);
cmsCloseProfile(xyz_profile);
if (!xyz2src)
return false;
double src_black[3];
cmsDoTransform(xyz2src, &bp_XYZ, src_black, 1);
cmsDeleteTransform(xyz2src);
// Contrast limiting
if (p->opts.contrast > 0) {
for (int i = 0; i < 3; i++)
src_black[i] = MPMAX(src_black[i], 1.0 / p->opts.contrast);
}
// Built-in contrast failsafe
double contrast = 3.0 / (src_black[0] + src_black[1] + src_black[2]);
if (contrast > 100000) {
MP_WARN(p, "ICC profile detected contrast very high (>100000),"
" falling back to contrast 1000 for sanity. Set the"
" icc-contrast option to silence this warning.\n");
src_black[0] = src_black[1] = src_black[2] = 1.0 / 1000;
}
// Build the parametric BT.1886 transfer curve, one per channel
for (int i = 0; i < 3; i++) {
const double gamma = 2.40;
double binv = pow(src_black[i], 1.0/gamma);
tonecurve[i] = cmsBuildParametricToneCurve(cms, 6,
(double[4]){gamma, 1.0 - binv, binv, 0.0});
}
break;
}
default:
abort();
}
if (!tonecurve[0])
return false;
if (!tonecurve[1]) tonecurve[1] = tonecurve[0];
if (!tonecurve[2]) tonecurve[2] = tonecurve[0];
cmsHPROFILE *vid_profile = cmsCreateRGBProfileTHR(cms, &wp_xyY, &prim_xyY,
tonecurve);
if (tonecurve[2] != tonecurve[0]) cmsFreeToneCurve(tonecurve[2]);
if (tonecurve[1] != tonecurve[0]) cmsFreeToneCurve(tonecurve[1]);
cmsFreeToneCurve(tonecurve[0]);
return vid_profile;
}
bool gl_lcms_get_lut3d(struct gl_lcms *p, struct lut3d **result_lut3d,
enum mp_csp_prim prim, enum mp_csp_trc trc)
{
int s_r, s_g, s_b;
bool result = false;
if (!parse_3dlut_size(p->opts.size_str, &s_r, &s_g, &s_b))
return false;
if (!p->icc_data && !p->icc_path)
return false;
void *tmp = talloc_new(NULL);
uint16_t *output = talloc_array(tmp, uint16_t, s_r * s_g * s_b * 3);
struct lut3d *lut = NULL;
cmsContext cms = NULL;
char *cache_file = NULL;
if (p->opts.cache_dir && p->opts.cache_dir[0]) {
// Gamma is included in the header to help uniquely identify it,
// because we may change the parameter in the future or make it
// customizable, same for the primaries.
char *cache_info = talloc_asprintf(tmp,
"ver=1.3, intent=%d, size=%dx%dx%d, prim=%d, trc=%d, "
"contrast=%d\n",
p->opts.intent, s_r, s_g, s_b, prim, trc, p->opts.contrast);
uint8_t hash[32];
struct AVSHA *sha = av_sha_alloc();
if (!sha)
abort();
av_sha_init(sha, 256);
av_sha_update(sha, cache_info, strlen(cache_info));
av_sha_update(sha, p->icc_data, p->icc_size);
av_sha_final(sha, hash);
av_free(sha);
char *cache_dir = mp_get_user_path(tmp, p->global, p->opts.cache_dir);
cache_file = talloc_strdup(tmp, "");
for (int i = 0; i < sizeof(hash); i++)
cache_file = talloc_asprintf_append(cache_file, "%02X", hash[i]);
cache_file = mp_path_join(tmp, cache_dir, cache_file);
mp_mkdirp(cache_dir);
}
// check cache
if (cache_file && stat(cache_file, &(struct stat){0}) == 0) {
MP_VERBOSE(p, "Opening 3D LUT cache in file '%s'.\n", cache_file);
struct bstr cachedata = stream_read_file(cache_file, tmp, p->global,
1000000000); // 1 GB
if (cachedata.len == talloc_get_size(output)) {
memcpy(output, cachedata.start, cachedata.len);
goto done;
} else {
MP_WARN(p, "3D LUT cache invalid!\n");
}
}
cms = cmsCreateContext(NULL, p);
if (!cms)
goto error_exit;
cmsSetLogErrorHandlerTHR(cms, lcms2_error_handler);
cmsHPROFILE profile =
cmsOpenProfileFromMemTHR(cms, p->icc_data, p->icc_size);
if (!profile)
goto error_exit;
cmsHPROFILE vid_profile = get_vid_profile(p, cms, profile, prim, trc);
if (!vid_profile) {
cmsCloseProfile(profile);
goto error_exit;
}
cmsHTRANSFORM trafo = cmsCreateTransformTHR(cms, vid_profile, TYPE_RGB_16,
profile, TYPE_RGB_16,
p->opts.intent,
cmsFLAGS_HIGHRESPRECALC |
cmsFLAGS_BLACKPOINTCOMPENSATION);
cmsCloseProfile(profile);
cmsCloseProfile(vid_profile);
if (!trafo)
goto error_exit;
// transform a (s_r)x(s_g)x(s_b) cube, with 3 components per channel
uint16_t *input = talloc_array(tmp, uint16_t, s_r * 3);
for (int b = 0; b < s_b; b++) {
for (int g = 0; g < s_g; g++) {
for (int r = 0; r < s_r; r++) {
input[r * 3 + 0] = r * 65535 / (s_r - 1);
input[r * 3 + 1] = g * 65535 / (s_g - 1);
input[r * 3 + 2] = b * 65535 / (s_b - 1);
}
size_t base = (b * s_r * s_g + g * s_r) * 3;
cmsDoTransform(trafo, input, output + base, s_r);
}
}
cmsDeleteTransform(trafo);
if (cache_file) {
FILE *out = fopen(cache_file, "wb");
if (out) {
fwrite(output, talloc_get_size(output), 1, out);
fclose(out);
}
}
done: ;
lut = talloc_ptrtype(NULL, lut);
*lut = (struct lut3d) {
.data = talloc_steal(lut, output),
.size = {s_r, s_g, s_b},
};
*result_lut3d = lut;
result = true;
error_exit:
if (cms)
cmsDeleteContext(cms);
if (!lut)
MP_FATAL(p, "Error loading ICC profile.\n");
talloc_free(tmp);
return result;
}
#else /* HAVE_LCMS2 */
const struct m_sub_options mp_icc_conf = {
.opts = (const m_option_t[]) { {0} },
.size = sizeof(struct mp_icc_opts),
.defaults = &(const struct mp_icc_opts) {0},
};
struct gl_lcms *gl_lcms_init(void *talloc_ctx, struct mp_log *log,
struct mpv_global *global)
{
return (struct gl_lcms *) talloc_new(talloc_ctx);
}
void gl_lcms_set_options(struct gl_lcms *p, struct mp_icc_opts *opts) { }
void gl_lcms_set_memory_profile(struct gl_lcms *p, bstr *profile) { }
bool gl_lcms_has_changed(struct gl_lcms *p, enum mp_csp_prim prim,
enum mp_csp_trc trc)
{
return false;
}
bool gl_lcms_get_lut3d(struct gl_lcms *p, struct lut3d **result_lut3d,
enum mp_csp_prim prim, enum mp_csp_trc trc)
{
return false;
}
#endif