/*
    Copyright (C) 2015-2017 Carl Hetherington <cth@carlh.net>

    This file is part of DCP-o-matic.

    DCP-o-matic is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    DCP-o-matic 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 General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.

*/

/** @file  test/dcpomatic_time_test.cc
 *  @brief Test dcpomatic::Time and dcpomatic::TimePeriod classes.
 *  @ingroup selfcontained
 */

#include "lib/dcpomatic_time.h"
#include "lib/dcpomatic_time_coalesce.h"
#include <boost/test/unit_test.hpp>
#include <list>
#include <iostream>

using std::list;
using std::cout;
using namespace dcpomatic;


// 24 hours
int64_t constexpr long_project_seconds = 12 * 60 * 60;


static DCPTime test_time(int t)
{
	return DCPTime(t, 96000);
}


BOOST_AUTO_TEST_CASE (dcpomatic_time_test)
{
	FrameRateChange frc (24, 48);
	int j = 0;
	int k = 0;
	for (int64_t i = 0; i < 62000; i += 2000) {
		auto const d = test_time(i);
		ContentTime c (d, frc);
		BOOST_CHECK_EQUAL (c.frames_floor (24.0), j);
		++k;
		if (k == 2) {
			++j;
			k = 0;
		}
	}
}


BOOST_AUTO_TEST_CASE(dcpomatic_time_construction_test)
{
	/* Check that we can construct a large time using the old timebase */
	BOOST_CHECK(DCPTime(long_project_seconds * 96000, 96000) == DCPTime(long_project_seconds * DCPTime::TIME_BASE, DCPTime::TIME_BASE));
}


