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 "util.h"
  28
  29 /** @class Options
  30  *  @brief Options for a transcoding operation.
  31  *
  32  *  These are settings which may be different, in different circumstances, for
  33  *  the same film; ie they are options for a particular transcode operation.
  34  */
  35 class Options
  36 {
  37 public:
  38
  39         Options (std::string f, std::string e, std::string m)
  40                 : padding (0)
  41                 , apply_crop (true)
  42                 , black_after (0)
  43                 , decode_video_frequency (0)
  44                 , decode_audio (true)
  45                 , _frame_out_path (f)
  46                 , _frame_out_extension (e)
  47                 , _multichannel_audio_out_path (m)
  48         {}
  49
  50         /** @return The path to write video frames to */
  51         std::string frame_out_path () const {
  52                 return _frame_out_path;
  53         }
  54
  55         /** @param f Frame index.
  56          *  @param t true to return a temporary file path, otherwise a permanent one.
  57          *  @return The path to write this video frame to.
  58          */
  59         std::string frame_out_path (int f, bool t, std::string e = "") const {
  60                 if (e.empty ()) {
  61                         e = _frame_out_extension;
  62                 }
  63
  64                 std::stringstream s;
  65                 s << _frame_out_path << "/";
  66                 s.width (8);
  67                 s << std::setfill('0') << f << e;
  68
  69                 if (t) {
  70                         s << ".tmp";
  71                 }
  72
  73                 return s.str ();
  74         }
  75
  76         /** @return Path to write multichannel audio data to */
  77         std::string multichannel_audio_out_path () const {
  78                 return _multichannel_audio_out_path;
  79         }
  80
  81         /** @param c Audio channel index.
  82          *  @param t true to return a temporary file path, otherwise a permanent one.
  83          *  @return The path to write this audio file to.
  84          */
  85         std::string multichannel_audio_out_path (int c, bool t) const {
  86                 std::stringstream s;
  87                 s << _multichannel_audio_out_path << "/" << (c + 1) << ".wav";
  88                 if (t) {
  89                         s << ".tmp";
  90                 }
  91
  92                 return s.str ();
  93         }
  94
  95         Size out_size;              ///< size of output images
  96         float ratio;                ///< ratio of the wanted output image (not considering padding)
  97         int padding;                ///< number of pixels of padding (in terms of the output size) each side of the image
  98         bool apply_crop;            ///< true to apply cropping
  99         int black_after;            ///< first frame for which to output a black frame, rather than the actual video content, or 0 for none
 100         int decode_video_frequency; ///< skip frames so that this many are decoded in all (or 0) (for generating thumbnails)
 101         bool decode_audio;          ///< true to decode audio, otherwise false
 102
 103 private:
 104         /** Path of the directory to write video frames to */
 105         std::string _frame_out_path;
 106         /** Extension to use for video frame files (including the leading .) */
 107         std::string _frame_out_extension;
 108         /** Path of the directory to write audio files to */
 109         std::string _multichannel_audio_out_path;
 110 };