summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/export_filename.h
blob: 94b13b65f095544bc6a77b047b9e89251bd74c7e (plain)
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
/*
    Copyright (C) 2008 Paul Davis
    Author: Sakari Bergen

    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 2 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, write to the Free Software
    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

*/

#ifndef __ardour_export_filename_h__
#define __ardour_export_filename_h__

#include <boost/shared_ptr.hpp>
#include <glibmm/ustring.h>
#include "pbd/statefuldestructible.h"

using Glib::ustring;

namespace ARDOUR
{

class Session;
class ExportTimespan;
class ExportChannelConfiguration;
class ExportFormatSpecification;

class ExportFilename {
  private:

	typedef boost::shared_ptr<ExportTimespan> TimespanPtr;
	typedef boost::shared_ptr<ExportChannelConfiguration> ChannelConfigPtr;
	typedef boost::shared_ptr<ExportFormatSpecification const> FormatPtr;

  public:

	enum DateFormat {
		D_None,
		D_ISO,       // ISO 8601 full date
		D_ISOShortY, // Like ISO 8601, but short year representation
		D_BE,        // big endian (no deliminator)
		D_BEShortY   // big endian short year representation
	};
	
	enum TimeFormat {
		T_None,
		T_NoDelim,
		T_Delim
	};

  private:
	friend class ExportElementFactory;
	ExportFilename (Session & session);

  public:	
	/* Serialization */
	
	XMLNode & get_state ();
	int set_state (const XMLNode &);
	
	/* data access */
	
	ustring get_path (FormatPtr format) const;
	ustring get_folder () const { return folder; }
	
	TimeFormat get_time_format () const { return time_format; }
	DateFormat get_date_format () const { return date_format; }
	ustring get_time_format_str (TimeFormat format) const;
	ustring get_date_format_str (DateFormat format) const;
	
	ustring get_label () const { return label; }
	uint32_t get_revision () const { return revision; }
	
	/* data modification */
	
	void set_time_format (TimeFormat format);
	void set_date_format (DateFormat format);
	void set_label (ustring value);
	void set_revision (uint32_t value) { revision = value; }
	void set_channel (uint32_t value) { channel = value; }
	bool set_folder (ustring path);
	
	void set_timespan (TimespanPtr ts) { timespan = ts; }
	void set_channel_config (ChannelConfigPtr cc) { channel_config = cc; }
	
	/* public members */
	
	bool include_label;
	bool include_session;
	bool include_revision;
	bool include_channel_config;
	bool include_channel;
	bool include_timespan;
	bool include_time;
	bool include_date;
	
  private:

	Session & session;

	ustring   label;
	uint32_t  revision;
	uint32_t  channel;
	
	ustring   folder;
	
	DateFormat date_format;
	TimeFormat time_format;
	
	ustring get_formatted_time (ustring const & format) const;
	struct tm * time_struct; // Due to static allocation no destructor or copy-ctor is needed because of this
	
	TimespanPtr timespan;
	ChannelConfigPtr channel_config;
	
	/* Serialization helpers */
	
	typedef std::pair<bool, ustring> FieldPair;
	
	void add_field (XMLNode * node, ustring const & name, bool enabled, ustring const & value = "");
	FieldPair get_field (XMLNode const & node, ustring const & name);
	FieldPair analyse_folder ();
	
};


} // namespace ARDOUR

#endif /* __ardour_export_filename_h__ */