BOOST_AUTO_TEST_CASE (dcpomatic_time_period_overlaps_test)
{
	/* Taking times as the start of a sampling interval

	   |--|--|--|--|--|--|--|--|--|--|
	   0  1  2  3  4  5  6  7  8  9  |
	   |--|--|--|--|--|--|--|--|--|--|

	   <------a----><----b----->

	   and saying `from' is the start of the first sampling
	   interval and `to' is the start of the interval after
	   the period... a and b do not overlap.
	*/

	TimePeriod<DCPTime> a(test_time(0), test_time(4));
	TimePeriod<DCPTime> b(test_time(4), test_time(8));
	BOOST_CHECK (!a.overlap (b));

	/* Some more obvious non-overlaps */
	a = TimePeriod<DCPTime>(test_time(0), test_time(4));
	b = TimePeriod<DCPTime>(test_time(5), test_time(8));
	BOOST_CHECK (!a.overlap (b));

	/* Some overlaps */
	a = TimePeriod<DCPTime>(test_time(0), test_time(4));
	b = TimePeriod<DCPTime>(test_time(3), test_time(8));
	BOOST_CHECK(a.overlap(b));
	BOOST_CHECK(a.overlap(b).get() == DCPTimePeriod(test_time(3), test_time(4)));
	a = TimePeriod<DCPTime>(test_time(1), test_time(9));
	b = TimePeriod<DCPTime>(test_time(0), test_time(10));
	BOOST_CHECK(a.overlap(b));
	BOOST_CHECK(a.overlap(b).get() == DCPTimePeriod(test_time(1), test_time(9)));
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_subtract_test1)
{
	DCPTimePeriod A(test_time(0), test_time(106));
	list<DCPTimePeriod> B;
	B.push_back(DCPTimePeriod(test_time(0), test_time(42)));
	B.push_back(DCPTimePeriod(test_time(52), test_time(91)));
	B.push_back(DCPTimePeriod(test_time(94), test_time(106)));
	list<DCPTimePeriod> r = subtract (A, B);
	list<DCPTimePeriod>::const_iterator i = r.begin ();
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(42));
	BOOST_CHECK(i->to == test_time(52));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(91));
	BOOST_CHECK(i->to == test_time(94));
	++i;
	BOOST_REQUIRE (i == r.end ());
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_subtract_test2)
{
	DCPTimePeriod A(test_time(0), test_time(106));
	list<DCPTimePeriod> B;
	B.push_back(DCPTimePeriod(test_time(14), test_time(42)));
	B.push_back(DCPTimePeriod(test_time(52), test_time(91)));
	B.push_back(DCPTimePeriod(test_time(94), test_time(106)));
	list<DCPTimePeriod> r = subtract (A, B);
	list<DCPTimePeriod>::const_iterator i = r.begin ();
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(0));
	BOOST_CHECK(i->to == test_time(14));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(42));
	BOOST_CHECK(i->to == test_time(52));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(91));
	BOOST_CHECK(i->to == test_time(94));
	++i;
	BOOST_REQUIRE (i == r.end ());
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_subtract_test3)
{
	DCPTimePeriod A(test_time(0), test_time(106));
	list<DCPTimePeriod> B;
	B.push_back(DCPTimePeriod(test_time(14), test_time(42)));
	B.push_back(DCPTimePeriod(test_time(52), test_time(91)));
	B.push_back(DCPTimePeriod(test_time(94), test_time(99)));
	list<DCPTimePeriod> r = subtract (A, B);
	list<DCPTimePeriod>::const_iterator i = r.begin ();
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(0));
	BOOST_CHECK(i->to == test_time(14));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(42));
	BOOST_CHECK(i->to == test_time(52));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(91));
	BOOST_CHECK(i->to == test_time(94));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(99));
	BOOST_CHECK(i->to == test_time(106));
	++i;
	BOOST_REQUIRE (i == r.end ());
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_subtract_test4)
{
	DCPTimePeriod A(test_time(0), test_time(106));
	list<DCPTimePeriod> B;
	list<DCPTimePeriod> r = subtract (A, B);
	list<DCPTimePeriod>::const_iterator i = r.begin ();
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(0));
	BOOST_CHECK(i->to == test_time(106));
	++i;
	BOOST_REQUIRE (i == r.end ());
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_subtract_test5)
{
	DCPTimePeriod A(test_time(0), test_time(106));
	list<DCPTimePeriod> B;
	B.push_back(DCPTimePeriod(test_time(14), test_time(42)));
	B.push_back(DCPTimePeriod(test_time(42), test_time(91)));
	B.push_back(DCPTimePeriod(test_time(94), test_time(99)));
	list<DCPTimePeriod> r = subtract (A, B);
	list<DCPTimePeriod>::const_iterator i = r.begin ();
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(0));
	BOOST_CHECK(i->to == test_time(14));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from ==test_time(91));
	BOOST_CHECK(i->to == test_time(94));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(99));
	BOOST_CHECK(i->to == test_time(106));
	++i;
	BOOST_REQUIRE (i == r.end ());
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_subtract_test6)
{
	DCPTimePeriod A(test_time(0), test_time(106));
	list<DCPTimePeriod> B;
	B.push_back(DCPTimePeriod(test_time(0), test_time(42)));
	B.push_back(DCPTimePeriod(test_time(42), test_time(91)));
	B.push_back(DCPTimePeriod(test_time(91), test_time(106)));
	list<DCPTimePeriod> r = subtract (A, B);
	BOOST_CHECK (r.empty());
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_subtract_test7)
{
	DCPTimePeriod A(test_time(228), test_time(356));
	list<DCPTimePeriod> B;
	B.push_back(DCPTimePeriod(test_time(34), test_time(162)));
	list<DCPTimePeriod> r = subtract (A, B);
	list<DCPTimePeriod>::const_iterator i = r.begin ();
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(i->from == test_time(228));
	BOOST_CHECK(i->to == test_time(356));
	++i;
	BOOST_REQUIRE (i == r.end ());
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_subtract_test8)
{
	DCPTimePeriod A(test_time(0), test_time(32000));
	list<DCPTimePeriod> B;
	B.push_back(DCPTimePeriod(test_time(8000), test_time(20000)));
	B.push_back(DCPTimePeriod(test_time(28000), test_time(32000)));
	list<DCPTimePeriod> r = subtract (A, B);
	list<DCPTimePeriod>::const_iterator i = r.begin ();
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(*i == DCPTimePeriod(test_time(0), test_time(8000)));
	++i;
	BOOST_REQUIRE (i != r.end ());
	BOOST_CHECK(*i == DCPTimePeriod(test_time(20000), test_time(28000)));
	++i;
	BOOST_REQUIRE (i == r.end ());
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_coalesce_test1)
{
	DCPTimePeriod A(test_time(14), test_time(29));
	DCPTimePeriod B(test_time(45), test_time(91));
	list<DCPTimePeriod> p;
	p.push_back (A);
	p.push_back (B);
	list<DCPTimePeriod> q = coalesce (p);
	BOOST_REQUIRE_EQUAL (q.size(), 2U);
	BOOST_CHECK(q.front() == DCPTimePeriod(test_time(14), test_time(29)));
	BOOST_CHECK(q.back () == DCPTimePeriod(test_time(45), test_time(91)));
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_coalesce_test2)
{
	DCPTimePeriod A(test_time(14), test_time(29));
	DCPTimePeriod B(test_time(26), test_time(91));
	list<DCPTimePeriod> p;
	p.push_back (A);
	p.push_back (B);
	list<DCPTimePeriod> q = coalesce (p);
	BOOST_REQUIRE_EQUAL (q.size(), 1U);
	BOOST_CHECK(q.front() == DCPTimePeriod(test_time(14), test_time(91)));
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_coalesce_test3)
{
	DCPTimePeriod A(test_time(14), test_time(29));
	DCPTimePeriod B(test_time(29), test_time(91));
	list<DCPTimePeriod> p;
	p.push_back (A);
	p.push_back (B);
	list<DCPTimePeriod> q = coalesce (p);
	BOOST_REQUIRE_EQUAL (q.size(), 1U);
	BOOST_CHECK(q.front() == DCPTimePeriod(test_time(14), test_time(91)));
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_coalesce_test4)
{
	DCPTimePeriod A(test_time(14), test_time(29));
	DCPTimePeriod B(test_time(20), test_time(91));
	DCPTimePeriod C(test_time(35), test_time(106));
	list<DCPTimePeriod> p;
	p.push_back (A);
	p.push_back (B);
	p.push_back (C);
	list<DCPTimePeriod> q = coalesce (p);
	BOOST_REQUIRE_EQUAL (q.size(), 1U);
	BOOST_CHECK(q.front() == DCPTimePeriod(test_time(14), test_time(106)));
}

