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