Aegisub/aegisub/src/vfr.h

159 lines
3.5 KiB
C
Raw Normal View History

// Copyright (c) 2005-2006, Rodrigo Braz Monteiro, Fredrik Mellbin
2006-01-16 22:02:54 +01:00
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
// * Neither the name of the Aegisub Group nor the names of its contributors
// may be used to endorse or promote products derived from this software
// without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
2006-01-16 22:02:54 +01:00
//
// $Id$
/// @file vfr.h
/// @see vfr.cpp
/// @ingroup video_input
///
2006-01-16 22:02:54 +01:00
// The FrameRate class stores all times internally as ints in ms precision
// V1 timecodes are partially expanded to v2 up until their last override line
// V2 timecodes are kept as is and if n frames beyond the end is requested a
// time is calculated by last_time+n/average_fps
2006-01-16 22:02:54 +01:00
#pragma once
///////////
// Headers
#ifndef AGI_PRE
2006-01-16 22:02:54 +01:00
#include <list>
#include <vector>
#include <wx/dynarray.h>
#include <wx/string.h>
#endif
#include "include/aegisub/aegisub.h"
2006-01-16 22:02:54 +01:00
/// DOCME
2006-01-16 22:02:54 +01:00
enum ASS_FrameRateType {
/// DOCME
2006-01-16 22:02:54 +01:00
NONE,
/// DOCME
2006-01-16 22:02:54 +01:00
CFR,
/// DOCME
2006-01-16 22:02:54 +01:00
VFR
};
/// DOCME
/// @class FrameRate
/// @brief DOCME
///
/// DOCME
class FrameRate {
friend class VideoContext;
2006-01-16 22:02:54 +01:00
private:
/// DOCME
double last_time;
/// DOCME
int last_frame;
/// DOCME
std::vector<int> Frame;
/// DOCME
double AverageFrameRate;
2006-01-16 22:02:54 +01:00
void AddFrame(int ms);
2006-01-16 22:02:54 +01:00
void Clear();
void CalcAverage();
int PFrameAtTime(int ms,bool useCeil=false);
int PTimeAtFrame(int frame);
/// DOCME
ASS_FrameRateType FrameRateType;
/// DOCME
bool loaded;
/// DOCME
wxString vfrFile;
2006-01-16 22:02:54 +01:00
public:
FrameRate();
~FrameRate();
void SetCFR(double fps);
void SetVFR(std::vector<int> times);
// Loading always unloads even on failure
2006-01-16 22:02:54 +01:00
void Load(wxString file);
void Save(wxString file);
2006-01-16 22:02:54 +01:00
void Unload();
int GetFrameAtTime(int ms,bool start=true);
int GetTimeAtFrame(int frame,bool start=true,bool exact=false);
/// @brief DOCME
/// @return
///
double GetAverage() { return AverageFrameRate; };
/// @brief DOCME
/// @return
///
bool IsLoaded() { return loaded; };
/// @brief DOCME
/// @return
///
ASS_FrameRateType GetFrameRateType() { return FrameRateType; };
/// @brief DOCME
///
wxString GetFilename() { return vfrFile; };
std::vector<int> GetFrameTimeList();
double GetCommonFPS();
2006-01-16 22:02:54 +01:00
};
///////////
// Globals
extern FrameRate VFR_Output;
extern FrameRate VFR_Input;