src/lib/film_state.h

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/film_state.h
  21  *  @brief The state of a Film.  This is separate from Film so that
  22  *  state can easily be copied and kept around for reference
  23  *  by long-running jobs.  This avoids the jobs getting confused
  24  *  by the user changing Film settings during their run.
  25  */
  26
  27 #ifndef DVDOMATIC_FILM_STATE_H
  28 #define DVDOMATIC_FILM_STATE_H
  29
  30 extern "C" {
  31 #include <libavcodec/avcodec.h>
  32 #include <libswscale/swscale.h>
  33 }
  34 #include "scaler.h"
  35 #include "util.h"
  36 #include "trim_action.h"
  37
  38 class Format;
  39 class DCPContentType;
  40 class Filter;
  41
  42 /** @class FilmState
  43  *  @brief The state of a Film.
  44  *
  45  *  This is separate from Film so that state can easily be copied and
  46  *  kept around for reference by long-running jobs.  This avoids the
  47  *  jobs getting confused by the user changing Film settings during
  48  *  their run.
  49  */
  50
  51 class FilmState
  52 {
  53 public:
  54         FilmState ()
  55                 : dcp_content_type (0)
  56                 , frames_per_second (0)
  57                 , format (0)
  58                 , scaler (Scaler::from_id ("bicubic"))
  59                 , dcp_frames (0)
  60                 , dcp_trim_action (CUT)
  61                 , dcp_ab (false)
  62                 , audio_gain (0)
  63                 , audio_delay (0)
  64                 , still_duration (10)
  65                 , with_subtitles (false)
  66                 , subtitle_offset (0)
  67                 , subtitle_scale (1)
  68                 , length (0)
  69                 , audio_channels (0)
  70                 , audio_sample_rate (0)
  71                 , audio_sample_format (AV_SAMPLE_FMT_NONE)
  72                 , has_subtitles (false)
  73         {}
  74
  75         std::string file (std::string f) const;
  76         std::string dir (std::string d) const;
  77
  78         std::string content_path () const;
  79         ContentType content_type () const;
  80
  81         bool content_is_dvd () const;
  82
  83         std::string thumb_file (int) const;
  84         std::string thumb_base (int) const;
  85         int thumb_frame (int) const;
  86
  87         int bytes_per_sample () const;
  88         int target_sample_rate () const;
  89
  90         void write_metadata (std::ofstream &) const;
  91         void read_metadata (std::string, std::string);
  92
  93         Size cropped_size (Size) const;
  94
  95         int dcp_length () const;
  96
  97         /** Complete path to directory containing the film metadata;
  98             must not be relative.
  99         */
 100         std::string directory;
 101         /** Name for DVD-o-matic */
 102         std::string name;
 103         /** File or directory containing content; may be relative to our directory
 104          *  or an absolute path.
 105          */
 106         std::string content;
 107         /** The type of content that this Film represents (feature, trailer etc.) */
 108         DCPContentType const * dcp_content_type;
 109         /** Frames per second of the source */
 110         float frames_per_second;
 111         /** The format to present this Film in (flat, scope, etc.) */
 112         Format const * format;
 113         Crop crop;
 114         /** Video filters that should be used when generating DCPs */
 115         std::vector<Filter const *> filters;
 116         /** Scaler algorithm to use */
 117         Scaler const * scaler;
 118         /** Number of frames to put in the DCP, or 0 for all */
 119         int dcp_frames;
 120
 121         TrimAction dcp_trim_action;
 122
 123         /** true to create an A/B comparison DCP, where the left half of the image
 124             is the video without any filters or post-processing, and the right half
 125             has the specified filters and post-processing.
 126         */
 127         bool dcp_ab;
 128         /** Gain to apply to audio in dB */
 129         float audio_gain;
 130         /** Delay to apply to audio (positive moves audio later) in milliseconds */
 131         int audio_delay;
 132         /** Duration to make still-sourced films (in seconds) */
 133         int still_duration;
 134         bool with_subtitles;
 135         /** y offset for placing subtitles, in source pixels; +ve is further down
 136             the frame, -ve is further up.
 137         */
 138         int subtitle_offset;
 139         float subtitle_scale;
 140
 141         /* Data which is cached to speed things up */
 142
 143         /** Vector of frame indices for each of our `thumbnails' */
 144         std::vector<int> thumbs;
 145         /** Size, in pixels, of the source (ignoring cropping) */
 146         Size size;
 147         /** Length of the source in frames */
 148         int length;
 149         /** Number of audio channels */
 150         int audio_channels;
 151         /** Sample rate of the source audio, in Hz */
 152         int audio_sample_rate;
 153         /** Format of the audio samples */
 154         AVSampleFormat audio_sample_format;
 155         /** MD5 digest of our content file */
 156         std::string content_digest;
 157         /** true if the source has subtitles */
 158         bool has_subtitles;
 159
 160 private:
 161         std::string thumb_file_for_frame (int) const;
 162         std::string thumb_base_for_frame (int) const;
 163 };
 164
 165 #endif