src/lib/filter.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/filter.h
  21  *  @brief A class to describe one of FFmpeg's video or post-processing filters.
  22  */
  23
  24 #ifndef DCPOMATIC_FILTER_H
  25 #define DCPOMATIC_FILTER_H
  26
  27 #include <string>
  28 #include <vector>
  29 #include <boost/utility.hpp>
  30
  31 /** @class Filter
  32  *  @brief A class to describe one of FFmpeg's video or post-processing filters.
  33  */
  34 class Filter : public boost::noncopyable
  35 {
  36 public:
  37         Filter (std::string, std::string, std::string, std::string, std::string);
  38
  39         /** @return our id */
  40         std::string id () const {
  41                 return _id;
  42         }
  43
  44         /** @return user-visible name */
  45         std::string name () const {
  46                 return _name;
  47         }
  48
  49         /** @return string for a FFmpeg video filter descriptor */
  50         std::string vf () const {
  51                 return _vf;
  52         }
  53
  54         /** @return string for a FFmpeg post-processing descriptor */
  55         std::string pp () const {
  56                 return _pp;
  57         }
  58
  59         std::string category () const {
  60                 return _category;
  61         }
  62
  63         static std::vector<Filter const *> all ();
  64         static Filter const * from_id (std::string);
  65         static void setup_filters ();
  66         static std::pair<std::string, std::string> ffmpeg_strings (std::vector<Filter const *> const &);
  67
  68 private:
  69
  70         /** our id */
  71         std::string _id;
  72         /** user-visible name */
  73         std::string _name;
  74         std::string _category;
  75         /** string for a FFmpeg video filter descriptor */
  76         std::string _vf;
  77         /** string for a FFmpeg post-processing descriptor */
  78         std::string _pp;
  79
  80         /** all available filters */
  81         static std::vector<Filter const *> _filters;
  82         static void maybe_add (std::string, std::string, std::string, std::string, std::string);
  83 };
  84
  85 #endif