File: minimizeduration.cc

package info (click to toggle)
subtitleeditor 0.56.1-2
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 8,908 kB
  • sloc: cpp: 26,446; makefile: 1,713; perl: 434; sh: 259; xml: 149
file content (189 lines) | stat: -rw-r--r-- 7,465 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
// subtitleeditor -- a tool to create or edit subtitle
//
// https://subtitleeditor.github.io/subtitleeditor/
// https://github.com/subtitleeditor/subtitleeditor/
//
// Copyright @ 2005-2018, kitone
//
// - "the ultimate subtitle fitness center"
// a subtitleeditor plugin by Eltomito <tomaspartl@centrum.cz>
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

#include <debug.h>
#include <extension/action.h>
#include <i18n.h>
#include <utility.h>

class MinimizeDurationPlugin : public Action {
  public:
   MinimizeDurationPlugin() {
      activate();
      update_ui();
   }

   ~MinimizeDurationPlugin() {
      deactivate();
   }

   void activate() {
      se_dbg(SE_DBG_PLUGINS);

      // actions
      action_group = Gtk::ActionGroup::create("MinimizeDurationPlugin");

      action_group->add(Gtk::Action::create("minimize-duration",
                                            _("Minimize Duration From Start"),
                                            _("Compact all selected subtitles to their minimum permissible "
                                              "duration set in preferences by decreasing the end timecode, so "
                                              "start time is unchanged")),
                        sigc::mem_fun(*this, &MinimizeDurationPlugin::on_minimize_duration_from_start));
      action_group->add(Gtk::Action::create("minimize-duration-from-end",
                                            _("Minimize Duration From End"),
                                            _("Compact all selected subtitles to their minimum permissible "
                                              "duration set in preferences by increasing the start timecode, "
                                              "so end time is unchanged")),
                        sigc::mem_fun(*this, &MinimizeDurationPlugin::on_minimize_duration_from_end));

      action_group->add(Gtk::Action::create("idealize-duration",
                                            _("_Idealize Duration From Start"),
                                            _("Compact all selected subtitles to their ideal "
                                              "duration set in preferences by decreasing the "
                                              "end timecode, so start time is unchanged")),
                        sigc::mem_fun(*this, &MinimizeDurationPlugin::on_idealize_duration_from_start));
      action_group->add(Gtk::Action::create("idealize-duration-from-end",
                                            _("_Idealize Duration From End"),
                                            _("Compact all selected subtitles to their ideal "
                                              "duration set in preferences by increasing the "
                                              "start timecode, so end time is unchanged")),
                        sigc::mem_fun(*this, &MinimizeDurationPlugin::on_idealize_duration_from_end));

      // ui
      Glib::RefPtr<Gtk::UIManager> ui = get_ui_manager();

      ui_id = ui->new_merge_id();

      ui->insert_action_group(action_group);

      ui->add_ui(ui_id, "/menubar/menu-timings/idealize-duration", "idealize-duration", "idealize-duration");
      ui->add_ui(ui_id, "/menubar/menu-timings/idealize-duration-from-end", "idealize-duration-from-end", "idealize-duration-from-end");
      ui->add_ui(ui_id, "/menubar/menu-timings/minimize-duration", "minimize-duration", "minimize-duration");
      ui->add_ui(ui_id, "/menubar/menu-timings/minimize-duration-from-end", "minimize-duration-from-end", "minimize-duration-from-end");
   }

   void deactivate() {
      se_dbg(SE_DBG_PLUGINS);

      Glib::RefPtr<Gtk::UIManager> ui = get_ui_manager();

      ui->remove_ui(ui_id);
      ui->remove_action_group(action_group);
   }

   void update_ui() {
      se_dbg(SE_DBG_PLUGINS);

      bool visible = (get_current_document() != NULL);

      action_group->get_action("minimize-duration")->set_sensitive(visible);
      action_group->get_action("minimize-duration-from-end")->set_sensitive(visible);
      action_group->get_action("idealize-duration")->set_sensitive(visible);
      action_group->get_action("idealize-duration-from-end")->set_sensitive(visible);
   }

  protected:
   void on_idealize_duration_from_start() {
      se_dbg(SE_DBG_PLUGINS);

      execute(cfg::get_double("timing", "ideal-characters-per-second"), true);
   }

   void on_idealize_duration_from_end() {
      se_dbg(SE_DBG_PLUGINS);

      execute(cfg::get_double("timing", "ideal-characters-per-second"), false);
   }

   void on_minimize_duration_from_start() {
      se_dbg(SE_DBG_PLUGINS);

      execute(cfg::get_double("timing", "max-characters-per-second"), true);
   }

   void on_minimize_duration_from_end() {
      se_dbg(SE_DBG_PLUGINS);

      execute(cfg::get_double("timing", "max-characters-per-second"), false);
   }

   bool execute(double maxcps, bool from_start) {
      se_dbg(SE_DBG_PLUGINS);

      Document* doc = get_current_document();

      g_return_val_if_fail(doc, false);

      Subtitles subtitles = doc->subtitles();

      // NOTE: the selection returned is always sorted regardless of the order the
      // user clicked on the subtitles in or at least it was when I tried it.
      std::vector<Subtitle> selection = subtitles.get_selection();

      if (selection.size() < 1) {
         doc->flash_message(_("This action needs at least one subtitle to work on."));
         return false;
      }

      // get relevant preferences
      SubtitleTime mindur = cfg::get_int("timing", "min-display");

      doc->start_command(_("Minimize Durations"));

      Glib::ustring subtext = "";

      // take each subtitle and set its duration to the permissible minimum
      unsigned long subchars = 0;
      SubtitleTime dur;

      for (auto& sub : selection) {
         subtext = sub.get_text();
         subchars = utility::get_text_length_for_timing(subtext);
         dur.totalmsecs = utility::get_min_duration_msecs(subchars, maxcps);
         // doc->flash_message ( _("duration calculated is 1000 * %i / %i = %i"),
         // (int)subchars, (int)maxcps, (int)dur.totalmsecs ); make sure we have at
         // least the minimum duration
         if (dur < mindur)
            dur = mindur;

         if (from_start) {
            // the start time is fixed, we are changind the end time
            sub.set_duration(dur);
         } else {
            // the end time is fixed, we are changing the start time
            SubtitleTime endtime = sub.get_end();
            sub.set_start_and_end(endtime - dur, endtime);
         }
      }

      doc->emit_signal("subtitle-time-changed");
      doc->finish_command();
      return true;
   }

  protected:
   Gtk::UIManager::ui_merge_id ui_id;
   Glib::RefPtr<Gtk::ActionGroup> action_group;
};

REGISTER_EXTENSION(MinimizeDurationPlugin)