BOOST_AUTO_TEST_CASE (dcpomatic_time_period_coalesce_test5)
{
	DCPTimePeriod A(test_time(14), test_time(29));
	DCPTimePeriod B(test_time(20), test_time(91));
	DCPTimePeriod C(test_time(100), test_time(106));
	list<DCPTimePeriod> p;
	p.push_back (A);
	p.push_back (B);
	p.push_back (C);
	list<DCPTimePeriod> q = coalesce (p);
	BOOST_REQUIRE_EQUAL (q.size(), 2U);
	BOOST_CHECK(q.front() == DCPTimePeriod(test_time(14), test_time(91)));
	BOOST_CHECK(q.back()  == DCPTimePeriod(test_time(100), test_time(106)));
}

BOOST_AUTO_TEST_CASE (test_coalesce_with_overlapping_periods)
{
	DCPTimePeriod A(test_time(0), test_time(10));
	DCPTimePeriod B(test_time(2), test_time(8));
	list<DCPTimePeriod> p;
	p.push_back (A);
	p.push_back (B);
	auto q = coalesce(p);
	BOOST_REQUIRE_EQUAL (q.size(), 1U);
	BOOST_CHECK(q.front() == DCPTimePeriod(test_time(0), test_time(10)));
}

/* Straightforward test of DCPTime::ceil */
BOOST_AUTO_TEST_CASE (dcpomatic_time_ceil_test)
{
	BOOST_CHECK(DCPTime(0, DCPTime::TIME_BASE).ceil(DCPTime::TIME_BASE / 2) == DCPTime(0, DCPTime::TIME_BASE));
	BOOST_CHECK(DCPTime(1, DCPTime::TIME_BASE).ceil(DCPTime::TIME_BASE / 2) == DCPTime(2, DCPTime::TIME_BASE));
	BOOST_CHECK(DCPTime(2, DCPTime::TIME_BASE).ceil(DCPTime::TIME_BASE / 2) == DCPTime(2, DCPTime::TIME_BASE));
	BOOST_CHECK(DCPTime(3, DCPTime::TIME_BASE).ceil(DCPTime::TIME_BASE / 2) == DCPTime(4, DCPTime::TIME_BASE));

	BOOST_CHECK(DCPTime(0, DCPTime::TIME_BASE).ceil(DCPTime::TIME_BASE / 42) == DCPTime(0, DCPTime::TIME_BASE));
	BOOST_CHECK(DCPTime(1, DCPTime::TIME_BASE).ceil(DCPTime::TIME_BASE / 42) == DCPTime(42, DCPTime::TIME_BASE));
	BOOST_CHECK(DCPTime(42, DCPTime::TIME_BASE).ceil(DCPTime::TIME_BASE / 42) == DCPTime(42, DCPTime::TIME_BASE));
	BOOST_CHECK(DCPTime(43, DCPTime::TIME_BASE).ceil(DCPTime::TIME_BASE / 42) == DCPTime(84, DCPTime::TIME_BASE));

	/* Check that rounding up to non-integer frame rates works */
	BOOST_CHECK(test_time(45312).ceil(29.976) == DCPTime(247316108887, DCPTime::TIME_BASE));

	/* Check another tricky case that used to fail */
	BOOST_CHECK(DCPTime(1092757128815583LL, DCPTime::TIME_BASE).ceil(23.976) == DCPTime(1092758247315315, DCPTime::TIME_BASE));
}

