src/lib/options.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/options.h
  21  *  @brief Options for a transcoding operation.
  22  */
  23
  24 #include <string>
  25 #include <iomanip>
  26 #include <sstream>
  27 #include <boost/optional.hpp>
  28 #include "util.h"
  29
  30 /** @class Options
  31  *  @brief Options for a transcoding operation.
  32  *
  33  *  These are settings which may be different, in different circumstances, for
  34  *  the same film; ie they are options for a particular transcode operation.
  35  */
  36 class Options
  37 {
  38 public:
  39
  40         Options (std::string f, std::string e, std::string m)
  41                 : padding (0)
  42                 , apply_crop (true)
  43                 , decode_video_skip (0)
  44                 , decode_audio (true)
  45                 , decode_subtitles (false)
  46                 , _frame_out_path (f)
  47                 , _frame_out_extension (e)
  48                 , _multichannel_audio_out_path (m)
  49         {}
  50
  51         /** @return The path to write video frames to */
  52         std::string frame_out_path () const {
  53                 return _frame_out_path;
  54         }
  55
  56         /** @param f Source frame index.
  57          *  @param t true to return a temporary file path, otherwise a permanent one.
  58          *  @return The path to write this video frame to.
  59          */
  60         std::string frame_out_path (SourceFrame f, bool t, std::string e = "") const {
  61                 if (e.empty ()) {
  62                         e = _frame_out_extension;
  63                 }
  64
  65                 std::stringstream s;
  66                 s << _frame_out_path << "/";
  67                 s.width (8);
  68                 s << std::setfill('0') << f << e;
  69
  70                 if (t) {
  71                         s << ".tmp";
  72                 }
  73
  74                 return s.str ();
  75         }
  76
  77         /** @return Path to write multichannel audio data to */
  78         std::string multichannel_audio_out_path () const {
  79                 return _multichannel_audio_out_path;
  80         }
  81
  82         /** @param c Audio channel index.
  83          *  @param t true to return a temporary file path, otherwise a permanent one.
  84          *  @return The path to write this audio file to.
  85          */
  86         std::string multichannel_audio_out_path (int c, bool t) const {
  87                 std::stringstream s;
  88                 s << _multichannel_audio_out_path << "/" << (c + 1) << ".wav";
  89                 if (t) {
  90                         s << ".tmp";
  91                 }
  92
  93                 return s.str ();
  94         }
  95
  96         Size out_size;              ///< size of output images
  97         float ratio;                ///< ratio of the wanted output image (not considering padding)
  98         int padding;                ///< number of pixels of padding (in terms of the output size) each side of the image
  99         bool apply_crop;            ///< true to apply cropping
 100
 101         /** Range of video frames to decode */
 102         boost::optional<std::pair<SourceFrame, SourceFrame> > video_decode_range;
 103         /** Range of audio frames to decode */
 104         boost::optional<std::pair<int64_t, int64_t> > audio_decode_range;
 105
 106         /** Skip frames such that we don't decode any frame where (index % decode_video_skip) != 0; e.g.
 107          *  1 for every frame, 2 for every other frame, etc.
 108          */
 109         SourceFrame decode_video_skip;
 110         bool decode_audio;          ///< true to decode audio, otherwise false
 111         bool decode_subtitles;
 112
 113 private:
 114         /** Path of the directory to write video frames to */
 115         std::string _frame_out_path;
 116         /** Extension to use for video frame files (including the leading .) */
 117         std::string _frame_out_extension;
 118         /** Path of the directory to write audio files to */
 119         std::string _multichannel_audio_out_path;
 120 };