sub_unit.go

package sub_helper

import (
	"bufio"
	"fmt"
	"math"
	"os"
	"time"

	"github.com/ChineseSubFinder/ChineseSubFinder/pkg"

	"github.com/ChineseSubFinder/ChineseSubFinder/pkg/vad"
)

type SubUnit struct {
	baseTime        time.Time     // 这个是基础的时间，后续需要减去这个，不然与导出的片段字幕去对比会有一个起始时间的偏差
	offsetStartTime time.Time     // 相对时间，这个时间会减去 baseTime 再存储
	offsetEndTime   time.Time     // 相对时间，这个时间会减去 baseTime 再存储
	VADList         []vad.VADInfo // 注意这里存储的是真实时间
	subCount        int
	firstAdd        bool
	outVADBytes     []byte
	outVADFloats    []float64
}

func NewSubUnit() *SubUnit {
	return &SubUnit{
		VADList:      make([]vad.VADInfo, 0),
		subCount:     0,
		firstAdd:     false,
		outVADBytes:  make([]byte, 0),
		outVADFloats: make([]float64, 0),
	}
}

func (s *SubUnit) Add(oneSubStartTime, oneSubEndTime time.Time) {

	//oneSubStartTime = my_util.MakeFloor10msMultipleFromTime(oneSubStartTime)
	//oneSubEndTime = my_util.MakeFloor10msMultipleFromTime(oneSubEndTime)

	if s.firstAdd == false {
		// 第一次 Add 需要给 baseTime 赋值
		s.baseTime = oneSubStartTime
		s.offsetStartTime = s.RealTimeToOffsetTime(oneSubStartTime)
		s.firstAdd = true
	}

	s.offsetEndTime = oneSubEndTime.Add(-pkg.Time2Duration(s.baseTime))

	// 添加 Start
	s.VADList = append(s.VADList, *vad.NewVADInfoBase(true, time.Duration((pkg.Time2SecondNumber(oneSubStartTime))*math.Pow10(9))))
	// 添加 End
	s.VADList = append(s.VADList, *vad.NewVADInfoBase(false, time.Duration((pkg.Time2SecondNumber(oneSubEndTime))*math.Pow10(9))))

	s.subCount++
}

// AddAndInsert 添加一句对白进来,并且填充中间的空白，间隔 10ms。传入的时间是真实的时间
func (s *SubUnit) AddAndInsert(oneSubStartTime, oneSubEndTime time.Time) {

	/*
		这里有个比较有意思的细节，字幕拆分到 dialogue 的时候，可能连续的多个 dialogue 是时间轴连续的
		但是实际上的语言就是可以分为几个句子的
		那么，在本函数中，就需要判断插入的时候，与上一句话的时间轴关系，前置无需进行句子的合并
		如果两句话时间轴是连续的（差值为0），那么就要主动修改这一点，采取的方案可以是
		1. 前后各 0.001 秒即可
		2. 后面这一句向后 0.002 秒（暂时优先考虑这个，容易实现）
	*/

	//oneSubStartTime = my_util.MakeFloor10msMultipleFromTime(oneSubStartTime)
	//oneSubEndTime = my_util.MakeFloor10msMultipleFromTime(oneSubEndTime)

	// 不是第一次添加，那么就需要把两句对白中间间隔的 active == false 的插入，插入间隙
	if len(s.VADList) > 0 {
		nowStartTime := s.RealTimeToOffsetTime(oneSubStartTime)
		nowStartOffsetTime := pkg.Time2SecondNumber(nowStartTime)
		nowEndOffsetTime := s.GetEndTimeNumber(false)

		needAddRange := nowStartOffsetTime - nowEndOffsetTime

		if needAddRange == 0 {
			// 说明是连续的句子，向后加 0.002 秒 addMoreTime
			addMore := time.Duration((s.GetEndTimeNumber(true) + addMoreTime) * math.Pow10(9))
			s.VADList = append(s.VADList, *vad.NewVADInfoBase(false, addMore))
			// 因为是连续的两句话的时间轴，强制插入了一个点，那么就需要在这句话的 Start 部分向后延迟对应的秒数
			oneSubStartTime = oneSubStartTime.Add(time.Duration(addMoreTime * math.Pow10(9)))
		} else {
			for i := 0.0; i < needAddRange; {

				s.VADList = append(s.VADList, *vad.NewVADInfoBase(false, time.Duration((s.GetEndTimeNumber(true)+i)*math.Pow10(9))))
				i += perWindows
			}
		}
	}

	if s.firstAdd == false {
		// 第一次 Add 需要给 baseTime 赋值
		s.baseTime = oneSubStartTime
		s.offsetStartTime = s.RealTimeToOffsetTime(oneSubStartTime)
		s.firstAdd = true
	}

	s.offsetEndTime = oneSubEndTime.Add(-pkg.Time2Duration(s.baseTime))

	nowStartTime := s.RealTimeToOffsetTime(oneSubStartTime)
	nowEndTime := s.RealTimeToOffsetTime(oneSubEndTime)

	nowStartOffsetTime := pkg.Time2SecondNumber(nowStartTime)
	nowEndOffsetTime := pkg.Time2SecondNumber(nowEndTime)

	needAddRange := nowEndOffsetTime - nowStartOffsetTime

	for i := 0.0; i < needAddRange; {
		s.VADList = append(s.VADList, *vad.NewVADInfoBase(true, time.Duration((pkg.Time2SecondNumber(oneSubStartTime)+i)*math.Pow10(9))))
		i += perWindows
	}

	s.subCount++
}