/* Straightforward test of DCPTime::floor */
BOOST_AUTO_TEST_CASE (dcpomatic_time_floor_test)
{
	BOOST_CHECK(test_time(0).floor(DCPTime::TIME_BASE / 2) == test_time(0));
	BOOST_CHECK(test_time(1).floor(DCPTime::TIME_BASE / 2) == test_time(0));
	BOOST_CHECK(test_time(2).floor(DCPTime::TIME_BASE / 2) == test_time(2));
	BOOST_CHECK(test_time(3).floor(DCPTime::TIME_BASE / 2) == test_time(2));

	BOOST_CHECK(test_time(0).floor(DCPTime::TIME_BASE / 42) == test_time(0));
	BOOST_CHECK(test_time(1).floor(DCPTime::TIME_BASE / 42) == test_time(0));
	BOOST_CHECK(test_time(42).floor(DCPTime::TIME_BASE / 42.0) == test_time(42));
	BOOST_CHECK(test_time(43).floor(DCPTime::TIME_BASE / 42.0) == test_time(42));

	/* Check that rounding down to non-integer frame rates works */
	BOOST_CHECK(test_time(45312).floor(29.976) == test_time(44836));
}


BOOST_AUTO_TEST_CASE(dcpomatic_time_factor_test)
{
	for (int i = 2; i <= 30; ++i) {
		BOOST_CHECK((dcpomatic::DCPTime::TIME_BASE % i) == 0);
	}

	BOOST_CHECK((dcpomatic::DCPTime::TIME_BASE % 36) == 0);
	BOOST_CHECK((dcpomatic::DCPTime::TIME_BASE % 48) == 0);
	BOOST_CHECK((dcpomatic::DCPTime::TIME_BASE % 60) == 0);
}


BOOST_AUTO_TEST_CASE(dcpomatic_time_frames_floor_test)
{
	BOOST_CHECK_EQUAL(dcpomatic::DCPTime(195061250884500LL, 69872686884000LL).frames_floor(48000), 134000);
}