/usr/include/libopenshot/FrameMapper.h is in libopenshot-dev 0.1.9+dfsg1-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 | /**
* @file
* @brief Header file for the FrameMapper class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @section LICENSE
*
* Copyright (c) 2008-2014 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) 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 3 of the
* License, or (at your option) any later version.
*
* OpenShot Library (libopenshot) 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 OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef OPENSHOT_FRAMEMAPPER_H
#define OPENSHOT_FRAMEMAPPER_H
#include <assert.h>
#include <iostream>
#include <math.h>
#include <vector>
#include <memory>
#include "CacheMemory.h"
#include "../include/ReaderBase.h"
#include "../include/Frame.h"
#include "../include/Fraction.h"
#include "../include/Exceptions.h"
#include "../include/KeyFrame.h"
// Include FFmpeg headers and macros
#include "FFmpegUtilities.h"
#include "OpenMPUtilities.h"
using namespace std;
namespace openshot
{
/**
* @brief This enumeration determines how frame rates are increased or decreased.
*
* Pull-down techniques are only needed to remove artificial fields added when converting
* between 24 fps (film) and television fps (29.97 fps NTSC or 25 fps PAL).
*/
enum PulldownType
{
PULLDOWN_CLASSIC, ///< Classic 2:3:2:3 pull-down
PULLDOWN_ADVANCED, ///< Advanced 2:3:3:2 pull-down (minimal dirty frames)
PULLDOWN_NONE, ///< Do not apply pull-down techniques, just repeat or skip entire frames
};
/**
* @brief This struct holds a single field (half a frame).
*
* A frame of video is made up of 2 fields (half a frame). This struct points to which original
* frame, and whether this is the ODD or EVEN lines (i.e. top or bottom).
*/
struct Field
{
int64_t Frame;
bool isOdd;
Field() : Frame(0), isOdd(true) { };
Field(int64_t frame, bool isodd)
{
Frame = frame;
isOdd = isodd;
}
};
/**
* @brief This struct holds a the range of samples needed by this frame
*
* When frame rate is changed, the audio needs to be redistributed among the remaining
* frames. This struct holds the range samples needed by the this frame.
*/
struct SampleRange
{
int64_t frame_start;
int sample_start;
int64_t frame_end;
int sample_end;
int total;
};
/**
* @brief This struct holds two fields which together make up a complete video frame.
*
* These fields can point at different original frame numbers, for example the odd lines from
* frame 3, and the even lines of frame 4, if required by a pull-down technique.
*/
struct MappedFrame
{
Field Odd;
Field Even;
SampleRange Samples;
};
/**
* @brief This class creates a mapping between 2 different frame rates, applying a specific pull-down technique.
*
* This class creates a mapping between 2 different video files, and supports many pull-down techniques,
* such as 2:3:2:3 or 2:3:3:2, and also supports inverse telecine. Pull-down techniques are only needed to remove
* artificial fields added when converting between 24 fps (film) and television fps (29.97 fps NTSC or 25 fps PAL).
*
* The <b>following graphic</b> displays a how frame rates are mapped, and how time remapping affects the order
* of frames returned from the FrameMapper.
* \image html /doc/images/FrameMapper.png
*
* Please see the following <b>Example Code</b>:
* \code
* // Create a frame mapper for a reader, and convert the frame rate (from 24 fps to 29.97 fps)
* FrameMapper mapping(reader, Fraction(30000, 1001), PULLDOWN_CLASSIC, 44100, 2, LAYOUT_STEREO);
* std::shared_ptr<Frame> frame2 = mapping.GetFrame(2);
* // If you need to change the mapping...
* mapping.ChangeMapping(Fraction(24, 1), PULLDOWN_CLASSIC, 48000, 2, LAYOUT_MONO)
* \endcode
*/
class FrameMapper : public ReaderBase {
private:
bool is_open;
bool field_toggle; // Internal odd / even toggle (used when building the mapping)
Fraction original; // The original frame rate
Fraction target; // The target frame rate
PulldownType pulldown; // The pull-down technique
ReaderBase *reader; // The source video reader
CacheMemory final_cache; // Cache of actual Frame objects
bool is_dirty; // When this is true, the next call to GetFrame will re-init the mapping
AVAudioResampleContext *avr; // Audio resampling context object
int64_t timeline_frame_offset; // Timeline frame offset
// Internal methods used by init
void AddField(int64_t frame);
void AddField(Field field);
// Get Frame or Generate Blank Frame
std::shared_ptr<Frame> GetOrCreateFrame(int64_t number);
// Use the original and target frame rates and a pull-down technique to create
// a mapping between the original fields and frames or a video to a new frame rate.
// This might repeat or skip fields and frames of the original video, depending on
// whether the frame rate is increasing or decreasing.
void Init();
public:
// Init some containers
vector<Field> fields; // List of all fields
vector<MappedFrame> frames; // List of all frames
/// Default constructor for openshot::FrameMapper class
FrameMapper(ReaderBase *reader, Fraction target_fps, PulldownType target_pulldown, int target_sample_rate, int target_channels, ChannelLayout target_channel_layout);
/// Destructor
~FrameMapper();
/// Change frame rate or audio mapping details
void ChangeMapping(Fraction target_fps, PulldownType pulldown, int target_sample_rate, int target_channels, ChannelLayout target_channel_layout);
// Set offset relative to parent timeline
void SetTimelineFrameOffset(int64_t offset);
/// Close the openshot::FrameMapper and internal reader
void Close();
/// Get a frame based on the target frame rate and the new frame number of a frame
MappedFrame GetMappedFrame(int64_t TargetFrameNumber);
/// Get the cache object used by this reader
CacheMemory* GetCache() { return &final_cache; };
/// @brief This method is required for all derived classes of ReaderBase, and return the
/// openshot::Frame object, which contains the image and audio information for that
/// frame of video.
///
/// @returns The requested frame of video
/// @param requested_frame The frame number that is requested.
std::shared_ptr<Frame> GetFrame(int64_t requested_frame);
/// Determine if reader is open or closed
bool IsOpen();
/// Return the type name of the class
string Name() { return "FrameMapper"; };
/// Get and Set JSON methods
string Json(); ///< Generate JSON string of this object
void SetJson(string value); ///< Load JSON string into this object
Json::Value JsonValue(); ///< Generate Json::JsonValue for this object
void SetJsonValue(Json::Value root); ///< Load Json::JsonValue into this object
/// Open the internal reader
void Open();
/// Print all of the original frames and which new frames they map to
void PrintMapping();
/// Get the current reader
ReaderBase* Reader();
/// Resample audio and map channels (if needed)
void ResampleMappedAudio(std::shared_ptr<Frame> frame, int64_t original_frame_number);
};
}
#endif
|