// AddBaseTime 如果 BaseTime 还有偏移，可以在 Add 和 AddAndInsert 逻辑完成后，调用此方法去调整基准时间
func (s *SubUnit) AddBaseTime(addBaseTime time.Duration) {
	s.baseTime = s.baseTime.Add(addBaseTime)
}

// SetBaseTime 设置基准时间
func (s *SubUnit) SetBaseTime(setBaseTime time.Time) {
	s.baseTime = setBaseTime
}

func (s *SubUnit) SetOffsetStartTime(realStartTime time.Time) {
	s.offsetStartTime = s.RealTimeToOffsetTime(realStartTime)
}

func (s *SubUnit) SetOffsetEndTime(realEndTime time.Time) {
	s.offsetEndTime = s.RealTimeToOffsetTime(realEndTime)
}

// GetDialogueCount 获取这个对白单元由几个对话
func (s SubUnit) GetDialogueCount() int {
	return s.subCount
}

// GetVADByteSlice 获取 VAD 的 byte 数组信息
func (s *SubUnit) GetVADByteSlice() []byte {

	if len(s.outVADBytes) != len(s.VADList) {
		s.outVADBytes = make([]byte, len(s.VADList))
		for i := 0; i < len(s.VADList); i++ {
			if s.VADList[i].Active == true {
				s.outVADBytes[i] = 1
			} else {
				s.outVADBytes[i] = 0
			}
		}
	}

	return s.outVADBytes
}

// GetVADFloatSlice 获取 VAD 的 float64 数组信息
func (s *SubUnit) GetVADFloatSlice() []float64 {

	if len(s.outVADFloats) != len(s.VADList) {
		s.outVADFloats = make([]float64, len(s.VADList))
		for i := 0; i < len(s.VADList); i++ {
			if s.VADList[i].Active == true {
				s.outVADFloats[i] = 1
			} else {
				s.outVADFloats[i] = -1
			}
		}
	}

	return s.outVADFloats
}

// GetStartTimeNumber 获取这个单元的起始时间，单位是秒
func (s SubUnit) GetStartTimeNumber(realOrOffsetTime bool) float64 {
	return pkg.Time2SecondNumber(s.GetStartTime(realOrOffsetTime))
}

// GetStartTime 获取这个单元的起始时间
func (s SubUnit) GetStartTime(realOrOffsetTime bool) time.Time {
	if realOrOffsetTime == true {
		return s.offsetStartTime.Add(pkg.Time2Duration(s.baseTime))
	} else {
		return s.offsetStartTime
	}
}

// GetEndTimeNumber 获取这个单元的结束时间，单位是秒
func (s SubUnit) GetEndTimeNumber(realOrOffsetTime bool) float64 {

	return pkg.Time2SecondNumber(s.GetEndTime(realOrOffsetTime))
}

// GetEndTime 获取这个单元的起始时间
func (s SubUnit) GetEndTime(realOrOffsetTime bool) time.Time {
	if realOrOffsetTime == true {
		return s.offsetEndTime.Add(pkg.Time2Duration(s.baseTime))
	} else {
		return s.offsetEndTime
	}
}

// GetIndexTime 当前 OffsetIndex 的时间
func (s SubUnit) GetIndexTime(index int, realOrOffsetTime bool) (bool, time.Time) {

	if index >= len(s.VADList) {
		return false, time.Time{}
	}

	if realOrOffsetTime == true {
		return true, time.Time{}.Add(s.VADList[index].Time)
	} else {
		return true, time.Time{}.Add(s.VADList[index].Time).Add(-pkg.Time2Duration(s.baseTime))
	}
}

// GetIndexTimeNumber 当前 OffsetIndex 的时间
func (s SubUnit) GetIndexTimeNumber(index int, realOrOffsetTime bool) (bool, float64) {

	bok, outTime := s.GetIndexTime(index, realOrOffsetTime)
	if bok == false {
		return false, 0
	}

	return true, pkg.Time2SecondNumber(outTime)
}

