libs/ardour/ardour/export_handler.h

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Sakari Bergen
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef __ardour_export_handler_h__
  22 #define __ardour_export_handler_h__
  23
  24 #include <map>
  25 #include <fstream>
  26
  27 #include <boost/operators.hpp>
  28 #include <boost/shared_ptr.hpp>
  29
  30 #include "ardour/export_pointers.h"
  31 #include "ardour/session.h"
  32 #include "ardour/libardour_visibility.h"
  33 #include "ardour/types.h"
  34
  35 namespace AudioGrapher {
  36         class BroadcastInfo;
  37 }
  38
  39 namespace ARDOUR
  40 {
  41
  42 class ExportTimespan;
  43 class ExportChannelConfiguration;
  44 class ExportFormatSpecification;
  45 class ExportFilename;
  46 class ExportGraphBuilder;
  47 class Location;
  48
  49 class LIBARDOUR_API ExportElementFactory
  50 {
  51   public:
  52
  53         ExportElementFactory (Session & session);
  54         ~ExportElementFactory ();
  55
  56         ExportTimespanPtr add_timespan ();
  57
  58         ExportChannelConfigPtr add_channel_config ();
  59
  60         ExportFormatSpecPtr    add_format ();
  61         ExportFormatSpecPtr    add_format (XMLNode const & state);
  62         ExportFormatSpecPtr    add_format_copy (ExportFormatSpecPtr other);
  63
  64         ExportFilenamePtr      add_filename ();
  65         ExportFilenamePtr      add_filename_copy (ExportFilenamePtr other);
  66
  67   private:
  68         Session & session;
  69 };
  70
  71 class LIBARDOUR_API ExportHandler : public ExportElementFactory
  72 {
  73   public:
  74         struct FileSpec {
  75                 FileSpec() {}
  76                 FileSpec (ExportChannelConfigPtr channel_config, ExportFormatSpecPtr format,
  77                           ExportFilenamePtr filename, BroadcastInfoPtr broadcast_info)
  78                   : channel_config (channel_config)
  79                   , format (format)
  80                   , filename (filename)
  81                   , broadcast_info (broadcast_info)
  82                         {}
  83
  84                 ExportChannelConfigPtr channel_config;
  85                 ExportFormatSpecPtr    format;
  86                 ExportFilenamePtr      filename;
  87                 BroadcastInfoPtr       broadcast_info;
  88         };
  89
  90   private:
  91         /* Session::get_export_handler() should be used to obtain an export handler
  92          * This ensures that it doesn't go out of scope before finalize_audio_export is called
  93          */
  94
  95         friend boost::shared_ptr<ExportHandler> Session::get_export_handler();
  96         ExportHandler (Session & session);
  97
  98   public:
  99         ~ExportHandler ();
 100
 101         bool add_export_config (ExportTimespanPtr timespan, ExportChannelConfigPtr channel_config,
 102                                 ExportFormatSpecPtr format, ExportFilenamePtr filename,
 103                                 BroadcastInfoPtr broadcast_info);
 104         void do_export ();
 105
 106         std::string get_cd_marker_filename(std::string filename, CDMarkerFormat format);
 107
 108   private:
 109
 110         void handle_duplicate_format_extensions();
 111         int process (framecnt_t frames);
 112
 113         Session &          session;
 114         boost::shared_ptr<ExportGraphBuilder> graph_builder;
 115         ExportStatusPtr    export_status;
 116
 117         /* The timespan and corresponding file specifications that we are exporting;
 118            there can be multiple FileSpecs for each ExportTimespan.
 119         */
 120         typedef std::multimap<ExportTimespanPtr, FileSpec> ConfigMap;
 121         ConfigMap          config_map;
 122
 123         bool               normalizing;
 124
 125         /* Timespan management */
 126
 127         void start_timespan ();
 128         int  process_timespan (framecnt_t frames);
 129         int  process_normalize ();
 130         void finish_timespan ();
 131
 132         typedef std::pair<ConfigMap::iterator, ConfigMap::iterator> TimespanBounds;
 133         ExportTimespanPtr     current_timespan;
 134         TimespanBounds        timespan_bounds;
 135
 136         PBD::ScopedConnection process_connection;
 137         framepos_t             process_position;
 138
 139         /* CD Marker stuff */
 140
 141         struct CDMarkerStatus {
 142                 CDMarkerStatus (std::string out_file, ExportTimespanPtr timespan,
 143                                 ExportFormatSpecPtr format, std::string filename)
 144                   : out (out_file.c_str()), timespan (timespan), format (format), filename (filename), marker(0)
 145                   , track_number (1), track_position (0), track_duration (0), track_start_frame (0)
 146                   , index_number (1), index_position (0)
 147                   {}
 148
 149                 /* General info */
 150                 std::ofstream  out;
 151                 ExportTimespanPtr   timespan;
 152                 ExportFormatSpecPtr format;
 153                 std::string         filename;
 154                 Location *          marker;
 155
 156                 /* Track info */
 157                 uint32_t        track_number;
 158                 framepos_t      track_position;
 159                 framepos_t      track_duration;
 160                 framepos_t      track_start_frame;
 161
 162                 /* Index info */
 163                 uint32_t       index_number;
 164                 framepos_t      index_position;
 165         };
 166
 167
 168         void export_cd_marker_file (ExportTimespanPtr timespan, ExportFormatSpecPtr file_format,
 169                                     std::string filename, CDMarkerFormat format);
 170
 171         void write_cue_header (CDMarkerStatus & status);
 172         void write_toc_header (CDMarkerStatus & status);
 173
 174         void write_track_info_cue (CDMarkerStatus & status);
 175         void write_track_info_toc (CDMarkerStatus & status);
 176
 177         void write_index_info_cue (CDMarkerStatus & status);
 178         void write_index_info_toc (CDMarkerStatus & status);
 179
 180         void frames_to_cd_frames_string (char* buf, framepos_t when);
 181         std::string toc_escape_cdtext (const std::string&);
 182         std::string toc_escape_filename (const std::string&);
 183         std::string cue_escape_cdtext (const std::string& txt);
 184
 185         int cue_tracknum;
 186         int cue_indexnum;
 187 };
 188
 189 } // namespace ARDOUR
 190
 191 #endif /* __ardour_export_handler_h__ */