src/lib/film.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.h
  21  *  @brief A representation of a piece of video (with sound), including naming,
  22  *  the source content file, and how it should be presented in a DCP.
  23  */
  24
  25 #ifndef DVDOMATIC_FILM_H
  26 #define DVDOMATIC_FILM_H
  27
  28 #include <string>
  29 #include <vector>
  30 #include <inttypes.h>
  31 #include <boost/thread/mutex.hpp>
  32 #include <boost/thread.hpp>
  33 #include <sigc++/signal.h>
  34 extern "C" {
  35 #include <libavcodec/avcodec.h>
  36 }
  37 #include "dcp_content_type.h"
  38 #include "film_state.h"
  39
  40 class Format;
  41 class Job;
  42 class Filter;
  43 class Log;
  44 class ExamineContentJob;
  45
  46 /** @class Film
  47  *  @brief A representation of a video with sound.
  48  *
  49  *  A representation of a piece of video (with sound), including naming,
  50  *  the source content file, and how it should be presented in a DCP.
  51  */
  52 class Film
  53 {
  54 public:
  55         Film (std::string d, bool must_exist = true);
  56         Film (Film const &);
  57         ~Film ();
  58
  59         void write_metadata () const;
  60
  61         /** @return complete path to directory containing the film metadata */
  62         std::string directory () const {
  63                 return _state.directory;
  64         }
  65
  66         std::string content () const;
  67         ContentType content_type () const;
  68
  69         /** @return name for DVD-o-matic */
  70         std::string name () const {
  71                 return _state.name;
  72         }
  73
  74         /** @return name to give the DCP */
  75         std::string dcp_name () const {
  76                 return _state.dcp_name ();
  77         }
  78
  79         /** @return true to use a DCI-spec name for the DCP */
  80         bool use_dci_name () const {
  81                 return _state.use_dci_name;
  82         }
  83
  84         /** @return number of pixels to crop from the sides of the original picture */
  85         Crop crop () const {
  86                 return _state.crop;
  87         }
  88
  89         /** @return the format to present this film in (flat, scope, etc.) */
  90         Format const * format () const {
  91                 return _state.format;
  92         }
  93
  94         /** @return video filters that should be used when generating DCPs */
  95         std::vector<Filter const *> filters () const {
  96                 return _state.filters;
  97         }
  98
  99         /** @return scaler algorithm to use */
 100         Scaler const * scaler () const {
 101                 return _state.scaler;
 102         }
 103
 104         /** @return number of frames to put in the DCP, or 0 for all */
 105         int dcp_frames () const {
 106                 return _state.dcp_frames;
 107         }
 108
 109         /** @return what to do with the end of an encode when trimming */
 110         TrimAction dcp_trim_action () const {
 111                 return _state.dcp_trim_action;
 112         }
 113
 114         /** @return true to create an A/B comparison DCP, where the left half of the image
 115          *  is the video without any filters or post-processing, and the right half
 116          *  has the specified filters and post-processing.
 117          */
 118         bool dcp_ab () const {
 119                 return _state.dcp_ab;
 120         }
 121
 122         /** @return gain that should be applied to the audio when making a DCP
 123             (in dB).
 124         */
 125         float audio_gain () const {
 126                 return _state.audio_gain;
 127         }
 128
 129         /** @return delay to apply to audio (positive moves audio later) in milliseconds */
 130         int audio_delay () const {
 131                 return _state.audio_delay;
 132         }
 133
 134         /** @return duration to make still-sourced films (in seconds) */
 135         int still_duration () const {
 136                 return _state.still_duration;
 137         }
 138
 139         /** @return true to encode DCP with subtitles, if they are available */
 140         bool with_subtitles () const {
 141                 return _state.with_subtitles;
 142         }
 143
 144         /** @return offset to move subtitles by, in source pixels; +ve moves
 145             them down the image, -ve moves them up.
 146         */
 147         int subtitle_offset () const {
 148                 return _state.subtitle_offset;
 149         }
 150
 151         /** @return scaling factor to apply to subtitle images */
 152         float subtitle_scale () const {
 153                 return _state.subtitle_scale;
 154         }
 155
 156         void set_filters (std::vector<Filter const *> const &);
 157
 158         void set_scaler (Scaler const *);
 159
 160         /** @return the type of content that this Film represents (feature, trailer etc.) */
 161         DCPContentType const * dcp_content_type () {
 162                 return _state.dcp_content_type;
 163         }
 164
 165         void set_dcp_frames (int);
 166         void set_dcp_trim_action (TrimAction);
 167         void set_dcp_ab (bool);
 168
 169         void set_name (std::string);
 170         void set_use_dci_name (bool);
 171         void set_content (std::string);
 172         void set_top_crop (int);
 173         void set_bottom_crop (int);
 174         void set_left_crop (int);
 175         void set_right_crop (int);
 176         void set_format (Format const *);
 177         void set_dcp_content_type (DCPContentType const *);
 178         void set_audio_gain (float);
 179         void set_audio_delay (int);
 180         void set_still_duration (int);
 181         void set_with_subtitles (bool);
 182         void set_subtitle_offset (int);
 183         void set_subtitle_scale (float);
 184         void set_audio_language (std::string);
 185         void set_subtitle_language (std::string);
 186         void set_territory (std::string);
 187         void set_rating (std::string);
 188         void set_studio (std::string);
 189         void set_facility (std::string);
 190         void set_package_type (std::string);
 191
 192         /** @return size, in pixels, of the source (ignoring cropping) */
 193         Size size () const {
 194                 return _state.size;
 195         }
 196
 197         /** @return length, in video frames */
 198         int length () const {
 199                 return _state.length;
 200         }
 201
 202         /** @return nnumber of video frames per second */
 203         float frames_per_second () const {
 204                 return _state.frames_per_second;
 205         }
 206
 207         /** @return number of audio channels */
 208         int audio_channels () const {
 209                 return _state.audio_channels;
 210         }
 211
 212         /** @return audio sample rate, in Hz */
 213         int audio_sample_rate () const {
 214                 return _state.audio_sample_rate;
 215         }
 216
 217         /** @return format of the audio samples */
 218         AVSampleFormat audio_sample_format () const {
 219                 return _state.audio_sample_format;
 220         }
 221
 222         bool has_subtitles () const {
 223                 return _state.has_subtitles;
 224         }
 225
 226         std::string audio_language () const {
 227                 return _state.audio_language;
 228         }
 229
 230         std::string subtitle_language () const {
 231                 return _state.subtitle_language;
 232         }
 233
 234         std::string territory () const {
 235                 return _state.territory;
 236         }
 237
 238         std::string rating () const {
 239                 return _state.rating;
 240         }
 241
 242         std::string studio () const {
 243                 return _state.studio;
 244         }
 245
 246         std::string facility () const {
 247                 return _state.facility;
 248         }
 249
 250         std::string package_type () const {
 251                 return _state.package_type;
 252         }
 253
 254         std::string j2k_dir () const;
 255
 256         std::vector<std::string> audio_files () const;
 257
 258         void update_thumbs_pre_gui ();
 259         void update_thumbs_post_gui ();
 260         int num_thumbs () const;
 261         int thumb_frame (int) const;
 262         std::string thumb_file (int) const;
 263         std::pair<Position, std::string> thumb_subtitle (int) const;
 264
 265         void copy_from_dvd_post_gui ();
 266         void examine_content ();
 267         void examine_content_post_gui ();
 268         void send_dcp_to_tms ();
 269         void copy_from_dvd ();
 270
 271         /** @return true if our metadata has been modified since it was last saved */
 272         bool dirty () const {
 273                 return _dirty;
 274         }
 275
 276         void make_dcp (bool, int freq = 0);
 277
 278         enum Property {
 279                 NONE,
 280                 NAME,
 281                 CONTENT,
 282                 DCP_CONTENT_TYPE,
 283                 FORMAT,
 284                 CROP,
 285                 FILTERS,
 286                 SCALER,
 287                 DCP_FRAMES,
 288                 DCP_TRIM_ACTION,
 289                 DCP_AB,
 290                 AUDIO_GAIN,
 291                 AUDIO_DELAY,
 292                 THUMBS,
 293                 SIZE,
 294                 LENGTH,
 295                 FRAMES_PER_SECOND,
 296                 AUDIO_CHANNELS,
 297                 AUDIO_SAMPLE_RATE,
 298                 STILL_DURATION,
 299                 WITH_SUBTITLES,
 300                 SUBTITLE_OFFSET,
 301                 SUBTITLE_SCALE,
 302                 USE_DCI_NAME,
 303                 DCI_METADATA
 304         };
 305
 306         boost::shared_ptr<FilmState> state_copy () const;
 307
 308         /** @return Logger.
 309          *  It is safe to call this from any thread.
 310          */
 311         Log* log () const {
 312                 return _log;
 313         }
 314
 315         int encoded_frames () const;
 316
 317         /** Emitted when some metadata property has changed */
 318         mutable sigc::signal1<void, Property> Changed;
 319
 320 private:
 321         void read_metadata ();
 322         std::string metadata_file () const;
 323         void update_dimensions ();
 324         void signal_changed (Property);
 325
 326         /** The majority of our state.  Kept in a separate object
 327          *  so that it can easily be copied for passing onto long-running
 328          *  jobs (which then have an unchanging set of parameters).
 329          */
 330         FilmState _state;
 331
 332         /** true if our metadata has changed since it was last written to disk */
 333         mutable bool _dirty;
 334
 335         /** Log to write to */
 336         Log* _log;
 337
 338         /** Any running ExamineContentJob, or 0 */
 339         boost::shared_ptr<ExamineContentJob> _examine_content_job;
 340 };
 341
 342 #endif