// GetTimelineRange 开始到结束的时间长度，单位是秒
func (s SubUnit) GetTimelineRange() float64 {
	return s.GetEndTimeNumber(false) - s.GetStartTimeNumber(false)
}

// GetOffsetTimeNumber 偏移时间，单位是秒
func (s SubUnit) GetOffsetTimeNumber() float64 {
	return pkg.Time2SecondNumber(s.baseTime)
}

// GetFFMPEGCutRangeString 这里会生成导出 FFMPEG 的参数字段，起始时间和结束的时间长度
// 以当前的 VAD 信息为基准，正负 expandTimeRange（秒为单位） 来生成截取的片段时间轴信息
func (s SubUnit) GetFFMPEGCutRangeString(expandTimeRange float64) (string, string, time.Time, float64) {

	var tmpStartTime time.Time
	if s.GetStartTimeNumber(true)-expandTimeRange < 0 {
		tmpStartTime = time.Time{}
	} else {
		startTime := s.GetStartTime(true)
		subTime := time.Duration(expandTimeRange) * time.Second
		tmpStartTime = startTime.Add(-subTime)
	}

	return fmt.Sprintf("%d:%d:%d.%d", tmpStartTime.Hour(), tmpStartTime.Minute(), tmpStartTime.Second(), tmpStartTime.Nanosecond()/1000/1000),
		fmt.Sprintf("%f", s.GetTimelineRange()+2*expandTimeRange),
		tmpStartTime,
		s.GetTimelineRange() + expandTimeRange
}

// GetExpandRangeIndex 导出扩展的起始时间和结束的时间，整个多出的参数只适用于整体的字幕范围，局部不试用
// 以当前的 VAD 信息为基准，正负 expandTimeRange（秒为单位） 来生成截取的片段时间轴信息
// 向左偏移的时候是可知有多少可以移动的，越界就置为 0
// 向右移动的时候，总长度是未知的，所以返回的值需要在外部重新 Check 是否会越界
func (s SubUnit) GetExpandRangeIndex(expandTimeRange float64) (int, int) {

	var tmpStartTimeIndex int
	var tmpEndTimeIndex int
	// 起始时间 -> OffsetIndex
	if s.GetStartTimeNumber(true)-expandTimeRange < 0 {
		// 向左偏移的时候是可知有多少可以移动的，越界就置为 0
		tmpStartTimeIndex = 0
	} else {
		// 没有越界就直接用得到的毫秒差值去推算 index 的偏移位置
		startTime := s.GetStartTime(true)
		subTime := time.Duration(expandTimeRange) * time.Second
		tmpStartTime := startTime.Add(-subTime)
		// 需要从秒换算到偏移的 OffsetIndex 数值，一共多少份
		tmpStartTimeIndex = int(pkg.Time2SecondNumber(tmpStartTime) / perWindows)
	}
	// 结束时间 -> OffsetIndex
	// 向右移动的时候，总长度是未知的，所以返回的值需要在外部重新 Check 是否会越界
	endTime := s.GetEndTime(true)
	subTime := time.Duration(expandTimeRange) * time.Second
	tmpEndTime := endTime.Add(subTime)
	// 需要从秒换算到偏移的 OffsetIndex 数值，一共多少份
	tmpEndTimeIndex = int(pkg.Time2SecondNumber(tmpEndTime) / perWindows)

	return tmpStartTimeIndex, tmpEndTimeIndex
}

// RealTimeToOffsetTime 真实时间转偏移时间
func (s SubUnit) RealTimeToOffsetTime(realTime time.Time) time.Time {
	dd := pkg.Time2Duration(s.baseTime)
	return realTime.Add(-dd)
}

// Save2Txt 导出为 float64 的内容
func (s SubUnit) Save2Txt(outFileFPath string, oneLine bool) error {

	file, err := os.OpenFile(outFileFPath, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0666)
	if err != nil {
		return err
	}
	defer file.Close()
	//写入文件时，使用带缓存的 *Writer
	write := bufio.NewWriter(file)
	for i := 0; i < len(s.VADList); i++ {
		active := 0.0
		if s.VADList[i].Active == true {
			active = 1.0
		}
		if oneLine == true {
			_, err = write.WriteString(fmt.Sprintf("%v", active))
			if err != nil {
				return err
			}
		} else {
			_, err = write.WriteString(fmt.Sprintf("%v\n", active))
			if err != nil {
				return err
			}
		}
	}
	err = write.Flush()
	if err != nil {
		return err
	}

	return nil
}

const perWindows = float64(vad.FrameDuration) / 1000

const addMoreTime = 0.002